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

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

None	__init__ (ULVectorExpression e)
	Initializes the `ULVectorQuaternionAdapter` instance. More...

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

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

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

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

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

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

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

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

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

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

object	toArray ()

None	swap (ULVectorQuaternionAdapter a)
	Swaps the components of this view with those of a. More...

None	setC1 (int v)

None	setC2 (int v)

None	setC3 (int v)

None	setC4 (int v)

None	set (int c1=0, int c2=0, int c3=0, int c4=0)
	Assigns the four supplied component values to this view (writing through to the wrapped vector). More...

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

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

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

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

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

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

ULVectorQuaternionAdapter	__pos__ ()

ConstULQuaternionExpression	__neg__ ()

ConstULQuaternionExpression	__add__ (int t)
	Returns the result of the addition operation `self + t`. More...

ConstULQuaternionExpression	__add__ (ConstULQuaternionExpression e)
	Returns the result of the addition operation `self + e`. More...

ConstULQuaternionExpression	__radd__ (int t)

ConstULQuaternionExpression	__sub__ (int t)
	Returns the result of the subtraction operation `self - t`. More...

ConstULQuaternionExpression	__sub__ (ConstULQuaternionExpression e)
	Returns the result of the subtraction operation `self - e`. More...

ConstULQuaternionExpression	__rsub__ (int t)

ConstULQuaternionExpression	__mul__ (int t)
	Returns the result of the multiplication operation `self * t`. More...

ConstULQuaternionExpression	__mul__ (ConstULQuaternionExpression e)
	Returns the result of the multiplication operation `self * e`. More...

ConstULQuaternionExpression	__rmul__ (int t)
	Returns the result of the multiplication operation `t * self`. More...

ConstULQuaternionExpression	__div__ (int t)
	Returns the result of the division operation `self // t`. More...

ConstULQuaternionExpression	__div__ (ConstULQuaternionExpression e)
	Returns the result of the division operation `self // e`. More...

ConstULQuaternionExpression	__truediv__ (int t)
	Returns the result of the true division operation `self / t`. More...

ConstULQuaternionExpression	__rdiv__ (int t)

ULVectorQuaternionAdapter	__iadd__ (int t)
	Adds the scalar t to component C1 of this view. More...

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

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

ULVectorQuaternionAdapter	__isub__ (int t)
	Subtracts the scalar t from component C1 of this view. More...

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

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

ULVectorQuaternionAdapter	__imul__ (int t)
	Multiplies every component of this view by the scalar t. More...

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

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

ULVectorQuaternionAdapter	__idiv__ (int t)
	Divides every component of this view by the scalar t. More...

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

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

ULVectorQuaternionAdapter	__itruediv__ (int t)

ULVectorQuaternionAdapter	__itruediv__ (ULVectorQuaternionAdapter a)

ULVectorQuaternionAdapter	__itruediv__ (ConstULQuaternionExpression 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.ULVectorQuaternionAdapter.__init__ ( ULVectorQuaternionAdapter a )

Initializes a copy of the ULVectorQuaternionAdapter instance a.

Parameters

a	The `ULVectorQuaternionAdapter` instance to copy.

◆ init() [2/2]

None CDPL.Math.ULVectorQuaternionAdapter.__init__ ( ULVectorExpression e )

Initializes the ULVectorQuaternionAdapter instance.

Parameters

e

Member Function Documentation

◆ getObjectID()

int CDPL.Math.ULVectorQuaternionAdapter.getObjectID ( )

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

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

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

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

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

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

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.assign ( ULVectorQuaternionAdapter a )

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

Parameters

a	The source adapter.

Returns: self

◆ getC1()

int CDPL.Math.ULVectorQuaternionAdapter.getC1 ( )

Returns a reference to component C1.

Returns: A reference to C1.

◆ getC2()

int CDPL.Math.ULVectorQuaternionAdapter.getC2 ( )

Returns a reference to component C2.

Returns: A reference to C2.

◆ getC3()

int CDPL.Math.ULVectorQuaternionAdapter.getC3 ( )

Returns a reference to component C3.

Returns: A reference to C3.

◆ getC4()

int CDPL.Math.ULVectorQuaternionAdapter.getC4 ( )

Returns a reference to component C4.

Returns: A reference to C4.

◆ swap()

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

Swaps the components of this view with those of a.

Parameters

a	The adapter to swap with.

◆ set()

None CDPL.Math.ULVectorQuaternionAdapter.set	(	int	c1 = `0`,
		int	c2 = `0`,
		int	c3 = `0`,
		int	c4 = `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()

ULVectorExpression CDPL.Math.ULVectorQuaternionAdapter.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.ULVectorQuaternionAdapter.__eq__ ( ULVectorQuaternionAdapter a )

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

Parameters

a	The `ULVectorQuaternionAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.ULVectorQuaternionAdapter.__eq__ ( ConstULQuaternionExpression q )

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

Parameters

q	The `ConstULQuaternionExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

bool CDPL.Math.ULVectorQuaternionAdapter.__ne__ ( ULVectorQuaternionAdapter a )

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

Parameters

a	The `ULVectorQuaternionAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.ULVectorQuaternionAdapter.__ne__ ( ConstULQuaternionExpression q )

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

Parameters

q	The `ConstULQuaternionExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ str()

str CDPL.Math.ULVectorQuaternionAdapter.__str__ ( )

Returns a string representation of the ULVectorQuaternionAdapter instance.

Returns: The generated string representation.

◆ add() [1/2]

ConstULQuaternionExpression CDPL.Math.ULVectorQuaternionAdapter.__add__ ( int t )

Returns the result of the addition operation self + t.

Parameters

t	Specifies the second addend.

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

◆ add() [2/2]

ConstULQuaternionExpression CDPL.Math.ULVectorQuaternionAdapter.__add__ ( ConstULQuaternionExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

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

◆ sub() [1/2]

ConstULQuaternionExpression CDPL.Math.ULVectorQuaternionAdapter.__sub__ ( int t )

Returns the result of the subtraction operation self - t.

Parameters

t	Specifies the subtrahend.

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

◆ sub() [2/2]

ConstULQuaternionExpression CDPL.Math.ULVectorQuaternionAdapter.__sub__ ( ConstULQuaternionExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/2]

ConstULQuaternionExpression CDPL.Math.ULVectorQuaternionAdapter.__mul__ ( int t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

Returns: A ConstULQuaternionExpression instance holding the result of the multiplication.

◆ mul() [2/2]

ConstULQuaternionExpression CDPL.Math.ULVectorQuaternionAdapter.__mul__ ( ConstULQuaternionExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

Returns: A ConstULQuaternionExpression instance holding the result of the multiplication.

◆ rmul()

ConstULQuaternionExpression CDPL.Math.ULVectorQuaternionAdapter.__rmul__ ( int t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

Returns: A ConstULQuaternionExpression instance holding the result of the multiplication.

◆ div() [1/2]

ConstULQuaternionExpression CDPL.Math.ULVectorQuaternionAdapter.__div__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ div() [2/2]

ConstULQuaternionExpression CDPL.Math.ULVectorQuaternionAdapter.__div__ ( ConstULQuaternionExpression e )

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

Parameters

e	Specifies the divisor.

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

◆ truediv()

ConstULQuaternionExpression CDPL.Math.ULVectorQuaternionAdapter.__truediv__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ iadd() [1/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__iadd__ ( int t )

Adds the scalar t to component C1 of this view.

Parameters

t	The scalar summand.

Returns: self

◆ iadd() [2/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__iadd__ ( ULVectorQuaternionAdapter a )

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

Parameters

a	Specifies the second addend.

Returns: The updated ULVectorQuaternionAdapter instance self.

◆ iadd() [3/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__iadd__ ( ConstULQuaternionExpression q )

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

Parameters

q	Specifies the second addend.

Returns: The updated ULVectorQuaternionAdapter instance self.

◆ isub() [1/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__isub__ ( int t )

Subtracts the scalar t from component C1 of this view.

Parameters

t	The scalar subtrahend.

Returns: self

◆ isub() [2/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__isub__ ( ULVectorQuaternionAdapter a )

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

Parameters

a	Specifies the subtrahend.

Returns: The updated ULVectorQuaternionAdapter instance self.

◆ isub() [3/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__isub__ ( ConstULQuaternionExpression q )

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

Parameters

q	Specifies the subtrahend.

Returns: The updated ULVectorQuaternionAdapter instance self.

◆ imul() [1/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__imul__ ( int t )

Multiplies every component of this view by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self

◆ imul() [2/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__imul__ ( ULVectorQuaternionAdapter a )

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

Parameters

a	Specifies the multiplier.

Returns: The updated ULVectorQuaternionAdapter instance self.

◆ imul() [3/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__imul__ ( ConstULQuaternionExpression q )

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

Parameters

q	Specifies the multiplier.

Returns: The updated ULVectorQuaternionAdapter instance self.

◆ idiv() [1/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__idiv__ ( int t )

Divides every component of this view by the scalar t.

Parameters

t	The scalar divisor.

Returns: self

◆ idiv() [2/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__idiv__ ( ULVectorQuaternionAdapter a )

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

Parameters

a	Specifies the divisor.

Returns: The updated ULVectorQuaternionAdapter instance self.

◆ idiv() [3/3]

ULVectorQuaternionAdapter CDPL.Math.ULVectorQuaternionAdapter.__idiv__ ( ConstULQuaternionExpression q )

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

Parameters

q	Specifies the divisor.

Returns: The updated ULVectorQuaternionAdapter 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]