SCR_BaseManualCameraComponent Interface Reference

Inheritance diagram for SCR_BaseManualCameraComponent:

Public Member Functions
void	SetEnabled (bool enabled)
	Enable the component.
int	IsEnabled ()
	Check if the component is enabled.
int	GetPriority ()
	Get evaluation priority.
bool	HasFlag (EManualCameraFlag flag)
	Check if the required flag is active.
bool	InitBase (SCR_ManualCamera camera)
Override Methods
Methods to be overridden by child classes.
void	EOnCameraFrame (SCR_ManualCameraParam param)
	Evaluate the component every frame.
bool	EOnCameraInit ()
	Initialise the component.
void	EOnCameraExit ()
	Terminate the component.
void	EOnCameraReset ()
	Camera value are reset.
void	EOnCameraParentChange (bool attached, IEntity parent)
	Terminate the component.
void	EOnCameraSave (SCR_ManualCameraComponentSave data)
	Save persistent data.
void	EOnCameraLoad (SCR_ManualCameraComponentSave data)
	Load persistent data.

Protected Member Functions
SCR_ManualCamera	GetCameraEntity ()
InputManager	GetInputManager ()
vector	CoordToCamera (vector pos)
vector	CoordFromCamera (vector pos)

Protected Attributes
int	m_iPriority
SCR_ManualCamera	m_Camera
InputManager	m_InputManager

Detailed Description

Parent class from which all SCR_ManualCamera components inherit.

Member Function Documentation

CoordFromCamera()

vector SCR_BaseManualCameraComponent.CoordFromCamera ( vector  pos )

protected

CoordToCamera()

vector SCR_BaseManualCameraComponent.CoordToCamera ( vector  pos )

protected

EOnCameraExit()

void SCR_BaseManualCameraComponent.EOnCameraExit

(

)

Terminate the component.

Implemented in SCR_AdjustSpeedManualCameraComponent, SCR_AttachManualCameraComponent, SCR_ControlPlayerCameraComponent, SCR_EditorToggleUIManualCameraComponent, SCR_FocusManualCameraComponent, SCR_HideHUDManualCameraComponent, SCR_LightManualCameraComponent, SCR_MapDescriptorManualCameraComponent, SCR_RotateModifierManualCameraComponent, SCR_SaveManualCameraComponent, SCR_SetSpeedManualCameraComponent, SCR_SettingsManualCameraComponent, SCR_SpeedBoostManualCameraComponent, SCR_TeleportPlayerManualCameraComponent, SCR_ToggleUIManualCameraComponent, SCR_UIManualCameraComponent, and SCR_ViewLinkManualCameraComponent.

EOnCameraFrame()

void SCR_BaseManualCameraComponent.EOnCameraFrame

(

SCR_ManualCameraParam

param

)

Evaluate the component every frame.

Parameters

[in]

param

Object carrying camera properties

Implemented in SCR_AccelerationManualCameraComponent, SCR_AdjustSpeedManualCameraComponent, SCR_ATLManualCameraComponent, SCR_AttachManualCameraComponent, SCR_ControlPlayerCameraComponent, SCR_EditorCursorManualCameraComponent, SCR_EditorHoveredManualCameraComponent, SCR_EditorSnapManualCameraComponent, SCR_FocusManualCameraComponent, SCR_InitInputManualCameraComponent, SCR_LightManualCameraComponent, SCR_LimitBoxManualCameraComponent, SCR_LimitCylinderManualCameraComponent, SCR_MapDescriptorManualCameraComponent, SCR_MoveManualCameraComponent, SCR_MovementInertiaManualCameraComponent, SCR_MoveRelativeManualCameraComponent, SCR_MoveToCursorManualCameraComponent, SCR_OrbitingManualCameraComponent, SCR_RotateManualCameraComponent, SCR_RotateModifierManualCameraComponent, SCR_RotateRollManualCameraComponent, SCR_RotationInertiaManualCameraComponent, SCR_SetSpeedManualCameraComponent, SCR_SettingsManualCameraComponent, SCR_SpeedBoostManualCameraComponent, SCR_SpeedBoostUpManualCameraComponent, SCR_SpeedByHeightManualCameraComponent, SCR_TeleportToCursorManualCameraComponent, SCR_TerrainCollisionManualCameraComponent, SCR_ViewLinkManualCameraComponent, and SCR_ZoomManualCameraComponent.

EOnCameraInit()

bool SCR_BaseManualCameraComponent.EOnCameraInit

(

)

Initialise the component.

Returns

True if the component should be evaluated every frame

Implemented in SCR_AccelerationManualCameraComponent, SCR_AdjustSpeedManualCameraComponent, SCR_ATLManualCameraComponent, SCR_AttachManualCameraComponent, SCR_CampaignBuildingLimitCylinderManualCameraComponent, SCR_ControlPlayerCameraComponent, SCR_EditorCursorManualCameraComponent, SCR_EditorHoveredManualCameraComponent, SCR_EditorSnapManualCameraComponent, SCR_EditorToggleUIManualCameraComponent, SCR_FocusManualCameraComponent, SCR_HideHUDManualCameraComponent, SCR_InitInputManualCameraComponent, SCR_LensFlareManualCameraComponent, SCR_LightManualCameraComponent, SCR_LimitBoxManualCameraComponent, SCR_LimitCylinderManualCameraComponent, SCR_MapDescriptorManualCameraComponent, SCR_MoveManualCameraComponent, SCR_MovementInertiaManualCameraComponent, SCR_MoveRelativeManualCameraComponent, SCR_MoveToCursorManualCameraComponent, SCR_OrbitingManualCameraComponent, SCR_RotateManualCameraComponent, SCR_RotateModifierManualCameraComponent, SCR_RotateRollManualCameraComponent, SCR_RotationInertiaManualCameraComponent, SCR_SaveManualCameraComponent, SCR_SetSpeedManualCameraComponent, SCR_SettingsManualCameraComponent, SCR_SpeedBoostManualCameraComponent, SCR_SpeedBoostUpManualCameraComponent, SCR_SpeedByHeightManualCameraComponent, SCR_TeleportPlayerManualCameraComponent, SCR_TeleportToCursorManualCameraComponent, SCR_TerrainCollisionManualCameraComponent, SCR_ToggleUIManualCameraComponent, SCR_UIManualCameraComponent, SCR_ViewLinkManualCameraComponent, and SCR_ZoomManualCameraComponent.

EOnCameraLoad()

void SCR_BaseManualCameraComponent.EOnCameraLoad

(

SCR_ManualCameraComponentSave

data

)

Load persistent data.

Parameters

[in]

data

Implemented in SCR_AdjustSpeedManualCameraComponent, SCR_AttachManualCameraComponent, SCR_FocusManualCameraComponent, SCR_LensFlareManualCameraComponent, SCR_LightManualCameraComponent, SCR_MoveManualCameraComponent, SCR_RotateRollManualCameraComponent, and SCR_ZoomManualCameraComponent.

EOnCameraParentChange()

void SCR_BaseManualCameraComponent.EOnCameraParentChange	(	bool	attached,
		IEntity	parent
	)

Terminate the component.

Parameters

[in]	attached
[in]	parent

Implemented in SCR_OrbitingManualCameraComponent, and SCR_TeleportToCursorManualCameraComponent.

EOnCameraReset()

void SCR_BaseManualCameraComponent.EOnCameraReset

(

)

Camera value are reset.

Implemented in SCR_FocusManualCameraComponent, SCR_RotateRollManualCameraComponent, and SCR_ZoomManualCameraComponent.

EOnCameraSave()

void SCR_BaseManualCameraComponent.EOnCameraSave

(

SCR_ManualCameraComponentSave

data

)

Save persistent data.

Parameters

[in]

data

Implemented in SCR_AdjustSpeedManualCameraComponent, SCR_AttachManualCameraComponent, SCR_FocusManualCameraComponent, SCR_LensFlareManualCameraComponent, SCR_LightManualCameraComponent, SCR_MoveManualCameraComponent, SCR_RotateRollManualCameraComponent, and SCR_ZoomManualCameraComponent.

GetCameraEntity()

SCR_ManualCamera SCR_BaseManualCameraComponent.GetCameraEntity ( )

protected

GetInputManager()

InputManager SCR_BaseManualCameraComponent.GetInputManager ( )

protected

GetPriority()

int SCR_BaseManualCameraComponent.GetPriority

(

)

Get evaluation priority.

Returns

Priority. Higher value = higher priority.

HasFlag()

bool SCR_BaseManualCameraComponent.HasFlag

(

EManualCameraFlag

flag

)

Check if the required flag is active.

Parameters

[in]

Camera

flag

Returns

True if the camera flag contains the required flag

InitBase()

bool SCR_BaseManualCameraComponent.InitBase

(

SCR_ManualCamera

camera

)

Parameters

[in]

camera

Returns

IsEnabled()

int SCR_BaseManualCameraComponent.IsEnabled

(

)

Check if the component is enabled.

Returns

True when enabled

SetEnabled()

void SCR_BaseManualCameraComponent.SetEnabled

(

bool

enabled

)

Enable the component.

EOnCameraFrame is not evaluated for disabled components.

Parameters

[in]

True

to enable the component, false to disable it

Member Data Documentation

m_Camera

SCR_ManualCamera SCR_BaseManualCameraComponent.m_Camera

protected

m_InputManager

InputManager SCR_BaseManualCameraComponent.m_InputManager

protected

m_iPriority

int SCR_BaseManualCameraComponent.m_iPriority

protected

---

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

• Game/Camera/Components/SCR_BaseManualCameraComponent.c