Inheritance diagram for SCR_CameraEditorComponent:

Public Member Functions
SCR_ManualCamera	GetCamera ()
	Get the camera entity.

bool	GetCamera (out SCR_ManualCamera camera)
	Get the camera entity.

ScriptInvokerBase< SCR_CameraEditorComponent_OnCameraCreated >	GetOnCameraCreate ()
	Get invoker called when new manual camera is created.

void	SetInitTransform (vector transform[4])
	Set initial camera transformation.

override void	ResetEditorComponent ()
	Reset values controlled by the component.

override void	EOnFrame (IEntity owner, float timeSlice)

Public Member Functions inherited from SCR_BaseEditorComponent
void	OnInitBase ()

void	OnDeleteBase ()

void	OnRequestBase (bool isOpen)

void	OnOpenedBase ()

void	OnClosedBase ()

void	OnPreActivateBase ()

void	OnActivateBase ()

bool	OnActivateAsyncBase (int attempt)

void	OnPostActivateBase ()

void	OnDeactivateBase ()

void	OnPostDeactivateBase ()

bool	OnDeactivateAsyncBase (int attempt)

void	OnEffectBase (SCR_BaseEditorEffect effect)

SCR_EditorManagerEntity	GetManager ()
	Get editor manager this component belongs to.

SCR_BaseEditorComponent	FindEditorComponent (TypeName type, bool showError=false, bool modeFirst=false)
	Get the editor manager to which this component belongs.

EntityComponentPrefabData	GetEditorComponentData ()
	Get prefab data of this component.

bool	IsRemoved ()
	Check if the component is being deleted.

ScriptInvoker	GetOnEffect ()
	Get event called when an effect is activated.

void	InitServer ()

void	InitOwner ()

override void	OnPostInit (IEntity owner)

void	SCR_BaseEditorComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

void	~SCR_BaseEditorComponent ()

Static Public Member Functions
static SCR_ManualCamera	GetCameraInstance ()
	Get camera entity instance.

Static Public Member Functions inherited from SCR_BaseEditorComponent
static Managed	GetInstance (TypeName type, bool showError=false, bool modeFirst=false)
	Get the local instance of a component attached on editor manager (SCR_EditorManagerEntity).

static Managed	GetInstance (SCR_EditorBaseEntity editorManager, TypeName type, bool showError=false)
	Get instance of a component attached on specific editor manager / mode (SCR_EditorBaseEntity).

static int	GetAllInstances (TypeName type, out notnull array< Managed > outComponents)
	Get component instances on editor manager (SCR_EditorBaseEntity) and all its modes (SCR_EditorModeEntity).

Protected Member Functions
void	InitCameraTransform ()

void	TryCreateCamera ()

bool	TryForceCamera ()

void	ReplaceCamera ()

void	CreateCamera ()

void	OnCameraDectivate ()

ResourceName	GetCameraPrefab ()

override void	EOnEditorInit ()
	When the entity is created.

override void	EOnEditorPreActivate ()
	Before the component is activated.

override void	EOnEditorPostActivate ()
	When the component is activated, but after EOnEditorActivate() function was called in all components.

override void	EOnEditorDeactivate ()
	When the component is deactivated.

override void	EOnEditorPostDeactivate ()
	When the component is deactivated, but after the next mode is activated.

Protected Member Functions inherited from SCR_BaseEditorComponent
bool	IsOnEditorManager ()

bool	IsOwner ()

bool	IsProxy ()

bool	IsMaster ()

bool	IsAdmin ()

SCR_BaseEditorComponent	GetParentComponent ()

void	SetParentComponent (SCR_BaseEditorComponent parent)

void	SendNotification (ENotification notificationID, int selfID=0, int targetID=0, vector position=vector.Zero)

void	EOnEditorDelete ()
	When the entity is destroyed.

void	EOnEditorRequest (bool isOpen)
	When opening/closing request is sent to server.

void	EOnEditorOpen ()
	When the editor is opened.

void	EOnEditorClose ()
	When the editor is closed.

void	EOnEditorActivate ()
	When the component is activated.

bool	EOnEditorActivateAsync (int attempt)
	When the component is activated.

bool	EOnEditorDeactivateAsync (int attempt)
	When the component is deactivated.

void	EOnEditorDebug (array< string > debugTexts)
	Every frame while the editor is opened and debug menu is shown.

void	EOnEffect (SCR_BaseEditorEffect effect)
	When an effect is created in reaction an an event.

void	EOnEditorInitServer ()
	When the entity is created (called on server)

void	EOnEditorDeleteServer ()
	When the entity is destroyed (called on server)

void	EOnEditorOpenServer ()
	When the editor is opened (called on server)

void	EOnEditorOpenServerCallback ()
	When the editor is opened (called on server after async loading finished on client)

void	EOnEditorCloseServer ()
	When the editor is closed (called on server)

void	EOnEditorCloseServerCallback ()
	When the editor is closed (called on server after async loading finished on client)

void	EOnEditorActivateServer ()
	When the component is activated (called on server)

void	EOnEditorDeactivateServer ()
	When the component is deactivated (called on server)

Protected Attributes
ResourceName	m_CameraPrefab

bool	m_bMoveUpOnInit

float	m_fDistance

vector	m_vDefaultOffset

vector	m_vDefaultAngle

CameraManager	m_CameraManager

SCR_ManualCamera	m_Camera

SCR_CameraDataEditorComponent	m_CameraData

vector	m_vInitCameraTransform [4]

vector	m_vPreActivateCameraTransform [4]

IEntity	m_PreActivateControlledEntity

bool	m_bIsReplacingCamera

ref ScriptInvokerBase< SCR_CameraEditorComponent_OnCameraCreated >	m_OnCameraCreate = new ScriptInvokerBase<SCR_CameraEditorComponent_OnCameraCreated>()

Protected Attributes inherited from SCR_BaseEditorComponent
SCR_EditorBaseEntity	m_Owner

SCR_EditorManagerEntity	m_Manager

SCR_BaseEditorComponent	m_Parent

RplComponent	m_RplComponent

Member Function Documentation

◆ CreateCamera()

void SCR_CameraEditorComponent.CreateCamera ( )

protected

Implemented in SCR_CampaignBuildingCameraEditorComponent.

◆ EOnEditorDeactivate()

override void SCR_CameraEditorComponent.EOnEditorDeactivate ( )

protected

When the component is deactivated.

When attached on SCR_EditorManagerEntity, this is executed together with EOnEditorClose()
When attached on SCR_EditorModeEntity, it's executed when the mode is deactivated

Implements SCR_BaseEditorComponent.

Implemented in SCR_CameraLimitedEditorComponent.

◆ EOnEditorInit()

override void SCR_CameraEditorComponent.EOnEditorInit ( )

protected

When the entity is created.

Implements SCR_BaseEditorComponent.

◆ EOnEditorPostActivate()

override void SCR_CameraEditorComponent.EOnEditorPostActivate ( )

protected

When the component is activated, but after EOnEditorActivate() function was called in all components.

Implements SCR_BaseEditorComponent.

◆ EOnEditorPostDeactivate()

override void SCR_CameraEditorComponent.EOnEditorPostDeactivate ( )

protected

When the component is deactivated, but after the next mode is activated.

Implements SCR_BaseEditorComponent.

◆ EOnEditorPreActivate()

override void SCR_CameraEditorComponent.EOnEditorPreActivate ( )

protected

Before the component is activated.

When attached on SCR_EditorManagerEntity, this is executed together with EOnEditorOpen()
When attached on SCR_EditorModeEntity, it's executed before previous mode is deactivated, so values can be read from it

Implements SCR_BaseEditorComponent.

◆ EOnFrame()

override void SCR_CameraEditorComponent.EOnFrame	(	IEntity	owner,
		float	timeSlice )

Implemented in SCR_CameraLimitedEditorComponent.

◆ GetCamera() [1/2]

SCR_ManualCamera SCR_CameraEditorComponent.GetCamera ( )

Get the camera entity.

Returns: Camera

◆ GetCamera() [2/2]

bool SCR_CameraEditorComponent.GetCamera ( out SCR_ManualCamera camera )

Get the camera entity.

Parameters

[out] camera Variable to be filled with the camera entity

Returns: True if the camera exists

◆ GetCameraInstance()

static SCR_ManualCamera SCR_CameraEditorComponent.GetCameraInstance ( )

static

Get camera entity instance.

Returns: Camera

◆ GetCameraPrefab()

ResourceName SCR_CameraEditorComponent.GetCameraPrefab ( )

protected

Implemented in SCR_CameraLimitedEditorComponent.

◆ GetOnCameraCreate()

ScriptInvokerBase< SCR_CameraEditorComponent_OnCameraCreated > SCR_CameraEditorComponent.GetOnCameraCreate ( )

Get invoker called when new manual camera is created.

Returns: Script invoker

◆ InitCameraTransform()

void SCR_CameraEditorComponent.InitCameraTransform ( )

protected

◆ OnCameraDectivate()

void SCR_CameraEditorComponent.OnCameraDectivate ( )

protected

◆ ReplaceCamera()

void SCR_CameraEditorComponent.ReplaceCamera ( )

protected

◆ ResetEditorComponent()

override void SCR_CameraEditorComponent.ResetEditorComponent ( )

Reset values controlled by the component.

To be overridden by child classes.

Implements SCR_BaseEditorComponent.

◆ SetInitTransform()

void SCR_CameraEditorComponent.SetInitTransform ( vector transform[4] )

Set initial camera transformation.

To be used before camera is created.

Parameters

transform Tranaformation matrix

◆ TryCreateCamera()

void SCR_CameraEditorComponent.TryCreateCamera ( )

protected

◆ TryForceCamera()

bool SCR_CameraEditorComponent.TryForceCamera ( )

protected

Member Data Documentation

◆ m_bIsReplacingCamera

bool SCR_CameraEditorComponent.m_bIsReplacingCamera

protected

◆ m_bMoveUpOnInit

bool SCR_CameraEditorComponent.m_bMoveUpOnInit

protected

◆ m_Camera

SCR_ManualCamera SCR_CameraEditorComponent.m_Camera

protected

◆ m_CameraData

SCR_CameraDataEditorComponent SCR_CameraEditorComponent.m_CameraData

protected

◆ m_CameraManager

CameraManager SCR_CameraEditorComponent.m_CameraManager

protected

◆ m_CameraPrefab

ResourceName SCR_CameraEditorComponent.m_CameraPrefab

protected

◆ m_fDistance

float SCR_CameraEditorComponent.m_fDistance

protected

◆ m_OnCameraCreate

ref ScriptInvokerBase<SCR_CameraEditorComponent_OnCameraCreated> SCR_CameraEditorComponent.m_OnCameraCreate = new ScriptInvokerBase<SCR_CameraEditorComponent_OnCameraCreated>()

protected

◆ m_PreActivateControlledEntity

IEntity SCR_CameraEditorComponent.m_PreActivateControlledEntity

protected

◆ m_vDefaultAngle

vector SCR_CameraEditorComponent.m_vDefaultAngle

protected

◆ m_vDefaultOffset

vector SCR_CameraEditorComponent.m_vDefaultOffset

protected

◆ m_vInitCameraTransform

vector SCR_CameraEditorComponent.m_vInitCameraTransform[4]

protected

◆ m_vPreActivateCameraTransform

vector SCR_CameraEditorComponent.m_vPreActivateCameraTransform[4]

protected

The documentation for this interface was generated from the following file:

Game/Editor/Components/Editor/SCR_CameraEditorComponent.c

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ CreateCamera()

◆ EOnEditorDeactivate()

◆ EOnEditorInit()

◆ EOnEditorPostActivate()

◆ EOnEditorPostDeactivate()

◆ EOnEditorPreActivate()

◆ EOnFrame()

◆ GetCamera() [1/2]

◆ GetCamera() [2/2]

◆ GetCameraInstance()

◆ GetCameraPrefab()

◆ GetOnCameraCreate()

◆ InitCameraTransform()

◆ OnCameraDectivate()

◆ ReplaceCamera()

◆ ResetEditorComponent()

◆ SetInitTransform()

◆ TryCreateCamera()

◆ TryForceCamera()

Member Data Documentation

◆ m_bIsReplacingCamera

◆ m_bMoveUpOnInit

◆ m_Camera

◆ m_CameraData

◆ m_CameraManager

◆ m_CameraPrefab

◆ m_fDistance

◆ m_OnCameraCreate

◆ m_PreActivateControlledEntity

◆ m_vDefaultAngle

◆ m_vDefaultOffset

◆ m_vInitCameraTransform

◆ m_vPreActivateCameraTransform