CryEngine.Angles3

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

CryEngine.Angles3

Helper class to indicate 3D angles in radians Allows for converting quaternions to human readable angles easily (and back to a quaternion) More...

Inherits IEquatable< Angles3 >.

Public Member Functions
	Angles3 (float xAngle, float yAngle, float zAngle)
	Creates a new Angles3 object from three xyz radians. More...

	Angles3 (Quaternion quat)
	Creates a new Angles3 object from a Quaternion. More...

override int	GetHashCode ()
	Returns the hashcode of this instance. More...

override bool	Equals (object obj)
	Returns true if this Angles3 is equal to the specified object. More...

bool	Equals (Angles3 other)
	Returns true if this Angles3 is equal to the specified Angles3. More...

override string	ToString ()
	Returns this Angles3 in a formatted string. The format is "{X}, {Y}, {Z}". More...

Static Public Member Functions
static implicit	operator Vec3 (Angles3 angles)
	Impicit converter from Angles3 to Vec3. More...

static implicit	operator Ang3 (Angles3 angles)
	Impicit converter from Angles3 to Ang3. More...

static implicit	operator Angles3 (Ang3 angles)
	Impicit converter from Ang3 to Angles3. More...

static implicit	operator Angles3 (Vec3 angles)
	Impicit converter from Vec3 to Angles3. More...

static implicit	operator Angles3 (Vector3 angles)
	Impicit converter from Vector3 to Angles3. More...

static implicit	operator Vector3 (Angles3 angles)
	Impicit converter from Angles3 to Vector3. More...

static Angles3	operator* (Angles3 v, float scale)
	Scale the angles by the value of scale . More...

static Angles3	operator* (float scale, Angles3 v)
	Scale the angles by the value of scale More...

static Angles3	operator/ (Angles3 v, float scale)
	Divides the angles by scale . More...

static Angles3	operator+ (Angles3 v0, Angles3 v1)
	Combine two Angles3 component wise together. More...

static Angles3	operator- (Angles3 v0, Angles3 v1)
	Subtract two Angles3 component wise from eachother. More...

static Angles3	operator- (Angles3 v)
	Flip the values of the Angles3. More...

static Angles3	operator! (Angles3 v)
	Flip the values of the Angles3. More...

static bool	operator== (Angles3 left, Angles3 right)
	Compare two values of Angles3 component wise. Returns true if both are equal. More...

static bool	operator!= (Angles3 left, Angles3 right)
	Compare two values of Angles3 component wise. Returns true if both are inequal. More...

Properties
float	x `[get, set]`
	The x-axis angle. More...

float	y `[get, set]`
	The y-axis angle. More...

float	z `[get, set]`
	The z-axis angle. More...

float	X `[get, set]`
	The x-axis angle. More...

float	Y `[get, set]`
	The y-axis angle. More...

float	Z `[get, set]`
	The z-axis angle. More...

Angles3	Absolute `[get]`
	Returns a new Angles3 with absolute values. More...

Angles3	Flipped `[get]`
	Returns a new Angles3 with flipped values. More...

Vector3	ViewDirection `[get]`
	Converts the yaw and pitch to a view direction. x=yaw y=pitch z=roll (we ignore this element, since its not possible to convert the roll-component into a vector) More...

Quaternion	Quaternion `[get]`
	Get this Angles3 as a Quaternion. More...

float	this[int index] `[get, set]`
	Gets individual axes by index More...

Detailed Description

Helper class to indicate 3D angles in radians Allows for converting quaternions to human readable angles easily (and back to a quaternion)

Constructor & Destructor Documentation

◆ Angles3() [1/2]

CryEngine.Angles3.Angles3	(	float	xAngle,
		float	yAngle,
		float	zAngle
	)

inline

Creates a new Angles3 object from three xyz radians.

Parameters

xAngle
yAngle
zAngle

◆ Angles3() [2/2]

CryEngine.Angles3.Angles3

(

Quaternion

quat

)

inline

Creates a new Angles3 object from a Quaternion.

Parameters

quat

Member Function Documentation

◆ Equals() [1/2]

override bool CryEngine.Angles3.Equals

(

object

obj

)

inline

Returns true if this Angles3 is equal to the specified object.

Parameters

obj

Returns

◆ Equals() [2/2]

bool CryEngine.Angles3.Equals

(

Angles3

other

)

inline

Returns true if this Angles3 is equal to the specified Angles3.

Parameters

other

Returns

◆ GetHashCode()

override int CryEngine.Angles3.GetHashCode

(

)

inline

Returns the hashcode of this instance.

Returns

◆ operator Ang3()

static implicit CryEngine.Angles3.operator Ang3

(

Angles3

angles

)

inline

static

Impicit converter from Angles3 to Ang3.

Parameters

angles

◆ operator Angles3() [1/3]

static implicit CryEngine.Angles3.operator Angles3

(

Ang3

angles

)

inline

static

Impicit converter from Ang3 to Angles3.

Parameters

angles

◆ operator Angles3() [2/3]

static implicit CryEngine.Angles3.operator Angles3

(

Vec3

angles

)

inline

static

Impicit converter from Vec3 to Angles3.

Parameters

angles

◆ operator Angles3() [3/3]

static implicit CryEngine.Angles3.operator Angles3

(

Vector3

angles

)

inline

static

Impicit converter from Vector3 to Angles3.

Parameters

angles

◆ operator Vec3()

static implicit CryEngine.Angles3.operator Vec3

(

Angles3

angles

)

inline

static

Impicit converter from Angles3 to Vec3.

Parameters

angles

◆ operator Vector3()

static implicit CryEngine.Angles3.operator Vector3

(

Angles3

angles

)

inline

static

Impicit converter from Angles3 to Vector3.

Parameters

angles

◆ operator!()

static Angles3 CryEngine.Angles3.operator!

(

Angles3

)

inline

static

Flip the values of the Angles3.

Parameters

Returns

◆ operator!=()

static bool CryEngine.Angles3.operator!=	(	Angles3	left,
		Angles3	right
	)

inline

static

Compare two values of Angles3 component wise. Returns true if both are inequal.

Parameters

left
right

Returns

◆ operator*() [1/2]

static Angles3 CryEngine.Angles3.operator*	(	Angles3	v,
		float	scale
	)

inline

static

Scale the angles by the value of scale .

Parameters

v
scale

Returns

◆ operator*() [2/2]

static Angles3 CryEngine.Angles3.operator*	(	float	scale,
		Angles3	v
	)

inline

static

Scale the angles by the value of scale

Parameters

scale
v

Returns

◆ operator+()

static Angles3 CryEngine.Angles3.operator+	(	Angles3	v0,
		Angles3	v1
	)

inline

static

Combine two Angles3 component wise together.

Parameters

v0
v1

Returns

◆ operator-() [1/2]

static Angles3 CryEngine.Angles3.operator-	(	Angles3	v0,
		Angles3	v1
	)

inline

static

Subtract two Angles3 component wise from eachother.

Parameters

v0
v1

Returns

◆ operator-() [2/2]

static Angles3 CryEngine.Angles3.operator-

(

Angles3

)

inline

static

Flip the values of the Angles3.

Parameters

Returns

◆ operator/()

static Angles3 CryEngine.Angles3.operator/	(	Angles3	v,
		float	scale
	)

inline

static

Divides the angles by scale .

Parameters

v
scale

Returns

◆ operator==()

static bool CryEngine.Angles3.operator==	(	Angles3	left,
		Angles3	right
	)

inline

static

Compare two values of Angles3 component wise. Returns true if both are equal.

Parameters

left
right

Returns

◆ ToString()

override string CryEngine.Angles3.ToString

(

)

inline

Returns this Angles3 in a formatted string. The format is "{X}, {Y}, {Z}".

Returns

Property Documentation

◆ Absolute

Angles3 CryEngine.Angles3.Absolute

get

Returns a new Angles3 with absolute values.

◆ Flipped

Angles3 CryEngine.Angles3.Flipped

get

Returns a new Angles3 with flipped values.

◆ Quaternion

Quaternion CryEngine.Angles3.Quaternion

get

Get this Angles3 as a Quaternion.

◆ this[int index]

float CryEngine.Angles3.this[int index]

get

set

Gets individual axes by index

Parameters

index

Index, 0 - 2 where 0 is X and 2 is Z

Returns: The axis value

◆ ViewDirection

Vector3 CryEngine.Angles3.ViewDirection

get

Converts the yaw and pitch to a view direction. x=yaw y=pitch z=roll (we ignore this element, since its not possible to convert the roll-component into a vector)

The view direction.

◆ x

float CryEngine.Angles3.x

get

set

The x-axis angle.

◆ X

float CryEngine.Angles3.X

get

set

The x-axis angle.

◆ y

float CryEngine.Angles3.y

get

set

The y-axis angle.

◆ Y

float CryEngine.Angles3.Y

get

set

The y-axis angle.

◆ z

float CryEngine.Angles3.z

get

set

The z-axis angle.

◆ Z

float CryEngine.Angles3.Z

get

set

The z-axis angle.