SCR_ModelAutotestCamera Interface Reference

Public Member Functions
bool	GetIsRelativeToCenter ()
	Returns whether camera should be set in global world coordinates or relative to spawned objects space. (boolean)
string	GetLabel ()
	Returns the label (name) of this camera. (string)
vector	GetPosition ()
	Return the position of this camera in world space. (metres; x,y,z)
vector	GetRotation ()
	Return the rotation of this camera in world space. (degrees; pitch, yaw, roll)
float	GetDuration ()
	Return the duration of how long this camera should be active. (seconds)
void	LogFramesPerSecond (float timeSlice)
	Call this every frame where you want to record data for the camera.
void	ClearFramesPerSecond ()
bool	GetFramesPerSecondsData (out float minFps, out float maxFps, out float averageFps)
void	SetAsCamera (BaseWorld world, vector center)
	Set engine's camera transformation to the one specified by this instance.
void	~SCR_ModelAutotestCamera ()

Constructor & Destructor Documentation

~SCR_ModelAutotestCamera()

void SCR_ModelAutotestCamera.~SCR_ModelAutotestCamera

(

)

Member Function Documentation

ClearFramesPerSecond()

void SCR_ModelAutotestCamera.ClearFramesPerSecond

(

)

GetDuration()

float SCR_ModelAutotestCamera.GetDuration

(

)

Return the duration of how long this camera should be active. (seconds)

GetFramesPerSecondsData()

bool SCR_ModelAutotestCamera.GetFramesPerSecondsData	(	out float	minFps,
		out float	maxFps,
		out float	averageFps )

Returns

Returns true if any frame data was captured, false if no data is found.

GetIsRelativeToCenter()

bool SCR_ModelAutotestCamera.GetIsRelativeToCenter

(

)

Returns whether camera should be set in global world coordinates or relative to spawned objects space. (boolean)

GetLabel()

string SCR_ModelAutotestCamera.GetLabel

(

)

Returns the label (name) of this camera. (string)

GetPosition()

vector SCR_ModelAutotestCamera.GetPosition

(

)

Return the position of this camera in world space. (metres; x,y,z)

GetRotation()

vector SCR_ModelAutotestCamera.GetRotation

(

)

Return the rotation of this camera in world space. (degrees; pitch, yaw, roll)

LogFramesPerSecond()

void SCR_ModelAutotestCamera.LogFramesPerSecond

(

float

timeSlice

)

Call this every frame where you want to record data for the camera.

SetAsCamera()

void SCR_ModelAutotestCamera.SetAsCamera	(	BaseWorld	world,
		vector	center )

Set engine's camera transformation to the one specified by this instance.

---

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

• Game/Entities/ModelAutotestEntity.c