SCR_OrbitingManualCameraComponent Interface Reference

Inheritance diagram for SCR_OrbitingManualCameraComponent:

Public Member Functions
bool	GetCenterPos ()
override void	EOnCameraFrame (SCR_ManualCameraParam param)
	Evaluate the component every frame.
override bool	EOnCameraInit ()
	Initialise the component.
override void	EOnCameraParentChange (bool attached, IEntity parent)
	Terminate the component.
Public Member Functions inherited from SCR_BaseManualCameraComponent
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)
void	EOnCameraExit ()
	Terminate the component.
void	EOnCameraReset ()
	Camera value are reset.
void	EOnCameraSave (SCR_ManualCameraComponentSave data)
	Save persistent data.
void	EOnCameraLoad (SCR_ManualCameraComponentSave data)
	Load persistent data.

Static Protected Attributes
static const float	INERTIA_THRESHOLD = 0.001

Additional Inherited Members
Protected Member Functions inherited from SCR_BaseManualCameraComponent
SCR_ManualCamera	GetCameraEntity ()
InputManager	GetInputManager ()
vector	CoordToCamera (vector pos)
vector	CoordFromCamera (vector pos)
Protected Attributes inherited from SCR_BaseManualCameraComponent
int	m_iPriority
SCR_ManualCamera	m_Camera
InputManager	m_InputManager

Detailed Description

Camera orbitting around a target

Member Function Documentation

EOnCameraFrame()

override void SCR_OrbitingManualCameraComponent.EOnCameraFrame

(

SCR_ManualCameraParam

param

)

Evaluate the component every frame.

Parameters

[in]

param

Object carrying camera properties

Implements SCR_BaseManualCameraComponent.

EOnCameraInit()

override bool SCR_OrbitingManualCameraComponent.EOnCameraInit

(

)

Initialise the component.

Returns

True if the component should be evaluated every frame

Implements SCR_BaseManualCameraComponent.

EOnCameraParentChange()

override void SCR_OrbitingManualCameraComponent.EOnCameraParentChange	(	bool	attached,
		IEntity	parent
	)

Terminate the component.

Parameters

[in]	attached
[in]	parent

Implements SCR_BaseManualCameraComponent.

GetCenterPos()

bool SCR_OrbitingManualCameraComponent.GetCenterPos

(

)

Returns

Member Data Documentation

INERTIA_THRESHOLD

const float SCR_OrbitingManualCameraComponent.INERTIA_THRESHOLD = 0.001

staticprotected

---

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

• Game/Camera/Components/SCR_OrbitingManualCameraComponent.c