CDPL.Math.FQuaternion Class Reference

Inheritance diagram for CDPL.Math.FQuaternion:

Public Member Functions
None	__init__ ()
	Initializes the FQuaternion instance.
None	__init__ (FQuaternion q)
	Initializes a copy of the FQuaternion instance q. More...
None	__init__ (float c1, float c2=0.0, float c3=0.0, float c4=0.0)
	Initializes the FQuaternion instance. More...
None	__init__ (ConstFQuaternionExpression e)
	Initializes the FQuaternion instance. More...
None	__init__ (ConstDQuaternionExpression e)
	Initializes the FQuaternion instance. More...
None	__init__ (ConstLQuaternionExpression e)
	Initializes the FQuaternion instance. More...
None	__init__ (ConstULQuaternionExpression e)
	Initializes the FQuaternion instance. More...
None	__init__ (object a)
	Initializes the FQuaternion instance. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
FQuaternion	assign (ConstFQuaternionExpression e)
	Replaces the current state of self with a copy of the state of the ConstFQuaternionExpression instance e. More...
FQuaternion	assign (ConstDQuaternionExpression e)
	Replaces the current state of self with a copy of the state of the ConstDQuaternionExpression instance e. More...
FQuaternion	assign (ConstLQuaternionExpression e)
	Replaces the current state of self with a copy of the state of the ConstLQuaternionExpression instance e. More...
FQuaternion	assign (ConstULQuaternionExpression e)
	Replaces the current state of self with a copy of the state of the ConstULQuaternionExpression instance e. More...
FQuaternion	assign (FQuaternion q)
	Replaces the current state of self with a copy of the state of the FQuaternion instance q. More...
None	assign (object a)
	Replaces the current state of self with a copy of the state of the object instance a. More...
float	getC1 ()
float	getC2 ()
float	getC3 ()
float	getC4 ()
object	toArray ()
None	swap (FQuaternion q)
None	setC1 (float v)
None	setC2 (float v)
None	setC3 (float v)
None	setC4 (float v)
None	set (float c1=0.0, float c2=0.0, float c3=0.0, float c4=0.0)
bool	__eq__ (FQuaternion q)
	Returns the result of the comparison operation self == q. More...
bool	__eq__ (ConstFQuaternionExpression q)
	Returns the result of the comparison operation self == q. More...
bool	__ne__ (FQuaternion q)
	Returns the result of the comparison operation self != q. More...
bool	__ne__ (ConstFQuaternionExpression q)
	Returns the result of the comparison operation self != q. More...
str	__str__ ()
	Returns a string representation of the FQuaternion instance. More...
FQuaternion	__pos__ ()
ConstFQuaternionExpression	__neg__ ()
ConstFQuaternionExpression	__add__ (float t)
	Returns the result of the addition operation self + t. More...
ConstFQuaternionExpression	__add__ (ConstFQuaternionExpression e)
	Returns the result of the addition operation self + e. More...
ConstFQuaternionExpression	__radd__ (float t)
ConstFQuaternionExpression	__sub__ (float t)
	Returns the result of the subtraction operation self - t. More...
ConstFQuaternionExpression	__sub__ (ConstFQuaternionExpression e)
	Returns the result of the subtraction operation self - e. More...
ConstFQuaternionExpression	__rsub__ (float t)
ConstFQuaternionExpression	__mul__ (float t)
	Returns the result of the multiplication operation self * t. More...
ConstFQuaternionExpression	__mul__ (ConstFQuaternionExpression e)
	Returns the result of the multiplication operation self * e. More...
ConstFQuaternionExpression	__rmul__ (float t)
ConstFQuaternionExpression	__div__ (float t)
	Returns the result of the division operation self / t. More...
ConstFQuaternionExpression	__div__ (ConstFQuaternionExpression e)
	Returns the result of the division operation self / e. More...
ConstFQuaternionExpression	__truediv__ (float t)
ConstFQuaternionExpression	__rdiv__ (float t)
FQuaternion	__iadd__ (float t)
	Performs the in-place addition operation self += t. More...
FQuaternion	__iadd__ (FQuaternion q)
	Performs the in-place addition operation self += q. More...
FQuaternion	__iadd__ (ConstFQuaternionExpression q)
	Performs the in-place addition operation self += q. More...
FQuaternion	__isub__ (float t)
	Performs the in-place subtraction operation self -= t. More...
FQuaternion	__isub__ (FQuaternion q)
	Performs the in-place subtraction operation self -= q. More...
FQuaternion	__isub__ (ConstFQuaternionExpression q)
	Performs the in-place subtraction operation self -= q. More...
FQuaternion	__imul__ (float t)
	Performs the in-place multiplication operation self *= t. More...
FQuaternion	__imul__ (FQuaternion q)
	Performs the in-place multiplication operation self *= q. More...
FQuaternion	__imul__ (ConstFQuaternionExpression q)
	Performs the in-place multiplication operation self *= q. More...
FQuaternion	__idiv__ (float t)
	Performs the in-place division operation self /= t. More...
FQuaternion	__idiv__ (FQuaternion q)
	Performs the in-place division operation self /= q. More...
FQuaternion	__idiv__ (ConstFQuaternionExpression q)
	Performs the in-place division operation self /= q. More...
FQuaternion	__itruediv__ (float t)
FQuaternion	__itruediv__ (FQuaternion q)
FQuaternion	__itruediv__ (ConstFQuaternionExpression q)

Properties
	objectID = property(getObjectID)

Constructor & Destructor Documentation

__init__() [1/7]

None CDPL.Math.FQuaternion.__init__

(

FQuaternion

q

)

Initializes a copy of the FQuaternion instance q.

Parameters

q	The FQuaternion instance to copy.

__init__() [2/7]

None CDPL.Math.FQuaternion.__init__	(	float	c1,
		float	c2 = 0.0,
		float	c3 = 0.0,
		float	c4 = 0.0
	)

Initializes the FQuaternion instance.

Parameters

c1
c2
c3
c4

__init__() [3/7]

None CDPL.Math.FQuaternion.__init__

(

ConstFQuaternionExpression

e

)

Initializes the FQuaternion instance.

Parameters

e

__init__() [4/7]

None CDPL.Math.FQuaternion.__init__

(

ConstDQuaternionExpression

e

)

Initializes the FQuaternion instance.

Parameters

e

__init__() [5/7]

None CDPL.Math.FQuaternion.__init__

(

ConstLQuaternionExpression

e

)

Initializes the FQuaternion instance.

Parameters

e

__init__() [6/7]

None CDPL.Math.FQuaternion.__init__

(

ConstULQuaternionExpression

e

)

Initializes the FQuaternion instance.

Parameters

e

__init__() [7/7]

None CDPL.Math.FQuaternion.__init__

(

object

a

)

Initializes the FQuaternion instance.

Parameters

a

Member Function Documentation

getObjectID()

int CDPL.Math.FQuaternion.getObjectID

(

)

Returns the numeric identifier (ID) of the wrapped C++ class instance.

Different Python FQuaternion instances may reference the same underlying C++ class instance. The commonly used Python expression a is not b thus cannot tell reliably whether the two FQuaternion instances a and b reference different C++ objects. The numeric identifier returned by this method allows to correctly implement such an identity test via the simple expression a.getObjectID() != b.getObjectID().

Returns

The numeric ID of the internally referenced C++ class instance.

assign() [1/6]

FQuaternion CDPL.Math.FQuaternion.assign

(

ConstFQuaternionExpression

e

)

Replaces the current state of self with a copy of the state of the ConstFQuaternionExpression instance e.

Parameters

e	The ConstFQuaternionExpression instance to copy.

Returns

self

assign() [2/6]

FQuaternion CDPL.Math.FQuaternion.assign

(

ConstDQuaternionExpression

e

)

Replaces the current state of self with a copy of the state of the ConstDQuaternionExpression instance e.

Parameters

e	The ConstDQuaternionExpression instance to copy.

Returns

self

assign() [3/6]

FQuaternion CDPL.Math.FQuaternion.assign

(

ConstLQuaternionExpression

e

)

Replaces the current state of self with a copy of the state of the ConstLQuaternionExpression instance e.

Parameters

e	The ConstLQuaternionExpression instance to copy.

Returns

self

assign() [4/6]

FQuaternion CDPL.Math.FQuaternion.assign

(

ConstULQuaternionExpression

e

)

Replaces the current state of self with a copy of the state of the ConstULQuaternionExpression instance e.

Parameters

e	The ConstULQuaternionExpression instance to copy.

Returns

self

assign() [5/6]

FQuaternion CDPL.Math.FQuaternion.assign

(

FQuaternion

q

)

Replaces the current state of self with a copy of the state of the FQuaternion instance q.

Parameters

q	The FQuaternion instance to copy.

Returns

self

assign() [6/6]

None CDPL.Math.FQuaternion.assign

(

object

a

)

Replaces the current state of self with a copy of the state of the object instance a.

Parameters

a	The object instance to copy.

Returns

self

getC1()

float CDPL.Math.FQuaternion.getC1

(

)

Returns

getC2()

float CDPL.Math.FQuaternion.getC2

(

)

Returns

getC3()

float CDPL.Math.FQuaternion.getC3

(

)

Returns

getC4()

float CDPL.Math.FQuaternion.getC4

(

)

Returns

toArray()

object CDPL.Math.FQuaternion.toArray

(

)

Returns

swap()

None CDPL.Math.FQuaternion.swap

(

FQuaternion

q

)

Parameters

q

setC1()

None CDPL.Math.FQuaternion.setC1

(

float

v

)

Parameters

v

setC2()

None CDPL.Math.FQuaternion.setC2

(

float

v

)

Parameters

v

setC3()

None CDPL.Math.FQuaternion.setC3

(

float

v

)

Parameters

v

setC4()

None CDPL.Math.FQuaternion.setC4

(

float

v

)

Parameters

v

set()

None CDPL.Math.FQuaternion.set	(	float	c1 = 0.0,
		float	c2 = 0.0,
		float	c3 = 0.0,
		float	c4 = 0.0
	)

Parameters

c1
c2
c3
c4

__eq__() [1/2]

bool CDPL.Math.FQuaternion.__eq__

(

FQuaternion

q

)

Returns the result of the comparison operation self == q.

Parameters

q	The FQuaternion instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.FQuaternion.__eq__

(

ConstFQuaternionExpression

q

)

Returns the result of the comparison operation self == q.

Parameters

q	The ConstFQuaternionExpression instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [1/2]

bool CDPL.Math.FQuaternion.__ne__

(

FQuaternion

q

)

Returns the result of the comparison operation self != q.

Parameters

q	The FQuaternion instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.FQuaternion.__ne__

(

ConstFQuaternionExpression

q

)

Returns the result of the comparison operation self != q.

Parameters

q	The ConstFQuaternionExpression instance to be compared with.

Returns

The result of the comparison operation.

__str__()

str CDPL.Math.FQuaternion.__str__

(

)

Returns a string representation of the FQuaternion instance.

Returns

The generated string representation.

__pos__()

FQuaternion CDPL.Math.FQuaternion.__pos__

(

)

Returns

__neg__()

ConstFQuaternionExpression CDPL.Math.FQuaternion.__neg__

(

)

Returns

__add__() [1/2]

ConstFQuaternionExpression CDPL.Math.FQuaternion.__add__

(

float

t

)

Returns the result of the addition operation self + t.

Parameters

t	Specifies the second addend.

Returns

A ConstFQuaternionExpression instance holding the result of the addition.

__add__() [2/2]

ConstFQuaternionExpression CDPL.Math.FQuaternion.__add__

(

ConstFQuaternionExpression

e

)

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns

A ConstFQuaternionExpression instance holding the result of the addition.

__radd__()

ConstFQuaternionExpression CDPL.Math.FQuaternion.__radd__

(

float

t

)

Parameters

t

Returns

__sub__() [1/2]

ConstFQuaternionExpression CDPL.Math.FQuaternion.__sub__

(

float

t

)

Returns the result of the subtraction operation self - t.

Parameters

t	Specifies the subtrahend.

Returns

A FQuaternion instance holding the result of the subtraction.

__sub__() [2/2]

ConstFQuaternionExpression CDPL.Math.FQuaternion.__sub__

(

ConstFQuaternionExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A FQuaternion instance holding the result of the subtraction.

__rsub__()

ConstFQuaternionExpression CDPL.Math.FQuaternion.__rsub__

(

float

t

)

Parameters

t

Returns

__mul__() [1/2]

ConstFQuaternionExpression CDPL.Math.FQuaternion.__mul__

(

float

t

)

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns

A ConstFQuaternionExpression instance holding the result of the multiplication.

__mul__() [2/2]

ConstFQuaternionExpression CDPL.Math.FQuaternion.__mul__

(

ConstFQuaternionExpression

e

)

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns

A ConstFQuaternionExpression instance holding the result of the multiplication.

__rmul__()

ConstFQuaternionExpression CDPL.Math.FQuaternion.__rmul__

(

float

t

)

Parameters

t

Returns

__div__() [1/2]

ConstFQuaternionExpression CDPL.Math.FQuaternion.__div__

(

float

t

)

Returns the result of the division operation self / t.

Parameters

t	Specifies the divisor.

Returns

A ConstFQuaternionExpression instance holding the result of the division.

__div__() [2/2]

ConstFQuaternionExpression CDPL.Math.FQuaternion.__div__

(

ConstFQuaternionExpression

e

)

Returns the result of the division operation self / e.

Parameters

e	Specifies the divisor.

Returns

A ConstFQuaternionExpression instance holding the result of the division.

__truediv__()

ConstFQuaternionExpression CDPL.Math.FQuaternion.__truediv__

(

float

t

)

Parameters

t

Returns

__rdiv__()

ConstFQuaternionExpression CDPL.Math.FQuaternion.__rdiv__

(

float

t

)

Parameters

t

Returns

__iadd__() [1/3]

FQuaternion CDPL.Math.FQuaternion.__iadd__

(

float

t

)

Performs the in-place addition operation self += t.

Parameters

t	Specifies the second addend.

Returns

The updated FQuaternion instance self.

__iadd__() [2/3]

FQuaternion CDPL.Math.FQuaternion.__iadd__

(

FQuaternion

q

)

Performs the in-place addition operation self += q.

Parameters

q	Specifies the second addend.

Returns

The updated FQuaternion instance self.

__iadd__() [3/3]

FQuaternion CDPL.Math.FQuaternion.__iadd__

(

ConstFQuaternionExpression

q

)

Performs the in-place addition operation self += q.

Parameters

q	Specifies the second addend.

Returns

The updated FQuaternion instance self.

__isub__() [1/3]

FQuaternion CDPL.Math.FQuaternion.__isub__

(

float

t

)

Performs the in-place subtraction operation self -= t.

Parameters

t	Specifies the subtrahend.

Returns

The updated FQuaternion instance self.

__isub__() [2/3]

FQuaternion CDPL.Math.FQuaternion.__isub__

(

FQuaternion

q

)

Performs the in-place subtraction operation self -= q.

Parameters

q	Specifies the subtrahend.

Returns

The updated FQuaternion instance self.

__isub__() [3/3]

FQuaternion CDPL.Math.FQuaternion.__isub__

(

ConstFQuaternionExpression

q

)

Performs the in-place subtraction operation self -= q.

Parameters

q	Specifies the subtrahend.

Returns

The updated FQuaternion instance self.

__imul__() [1/3]

FQuaternion CDPL.Math.FQuaternion.__imul__

(

float

t

)

Performs the in-place multiplication operation self *= t.

Parameters

t	Specifies the multiplier.

Returns

The updated FQuaternion instance self.

__imul__() [2/3]

FQuaternion CDPL.Math.FQuaternion.__imul__

(

FQuaternion

q

)

Performs the in-place multiplication operation self *= q.

Parameters

q	Specifies the multiplier.

Returns

The updated FQuaternion instance self.

__imul__() [3/3]

FQuaternion CDPL.Math.FQuaternion.__imul__

(

ConstFQuaternionExpression

q

)

Performs the in-place multiplication operation self *= q.

Parameters

q	Specifies the multiplier.

Returns

The updated FQuaternion instance self.

__idiv__() [1/3]

FQuaternion CDPL.Math.FQuaternion.__idiv__

(

float

t

)

Performs the in-place division operation self /= t.

Parameters

t	Specifies the divisor.

Returns

The updated FQuaternion instance self.

__idiv__() [2/3]

FQuaternion CDPL.Math.FQuaternion.__idiv__

(

FQuaternion

q

)

Performs the in-place division operation self /= q.

Parameters

q	Specifies the divisor.

Returns

The updated FQuaternion instance self.

__idiv__() [3/3]

FQuaternion CDPL.Math.FQuaternion.__idiv__

(

ConstFQuaternionExpression

q

)

Performs the in-place division operation self /= q.

Parameters

q	Specifies the divisor.

Returns

The updated FQuaternion instance self.

__itruediv__() [1/3]

FQuaternion CDPL.Math.FQuaternion.__itruediv__

(

float

t

)

Parameters

t

Returns

__itruediv__() [2/3]

FQuaternion CDPL.Math.FQuaternion.__itruediv__

(

FQuaternion

q

)

Parameters

q

Returns

__itruediv__() [3/3]

FQuaternion CDPL.Math.FQuaternion.__itruediv__

(

ConstFQuaternionExpression

q

)

Parameters

q

Returns