CDPL.Math.FQuaternion Class Reference

General 4-component quaternion with component values of type float. More...

Inheritance diagram for CDPL.Math.FQuaternion:

Public Member Functions
None	__init__ ()
	Constructs an uninitialized quaternion.
None	__init__ (FQuaternion q)
	Constructs a copy of the quaternion q. More...
None	__init__ (float c1, float c2=0.0, float c3=0.0, float c4=0.0)
	Constructs the quaternion with the supplied component values (omitted components default to the value-initialized ValueType). 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)
	Assigns the quaternion expression e to this quaternion without intermediate temporary. More...
FQuaternion	assign (ConstDQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion without intermediate temporary. More...
FQuaternion	assign (ConstLQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion without intermediate temporary. More...
FQuaternion	assign (ConstULQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion without intermediate temporary. More...
FQuaternion	assign (FQuaternion q)
	Copy-assigns the components of q to this quaternion. 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 ()
	Returns a reference to the real component C1. More...
float	getC2 ()
	Returns a reference to the imaginary component C2. More...
float	getC3 ()
	Returns a reference to the imaginary component C3. More...
float	getC4 ()
	Returns a reference to the imaginary component C4. More...
object	toArray ()
None	swap (FQuaternion q)
	Swaps the four components of this quaternion with those of q. More...
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)
	Sets the four quaternion components to the supplied values (omitted arguments default to the value-initialized ValueType). More...
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)
	Returns the result of the multiplication operation t * self. More...
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)
	Returns the result of the true division operation self / t. More...
ConstFQuaternionExpression	__rdiv__ (float t)
FQuaternion	__iadd__ (float t)
	Adds the scalar t to the real component. 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)
	Subtracts the scalar t from the real component. 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)
	Multiplies every component by the scalar 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)
	Divides every component by the scalar 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)

Detailed Description

General 4-component quaternion with component values of type float.

Constructor & Destructor Documentation

__init__() [1/7]

None CDPL.Math.FQuaternion.__init__

(

FQuaternion

q

)

Constructs a copy of the quaternion q.

Parameters

q	The quaternion to copy.

__init__() [2/7]

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

Constructs the quaternion with the supplied component values (omitted components default to the value-initialized ValueType).

Parameters

c1	The real component.
c2	The first imaginary component.
c3	The second imaginary component.
c4	The third imaginary component.

__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

)

Assigns the quaternion expression e to this quaternion without intermediate temporary.

Parameters

e	The source quaternion expression.

Returns

self

assign() [2/6]

FQuaternion CDPL.Math.FQuaternion.assign

(

ConstDQuaternionExpression

e

)

Assigns the quaternion expression e to this quaternion without intermediate temporary.

Parameters

e	The source quaternion expression.

Returns

self

assign() [3/6]

FQuaternion CDPL.Math.FQuaternion.assign

(

ConstLQuaternionExpression

e

)

Assigns the quaternion expression e to this quaternion without intermediate temporary.

Parameters

e	The source quaternion expression.

Returns

self

assign() [4/6]

FQuaternion CDPL.Math.FQuaternion.assign

(

ConstULQuaternionExpression

e

)

Assigns the quaternion expression e to this quaternion without intermediate temporary.

Parameters

e	The source quaternion expression.

Returns

self

assign() [5/6]

FQuaternion CDPL.Math.FQuaternion.assign

(

FQuaternion

q

)

Copy-assigns the components of q to this quaternion.

Parameters

q	The source quaternion.

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 a reference to the real component C1.

Returns

A reference to C1.

getC2()

float CDPL.Math.FQuaternion.getC2

(

)

Returns a reference to the imaginary component C2.

Returns

A reference to C2.

getC3()

float CDPL.Math.FQuaternion.getC3

(

)

Returns a reference to the imaginary component C3.

Returns

A reference to C3.

getC4()

float CDPL.Math.FQuaternion.getC4

(

)

Returns a reference to the imaginary component C4.

Returns

A reference to C4.

swap()

None CDPL.Math.FQuaternion.swap

(

FQuaternion

q

)

Swaps the four components of this quaternion with those of q.

Parameters

q	The quaternion to swap with.

set()

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

Sets the four quaternion components to the supplied values (omitted arguments default to the value-initialized ValueType).

Parameters

c1	The new real component.
c2	The new first imaginary component.
c3	The new second imaginary component.
c4	The new third imaginary component.

__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.

__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.

__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.

__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

)

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns

A ConstFQuaternionExpression instance holding the result of the multiplication.

__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

)

Returns the result of the true division operation self / t.

Parameters

t	Specifies the divisor.

Returns

A ConstFQuaternionExpression instance holding the result of the division.

__iadd__() [1/3]

FQuaternion CDPL.Math.FQuaternion.__iadd__

(

float

t

)

Adds the scalar t to the real component.

Parameters

t	The scalar addend.

Returns

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

)

Subtracts the scalar t from the real component.

Parameters

t	The scalar subtrahend.

Returns

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

)

Multiplies every component by the scalar t.

Parameters

t	The scalar multiplier.

Returns

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

)

Divides every component by the scalar t.

Parameters

t	The scalar divisor.

Returns

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.