SCR_ManualCamera Class Reference

Inheritance diagram for SCR_ManualCamera:

Protected Member Functions
void	RegisterComponents ()
void	InitComponents ()
void	ProcessComponents (float timeSlice=0)
void	SaveComponents (notnull array< ref SCR_ManualCameraComponentSave > outData)
void	LoadComponents (array< ref SCR_ManualCameraComponentSave > data)
void	ResetComponents ()
SCR_BaseManualCameraComponent	FindCameraComponent (typename type)
void	MoveToCamera (CameraBase camera=null)
CameraBase	GetPreviousCamera ()
bool	TrySwitchToControlledEntityCamera ()
void	SwitchToPreviousCamera ()
bool	IsFirstCamera ()
bool	IsDisabledByMenu ()
void	AttachTo (IEntity parent)
void	Detach ()
	Detach camera from its parent entity.
void	SetInputEnabled (bool enable)
bool	IsInputEnabled ()
float	GetDefaultFOV ()
bool	IsManualInput ()
void	SetDirty (bool isDirty)
Widget	GetWidget ()
Widget	CreateCameraWidget (ResourceName layout, bool isVisible=true)
SCR_ManualCameraParam	GetCameraParam ()
void	Terminate ()
void	EOnPostFrame (IEntity owner, float timeSlice)
void	EOnInit (IEntity owner)
void	SCR_ManualCamera (IEntitySource src, IEntity parent)
void	~SCR_ManualCamera ()

Detailed Description

Entity for managing manual camera and its components.

The entity itself does not handle any input. Instead, it calls functions in components which each take care of a specific feature, e.g., a component for basic movement, a component for speed boost, etc.

Definition at line 16 of file SCR_ManualCamera.c.

Constructor & Destructor Documentation

SCR_ManualCamera()

void SCR_ManualCamera::SCR_ManualCamera ( IEntitySource src, IEntity parent )

inlineprotected

Parameters

src
parent

Definition at line 494 of file SCR_ManualCamera.c.

~SCR_ManualCamera()

void SCR_ManualCamera::~SCR_ManualCamera ( )

inlineprotected

Definition at line 521 of file SCR_ManualCamera.c.

Member Function Documentation

AttachTo()

void SCR_ManualCamera::AttachTo ( IEntity parent )

inlineprotected

Attach camera to an entity.

Parameters

parent

Target entity

Definition at line 309 of file SCR_ManualCamera.c.

CreateCameraWidget()

Widget SCR_ManualCamera::CreateCameraWidget ( ResourceName layout, bool isVisible = true )

inlineprotected

Create camera widget.

Parameters

layout	GUI layout path
isVisible	True if the widget should be visible by default

Returns

Definition at line 395 of file SCR_ManualCamera.c.

Detach()

void SCR_ManualCamera::Detach ( )

inlineprotected

Detach camera from its parent entity.

Definition at line 326 of file SCR_ManualCamera.c.

EOnInit()

void SCR_ManualCamera::EOnInit ( IEntity owner )

inlineprotected

Definition at line 449 of file SCR_ManualCamera.c.

EOnPostFrame()

void SCR_ManualCamera::EOnPostFrame ( IEntity owner, float timeSlice )

inlineprotected

Definition at line 439 of file SCR_ManualCamera.c.

FindCameraComponent()

SCR_BaseManualCameraComponent SCR_ManualCamera::FindCameraComponent ( typename type )

inlineprotected

Find camera component of given type.

Parameters

type	Component type

Returns

Component, or null when not found

Definition at line 200 of file SCR_ManualCamera.c.

GetCameraParam()

SCR_ManualCameraParam SCR_ManualCamera::GetCameraParam ( )

inlineprotected

Return camera param passed to components in the previous frame.

Returns

Camera param

Definition at line 409 of file SCR_ManualCamera.c.

GetDefaultFOV()

float SCR_ManualCamera::GetDefaultFOV ( )

inlineprotected

Get default field of view.

Returns

Default FOV

Definition at line 361 of file SCR_ManualCamera.c.

GetPreviousCamera()

CameraBase SCR_ManualCamera::GetPreviousCamera ( )

inlineprotected

Definition at line 221 of file SCR_ManualCamera.c.

GetWidget()

Widget SCR_ManualCamera::GetWidget ( )

inlineprotected

Get widget which individual components can fill

Returns

Definition at line 385 of file SCR_ManualCamera.c.

InitComponents()

void SCR_ManualCamera::InitComponents ( )

inlineprotected

Definition at line 71 of file SCR_ManualCamera.c.

IsDisabledByMenu()

bool SCR_ManualCamera::IsDisabledByMenu ( )

inlineprotected

Definition at line 296 of file SCR_ManualCamera.c.

IsFirstCamera()

bool SCR_ManualCamera::IsFirstCamera ( )

inlineprotected

Definition at line 277 of file SCR_ManualCamera.c.

IsInputEnabled()

bool SCR_ManualCamera::IsInputEnabled ( )

inlineprotected

Check if manual input is enabled.

Returns

True when input is enabled

Definition at line 353 of file SCR_ManualCamera.c.

IsManualInput()

bool SCR_ManualCamera::IsManualInput ( )

inlineprotected

Check if the camera was moved manually this frame

Returns

True if manual input was given

Definition at line 369 of file SCR_ManualCamera.c.

LoadComponents()

void SCR_ManualCamera::LoadComponents ( array< ref SCR_ManualCameraComponentSave > data )

inlineprotected

Parameters

data

Definition at line 172 of file SCR_ManualCamera.c.

MoveToCamera()

void SCR_ManualCamera::MoveToCamera ( CameraBase camera = null )

inlineprotected

Definition at line 211 of file SCR_ManualCamera.c.

ProcessComponents()

void SCR_ManualCamera::ProcessComponents ( float timeSlice = 0 )

inlineprotected

SCR_Math3D.MatrixEqual(transform, m_vTransformPrev);

Definition at line 82 of file SCR_ManualCamera.c.

RegisterComponents()

void SCR_ManualCamera::RegisterComponents ( )

inlineprotected

Definition at line 56 of file SCR_ManualCamera.c.

ResetComponents()

void SCR_ManualCamera::ResetComponents ( )

inlineprotected

Definition at line 188 of file SCR_ManualCamera.c.

SaveComponents()

void SCR_ManualCamera::SaveComponents ( notnull array< ref SCR_ManualCameraComponentSave > outData )

inlineprotected

Parameters

outData

Definition at line 136 of file SCR_ManualCamera.c.

SetDirty()

void SCR_ManualCamera::SetDirty ( bool isDirty )

inlineprotected

Mark as dirty based on external influence (e.g., when some script teleports the camera)

Parameters

isDirty

True when dirty

Definition at line 377 of file SCR_ManualCamera.c.

SetInputEnabled()

void SCR_ManualCamera::SetInputEnabled ( bool enable )

inlineprotected

Enable manual input.

Parameters

enable

true to enable input, false to disable it

Definition at line 345 of file SCR_ManualCamera.c.

SwitchToPreviousCamera()

void SCR_ManualCamera::SwitchToPreviousCamera ( )

inlineprotected

Definition at line 265 of file SCR_ManualCamera.c.

Terminate()

void SCR_ManualCamera::Terminate ( )

inlineprotected

Destroy the camera. Deinitializes components in this frame. Calling 'delete' would also destroy the camera, but components would be terminated only in the next frame when called from destructor.

Definition at line 419 of file SCR_ManualCamera.c.

TrySwitchToControlledEntityCamera()

bool SCR_ManualCamera::TrySwitchToControlledEntityCamera ( )

inlineprotected

Returns

Definition at line 240 of file SCR_ManualCamera.c.

---

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

• scripts/Game/Camera/SCR_ManualCamera.c