SCR_BaseManualCameraComponent Class Reference

Parent class from which all SCR_ManualCamera components inherit. More...

Inheritance diagram for SCR_BaseManualCameraComponent:

Protected Member Functions
SCR_ManualCamera	GetCameraEntity ()
InputManager	GetInputManager ()
vector	CoordToCamera (vector pos)
vector	CoordFromCamera (vector pos)
void	SetEnabled (bool enabled)
int	IsEnabled ()
int	GetPriority ()
bool	HasFlag (EManualCameraFlag flag)
bool	InitBase (SCR_ManualCamera camera)
Override Methods
Methods to be overridden by child classes.
void	EOnCameraFrame (SCR_ManualCameraParam param)
bool	EOnCameraInit ()
void	EOnCameraExit ()
	Terminate the component.
void	EOnCameraReset ()
	Camera value are reset.
void	EOnCameraParentChange (bool attached, IEntity parent)
void	EOnCameraSave (SCR_ManualCameraComponentSave data)
void	EOnCameraLoad (SCR_ManualCameraComponentSave data)

Protected Attributes
int	m_iPriority
SCR_ManualCamera	m_Camera
InputManager	m_InputManager

Detailed Description

Parent class from which all SCR_ManualCamera components inherit.

Definition at line 5 of file SCR_BaseManualCameraComponent.c.

Member Function Documentation

CoordFromCamera()

vector SCR_BaseManualCameraComponent::CoordFromCamera ( vector pos )

inlineprotected

Definition at line 85 of file SCR_BaseManualCameraComponent.c.

CoordToCamera()

vector SCR_BaseManualCameraComponent::CoordToCamera ( vector pos )

inlineprotected

Definition at line 76 of file SCR_BaseManualCameraComponent.c.

EOnCameraExit()

void SCR_BaseManualCameraComponent::EOnCameraExit ( )

protected

Terminate the component.

EOnCameraFrame()

void SCR_BaseManualCameraComponent::EOnCameraFrame ( SCR_ManualCameraParam param )

protected

Evaluate the component every frame.

Parameters

[in]

param

Object carrying camera properties

EOnCameraInit()

bool SCR_BaseManualCameraComponent::EOnCameraInit ( )

protected

Initialise the component.

Returns

True if the component should be evaluated every frame

EOnCameraLoad()

void SCR_BaseManualCameraComponent::EOnCameraLoad ( SCR_ManualCameraComponentSave data )

protected

Load persistent data.

Parameters

[in]

data

EOnCameraParentChange()

void SCR_BaseManualCameraComponent::EOnCameraParentChange ( bool attached, IEntity parent )

protected

Terminate the component.

Parameters

[in]	attached
[in]	parent

EOnCameraReset()

void SCR_BaseManualCameraComponent::EOnCameraReset ( )

protected

Camera value are reset.

EOnCameraSave()

void SCR_BaseManualCameraComponent::EOnCameraSave ( SCR_ManualCameraComponentSave data )

protected

Save persistent data.

Parameters

[in]

data

GetCameraEntity()

SCR_ManualCamera SCR_BaseManualCameraComponent::GetCameraEntity ( )

inlineprotected

Definition at line 64 of file SCR_BaseManualCameraComponent.c.

GetInputManager()

InputManager SCR_BaseManualCameraComponent::GetInputManager ( )

inlineprotected

Definition at line 70 of file SCR_BaseManualCameraComponent.c.

GetPriority()

int SCR_BaseManualCameraComponent::GetPriority ( )

inlineprotected

Get evaluation priority.

Returns

Priority. Higher value = higher priority.

Definition at line 112 of file SCR_BaseManualCameraComponent.c.

HasFlag()

bool SCR_BaseManualCameraComponent::HasFlag ( EManualCameraFlag flag )

inlineprotected

Check if the required flag is active.

Parameters

[in]

Camera

flag

Returns

True if the camera flag contains the required flag

Definition at line 121 of file SCR_BaseManualCameraComponent.c.

InitBase()

bool SCR_BaseManualCameraComponent::InitBase ( SCR_ManualCamera camera )

inlineprotected

Parameters

[in]

camera

Returns

Definition at line 130 of file SCR_BaseManualCameraComponent.c.

IsEnabled()

int SCR_BaseManualCameraComponent::IsEnabled ( )

inlineprotected

Check if the component is enabled.

Returns

True when enabled

Definition at line 104 of file SCR_BaseManualCameraComponent.c.

SetEnabled()

void SCR_BaseManualCameraComponent::SetEnabled ( bool enabled )

inlineprotected

Enable the component. EOnCameraFrame is not evaluated for disabled components.

Parameters

[in]

True

to enable the component, false to disable it

Definition at line 96 of file SCR_BaseManualCameraComponent.c.

Member Data Documentation

m_Camera

SCR_ManualCamera SCR_BaseManualCameraComponent::m_Camera

protected

Definition at line 19 of file SCR_BaseManualCameraComponent.c.

m_InputManager

InputManager SCR_BaseManualCameraComponent::m_InputManager

protected

Definition at line 20 of file SCR_BaseManualCameraComponent.c.

m_iPriority

int SCR_BaseManualCameraComponent::m_iPriority

protected

Definition at line 17 of file SCR_BaseManualCameraComponent.c.

---

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

• scripts/Game/Camera/Components/SCR_BaseManualCameraComponent.c