CharacterCamera1stPerson Interface Reference

Inheritance diagram for CharacterCamera1stPerson:

Public Member Functions
void	CharacterCamera1stPerson (CameraHandlerComponent pCameraHandler)
override void	OnActivate (ScriptedCameraItem pPrevCamera, ScriptedCameraItemResult pPrevCameraResult)
	this overrides freelook for cameras
override void	OnUpdate (float pDt, out ScriptedCameraItemResult pOutResult)
	virtual callback - called each frame
override float	GetBaseFOV ()
Public Member Functions inherited from CharacterCameraBase
void	CharacterCameraBase (CameraHandlerComponent pCameraHandler)
	constructor
float	UpdateUDAngle (out float pAngle, float pMin, float pMax, float pDt)
float	UpdateLRAngle (float pAngle, float pMin, float pMax, float pDt)
override void	OnUpdate (float pDt, out ScriptedCameraItemResult pOutResult)
	virtual callback - called each frame
override void	OnActivate (ScriptedCameraItem pPrevCamera, ScriptedCameraItemResult pPrevCameraResult)
	this overrides freelook for cameras
void	ForceFreelook (bool state)
int	GetShoulderLastActive ()
	Get last 3rd person shoulder state.
float	GetShoulderDistance ()
float	GetInterpolatedUDTransformAngle (float pDt)
void	AddPitchRoll (vector yawPitchRoll, float pitchFactor, float rollFactor, inout vector transformMS[4])
override void	SetBaseAngles (out vector angles)
	Sets the camera angles in DEG, useful when switching between cameras and changing orientation of the character.
override vector	GetBaseAngles ()
	helper to blend between cameras ret[0] - up down angle ret[1] - left right angle ret[2] - roll
Public Member Functions inherited from ScriptedCameraItem
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 ()
Public Member Functions inherited from BaseScriptedCameraItem
void	OnActivate (ScriptedCameraItem pPrevCamera, ScriptedCameraItemResult pPrevCameraResult)
	virtual callback - called when camera is created
void	OnDeactivate (ScriptedCameraItem pNextCamera)
void	OnBlendIn ()
void	OnBlendOut ()
void	OnUpdate (float pDt, out ScriptedCameraItemResult pOutResult)
	virtual callback - called each frame
void	SetBaseAngles (out vector angles)
	Sets the camera angles in DEG, useful when switching between cameras and changing orientation of the character.

Static Public Attributes
static const float	CONST_UD_MIN = -89.0
	down limit
static const float	CONST_UD_MAX = 89.0
	up limit
static const float	CONST_LR_MIN = -160.0
	left limit
static const float	CONST_LR_MAX = 160.0
	right limit

Protected Attributes
vector	m_OffsetLS
	position offset
bool	m_ApplyHeadBob
bool	m_bCameraTransition = false
CompartmentAccessComponent	m_pCompartmentAccess
bool	m_UseLookPositionOverrideLS = false
vector	m_LookPositionOverrideLS
Protected Attributes inherited from CharacterCameraBase
float	m_fUpDownAngle
	runtime values
float	m_fUpDownAngleAdd
	up down angle in rad
float	m_fLeftRightAngle = 0.0
	left right angle in rad
float	m_fFOV
float	m_fLRAngleVel
float	m_fUDAngleVel
float	m_fTransformUDAngleVel
float	m_fTransformUDAngle
bool	m_bForceFreeLook
bool	m_bLRAngleNoLimit
bool	m_bIgnoreCharacterPitch
float	m_fFOVFilter
float	m_fFOVFilterVel
int	m_fShoulderLastActive = 1
	saved active shoulder for 3rd person cam (1 - right, -1 left)
float	m_fRollFactor
float	m_fRollSmooth
float	m_fRollSmoothVel
float	m_fPitchFactor
float	m_fPitchSmooth
float	m_fPitchSmoothVel
ChimeraCharacter	m_OwnerCharacter
SCR_CharacterControllerComponent	m_ControllerComponent
CharacterInputContext	m_Input
SCR_CharacterCameraHandlerComponent	m_CharacterCameraHandler
CharacterAnimationComponent	m_CharacterAnimationComponent
CharacterHeadAimingComponent	m_CharacterHeadAimingComponent
CharacterCommandWeapon	m_CommandWeapons
CompartmentAccessComponent	m_CompartmentAccessComponent
CharacterCommandHandlerComponent	m_CmdHandler
float	m_fShakeProgress
float	m_fShakeVelocity
Protected Attributes inherited from ScriptedCameraItem
CameraHandlerComponent	m_CameraHandler
	data

Additional Inherited Members
Protected Member Functions inherited from CharacterCameraBase
void	AddVehiclePitchRoll (IEntity vehicle, float pDt, inout vector transformMS[4])
TNodeId	GetCameraBoneIndex ()
	Since camera bone is animated only in certain situations we want to provide camera bone whenever it is requested by animation otherwise we provide head bone to reduce amount of work animators need to do in order to make camera bone following head bone.
Static Protected Attributes inherited from CharacterCameraBase
static TNodeId	sm_iCameraBoneIndex = -1
static TNodeId	sm_iHeadBoneIndex = -1
static TNodeId	s_iNeckBoneIndex = -1
static AnimationTagID	sm_TagFPCamera = -1
static AnimationTagID	sm_TagLyingCamera = -1
static AnimationTagID	sm_TagItemUpdateCols = -1
static AnimationTagID	sm_TagADSTransitionOut = -1
static AnimationTagID	sm_TagADSTransitionIn = -1

Constructor & Destructor Documentation

CharacterCamera1stPerson()

void CharacterCamera1stPerson.CharacterCamera1stPerson

(

CameraHandlerComponent

pCameraHandler

)

Member Function Documentation

GetBaseFOV()

override float CharacterCamera1stPerson.GetBaseFOV

(

)

Implements ScriptedCameraItem.

Implemented in CharacterCamera1stPersonTurret, and CharacterCamera1stPersonVehicle.

OnActivate()

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

this overrides freelook for cameras

virtual callback - called when camera is created

Implements CharacterCameraBase.

Implemented in CharacterCameraBinoculars, CharacterCamera1stPersonTurret, CharacterCamera1stPersonVehicle, and CharacterCamera1stPersonVehicleTransition.

OnUpdate()

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

virtual callback - called each frame

update fov

Implements CharacterCameraBase.

Implemented in CharacterCameraBinoculars, CharacterCamera1stPersonBoneTransform, CharacterCamera1stPersonFloat, CharacterCamera1stPersonTurret, CharacterCamera1stPersonUnconscious, CharacterCamera1stPersonVehicle, and CharacterCamera1stPersonVehicleTransition.

Member Data Documentation

CONST_LR_MAX

const float CharacterCamera1stPerson.CONST_LR_MAX = 160.0

static

right limit

CONST_LR_MIN

const float CharacterCamera1stPerson.CONST_LR_MIN = -160.0

static

left limit

CONST_UD_MAX

const float CharacterCamera1stPerson.CONST_UD_MAX = 89.0

static

up limit

CONST_UD_MIN

const float CharacterCamera1stPerson.CONST_UD_MIN = -89.0

static

down limit

m_ApplyHeadBob

bool CharacterCamera1stPerson.m_ApplyHeadBob

protected

m_bCameraTransition

bool CharacterCamera1stPerson.m_bCameraTransition = false

protected

m_LookPositionOverrideLS

vector CharacterCamera1stPerson.m_LookPositionOverrideLS

protected

m_OffsetLS

vector CharacterCamera1stPerson.m_OffsetLS

protected

position offset

m_pCompartmentAccess

CompartmentAccessComponent CharacterCamera1stPerson.m_pCompartmentAccess

protected

m_UseLookPositionOverrideLS

bool CharacterCamera1stPerson.m_UseLookPositionOverrideLS = false

protected

---

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

• Game/Character/Cameras/FirstPerson/CharacterCamera1stPerson.c