CryEngine.View

Public Member Functions | Static Public Member Functions | List of all members

CryEngine.View

Public Member Functions
void	RemoveView ()
	Removes this View from the game. More...

void	LinkTo (Entity entity)
	Link this view to an Entity. More...

void	SetActive (bool active)
	Enable or disable this View as the active view. If a new view is activated the previous active view is deactivated. More...

void	ResetBlending ()
	Resets the blendings that are currently active on this View. More...

void	ResetShaking ()
	Resets all the shakes that are currently active on this View. More...

void	SetFrameAdditiveCameraAngles (Angles3 addFrameAngles)
	Set the additive camera angles for this View. More...

void	SetScale (float scale)
	Set the scale of this View. More...

void	SetViewShake (Angles3 shakeAngle, Vector3 shakeShift, float duration, float frequency, float randomness, int shakeId)
	Set new shake parameters for a new or existing shake on this View. More...

void	SetViewShake (Angles3 shakeAngle, Vector3 shakeShift, float duration, float frequency, float randomness, int shakeId, bool flipVector)
	Set new shake parameters for a new or existing shake on this View. More...

void	SetViewShake (Angles3 shakeAngle, Vector3 shakeShift, float duration, float frequency, float randomness, int shakeId, bool flipVector, bool updateOnly)
	Set new shake parameters for a new or existing shake on this View. More...

void	SetZoomedScale (float scale)
	Set the zoomed scale of this View. More...

void	StopShake (int shakeID)
	Stop a shake with the specified ID from shaking. More...

void	Update (float frameTime, bool isActive)
	Manually update this View. More...

Static Public Member Functions
static View	Create ()
	Creates a new View that can be used to modify the camera-properties. More...

Member Function Documentation

◆ Create()

static View CryEngine.View.Create

(

)

inline

static

Creates a new View that can be used to modify the camera-properties.

Returns: The created View.

◆ LinkTo()

void CryEngine.View.LinkTo

(

Entity

entity

)

inline

Link this view to an Entity.

Parameters

entity

Entity that this View will be linked to.

◆ RemoveView()

void CryEngine.View.RemoveView

(

)

inline

Removes this View from the game.

◆ ResetBlending()

void CryEngine.View.ResetBlending

(

)

inline

Resets the blendings that are currently active on this View.

◆ ResetShaking()

void CryEngine.View.ResetShaking

(

)

inline

Resets all the shakes that are currently active on this View.

◆ SetActive()

void CryEngine.View.SetActive

(

bool

active

)

inline

Enable or disable this View as the active view. If a new view is activated the previous active view is deactivated.

Parameters

active If set to true this will become the active view. If set to false this view will be set to inactive.

◆ SetFrameAdditiveCameraAngles()

void CryEngine.View.SetFrameAdditiveCameraAngles

(

Angles3

addFrameAngles

)

inline

Set the additive camera angles for this View.

Parameters

addFrameAngles

Add frame angles.

◆ SetScale()

void CryEngine.View.SetScale

(

float

scale

)

inline

Set the scale of this View.

Parameters

scale

Scale.

◆ SetViewShake() [1/3]

void CryEngine.View.SetViewShake	(	Angles3	shakeAngle,
		Vector3	shakeShift,
		float	duration,
		float	frequency,
		float	randomness,
		int	shakeId
	)

inline

Set new shake parameters for a new or existing shake on this View.

Parameters

shakeAngle	The angle the view will shake to.
shakeShift	The direction and magnitude of the shake.
duration	Duration of the full shake.
frequency	The time it takes for a single oscilation to complete.
randomness	Amount of randomness that's added to the shake direction and angle.
shakeId	ID of the Shake. If a shake with this ID already exists, it will be adjusted with the new parameters, otherwise a new shake is created.

◆ SetViewShake() [2/3]

void CryEngine.View.SetViewShake	(	Angles3	shakeAngle,
		Vector3	shakeShift,
		float	duration,
		float	frequency,
		float	randomness,
		int	shakeId,
		bool	flipVector
	)

inline

Set new shake parameters for a new or existing shake on this View.

Parameters

shakeAngle	The angle the view will shake to.
shakeShift	The direction and magnitude of the shake.
duration	Duration of the full shake.
frequency	The time it takes for a single oscilation to complete.
randomness	Amount of randomness that's added to the shake direction and angle.
shakeId	ID of the Shake. If a shake with this ID already exists, it will be adjusted with the new parameters, otherwise a new shake is created.
flipVector	If set to `true` the direction and angle of the shake will be flipped after each oscilation.

◆ SetViewShake() [3/3]

void CryEngine.View.SetViewShake	(	Angles3	shakeAngle,
		Vector3	shakeShift,
		float	duration,
		float	frequency,
		float	randomness,
		int	shakeId,
		bool	flipVector,
		bool	updateOnly
	)

inline

Set new shake parameters for a new or existing shake on this View.

Parameters

shakeAngle	The angle the view will shake to.
shakeShift	The direction and magnitude of the shake.
duration	Duration of the full shake.
frequency	The time it takes for a single oscilation to complete.
randomness	Amount of randomness that's added to the shake direction and angle.
shakeId	ID of the Shake. If a shake with this ID already exists, it will be adjusted with the new parameters, otherwise a new shake is created.
flipVector	If set to `true` the direction and angle of the shake will be flipped after each oscilation.
updateOnly	If set to `true` this will only update an existing shake.

◆ SetZoomedScale()

void CryEngine.View.SetZoomedScale

(

float

scale

)

inline

Set the zoomed scale of this View.

Parameters

scale

Scale.

◆ StopShake()

void CryEngine.View.StopShake

(

int

shakeID

)

inline

Stop a shake with the specified ID from shaking.

Parameters

shakeID

ID of the shake that needs to stop.

◆ Update()

void CryEngine.View.Update	(	float	frameTime,
		bool	isActive
	)

inline

Manually update this View.

Parameters

frameTime	Time between this and last frame.
isActive	If set to `true` this View is updated, otherwise it will not be updated.