SCR_ZoomManualCameraComponent Interface Reference

Adjust camera field of view. More...

Inheritance diagram for SCR_ZoomManualCameraComponent:

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

Protected Attributes
float	m_fMinFOV
float	m_fMaxFOV
float	m_fCoef
float	m_fInertiaStrength
float	m_fTargetFOV
bool	m_bIsAnimating
bool	m_bIsInstant
ref ScriptInvoker	m_OnZoomChange = new ScriptInvoker()
Protected Attributes inherited from SCR_BaseManualCameraComponent
int	m_iPriority
SCR_ManualCamera	m_Camera
InputManager	m_InputManager

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)

Detailed Description

Adjust camera field of view.

Member Function Documentation

EOnCameraFrame()

override void SCR_ZoomManualCameraComponent.EOnCameraFrame

(

SCR_ManualCameraParam

param

)

Evaluate the component every frame.

Parameters

[in]

param

Object carrying camera properties

Implements SCR_BaseManualCameraComponent.

EOnCameraInit()

override bool SCR_ZoomManualCameraComponent.EOnCameraInit

(

)

Initialise the component.

Returns

True if the component should be evaluated every frame

Implements SCR_BaseManualCameraComponent.

EOnCameraLoad()

override void SCR_ZoomManualCameraComponent.EOnCameraLoad

(

SCR_ManualCameraComponentSave

data

)

Load persistent data.

Parameters

[in]

data

Implements SCR_BaseManualCameraComponent.

EOnCameraReset()

override void SCR_ZoomManualCameraComponent.EOnCameraReset

(

)

Camera value are reset.

Implements SCR_BaseManualCameraComponent.

EOnCameraSave()

override void SCR_ZoomManualCameraComponent.EOnCameraSave

(

SCR_ManualCameraComponentSave

data

)

Save persistent data.

Parameters

[in]

data

Implements SCR_BaseManualCameraComponent.

GetOnZoomChange()

ScriptInvoker SCR_ZoomManualCameraComponent.GetOnZoomChange

(

)

Returns

Member Data Documentation

INERTIA_THRESHOLD

const float SCR_ZoomManualCameraComponent.INERTIA_THRESHOLD = 0.001

staticprotected

m_bIsAnimating

bool SCR_ZoomManualCameraComponent.m_bIsAnimating

protected

m_bIsInstant

bool SCR_ZoomManualCameraComponent.m_bIsInstant

protected

m_fCoef

float SCR_ZoomManualCameraComponent.m_fCoef

protected

m_fInertiaStrength

float SCR_ZoomManualCameraComponent.m_fInertiaStrength

protected

m_fMaxFOV

float SCR_ZoomManualCameraComponent.m_fMaxFOV

protected

m_fMinFOV

float SCR_ZoomManualCameraComponent.m_fMinFOV

protected

m_fTargetFOV

float SCR_ZoomManualCameraComponent.m_fTargetFOV

protected

m_OnZoomChange

ref ScriptInvoker SCR_ZoomManualCameraComponent.m_OnZoomChange = new ScriptInvoker()

protected

---

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

• Game/Camera/Components/SCR_ZoomManualCameraComponent.c