Camera

Classes
class	BaseScriptedCameraItem
class	BaseScriptedCameraSet
class	CameraBaseClass
class	CameraHandlerComponent
class	CameraHandlerComponentClass
class	CameraManagerClass
class	PlayerCameraClass
class	ScriptedCameraBaseClass

Functions
CameraBaseClass GenericEntityClass	ApplyTransform (float timeslice)
	Manually applies transformation. This is usually done in EOnPostFrame automatically.
proto external void	GetWorldCameraTransform (out vector mat[4])
	Get current camera world transformation.
proto external IEntity	GetCursorTarget ()
proto external IEntity	GetCursorTargetWithPosition (out vector outPosition)
proto external CameraType	GetProjType ()
	Get projection type.
proto external float	GetVerticalFOV ()
proto external float	GetNearPlane ()
proto external float	GetFarPlane ()
proto external void	SetFOVDegree (float fovDegrees)
proto external void	SetVerticalFOV (float fov)
proto external void	SetNearPlane (float nearPlane)
proto external void	SetFarPlane (float farPlane)
proto external void	SetCameraIndex (int cameraIndex)
proto external int	GetCameraIndex ()
proto external void	SetLensFlareSet (CameraLensFlareSetType type, string userName)
proto external bool	IsAABBVisible (vector mins, vector maxs)
	Test if the AABB is visible against the view frustum of the camera.
proto external bool	IsSphereVisible (vector origin, float radius)
	Test if the sphere is visible against the view frustum of the camera.
void	CameraActivate ()
	Called the moment this camera is activated by CameraManager.
void	CameraDeactivate ()
	Called the moment this camera is deactivated by CameraManager.
CameraManagerClass GenericEntityClass	CurrentCamera ()
	Returns the current camera.
proto external bool	SetCamera (CameraBase pCam)
proto external void	SetNextCamera ()
	Set the next camera in the list as current camera.
proto external void	SetPreviousCamera ()
	Set the previous camera in the list as current camera.
proto external int	GetCamerasList (out notnull array< CameraBase > outCameras)
proto external void	SetOverlayCamera (CameraBase pCam)
proto external CameraBase	GetOverlayCamera ()
proto external void	SetFirstPersonFOV (float fieldOfView)
proto external float	GetFirstPersonFOV ()
proto external void	SetThirdPersonFOV (float fieldOfView)
proto external float	GetThirdPersonFOV ()
proto external void	SetVehicleFOV (float fieldOfView)
proto external float	GetVehicleFOV ()
proto external float	GetClampedFOV (float fieldOfView)
proto external float	GetMinFOV ()
proto external float	GetMaxFOV ()
void	OnInit ()
PlayerCameraClass CameraBaseClass	GetFocusMode ()
	Returns the current value of focus mode in the <0,1> range.
proto external float	GetFocusFOV ()
	Returns the focus field of view in degrees.
proto external float	GetFocusFOVScale (float baseFOV, float scalar)
	Returns interpolated value from baseFOV to focusFOV based on the input scalar value.

Detailed Description

Function Documentation

ApplyTransform()

CameraBaseClass GenericEntityClass ApplyTransform

(

float

timeslice

)

Manually applies transformation. This is usually done in EOnPostFrame automatically.

CameraActivate()

void CameraActivate ( )

protected

Called the moment this camera is activated by CameraManager.

CameraDeactivate()

void CameraDeactivate ( )

protected

Called the moment this camera is deactivated by CameraManager.

CurrentCamera()

CameraManagerClass GenericEntityClass CurrentCamera

(

)

Returns the current camera.

GetCameraIndex()

proto external int GetCameraIndex

(

)

Get the current camera index.

Returns

Returns the camera index.

GetCamerasList()

proto external int GetCamerasList

(

out notnull array< CameraBase >

outCameras

)

Return the list of all cameras

Parameters

outCameras

List where all cameras will be inserted.

Returns

The number of camera in the list

GetClampedFOV()

proto external float GetClampedFOV

(

float

fieldOfView

)

Returns value clamped between min and max settings.

GetCursorTarget()

proto external IEntity GetCursorTarget

(

)

Performs a raycast from the center of this camera in the forward direction. (result is cached within single frame and reused if called multiple times)

Returns

Reference to an entity if it was hit by the trace or null otherwise.

GetCursorTargetWithPosition()

proto external IEntity GetCursorTargetWithPosition

(

out vector

outPosition

)

Performs a raycast from the center of this camera in the forward direction. (result is cached within single frame and reused if called multiple times)

Parameters

outPosition

Position of the ray and target intersect point.

Returns

Reference to an entity if it was hit by the trace or null otherwise.

GetFarPlane()

proto external float GetFarPlane

(

)

Get the current far plane clipping value.

Returns

Returns the far plane value in meters.

GetFirstPersonFOV()

proto external float GetFirstPersonFOV

(

)

Returns default first person field of view.

GetFocusFOV()

proto external float GetFocusFOV

(

)

Returns the focus field of view in degrees.

GetFocusFOVScale()

proto external float GetFocusFOVScale	(	float	baseFOV,
		float	scalar )

Returns interpolated value from baseFOV to focusFOV based on the input scalar value.

GetFocusMode()

PlayerCameraClass CameraBaseClass GetFocusMode

(

)

Returns the current value of focus mode in the <0,1> range.

GetMaxFOV()

proto external float GetMaxFOV

(

)

Returns maximum allowed field of view value.

GetMinFOV()

proto external float GetMinFOV

(

)

Returns minimum allowed field of view value.

GetNearPlane()

proto external float GetNearPlane

(

)

Get the current near plane clipping value.

Returns

Returns the near plane value in meters.

GetOverlayCamera()

proto external CameraBase GetOverlayCamera

(

)

Get the current overlay camera

Returns

Returns the current overlay canera or null if none.

GetProjType()

proto external CameraType GetProjType

(

)

Get projection type.

GetThirdPersonFOV()

proto external float GetThirdPersonFOV

(

)

Returns default third person field of view.

GetVehicleFOV()

proto external float GetVehicleFOV

(

)

Returns default vehicle field of view.

GetVerticalFOV()

proto external float GetVerticalFOV

(

)

Get the vertical FOV.

Returns

Returns the vertical FOV in degrees.

GetWorldCameraTransform()

proto external void GetWorldCameraTransform

(

out vector

mat[4]

)

Get current camera world transformation.

IsAABBVisible()

proto external bool IsAABBVisible	(	vector	mins,
		vector	maxs )

Test if the AABB is visible against the view frustum of the camera.

IsSphereVisible()

proto external bool IsSphereVisible	(	vector	origin,
		float	radius )

Test if the sphere is visible against the view frustum of the camera.

OnInit()

void OnInit ( )

protected

Called on initialization.

SetCamera()

proto external bool SetCamera

(

CameraBase

pCam

)

Set the current camera, it should be alreday registered in this Camera Manager.

Parameters

cam	Camera which will be the new camera used.

SetCameraIndex()

proto external void SetCameraIndex

(

int

cameraIndex

)

Set the current camera index.

Parameters

cameraIndex

The new camera index.

SetFarPlane()

proto external void SetFarPlane

(

float

farPlane

)

Set the current far plane value.

Parameters

farPlane

The new far plane value in meters.

SetFirstPersonFOV()

proto external void SetFirstPersonFOV

(

float

fieldOfView

)

Sets default first person field of view.

SetFOVDegree()

proto external void SetFOVDegree

(

float

fovDegrees

)

Set full symmetrical vertical FOV in degrees.

Parameters

fovDegrees

Vertical FOV in degrees.

SetLensFlareSet()

proto external void SetLensFlareSet	(	CameraLensFlareSetType	type,
		string	userName )

Sets camera lens flare set

Parameters

type	type of the lens flare set
userSetName	user name of the lens flare set (used only when type is set to User)

SetNearPlane()

proto external void SetNearPlane

(

float

nearPlane

)

Set the current near plane clipping value.

Parameters

nearPlane

The new near plane value in meters.

SetNextCamera()

proto external void SetNextCamera

(

)

Set the next camera in the list as current camera.

SetOverlayCamera()

proto external void SetOverlayCamera

(

CameraBase

pCam

)

Set the current overlay camera

Parameters

pCamera

Camera which will be the new overlay camera.

SetPreviousCamera()

proto external void SetPreviousCamera

(

)

Set the previous camera in the list as current camera.

SetThirdPersonFOV()

proto external void SetThirdPersonFOV

(

float

fieldOfView

)

Sets default first person field of view.

SetVehicleFOV()

proto external void SetVehicleFOV

(

float

fieldOfView

)

Sets default vehicle field of view.

SetVerticalFOV()

proto external void SetVerticalFOV

(

float

fov

)

Set the vertical FOV.

Parameters

fov	FOV in degrees.