Base class for scripted cameras. More...

Inheritance diagram for SCR_CameraBase:

Public Member Functions
bool	IsInView (vector worldPos, WorkspaceWidget workspace=null)
	Check if position is in camera view for given workspace.

bool	IsInView (vector worldPos, float aspectRatio)
	Check if position is in camera view for given aspect ratio.

ScriptInvoker	GetOnActivate ()

ScriptInvoker	GetOnDeactivate ()

ScriptInvoker	GetOnCameraActivate ()

ScriptInvoker	GetOnCameraDeactivate ()

override void	EOnActivate (IEntity owner)

override void	EOnDeactivate (IEntity owner)

override void	CameraActivate ()
	Called the moment this camera is activated by CameraManager.

override void	CameraDeactivate ()
	Called the moment this camera is deactivated by CameraManager.

override void	_WB_AfterWorldUpdate (float timeSlice)

Public Member Functions inherited from CameraBase
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 Attributes
bool	m_bShowDebugViewCone

Additional Inherited Members
void	CameraActivate ()
	Called the moment this camera is activated by CameraManager.

void	CameraDeactivate ()
	Called the moment this camera is deactivated by CameraManager.

Detailed Description

Base class for scripted cameras.

Member Function Documentation

◆ _WB_AfterWorldUpdate()

override void SCR_CameraBase._WB_AfterWorldUpdate ( float timeSlice )

◆ CameraActivate()

override void SCR_CameraBase.CameraActivate ( )

Called the moment this camera is activated by CameraManager.

Implements CameraBase.

◆ CameraDeactivate()

override void SCR_CameraBase.CameraDeactivate ( )

Called the moment this camera is deactivated by CameraManager.

Implements CameraBase.

◆ EOnActivate()

override void SCR_CameraBase.EOnActivate ( IEntity owner )

◆ EOnDeactivate()

override void SCR_CameraBase.EOnDeactivate ( IEntity owner )

◆ GetOnActivate()

ScriptInvoker SCR_CameraBase.GetOnActivate ( )

◆ GetOnCameraActivate()

ScriptInvoker SCR_CameraBase.GetOnCameraActivate ( )

◆ GetOnCameraDeactivate()

ScriptInvoker SCR_CameraBase.GetOnCameraDeactivate ( )

◆ GetOnDeactivate()

ScriptInvoker SCR_CameraBase.GetOnDeactivate ( )

◆ IsInView() [1/2]

bool SCR_CameraBase.IsInView	(	vector	worldPos,
		float	aspectRatio
	)

Check if position is in camera view for given aspect ratio.

Parameters

worldPos	World position
aspectRatio	Aspect ratio W/H, e.g., 4:3 = 1.333

Returns: True when in view

◆ IsInView() [2/2]

bool SCR_CameraBase.IsInView	(	vector	worldPos,
		WorkspaceWidget	workspace = `null`
	)

Check if position is in camera view for given workspace.

Parameters

worldPos	World position
workspace	Workspace widget

Returns: True when in view

Member Data Documentation

◆ m_bShowDebugViewCone

bool SCR_CameraBase.m_bShowDebugViewCone

protected

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

Game/Camera/SCR_CameraBase.c

Public Member Functions

Protected Attributes

Additional Inherited Members