Quaternion expression that exposes a 4-element vector as a quaternion (component indices 0-3 map to C1-C4). More...

Inheritance diagram for CDPL.Math.DVectorQuaternionAdapter:

Public Member Functions
None	__init__ (DVectorQuaternionAdapter a)
	Initializes a copy of the `DVectorQuaternionAdapter` instance a. More...

None	__init__ (DVectorExpression e)
	Initializes the `DVectorQuaternionAdapter` instance. More...

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

DVectorQuaternionAdapter	assign (ConstFQuaternionExpression e)
	Assigns the quaternion expression e to this view without intermediate temporary (use only when e does not alias the wrapped vector). More...

DVectorQuaternionAdapter	assign (ConstDQuaternionExpression e)
	Assigns the quaternion expression e to this view without intermediate temporary (use only when e does not alias the wrapped vector). More...

DVectorQuaternionAdapter	assign (ConstLQuaternionExpression e)
	Assigns the quaternion expression e to this view without intermediate temporary (use only when e does not alias the wrapped vector). More...

DVectorQuaternionAdapter	assign (ConstULQuaternionExpression e)
	Assigns the quaternion expression e to this view without intermediate temporary (use only when e does not alias the wrapped vector). More...

DVectorQuaternionAdapter	assign (DVectorQuaternionAdapter a)
	Copies the components of a into this view (writing through to the wrapped vector). More...

float	getC1 ()
	Returns a reference to component C1. More...

float	getC2 ()
	Returns a reference to component C2. More...

float	getC3 ()
	Returns a reference to component C3. More...

float	getC4 ()
	Returns a reference to component C4. More...

object	toArray ()

None	swap (DVectorQuaternionAdapter a)
	Swaps the components of this view with those of a. 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)
	Assigns the four supplied component values to this view (writing through to the wrapped vector). More...

DVectorExpression	getData ()
	Returns a reference to the wrapped vector (via its stored closure). More...

bool	__eq__ (DVectorQuaternionAdapter a)
	Returns the result of the comparison operation `self == a`. More...

bool	__eq__ (ConstDQuaternionExpression q)
	Returns the result of the comparison operation `self == q`. More...

bool	__ne__ (DVectorQuaternionAdapter a)
	Returns the result of the comparison operation `self != a`. More...

bool	__ne__ (ConstDQuaternionExpression q)
	Returns the result of the comparison operation `self != q`. More...

str	__str__ ()
	Returns a string representation of the `DVectorQuaternionAdapter` instance. More...

DVectorQuaternionAdapter	__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)

DVectorQuaternionAdapter	__iadd__ (float t)
	Adds the scalar t to component C1 of this view. More...

DVectorQuaternionAdapter	__iadd__ (DVectorQuaternionAdapter a)
	Performs the in-place addition operation `self += a`. More...

DVectorQuaternionAdapter	__iadd__ (ConstDQuaternionExpression q)
	Performs the in-place addition operation `self += q`. More...

DVectorQuaternionAdapter	__isub__ (float t)
	Subtracts the scalar t from component C1 of this view. More...

DVectorQuaternionAdapter	__isub__ (DVectorQuaternionAdapter a)
	Performs the in-place subtraction operation `self -= a`. More...

DVectorQuaternionAdapter	__isub__ (ConstDQuaternionExpression q)
	Performs the in-place subtraction operation `self -= q`. More...

DVectorQuaternionAdapter	__imul__ (float t)
	Multiplies every component of this view by the scalar t. More...

DVectorQuaternionAdapter	__imul__ (DVectorQuaternionAdapter a)
	Performs the in-place multiplication operation `self *= a`. More...

DVectorQuaternionAdapter	__imul__ (ConstDQuaternionExpression q)
	Performs the in-place multiplication operation `self *= q`. More...

DVectorQuaternionAdapter	__idiv__ (float t)
	Divides every component of this view by the scalar t. More...

DVectorQuaternionAdapter	__idiv__ (DVectorQuaternionAdapter a)
	Performs the in-place division operation `self /= a`. More...

DVectorQuaternionAdapter	__idiv__ (ConstDQuaternionExpression q)
	Performs the in-place division operation `self /= q`. More...

DVectorQuaternionAdapter	__itruediv__ (float t)

DVectorQuaternionAdapter	__itruediv__ (DVectorQuaternionAdapter a)

DVectorQuaternionAdapter	__itruediv__ (ConstDQuaternionExpression q)

Properties
	objectID = property(getObjectID)

	data = property(getData)

Detailed Description

Quaternion expression that exposes a 4-element vector as a quaternion (component indices 0-3 map to C1-C4).

Constructor & Destructor Documentation

◆ init() [1/2]

None CDPL.Math.DVectorQuaternionAdapter.__init__ ( DVectorQuaternionAdapter a )

Initializes a copy of the DVectorQuaternionAdapter instance a.

Parameters

a	The `DVectorQuaternionAdapter` instance to copy.

◆ init() [2/2]

None CDPL.Math.DVectorQuaternionAdapter.__init__ ( DVectorExpression e )

Initializes the DVectorQuaternionAdapter instance.

Parameters

e

Member Function Documentation

◆ getObjectID()

int CDPL.Math.DVectorQuaternionAdapter.getObjectID ( )

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

Different Python DVectorQuaternionAdapter 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 DVectorQuaternionAdapter 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/5]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.assign ( ConstFQuaternionExpression e )

Assigns the quaternion expression e to this view without intermediate temporary (use only when e does not alias the wrapped vector).

Parameters

e	The source quaternion expression.

Returns: self

◆ assign() [2/5]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.assign ( ConstDQuaternionExpression e )

Assigns the quaternion expression e to this view without intermediate temporary (use only when e does not alias the wrapped vector).

Parameters

e	The source quaternion expression.

Returns: self

◆ assign() [3/5]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.assign ( ConstLQuaternionExpression e )

Assigns the quaternion expression e to this view without intermediate temporary (use only when e does not alias the wrapped vector).

Parameters

e	The source quaternion expression.

Returns: self

◆ assign() [4/5]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.assign ( ConstULQuaternionExpression e )

Assigns the quaternion expression e to this view without intermediate temporary (use only when e does not alias the wrapped vector).

Parameters

e	The source quaternion expression.

Returns: self

◆ assign() [5/5]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.assign ( DVectorQuaternionAdapter a )

Copies the components of a into this view (writing through to the wrapped vector).

Parameters

a	The source adapter.

Returns: self

◆ getC1()

float CDPL.Math.DVectorQuaternionAdapter.getC1 ( )

Returns a reference to component C1.

Returns: A reference to C1.

◆ getC2()

float CDPL.Math.DVectorQuaternionAdapter.getC2 ( )

Returns a reference to component C2.

Returns: A reference to C2.

◆ getC3()

float CDPL.Math.DVectorQuaternionAdapter.getC3 ( )

Returns a reference to component C3.

Returns: A reference to C3.

◆ getC4()

float CDPL.Math.DVectorQuaternionAdapter.getC4 ( )

Returns a reference to component C4.

Returns: A reference to C4.

◆ swap()

None CDPL.Math.DVectorQuaternionAdapter.swap ( DVectorQuaternionAdapter a )

Swaps the components of this view with those of a.

Parameters

a	The adapter to swap with.

◆ set()

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

Assigns the four supplied component values to this view (writing through to the wrapped vector).

Parameters

c1	The C1 component value.
c2	The C2 component value.
c3	The C3 component value.
c4	The C4 component value.

◆ getData()

DVectorExpression CDPL.Math.DVectorQuaternionAdapter.getData ( )

Returns a reference to the wrapped vector (via its stored closure).

Returns: A reference to the wrapped vector closure.

◆ eq() [1/2]

bool CDPL.Math.DVectorQuaternionAdapter.__eq__ ( DVectorQuaternionAdapter a )

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

Parameters

a	The `DVectorQuaternionAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.DVectorQuaternionAdapter.__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.DVectorQuaternionAdapter.__ne__ ( DVectorQuaternionAdapter a )

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

Parameters

a	The `DVectorQuaternionAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.DVectorQuaternionAdapter.__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.DVectorQuaternionAdapter.__str__ ( )

Returns a string representation of the DVectorQuaternionAdapter instance.

Returns: The generated string representation.

◆ add() [1/2]

ConstDQuaternionExpression CDPL.Math.DVectorQuaternionAdapter.__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.DVectorQuaternionAdapter.__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.DVectorQuaternionAdapter.__sub__ ( float t )

Returns the result of the subtraction operation self - t.

Parameters

t	Specifies the subtrahend.

Returns: A DVectorQuaternionAdapter instance holding the result of the subtraction.

◆ sub() [2/2]

ConstDQuaternionExpression CDPL.Math.DVectorQuaternionAdapter.__sub__ ( ConstDQuaternionExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns: A DVectorQuaternionAdapter instance holding the result of the subtraction.

◆ mul() [1/2]

ConstDQuaternionExpression CDPL.Math.DVectorQuaternionAdapter.__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.DVectorQuaternionAdapter.__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.DVectorQuaternionAdapter.__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.DVectorQuaternionAdapter.__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.DVectorQuaternionAdapter.__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.DVectorQuaternionAdapter.__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]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__iadd__ ( float t )

Adds the scalar t to component C1 of this view.

Parameters

t	The scalar summand.

Returns: self

◆ iadd() [2/3]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__iadd__ ( DVectorQuaternionAdapter a )

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

Parameters

a	Specifies the second addend.

Returns: The updated DVectorQuaternionAdapter instance self.

◆ iadd() [3/3]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__iadd__ ( ConstDQuaternionExpression q )

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

Parameters

q	Specifies the second addend.

Returns: The updated DVectorQuaternionAdapter instance self.

◆ isub() [1/3]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__isub__ ( float t )

Subtracts the scalar t from component C1 of this view.

Parameters

t	The scalar subtrahend.

Returns: self

◆ isub() [2/3]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__isub__ ( DVectorQuaternionAdapter a )

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

Parameters

a	Specifies the subtrahend.

Returns: The updated DVectorQuaternionAdapter instance self.

◆ isub() [3/3]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__isub__ ( ConstDQuaternionExpression q )

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

Parameters

q	Specifies the subtrahend.

Returns: The updated DVectorQuaternionAdapter instance self.

◆ imul() [1/3]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__imul__ ( float t )

Multiplies every component of this view by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self

◆ imul() [2/3]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__imul__ ( DVectorQuaternionAdapter a )

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

Parameters

a	Specifies the multiplier.

Returns: The updated DVectorQuaternionAdapter instance self.

◆ imul() [3/3]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__imul__ ( ConstDQuaternionExpression q )

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

Parameters

q	Specifies the multiplier.

Returns: The updated DVectorQuaternionAdapter instance self.

◆ idiv() [1/3]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__idiv__ ( float t )

Divides every component of this view by the scalar t.

Parameters

t	The scalar divisor.

Returns: self

◆ idiv() [2/3]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__idiv__ ( DVectorQuaternionAdapter a )

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

Parameters

a	Specifies the divisor.

Returns: The updated DVectorQuaternionAdapter instance self.

◆ idiv() [3/3]

DVectorQuaternionAdapter CDPL.Math.DVectorQuaternionAdapter.__idiv__ ( ConstDQuaternionExpression q )

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

Parameters

q	Specifies the divisor.

Returns: The updated DVectorQuaternionAdapter instance self.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ getObjectID()

◆ assign() [1/5]

◆ assign() [2/5]

◆ assign() [3/5]

◆ assign() [4/5]

◆ assign() [5/5]

◆ getC1()

◆ getC2()

◆ getC3()

◆ getC4()

◆ swap()

◆ set()

◆ getData()

◆ __eq__() [1/2]

◆ __eq__() [2/2]

◆ __ne__() [1/2]

◆ __ne__() [2/2]

◆ __str__()

◆ __add__() [1/2]

◆ __add__() [2/2]

◆ __sub__() [1/2]

◆ __sub__() [2/2]

◆ __mul__() [1/2]

◆ __mul__() [2/2]

◆ __rmul__()

◆ __div__() [1/2]

◆ __div__() [2/2]

◆ __truediv__()

◆ __iadd__() [1/3]

◆ __iadd__() [2/3]

◆ __iadd__() [3/3]

◆ __isub__() [1/3]

◆ __isub__() [2/3]

◆ __isub__() [3/3]

◆ __imul__() [1/3]

◆ __imul__() [2/3]

◆ __imul__() [3/3]

◆ __idiv__() [1/3]

◆ __idiv__() [2/3]

◆ __idiv__() [3/3]

◆ init() [1/2]

◆ init() [2/2]

◆ eq() [1/2]

◆ eq() [2/2]

◆ ne() [1/2]

◆ ne() [2/2]

◆ str()

◆ add() [1/2]

◆ add() [2/2]

◆ sub() [1/2]

◆ sub() [2/2]

◆ mul() [1/2]

◆ mul() [2/2]

◆ rmul()

◆ div() [1/2]

◆ div() [2/2]

◆ truediv()

◆ iadd() [1/3]

◆ iadd() [2/3]

◆ iadd() [3/3]

◆ isub() [1/3]

◆ isub() [2/3]

◆ isub() [3/3]

◆ imul() [1/3]

◆ imul() [2/3]

◆ imul() [3/3]

◆ idiv() [1/3]

◆ idiv() [2/3]

◆ idiv() [3/3]