ScriptedCameraItem Interface Reference

Inheritance diagram for ScriptedCameraItem:

Public Member Functions
void	ScriptedCameraItem (CameraHandlerComponent pCameraHandler)
override void	OnActivate (ScriptedCameraItem pPrevCamera, ScriptedCameraItemResult pPrevCameraResult)
	this overrides freelook for cameras
override void	OnBlendIn ()
override void	OnBlendOut ()
override void	OnUpdate (float pDt, out ScriptedCameraItemResult pOutResult)
	virtual callback - called each frame
void	OnAfterCameraUpdate (float pDt, bool pIsKeyframe, inout vector transformMS[4])
vector	GetBaseAngles ()
	helper to blend between cameras ret[0] - up down angle ret[1] - left right angle ret[2] - roll
override void	SetBaseAngles (out vector angles)
	Sets the camera angles in DEG, useful when switching between cameras and changing orientation of the character.
float	GetBaseFOV ()
void	OverrideDirectBoneMode (EDirectBoneMode boneMode)
EDirectBoneMode	GetOverrideDirectBoneMode ()
Public Member Functions inherited from BaseScriptedCameraItem
void	OnDeactivate (ScriptedCameraItem pNextCamera)

Protected Attributes
CameraHandlerComponent	m_CameraHandler
	data
EDirectBoneMode	m_OverrideDirectBoneMode = 0

Constructor & Destructor Documentation

ScriptedCameraItem()

void ScriptedCameraItem.ScriptedCameraItem

(

CameraHandlerComponent

pCameraHandler

)

Member Function Documentation

GetBaseAngles()

vector ScriptedCameraItem.GetBaseAngles

(

)

helper to blend between cameras ret[0] - up down angle ret[1] - left right angle ret[2] - roll

Implemented in CharacterCameraBase.

GetBaseFOV()

float ScriptedCameraItem.GetBaseFOV

(

)

Implemented in CharacterCamera1stPerson, CharacterCamera1stPersonTurret, CharacterCamera1stPersonVehicle, CharacterCamera3rdPersonBase, and CharacterCamera3rdPersonVehicle.

GetOverrideDirectBoneMode()

EDirectBoneMode ScriptedCameraItem.GetOverrideDirectBoneMode

(

)

OnActivate()

override void ScriptedCameraItem.OnActivate	(	ScriptedCameraItem	pPrevCamera,
		ScriptedCameraItemResult	pPrevCameraResult )

this overrides freelook for cameras

virtual callback - called when camera is created

Implements BaseScriptedCameraItem.

Implemented in CharacterCamera1stPerson, CharacterCamera1stPersonTurret, CharacterCamera1stPersonTurretTransition, CharacterCamera1stPersonVehicle, CharacterCamera1stPersonVehicleTransition, CharacterCamera3rdPersonBase, CharacterCamera3rdPersonVehicle, CharacterCameraADS, CharacterCameraBase, CharacterCameraBinoculars, and CharacterCameraDebug.

OnAfterCameraUpdate()

void ScriptedCameraItem.OnAfterCameraUpdate	(	float	pDt,
		bool	pIsKeyframe,
		inout vector	transformMS[4] )

Implemented in CharacterCamera1stPersonTurret, CharacterCamera1stPersonVehicle, CharacterCamera3rdPersonVehicle, and CharacterCameraADSVehicle.

OnBlendIn()

override void ScriptedCameraItem.OnBlendIn

(

)

Implements BaseScriptedCameraItem.

Implemented in CharacterCameraADS, and CharacterCameraADSVehicle.

OnBlendOut()

override void ScriptedCameraItem.OnBlendOut

(

)

Implements BaseScriptedCameraItem.

Implemented in CharacterCameraADS, and CharacterCameraADSVehicle.

OnUpdate()

override void ScriptedCameraItem.OnUpdate	(	float	pDt,
		out ScriptedCameraItemResult	pOutResult )

virtual callback - called each frame

Implements BaseScriptedCameraItem.

Implemented in CharacterCamera1stPerson, CharacterCamera1stPersonBoneTransform, CharacterCamera1stPersonFloat, CharacterCamera1stPersonTurret, CharacterCamera1stPersonTurretTransition, CharacterCamera1stPersonUnconscious, CharacterCamera1stPersonVehicle, CharacterCamera1stPersonVehicleTransition, CharacterCamera3rdPersonBase, CharacterCamera3rdPersonClimb, CharacterCamera3rdPersonCrouch, CharacterCamera3rdPersonErc, CharacterCamera3rdPersonFloat, CharacterCamera3rdPersonProne, CharacterCamera3rdPersonUnconscious, CharacterCamera3rdPersonVehicle, CharacterCameraADS, CharacterCameraADSVehicle, CharacterCameraBase, CharacterCameraBinoculars, and CharacterCameraDebug.

OverrideDirectBoneMode()

void ScriptedCameraItem.OverrideDirectBoneMode

(

EDirectBoneMode

boneMode

)

SetBaseAngles()

override void ScriptedCameraItem.SetBaseAngles

(

out vector

angles

)

Sets the camera angles in DEG, useful when switching between cameras and changing orientation of the character.

Implements BaseScriptedCameraItem.

Implemented in CharacterCameraBase.

Member Data Documentation

m_CameraHandler

CameraHandlerComponent ScriptedCameraItem.m_CameraHandler

protected

data

component owner

m_OverrideDirectBoneMode

EDirectBoneMode ScriptedCameraItem.m_OverrideDirectBoneMode = 0

protected

---

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

• GameCode/Camera/ScriptedCameraSet.c