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.ConstFVectorQuaternionAdapter:

Public Member Functions
None	__init__ (ConstFVectorQuaternionAdapter va)
	Contructs a copy of the `ConstFVectorQuaternionAdapter` instance va. More...

None	__init__ (ConstFVectorExpression v)
	Constructs the adapter wrapping the 4-element vector v. More...

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

float	getC1 ()
	Returns the real component C1. More...

float	getC2 ()
	Returns the imaginary component C2. More...

float	getC3 ()
	Returns the imaginary component C3. More...

float	getC4 ()
	Returns the imaginary component C4. More...

object	toArray ()
	Converts the `ConstFVectorQuaternionAdapter` instance into a corresponding `numpy.ndarray` object. More...

ConstFVectorExpression	getData ()
	Returns the wrapped vector. More...

bool	__eq__ (ConstFVectorQuaternionAdapter va)
	Returns the result of the comparison operation `self == va`. More...

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

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

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

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

ConstFVectorQuaternionAdapter	__pos__ ()
	Returns self. More...

ConstFQuaternionExpression	__neg__ ()
	Returns the result of the operation `self * -1`. More...

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)
	Returns the result of the addition operation `t + self`. More...

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)
	Returns the result of the subtraction operation `t - self`. More...

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)
	Returns the result of the division operation `t // self`. More...

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.ConstFVectorQuaternionAdapter.__init__ ( ConstFVectorQuaternionAdapter va )

Contructs a copy of the ConstFVectorQuaternionAdapter instance va.

Parameters

va	The `ConstFVectorQuaternionAdapter` instance to copy.

◆ init() [2/2]

None CDPL.Math.ConstFVectorQuaternionAdapter.__init__ ( ConstFVectorExpression v )

Constructs the adapter wrapping the 4-element vector v.

Parameters

v	The 4-element vector to be viewed as a quaternion.

Member Function Documentation

◆ getObjectID()

int CDPL.Math.ConstFVectorQuaternionAdapter.getObjectID ( )

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

Different Python ConstFVectorQuaternionAdapter 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 ConstFVectorQuaternionAdapter 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.

◆ getC1()

float CDPL.Math.ConstFVectorQuaternionAdapter.getC1 ( )

Returns the real component C1.

Returns: The value of C1.

◆ getC2()

float CDPL.Math.ConstFVectorQuaternionAdapter.getC2 ( )

Returns the imaginary component C2.

Returns: The value of C2.

◆ getC3()

float CDPL.Math.ConstFVectorQuaternionAdapter.getC3 ( )

Returns the imaginary component C3.

Returns: The value of C3.

◆ getC4()

float CDPL.Math.ConstFVectorQuaternionAdapter.getC4 ( )

Returns the imaginary component C4.

Returns: The value of C4.

◆ toArray()

object CDPL.Math.ConstFVectorQuaternionAdapter.toArray ( )

Converts the ConstFVectorQuaternionAdapter instance into a corresponding numpy.ndarray object.

Returns: The generated numpy.ndarray object.

See also: [NUMPY]

◆ getData()

ConstFVectorExpression CDPL.Math.ConstFVectorQuaternionAdapter.getData ( )

Returns the wrapped vector.

Returns: The wrapped vector closure.

◆ eq() [1/2]

bool CDPL.Math.ConstFVectorQuaternionAdapter.__eq__ ( ConstFVectorQuaternionAdapter va )

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

Parameters

va	The `ConstFVectorQuaternionAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

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

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

Parameters

va	The `ConstFVectorQuaternionAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

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

Returns a string representation of the ConstFVectorQuaternionAdapter instance.

Returns: The generated string representation.

◆ pos()

ConstFVectorQuaternionAdapter CDPL.Math.ConstFVectorQuaternionAdapter.__pos__ ( )

Returns self.

Returns: self.

◆ neg()

ConstFQuaternionExpression CDPL.Math.ConstFVectorQuaternionAdapter.__neg__ ( )

Returns the result of the operation self * -1.

Returns: A ConstFQuaternionExpression instance holding the result of the element negation.

◆ add() [1/2]

ConstFQuaternionExpression CDPL.Math.ConstFVectorQuaternionAdapter.__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.ConstFVectorQuaternionAdapter.__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.ConstFVectorQuaternionAdapter.__radd__ ( float t )

Returns the result of the addition operation t + self.

Parameters

t	Specifies the first addend.

Returns: A ConstFQuaternionExpression instance holding the result of the addition.

◆ sub() [1/2]

ConstFQuaternionExpression CDPL.Math.ConstFVectorQuaternionAdapter.__sub__ ( float t )

Returns the result of the subtraction operation self - t.

Parameters

t	Specifies the subtrahend.

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

◆ sub() [2/2]

ConstFQuaternionExpression CDPL.Math.ConstFVectorQuaternionAdapter.__sub__ ( ConstFQuaternionExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ rsub()

ConstFQuaternionExpression CDPL.Math.ConstFVectorQuaternionAdapter.__rsub__ ( float t )

Returns the result of the subtraction operation t - self.

Parameters

t	Specifies the minuend.

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

◆ mul() [1/2]

ConstFQuaternionExpression CDPL.Math.ConstFVectorQuaternionAdapter.__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.ConstFVectorQuaternionAdapter.__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.ConstFVectorQuaternionAdapter.__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.ConstFVectorQuaternionAdapter.__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.ConstFVectorQuaternionAdapter.__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.ConstFVectorQuaternionAdapter.__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.

◆ rdiv()

ConstFQuaternionExpression CDPL.Math.ConstFVectorQuaternionAdapter.__rdiv__ ( float t )

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

Parameters

t	Specifies the dividend.

Returns: A ConstFQuaternionExpression instance holding the result of the division.

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ __init__() [1/2]

◆ __init__() [2/2]

Member Function Documentation

◆ getObjectID()

◆ getC1()

◆ getC2()

◆ getC3()

◆ getC4()

◆ toArray()

◆ getData()

◆ __eq__() [1/2]

◆ __eq__() [2/2]

◆ __ne__() [1/2]

◆ __ne__() [2/2]

◆ __str__()

◆ __pos__()

◆ __neg__()

◆ __add__() [1/2]

◆ __add__() [2/2]

◆ __radd__()

◆ __sub__() [1/2]

◆ __sub__() [2/2]

◆ __rsub__()

◆ __mul__() [1/2]

◆ __mul__() [2/2]

◆ __rmul__()

◆ __div__() [1/2]

◆ __div__() [2/2]

◆ __truediv__()

◆ __rdiv__()

◆ init() [1/2]

◆ init() [2/2]

◆ eq() [1/2]

◆ eq() [2/2]

◆ ne() [1/2]

◆ ne() [2/2]

◆ str()

◆ pos()

◆ neg()

◆ add() [1/2]

◆ add() [2/2]

◆ radd()

◆ sub() [1/2]

◆ sub() [2/2]

◆ rsub()

◆ mul() [1/2]

◆ mul() [2/2]

◆ rmul()

◆ div() [1/2]

◆ div() [2/2]

◆ truediv()

◆ rdiv()