SCR_ManualCameraParam Interface Reference

Parameter for carrying information between individual camera components. More...

Public Member Functions
void	SetDeltaPos (vector deltaPos)
	Set position as delta change from the current position.
bool	GetCursorWorldPos (out vector outPos=vector.Zero)
	Get position under cursor.
void	SetCursorWorldPos (vector pos)
void	ShowDebug (SCR_ManualCamera camera)
void	ProcessTransform ()
void	SCR_ManualCameraParam (vector transformOriginalIn[4], float timeSliceIn, BaseWorld worldIn, float fovIn, bool isManualInputEnabledIn, vector velocityOriginalIn, EManualCameraFlag flagIn)

Public Attributes
float	timeSlice
	Frame time slice.
BaseWorld	world
	World in which the camera exists.
IEntity	target
	Entity under cursor.
EManualCameraFlag	flag
	Camera flag.
vector	transformOriginal [4]
	Camera transform before components evalulation.
vector	transform [4]
	Camera transform applied after components evaluation.
vector	rotOriginal
	Camera rotation in euler angles before components evaluation.
vector	rotDelta
	Camera rotation in euler angles applied after components evaluation.
vector	velocityOriginal
	Velocity from the previous frame.
vector	multiplier
	Speed multiplier horizontal[0] and vertical[1].
float	fovOriginal
	Field of view before components evaluation.
float	fov
	Field of view applied after components evaluation.
bool	isManualInputEnabled
	Is manual input enabled by the camera entity?
bool	isManualInput
	Did manual input modify the camera?
bool	isCursorEnabled = true
	Is cursor on empty space and not on some active element, e.g., button?
bool	isDirty
	Did camera settings change?
bool	isDirtyExternal
	Did some external settings change the camera?

Static Protected Attributes
const float	TRACE_DIS = 250

Detailed Description

Parameter for carrying information between individual camera components.

Constructor & Destructor Documentation

SCR_ManualCameraParam()

void SCR_ManualCameraParam.SCR_ManualCameraParam	(	vector	transformOriginalIn[4],
		float	timeSliceIn,
		BaseWorld	worldIn,
		float	fovIn,
		bool	isManualInputEnabledIn,
		vector	velocityOriginalIn,
		EManualCameraFlag	flagIn )

Parameters

transformOriginalIn
timeSliceIn
worldIn
fovIn
isManualInputEnabledIn
velocityOriginalIn
flagIn

Member Function Documentation

GetCursorWorldPos()

bool SCR_ManualCameraParam.GetCursorWorldPos

(

out vector

outPos = vector::Zero

)

Get position under cursor.

Parameters

[out]

outPos

world position under cursor

Returns

true on success, false otherwise

ProcessTransform()

void SCR_ManualCameraParam.ProcessTransform

(

)

SetCursorWorldPos()

void SCR_ManualCameraParam.SetCursorWorldPos

(

vector

pos

)

Parameters

pos

SetDeltaPos()

void SCR_ManualCameraParam.SetDeltaPos

(

vector

deltaPos

)

Set position as delta change from the current position.

Parameters

deltaPos

Delta vector

ShowDebug()

void SCR_ManualCameraParam.ShowDebug

(

SCR_ManualCamera

camera

)

Parameters

camera

Member Data Documentation

flag

EManualCameraFlag SCR_ManualCameraParam.flag

Camera flag.

fov

float SCR_ManualCameraParam.fov

Field of view applied after components evaluation.

fovOriginal

float SCR_ManualCameraParam.fovOriginal

Field of view before components evaluation.

DO NOT MODIFY!

isCursorEnabled

bool SCR_ManualCameraParam.isCursorEnabled = true

Is cursor on empty space and not on some active element, e.g., button?

isDirty

bool SCR_ManualCameraParam.isDirty

Did camera settings change?

isDirtyExternal

bool SCR_ManualCameraParam.isDirtyExternal

Did some external settings change the camera?

DO NOT MODIFY!

isManualInput

bool SCR_ManualCameraParam.isManualInput

Did manual input modify the camera?

isManualInputEnabled

bool SCR_ManualCameraParam.isManualInputEnabled

Is manual input enabled by the camera entity?

multiplier

vector SCR_ManualCameraParam.multiplier

Speed multiplier horizontal[0] and vertical[1].

rotDelta

vector SCR_ManualCameraParam.rotDelta

Camera rotation in euler angles applied after components evaluation.

rotOriginal

vector SCR_ManualCameraParam.rotOriginal

Camera rotation in euler angles before components evaluation.

DO NOT MODIFY!

target

IEntity SCR_ManualCameraParam.target

Entity under cursor.

timeSlice

float SCR_ManualCameraParam.timeSlice

Frame time slice.

TRACE_DIS

const float SCR_ManualCameraParam.TRACE_DIS = 250

staticprotected

transform

vector SCR_ManualCameraParam.transform[4]

Camera transform applied after components evaluation.

transformOriginal

vector SCR_ManualCameraParam.transformOriginal[4]

Camera transform before components evalulation.

DO NOT MODIFY!

velocityOriginal

vector SCR_ManualCameraParam.velocityOriginal

Velocity from the previous frame.

DO NOT MODIFY!

world

BaseWorld SCR_ManualCameraParam.world

World in which the camera exists.

---

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

• Game/Camera/SCR_ManualCameraParam.c