CameraBase Interface Reference

Inheritance diagram for CameraBase:

Public Member Functions
proto external void	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 ()
	Performs a raycast from the center of this camera in the forward direction.
proto external IEntity	GetCursorTargetWithPosition (out vector outPosition)
	Performs a raycast from the center of this camera in the forward direction.
proto external CameraType	GetProjType ()
	Get projection type.
proto external float	GetVerticalFOV ()
	Get the vertical FOV.
proto external float	GetNearPlane ()
	Get the current near plane clipping value.
proto external float	GetFarPlane ()
	Get the current far plane clipping value.
proto external void	SetFOVDegree (float fovDegrees)
	Set full symmetrical vertical FOV in degrees.
proto external void	SetVerticalFOV (float fov)
	Set the vertical FOV.
proto external void	SetNearPlane (float nearPlane)
	Set the current near plane clipping value.
proto external void	SetFarPlane (float farPlane)
	Set the current far plane value.
proto external void	SetCameraIndex (int cameraIndex)
	Set the current camera index.
proto external int	GetCameraIndex ()
	Get the current camera index.
proto external void	SetLensFlareSet (CameraLensFlareSetType type, string userName)
	Sets camera lens flare set.
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.

Protected Member Functions
void	CameraActivate ()
	Called the moment this camera is activated by CameraManager.
void	CameraDeactivate ()
	Called the moment this camera is deactivated by CameraManager.

Member Function Documentation

ApplyTransform()

proto external void CameraBase.ApplyTransform

(

float

timeslice

)

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

CameraActivate()

void CameraBase.CameraActivate ( )

protected

Called the moment this camera is activated by CameraManager.

Implemented in SCR_CameraBase.

CameraDeactivate()

void CameraBase.CameraDeactivate ( )

protected

Called the moment this camera is deactivated by CameraManager.

Implemented in SCR_CameraBase.

GetCameraIndex()

proto external int CameraBase.GetCameraIndex

(

)

Get the current camera index.

Returns

Returns the camera index.

GetCursorTarget()

proto external IEntity CameraBase.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 CameraBase.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 CameraBase.GetFarPlane

(

)

Get the current far plane clipping value.

Returns

Returns the far plane value in meters.

GetNearPlane()

proto external float CameraBase.GetNearPlane

(

)

Get the current near plane clipping value.

Returns

Returns the near plane value in meters.

GetProjType()

proto external CameraType CameraBase.GetProjType

(

)

Get projection type.

GetVerticalFOV()

proto external float CameraBase.GetVerticalFOV

(

)

Get the vertical FOV.

Returns

Returns the vertical FOV in degrees.

GetWorldCameraTransform()

proto external void CameraBase.GetWorldCameraTransform

(

out vector

mat[4]

)

Get current camera world transformation.

IsAABBVisible()

proto external bool CameraBase.IsAABBVisible	(	vector	mins,
		vector	maxs
	)

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

IsSphereVisible()

proto external bool CameraBase.IsSphereVisible	(	vector	origin,
		float	radius
	)

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

SetCameraIndex()

proto external void CameraBase.SetCameraIndex

(

int

cameraIndex

)

Set the current camera index.

Parameters

cameraIndex

The new camera index.

SetFarPlane()

proto external void CameraBase.SetFarPlane

(

float

farPlane

)

Set the current far plane value.

Parameters

farPlane

The new far plane value in meters.

SetFOVDegree()

proto external void CameraBase.SetFOVDegree

(

float

fovDegrees

)

Set full symmetrical vertical FOV in degrees.

Parameters

fovDegrees

Vertical FOV in degrees.

SetLensFlareSet()

proto external void CameraBase.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 CameraBase.SetNearPlane

(

float

nearPlane

)

Set the current near plane clipping value.

Parameters

nearPlane

The new near plane value in meters.

SetVerticalFOV()

proto external void CameraBase.SetVerticalFOV

(

float

fov

)

Set the vertical FOV.

Parameters

fov	FOV in degrees.

---

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

• Game/generated/Camera/CameraBase.c