CDPL.Math.DQuaternion Class Reference

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

Inheritance diagram for CDPL.Math.DQuaternion:

Public Member Functions
None	__init__ ()
	Constructs an uninitialized quaternion.
None	__init__ (DQuaternion 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 DQuaternion instance. More...
None	__init__ (ConstDQuaternionExpression e)
	Initializes the DQuaternion instance. More...
None	__init__ (ConstLQuaternionExpression e)
	Initializes the DQuaternion instance. More...
None	__init__ (ConstULQuaternionExpression e)
	Initializes the DQuaternion instance. More...
None	__init__ (object a)
	Initializes the DQuaternion instance. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
DQuaternion	assign (ConstFQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion without intermediate temporary. More...
DQuaternion	assign (ConstDQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion without intermediate temporary. More...
DQuaternion	assign (ConstLQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion without intermediate temporary. More...
DQuaternion	assign (ConstULQuaternionExpression e)
	Assigns the quaternion expression e to this quaternion without intermediate temporary. More...
DQuaternion	assign (DQuaternion 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 (DQuaternion 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__ (DQuaternion q)
	Returns the result of the comparison operation self == q. More...
bool	__eq__ (ConstDQuaternionExpression q)
	Returns the result of the comparison operation self == q. More...
bool	__ne__ (DQuaternion q)
	Returns the result of the comparison operation self != q. More...
bool	__ne__ (ConstDQuaternionExpression q)
	Returns the result of the comparison operation self != q. More...
str	__str__ ()
	Returns a string representation of the DQuaternion instance. More...
DQuaternion	__pos__ ()
ConstDQuaternionExpression	__neg__ ()
ConstDQuaternionExpression	__add__ (float t)
	Returns the result of the addition operation self + t. More...
ConstDQuaternionExpression	__add__ (ConstDQuaternionExpression e)
	Returns the result of the addition operation self + e. More...
ConstDQuaternionExpression	__radd__ (float t)
ConstDQuaternionExpression	__sub__ (float t)
	Returns the result of the subtraction operation self - t. More...
ConstDQuaternionExpression	__sub__ (ConstDQuaternionExpression e)
	Returns the result of the subtraction operation self - e. More...
ConstDQuaternionExpression	__rsub__ (float t)
ConstDQuaternionExpression	__mul__ (float t)
	Returns the result of the multiplication operation self * t. More...
ConstDQuaternionExpression	__mul__ (ConstDQuaternionExpression e)
	Returns the result of the multiplication operation self * e. More...
ConstDQuaternionExpression	__rmul__ (float t)
	Returns the result of the multiplication operation t * self. More...
ConstDQuaternionExpression	__div__ (float t)
	Returns the result of the division operation self // t. More...
ConstDQuaternionExpression	__div__ (ConstDQuaternionExpression e)
	Returns the result of the division operation self // e. More...
ConstDQuaternionExpression	__truediv__ (float t)
	Returns the result of the true division operation self / t. More...
ConstDQuaternionExpression	__rdiv__ (float t)
DQuaternion	__iadd__ (float t)
	Adds the scalar t to the real component. More...
DQuaternion	__iadd__ (DQuaternion q)
	Performs the in-place addition operation self += q. More...
DQuaternion	__iadd__ (ConstDQuaternionExpression q)
	Performs the in-place addition operation self += q. More...
DQuaternion	__isub__ (float t)
	Subtracts the scalar t from the real component. More...
DQuaternion	__isub__ (DQuaternion q)
	Performs the in-place subtraction operation self -= q. More...
DQuaternion	__isub__ (ConstDQuaternionExpression q)
	Performs the in-place subtraction operation self -= q. More...
DQuaternion	__imul__ (float t)
	Multiplies every component by the scalar t. More...
DQuaternion	__imul__ (DQuaternion q)
	Performs the in-place multiplication operation self *= q. More...
DQuaternion	__imul__ (ConstDQuaternionExpression q)
	Performs the in-place multiplication operation self *= q. More...
DQuaternion	__idiv__ (float t)
	Divides every component by the scalar t. More...
DQuaternion	__idiv__ (DQuaternion q)
	Performs the in-place division operation self /= q. More...
DQuaternion	__idiv__ (ConstDQuaternionExpression q)
	Performs the in-place division operation self /= q. More...
DQuaternion	__itruediv__ (float t)
DQuaternion	__itruediv__ (DQuaternion q)
DQuaternion	__itruediv__ (ConstDQuaternionExpression q)

Properties
	objectID = property(getObjectID)

Detailed Description

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

Constructor & Destructor Documentation

__init__() [1/7]

None CDPL.Math.DQuaternion.__init__

(

DQuaternion

q

)

Constructs a copy of the quaternion q.

Parameters

q	The quaternion to copy.

__init__() [2/7]

None CDPL.Math.DQuaternion.__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.DQuaternion.__init__

(

ConstFQuaternionExpression

e

)

Initializes the DQuaternion instance.

Parameters

e

__init__() [4/7]

None CDPL.Math.DQuaternion.__init__

(

ConstDQuaternionExpression

e

)

Initializes the DQuaternion instance.

Parameters

e

__init__() [5/7]

None CDPL.Math.DQuaternion.__init__

(

ConstLQuaternionExpression

e

)

Initializes the DQuaternion instance.

Parameters

e

__init__() [6/7]

None CDPL.Math.DQuaternion.__init__

(

ConstULQuaternionExpression

e

)

Initializes the DQuaternion instance.

Parameters

e

__init__() [7/7]

None CDPL.Math.DQuaternion.__init__

(

object

a

)

Initializes the DQuaternion instance.

Parameters

a

Member Function Documentation

getObjectID()

int CDPL.Math.DQuaternion.getObjectID

(

)

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

Different Python DQuaternion 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 DQuaternion 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]

DQuaternion CDPL.Math.DQuaternion.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]

DQuaternion CDPL.Math.DQuaternion.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]

DQuaternion CDPL.Math.DQuaternion.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]

DQuaternion CDPL.Math.DQuaternion.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]

DQuaternion CDPL.Math.DQuaternion.assign

(

DQuaternion

q

)

Copy-assigns the components of q to this quaternion.

Parameters

q	The source quaternion.

Returns

self

assign() [6/6]

None CDPL.Math.DQuaternion.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.DQuaternion.getC1

(

)

Returns a reference to the real component C1.

Returns

A reference to C1.

getC2()

float CDPL.Math.DQuaternion.getC2

(

)

Returns a reference to the imaginary component C2.

Returns

A reference to C2.

getC3()

float CDPL.Math.DQuaternion.getC3

(

)

Returns a reference to the imaginary component C3.

Returns

A reference to C3.

getC4()

float CDPL.Math.DQuaternion.getC4

(

)

Returns a reference to the imaginary component C4.

Returns

A reference to C4.

swap()

None CDPL.Math.DQuaternion.swap

(

DQuaternion

q

)

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

Parameters

q	The quaternion to swap with.

set()

None CDPL.Math.DQuaternion.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.DQuaternion.__eq__

(

DQuaternion

q

)

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

Parameters

q	The DQuaternion instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.DQuaternion.__eq__

(

ConstDQuaternionExpression

q

)

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

Parameters

q	The ConstDQuaternionExpression instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [1/2]

bool CDPL.Math.DQuaternion.__ne__

(

DQuaternion

q

)

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

Parameters

q	The DQuaternion instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.DQuaternion.__ne__

(

ConstDQuaternionExpression

q

)

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

Parameters

q	The ConstDQuaternionExpression instance to be compared with.

Returns

The result of the comparison operation.

__str__()

str CDPL.Math.DQuaternion.__str__

(

)

Returns a string representation of the DQuaternion instance.

Returns

The generated string representation.

__add__() [1/2]

ConstDQuaternionExpression CDPL.Math.DQuaternion.__add__

(

float

t

)

Returns the result of the addition operation self + t.

Parameters

t	Specifies the second addend.

Returns

A ConstDQuaternionExpression instance holding the result of the addition.

__add__() [2/2]

ConstDQuaternionExpression CDPL.Math.DQuaternion.__add__

(

ConstDQuaternionExpression

e

)

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

Returns

A ConstDQuaternionExpression instance holding the result of the addition.

__sub__() [1/2]

ConstDQuaternionExpression CDPL.Math.DQuaternion.__sub__

(

float

t

)

Returns the result of the subtraction operation self - t.

Parameters

t	Specifies the subtrahend.

Returns

A DQuaternion instance holding the result of the subtraction.

__sub__() [2/2]

ConstDQuaternionExpression CDPL.Math.DQuaternion.__sub__

(

ConstDQuaternionExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A DQuaternion instance holding the result of the subtraction.

__mul__() [1/2]

ConstDQuaternionExpression CDPL.Math.DQuaternion.__mul__

(

float

t

)

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns

A ConstDQuaternionExpression instance holding the result of the multiplication.

__mul__() [2/2]

ConstDQuaternionExpression CDPL.Math.DQuaternion.__mul__

(

ConstDQuaternionExpression

e

)

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns

A ConstDQuaternionExpression instance holding the result of the multiplication.

__rmul__()

ConstDQuaternionExpression CDPL.Math.DQuaternion.__rmul__

(

float

t

)

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns

A ConstDQuaternionExpression instance holding the result of the multiplication.

__div__() [1/2]

ConstDQuaternionExpression CDPL.Math.DQuaternion.__div__

(

float

t

)

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

Parameters

t	Specifies the divisor.

Returns

A ConstDQuaternionExpression instance holding the result of the division.

__div__() [2/2]

ConstDQuaternionExpression CDPL.Math.DQuaternion.__div__

(

ConstDQuaternionExpression

e

)

Returns the result of the division operation self // e.

Parameters

e	Specifies the divisor.

Returns

A ConstDQuaternionExpression instance holding the result of the division.

__truediv__()

ConstDQuaternionExpression CDPL.Math.DQuaternion.__truediv__

(

float

t

)

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

Parameters

t	Specifies the divisor.

Returns

A ConstDQuaternionExpression instance holding the result of the division.

__iadd__() [1/3]

DQuaternion CDPL.Math.DQuaternion.__iadd__

(

float

t

)

Adds the scalar t to the real component.

Parameters

t	The scalar addend.

Returns

self

__iadd__() [2/3]

DQuaternion CDPL.Math.DQuaternion.__iadd__

(

DQuaternion

q

)

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

Parameters

q	Specifies the second addend.

Returns

The updated DQuaternion instance self.

__iadd__() [3/3]

DQuaternion CDPL.Math.DQuaternion.__iadd__

(

ConstDQuaternionExpression

q

)

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

Parameters

q	Specifies the second addend.

Returns

The updated DQuaternion instance self.

__isub__() [1/3]

DQuaternion CDPL.Math.DQuaternion.__isub__

(

float

t

)

Subtracts the scalar t from the real component.

Parameters

t	The scalar subtrahend.

Returns

self

__isub__() [2/3]

DQuaternion CDPL.Math.DQuaternion.__isub__

(

DQuaternion

q

)

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

Parameters

q	Specifies the subtrahend.

Returns

The updated DQuaternion instance self.

__isub__() [3/3]

DQuaternion CDPL.Math.DQuaternion.__isub__

(

ConstDQuaternionExpression

q

)

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

Parameters

q	Specifies the subtrahend.

Returns

The updated DQuaternion instance self.

__imul__() [1/3]

DQuaternion CDPL.Math.DQuaternion.__imul__

(

float

t

)

Multiplies every component by the scalar t.

Parameters

t	The scalar multiplier.

Returns

self

__imul__() [2/3]

DQuaternion CDPL.Math.DQuaternion.__imul__

(

DQuaternion

q

)

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

Parameters

q	Specifies the multiplier.

Returns

The updated DQuaternion instance self.

__imul__() [3/3]

DQuaternion CDPL.Math.DQuaternion.__imul__

(

ConstDQuaternionExpression

q

)

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

Parameters

q	Specifies the multiplier.

Returns

The updated DQuaternion instance self.

__idiv__() [1/3]

DQuaternion CDPL.Math.DQuaternion.__idiv__

(

float

t

)

Divides every component by the scalar t.

Parameters

t	The scalar divisor.

Returns

self

__idiv__() [2/3]

DQuaternion CDPL.Math.DQuaternion.__idiv__

(

DQuaternion

q

)

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

Parameters

q	Specifies the divisor.

Returns

The updated DQuaternion instance self.

__idiv__() [3/3]

DQuaternion CDPL.Math.DQuaternion.__idiv__

(

ConstDQuaternionExpression

q

)

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

Parameters

q	Specifies the divisor.

Returns

The updated DQuaternion instance self.