QuaternionCompressed Struct Reference

Represents a compressed Quaternion value for network transmission. More...

Inherits INetworkStruct, and IEquatable< QuaternionCompressed >.

Public Member Functions
override bool	Equals (object obj)
	Checks if the provided object is a QuaternionCompressed instance and if it's equal to the current QuaternionCompressed instance. More...
bool	Equals (QuaternionCompressed other)
	Checks if the current QuaternionCompressed instance is equal to the other QuaternionCompressed instance. More...
override int	GetHashCode ()
	Returns the hash code for the current QuaternionCompressed instance. More...

Static Public Member Functions
static implicit	operator Quaternion (QuaternionCompressed q)
	Implicit conversion from QuaternionCompressed to Quaternion. More...
static implicit	operator QuaternionCompressed (Quaternion v)
	Implicit conversion from Quaternion to QuaternionCompressed. More...
static bool	operator!= (QuaternionCompressed left, QuaternionCompressed right)
	Inequality operator for QuaternionCompressed struct. More...
static bool	operator== (QuaternionCompressed left, QuaternionCompressed right)
	Equality operator for QuaternionCompressed struct. More...

Public Attributes
int	wEncoded
	Encoded value of the w component. More...
int	xEncoded
	Encoded value of the x component. More...
int	yEncoded
	Encoded value of the y component. More...
int	zEncoded
	Encoded value of the z component. More...

Properties
float	W [get, set]
	Gets or sets the w component. More...
float	X [get, set]
	Gets or sets the x component. More...
float	Y [get, set]
	Gets or sets the y component. More...
float	Z [get, set]
	Gets or sets the z component. More...

Detailed Description

Represents a compressed Quaternion value for network transmission.

Member Function Documentation

Equals() [1/2]

override bool Equals

(

object

obj

)

Checks if the provided object is a QuaternionCompressed instance and if it's equal to the current QuaternionCompressed instance.

Parameters

obj	The object to compare with the current QuaternionCompressed instance.

Returns

True if the provided object is a QuaternionCompressed instance and it's equal to the current QuaternionCompressed instance, otherwise false.

Equals() [2/2]

bool Equals

(

QuaternionCompressed

other

)

Checks if the current QuaternionCompressed instance is equal to the other QuaternionCompressed instance.

Parameters

other

The other QuaternionCompressed instance to compare with the current QuaternionCompressed instance.

Returns

True if the values of both QuaternionCompressed instances are equal, otherwise false.

GetHashCode()

override int GetHashCode

(

)

Returns the hash code for the current QuaternionCompressed instance.

Returns

A hash code for the current QuaternionCompressed instance.

operator Quaternion()

static implicit operator Quaternion ( QuaternionCompressed  q )

static

Implicit conversion from QuaternionCompressed to Quaternion.

Parameters

q	The QuaternionCompressed instance to convert.

Returns

The decompressed Quaternion value of the QuaternionCompressed instance.

operator QuaternionCompressed()

static implicit operator QuaternionCompressed ( Quaternion  v )

static

Implicit conversion from Quaternion to QuaternionCompressed.

Parameters

v	The Quaternion value to convert.

Returns

A new QuaternionCompressed instance with the compressed value of the Quaternion.

operator!=()

static bool operator!= ( QuaternionCompressed  left, QuaternionCompressed  right  )

static

Inequality operator for QuaternionCompressed struct.

Parameters

left	First QuaternionCompressed instance.
right	Second QuaternionCompressed instance.

Returns

True if the value of the first QuaternionCompressed instance is not equal to the value of the second QuaternionCompressed instance, otherwise false.

operator==()

static bool operator== ( QuaternionCompressed  left, QuaternionCompressed  right  )

static

Equality operator for QuaternionCompressed struct.

Parameters

left	First QuaternionCompressed instance.
right	Second QuaternionCompressed instance.

Returns

True if the value of the first QuaternionCompressed instance is equal to the value of the second QuaternionCompressed instance, otherwise false.

Member Data Documentation

wEncoded

int wEncoded

Encoded value of the w component.

xEncoded

int xEncoded

Encoded value of the x component.

yEncoded

int yEncoded

Encoded value of the y component.

zEncoded

int zEncoded

Encoded value of the z component.

Property Documentation

W

float W

getset

Gets or sets the w component.

X

float X

getset

Gets or sets the x component.

Y

float Y

getset

Gets or sets the y component.

Z

float Z

getset

Gets or sets the z component.