SCR_FocusManualCameraComponent Interface Reference

Inheritance diagram for SCR_FocusManualCameraComponent:

Public Member Functions
bool	GetFocusPos (out vector outPos)
	Get focus position in the world.
float	GetFocusDistance ()
void	SetFocusToCursor ()
	Set focus to cursor position.
void	SetFocus (vector pos, IEntity entity=null)
void	ResetFocus ()
	Reset focus.
ScriptInvoker	GetOnFocusChange ()
	Get event called when focus is set or cleared.
ScriptInvoker	GetOnFocusDistanceChange ()
	Get event called when focus distance changes.
override void	EOnCameraReset ()
	Camera value are reset.
override void	EOnCameraFrame (SCR_ManualCameraParam param)
	Evaluate the component every frame.
override void	EOnCameraSave (SCR_ManualCameraComponentSave data)
	Save persistent data.
override void	EOnCameraLoad (SCR_ManualCameraComponentSave data)
	Load persistent data.
override bool	EOnCameraInit ()
	Initialise the component.
override void	EOnCameraExit ()
	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	EOnCameraParentChange (bool attached, IEntity parent)
	Terminate the component.

Protected Attributes
ref ScriptInvoker	m_OnFocusChange = new ScriptInvoker()
ref ScriptInvoker	m_OnFocusDistanceChange = new ScriptInvoker()
Protected Attributes inherited from SCR_BaseManualCameraComponent
int	m_iPriority
SCR_ManualCamera	m_Camera
InputManager	m_InputManager

Additional Inherited Members
Protected Member Functions inherited from SCR_BaseManualCameraComponent
SCR_ManualCamera	GetCameraEntity ()
InputManager	GetInputManager ()
vector	CoordToCamera (vector pos)
vector	CoordFromCamera (vector pos)

Detailed Description

Focus camera on cursor position.

Member Function Documentation

EOnCameraExit()

override void SCR_FocusManualCameraComponent.EOnCameraExit

(

)

Terminate the component.

Implements SCR_BaseManualCameraComponent.

EOnCameraFrame()

override void SCR_FocusManualCameraComponent.EOnCameraFrame

(

SCR_ManualCameraParam

param

)

Evaluate the component every frame.

Parameters

[in]

param

Object carrying camera properties

Implements SCR_BaseManualCameraComponent.

EOnCameraInit()

override bool SCR_FocusManualCameraComponent.EOnCameraInit

(

)

Initialise the component.

Returns

True if the component should be evaluated every frame

Implements SCR_BaseManualCameraComponent.

EOnCameraLoad()

override void SCR_FocusManualCameraComponent.EOnCameraLoad

(

SCR_ManualCameraComponentSave

data

)

Load persistent data.

Parameters

[in]

data

Implements SCR_BaseManualCameraComponent.

EOnCameraReset()

override void SCR_FocusManualCameraComponent.EOnCameraReset

(

)

Camera value are reset.

Implements SCR_BaseManualCameraComponent.

EOnCameraSave()

override void SCR_FocusManualCameraComponent.EOnCameraSave

(

SCR_ManualCameraComponentSave

data

)

Save persistent data.

Parameters

[in]

data

Implements SCR_BaseManualCameraComponent.

GetFocusDistance()

float SCR_FocusManualCameraComponent.GetFocusDistance

(

)

Returns

Distance to focused position.

GetFocusPos()

bool SCR_FocusManualCameraComponent.GetFocusPos

(

out vector

outPos

)

Get focus position in the world.

Parameters

[out]

outPos

Focus position

Returns

True if focus is set

GetOnFocusChange()

ScriptInvoker SCR_FocusManualCameraComponent.GetOnFocusChange

(

)

Get event called when focus is set or cleared.

Returns

Script invoker

GetOnFocusDistanceChange()

ScriptInvoker SCR_FocusManualCameraComponent.GetOnFocusDistanceChange

(

)

Get event called when focus distance changes.

Returns

Script invoker

ResetFocus()

void SCR_FocusManualCameraComponent.ResetFocus

(

)

Reset focus.

SetFocus()

void SCR_FocusManualCameraComponent.SetFocus	(	vector	pos,
		IEntity	entity = null
	)

Parameters

[in]	pos
[in]	entity

SetFocusToCursor()

void SCR_FocusManualCameraComponent.SetFocusToCursor

(

)

Set focus to cursor position.

Member Data Documentation

m_OnFocusChange

ref ScriptInvoker SCR_FocusManualCameraComponent.m_OnFocusChange = new ScriptInvoker()

protected

m_OnFocusDistanceChange

ref ScriptInvoker SCR_FocusManualCameraComponent.m_OnFocusDistanceChange = new ScriptInvoker()

protected

---

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

• Game/Camera/Components/SCR_FocusManualCameraComponent.c