SCR_FocusManualCameraComponent Class Reference

Focus camera on cursor position. More...

Inheritance diagram for SCR_FocusManualCameraComponent:

Protected Member Functions
bool	GetFocusPos (out vector outPos)
float	GetFocusDistance ()
void	SetFocusToCursor ()
	Set focus to cursor position.
void	SetFocus (vector pos, IEntity entity=null)
void	ResetFocus ()
	Reset focus.
ScriptInvoker	GetOnFocusChange ()
ScriptInvoker	GetOnFocusDistanceChange ()
override void	EOnCameraReset ()
override void	EOnCameraFrame (SCR_ManualCameraParam param)
override void	EOnCameraSave (SCR_ManualCameraComponentSave data)
override void	EOnCameraLoad (SCR_ManualCameraComponentSave data)
override bool	EOnCameraInit ()
override void	EOnCameraExit ()

Protected Attributes
ref ScriptInvoker	m_OnFocusChange = new ScriptInvoker()
ref ScriptInvoker	m_OnFocusDistanceChange = new ScriptInvoker()

Detailed Description

Focus camera on cursor position.

Definition at line 5 of file SCR_FocusManualCameraComponent.c.

Member Function Documentation

EOnCameraExit()

override void SCR_FocusManualCameraComponent::EOnCameraExit ( )

inlineprotected

Definition at line 242 of file SCR_FocusManualCameraComponent.c.

EOnCameraFrame()

override void SCR_FocusManualCameraComponent::EOnCameraFrame ( SCR_ManualCameraParam param )

inlineprotected

Definition at line 126 of file SCR_FocusManualCameraComponent.c.

EOnCameraInit()

override bool SCR_FocusManualCameraComponent::EOnCameraInit ( )

inlineprotected

Definition at line 208 of file SCR_FocusManualCameraComponent.c.

EOnCameraLoad()

override void SCR_FocusManualCameraComponent::EOnCameraLoad ( SCR_ManualCameraComponentSave data )

inlineprotected

Definition at line 202 of file SCR_FocusManualCameraComponent.c.

EOnCameraReset()

override void SCR_FocusManualCameraComponent::EOnCameraReset ( )

inlineprotected

Definition at line 120 of file SCR_FocusManualCameraComponent.c.

EOnCameraSave()

override void SCR_FocusManualCameraComponent::EOnCameraSave ( SCR_ManualCameraComponentSave data )

inlineprotected

Definition at line 192 of file SCR_FocusManualCameraComponent.c.

GetFocusDistance()

float SCR_FocusManualCameraComponent::GetFocusDistance ( )

inlineprotected

Returns

Distance to focused position.

Definition at line 41 of file SCR_FocusManualCameraComponent.c.

GetFocusPos()

bool SCR_FocusManualCameraComponent::GetFocusPos ( out vector outPos )

inlineprotected

Get focus position in the world.

Parameters

[out]

outPos

Focus position

Returns

True if focus is set

Definition at line 30 of file SCR_FocusManualCameraComponent.c.

GetOnFocusChange()

ScriptInvoker SCR_FocusManualCameraComponent::GetOnFocusChange ( )

inlineprotected

Get event called when focus is set or cleared.

Returns

Script invoker

Definition at line 106 of file SCR_FocusManualCameraComponent.c.

GetOnFocusDistanceChange()

ScriptInvoker SCR_FocusManualCameraComponent::GetOnFocusDistanceChange ( )

inlineprotected

Get event called when focus distance changes.

Returns

Script invoker

Definition at line 114 of file SCR_FocusManualCameraComponent.c.

ResetFocus()

void SCR_FocusManualCameraComponent::ResetFocus ( )

inlineprotected

Reset focus.

Definition at line 77 of file SCR_FocusManualCameraComponent.c.

SetFocus()

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

inlineprotected

Parameters

[in]	pos
[in]	entity

Definition at line 68 of file SCR_FocusManualCameraComponent.c.

SetFocusToCursor()

void SCR_FocusManualCameraComponent::SetFocusToCursor ( )

inlineprotected

Set focus to cursor position.

Definition at line 48 of file SCR_FocusManualCameraComponent.c.

Member Data Documentation

m_OnFocusChange

ref ScriptInvoker SCR_FocusManualCameraComponent::m_OnFocusChange = new ScriptInvoker()

protected

Definition at line 23 of file SCR_FocusManualCameraComponent.c.

m_OnFocusDistanceChange

ref ScriptInvoker SCR_FocusManualCameraComponent::m_OnFocusDistanceChange = new ScriptInvoker()

protected

Definition at line 24 of file SCR_FocusManualCameraComponent.c.

---

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

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