PlayerCamera Interface Reference

Inheritance diagram for PlayerCamera:

Public Member Functions
proto external float	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.
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.

Additional Inherited Members
Protected Member Functions inherited from CameraBase
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

GetFocusFOV()

proto external float PlayerCamera.GetFocusFOV

(

)

Returns the focus field of view in degrees.

GetFocusFOVScale()

proto external float PlayerCamera.GetFocusFOVScale	(	float	baseFOV,
		float	scalar
	)

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

GetFocusMode()

proto external float PlayerCamera.GetFocusMode

(

)

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

---

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

• Game/generated/Camera/PlayerCamera.c