Sandbox.Engine.Utils.MyThirdPersonSpectator Class Reference

Inheritance diagram for Sandbox.Engine.Utils.MyThirdPersonSpectator:

Classes
class	SpringInfo

Public Member Functions
	MyThirdPersonSpectator ()
void	Update ()
void	Rotate (Vector2 rotationIndicator, float rollIndicator)
void	MoveAndRotate (Vector3 moveIndicator, Vector2 rotationIndicator, float rollIndicator)
MatrixD	GetViewMatrix ()
bool	IsCameraPositionOk ()
void	RecalibrateCameraPosition (bool isCharacter=false)
void	UpdateZoom ()
bool	ResetViewerDistance (double?newDistance=null)
	Reset the third person camera distance. More...
bool	ResetViewerAngle (Vector2?headAngle)
	Reset the third person camera "head" angles. More...
double	GetViewerDistance ()
	Get the distance from viewer to the target. More...
void	SaveSettings ()
	Flag this spectator to save its settings next Update call. More...
Vector3D	GetCrosshair ()
Public Member Functions inherited from VRage.Game.Components.MySessionComponentBase
virtual bool	UpdatedBeforeInit ()
	MySessionComponentBase ()
void	SetUpdateOrder (MyUpdateOrder order)
virtual void	InitFromDefinition (MySessionComponentDefinition definition)
virtual void	Init (MyObjectBuilder_SessionComponent sessionComponent)
virtual MyObjectBuilder_SessionComponent	GetObjectBuilder ()
void	AfterLoadData ()
void	UnloadDataConditional ()
virtual void	LoadData ()
virtual void	SaveData ()
virtual void	BeforeStart ()
virtual void	UpdateBeforeSimulation ()
virtual void	Simulate ()
virtual void	UpdateAfterSimulation ()
virtual void	UpdatingStopped ()
virtual void	Draw ()
virtual void	HandleInput ()
override string	ToString ()

Public Attributes
const float	MIN_VIEWER_DISTANCE = 1.45f
const float	MAX_VIEWER_DISTANCE = 200.0f
const float	CAMERA_RADIUS = 0.3f
bool	m_disableSpringThisFrame = false
SpringInfo	NormalSpring
Public Attributes inherited from VRage.Game.Components.MySessionComponentBase
readonly string	DebugName
readonly int	Priority
readonly Type	ComponentType
IMySession	Session

Static Public Attributes
static MyThirdPersonSpectator	Static

Properties
bool	EnableDebugDraw [get, set]
Properties inherited from VRage.Game.Components.MySessionComponentBase
MyUpdateOrder	UpdateOrder [get]
MyObjectBuilderType	ObjectBuilderType [get]
bool	Loaded [get]
bool	Initialized [get]
MyDefinitionId	Definition [get, set]
virtual Type[]	Dependencies [get]
virtual bool	IsRequiredByGame [get]
	Indicates whether a session component should be used in current configuration. Example: MyDestructionData component returns true only when game uses Havok Destruction More...

Additional Inherited Members
Protected Member Functions inherited from VRage.Game.Components.MySessionComponentBase
virtual void	UnloadData ()

Detailed Description

Definition at line 22 of file MyThirdPersonSpectator.cs.

Constructor & Destructor Documentation

Sandbox.Engine.Utils.MyThirdPersonSpectator.MyThirdPersonSpectator ( )

inline

Definition at line 151 of file MyThirdPersonSpectator.cs.

Member Function Documentation

Vector3D Sandbox.Engine.Utils.MyThirdPersonSpectator.GetCrosshair ( )

inline

Definition at line 775 of file MyThirdPersonSpectator.cs.

double Sandbox.Engine.Utils.MyThirdPersonSpectator.GetViewerDistance ( )

inline

Get the distance from viewer to the target.

Returns

Definition at line 759 of file MyThirdPersonSpectator.cs.

MatrixD Sandbox.Engine.Utils.MyThirdPersonSpectator.GetViewMatrix ( )

inline

Definition at line 301 of file MyThirdPersonSpectator.cs.

bool Sandbox.Engine.Utils.MyThirdPersonSpectator.IsCameraPositionOk ( )

inline

Definition at line 315 of file MyThirdPersonSpectator.cs.

void Sandbox.Engine.Utils.MyThirdPersonSpectator.MoveAndRotate ( Vector3  moveIndicator, Vector2  rotationIndicator, float  rollIndicator  )

inline

Definition at line 282 of file MyThirdPersonSpectator.cs.

void Sandbox.Engine.Utils.MyThirdPersonSpectator.RecalibrateCameraPosition ( bool  isCharacter = false )

inline

Definition at line 607 of file MyThirdPersonSpectator.cs.

bool Sandbox.Engine.Utils.MyThirdPersonSpectator.ResetViewerAngle ( Vector2?  headAngle )

inline

Reset the third person camera "head" angles.

Parameters

headAngle

new head angle

Definition at line 741 of file MyThirdPersonSpectator.cs.

bool Sandbox.Engine.Utils.MyThirdPersonSpectator.ResetViewerDistance ( double?  newDistance = null )

inline

Reset the third person camera distance.

Parameters

newDistance

New camera distance. If null, it is not changed.

Definition at line 725 of file MyThirdPersonSpectator.cs.

void Sandbox.Engine.Utils.MyThirdPersonSpectator.Rotate ( Vector2  rotationIndicator, float  rollIndicator  )

inline

Definition at line 277 of file MyThirdPersonSpectator.cs.

void Sandbox.Engine.Utils.MyThirdPersonSpectator.SaveSettings ( )

inline

Flag this spectator to save its settings next Update call.

Definition at line 769 of file MyThirdPersonSpectator.cs.

void Sandbox.Engine.Utils.MyThirdPersonSpectator.Update ( )

inline

Definition at line 170 of file MyThirdPersonSpectator.cs.

void Sandbox.Engine.Utils.MyThirdPersonSpectator.UpdateZoom ( )

inline

Definition at line 668 of file MyThirdPersonSpectator.cs.

Member Data Documentation

const float Sandbox.Engine.Utils.MyThirdPersonSpectator.CAMERA_RADIUS = 0.3f

Definition at line 32 of file MyThirdPersonSpectator.cs.

bool Sandbox.Engine.Utils.MyThirdPersonSpectator.m_disableSpringThisFrame = false

Definition at line 44 of file MyThirdPersonSpectator.cs.

const float Sandbox.Engine.Utils.MyThirdPersonSpectator.MAX_VIEWER_DISTANCE = 200.0f

Definition at line 30 of file MyThirdPersonSpectator.cs.

const float Sandbox.Engine.Utils.MyThirdPersonSpectator.MIN_VIEWER_DISTANCE = 1.45f

Definition at line 28 of file MyThirdPersonSpectator.cs.

SpringInfo Sandbox.Engine.Utils.MyThirdPersonSpectator.NormalSpring

Definition at line 117 of file MyThirdPersonSpectator.cs.

MyThirdPersonSpectator Sandbox.Engine.Utils.MyThirdPersonSpectator.Static

static

Definition at line 25 of file MyThirdPersonSpectator.cs.

Property Documentation

bool Sandbox.Engine.Utils.MyThirdPersonSpectator.EnableDebugDraw

getset

Definition at line 146 of file MyThirdPersonSpectator.cs.

---

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

• Sources/Sandbox.Game/Engine/Utils/MyThirdPersonSpectator.cs