SCR_BaseManualCameraComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_BaseManualCameraComponent
	Parent class from which all SCR_ManualCamera components inherit. More...

Functions
class SCR_BaseManualCameraComponent	_WB_GetCustomTitle (BaseContainer source, out string title)
protected SCR_ManualCamera	GetCameraEntity ()
protected InputManager	GetInputManager ()
protected vector	CoordToCamera (vector pos)
protected 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. More...
void	EOnCameraReset ()
	Camera value are reset. More...
void	EOnCameraParentChange (bool attached, IEntity parent)
void	EOnCameraSave (SCR_ManualCameraComponentSave data)
void	EOnCameraLoad (SCR_ManualCameraComponentSave data)

Variables
private bool	m_bEnabled
private EManualCameraFlag	m_FlagsWhitelist
private EManualCameraFlag	m_FlagsBlacklist
protected int	m_iPriority
protected SCR_ManualCamera	m_Camera
protected InputManager	m_InputManager

Function Documentation

CoordFromCamera()

protected vector _WB_GetCustomTitle::CoordFromCamera

(

vector

pos

)

Definition at line 80 of file SCR_BaseManualCameraComponent.c.

CoordToCamera()

protected vector _WB_GetCustomTitle::CoordToCamera

(

vector

pos

)

Definition at line 71 of file SCR_BaseManualCameraComponent.c.

EOnCameraExit()

void _WB_GetCustomTitle::EOnCameraExit

(

)

Terminate the component.

EOnCameraFrame()

void _WB_GetCustomTitle::EOnCameraFrame

(

SCR_ManualCameraParam

param

)

Evaluate the component every frame.

Parameters

[in]

param

Object carrying camera properties

EOnCameraInit()

bool _WB_GetCustomTitle::EOnCameraInit

(

)

Initialise the component.

Returns

True if the component should be evaluated every frame

EOnCameraLoad()

void _WB_GetCustomTitle::EOnCameraLoad

(

SCR_ManualCameraComponentSave

data

)

Load persistent data.

Parameters

[in]

data

EOnCameraParentChange()

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

Terminate the component.

Parameters

[in]	attached
[in]	parent

EOnCameraReset()

void _WB_GetCustomTitle::EOnCameraReset

(

)

Camera value are reset.

EOnCameraSave()

void _WB_GetCustomTitle::EOnCameraSave

(

SCR_ManualCameraComponentSave

data

)

Save persistent data.

Parameters

[in]

data

GetCameraEntity()

protected SCR_ManualCamera _WB_GetCustomTitle::GetCameraEntity

(

)

Definition at line 59 of file SCR_BaseManualCameraComponent.c.

GetInputManager()

protected InputManager _WB_GetCustomTitle::GetInputManager

(

)

Definition at line 65 of file SCR_BaseManualCameraComponent.c.

HasFlag()

bool _WB_GetCustomTitle::HasFlag

(

EManualCameraFlag

flag

)

Check if the required flag is active.

Parameters

[in]

Camera

flag

Returns

True if the camera flag contains the required flag

Definition at line 116 of file SCR_BaseManualCameraComponent.c.

InitBase()

bool _WB_GetCustomTitle::InitBase

(

SCR_ManualCamera

camera

)

Parameters

[in]

camera

Returns

Definition at line 125 of file SCR_BaseManualCameraComponent.c.

SetEnabled()

void _WB_GetCustomTitle::SetEnabled

(

bool

enabled

)

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

Parameters

[in]

True

to enable the component, false to disable it

Definition at line 91 of file SCR_BaseManualCameraComponent.c.

Variable Documentation

m_bEnabled

private bool m_bEnabled

Definition at line 3 of file SCR_BaseManualCameraComponent.c.

m_Camera

protected SCR_ManualCamera m_Camera

Definition at line 14 of file SCR_BaseManualCameraComponent.c.

m_FlagsBlacklist

private EManualCameraFlag m_FlagsBlacklist

Definition at line 9 of file SCR_BaseManualCameraComponent.c.

m_FlagsWhitelist

private EManualCameraFlag m_FlagsWhitelist

Definition at line 6 of file SCR_BaseManualCameraComponent.c.

m_InputManager

protected InputManager m_InputManager

Definition at line 15 of file SCR_BaseManualCameraComponent.c.

m_iPriority

protected int m_iPriority

Definition at line 12 of file SCR_BaseManualCameraComponent.c.