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

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

None	__init__ (LVectorExpression e)
	Initializes the `LVectorQuaternionAdapter` instance. More...

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

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

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

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

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

LVectorQuaternionAdapter	assign (LVectorQuaternionAdapter 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 (LVectorQuaternionAdapter 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...

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

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

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

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

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

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

LVectorQuaternionAdapter	__pos__ ()

ConstLQuaternionExpression	__neg__ ()

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

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

ConstLQuaternionExpression	__radd__ (int t)

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

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

ConstLQuaternionExpression	__rsub__ (int t)

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

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

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

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

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

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

ConstLQuaternionExpression	__rdiv__ (int t)

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

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

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

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

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

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

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

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

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

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

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

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

LVectorQuaternionAdapter	__itruediv__ (int t)

LVectorQuaternionAdapter	__itruediv__ (LVectorQuaternionAdapter a)

LVectorQuaternionAdapter	__itruediv__ (ConstLQuaternionExpression 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.LVectorQuaternionAdapter.__init__ ( LVectorQuaternionAdapter a )

Initializes a copy of the LVectorQuaternionAdapter instance a.

Parameters

a	The `LVectorQuaternionAdapter` instance to copy.

◆ init() [2/2]

None CDPL.Math.LVectorQuaternionAdapter.__init__ ( LVectorExpression e )

Initializes the LVectorQuaternionAdapter instance.

Parameters

e

Member Function Documentation

◆ getObjectID()

int CDPL.Math.LVectorQuaternionAdapter.getObjectID ( )

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

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

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

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

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

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

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.assign ( LVectorQuaternionAdapter 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.LVectorQuaternionAdapter.getC1 ( )

Returns a reference to component C1.

Returns: A reference to C1.

◆ getC2()

int CDPL.Math.LVectorQuaternionAdapter.getC2 ( )

Returns a reference to component C2.

Returns: A reference to C2.

◆ getC3()

int CDPL.Math.LVectorQuaternionAdapter.getC3 ( )

Returns a reference to component C3.

Returns: A reference to C3.

◆ getC4()

int CDPL.Math.LVectorQuaternionAdapter.getC4 ( )

Returns a reference to component C4.

Returns: A reference to C4.

◆ swap()

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

Swaps the components of this view with those of a.

Parameters

a	The adapter to swap with.

◆ set()

None CDPL.Math.LVectorQuaternionAdapter.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()

LVectorExpression CDPL.Math.LVectorQuaternionAdapter.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.LVectorQuaternionAdapter.__eq__ ( LVectorQuaternionAdapter a )

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

Parameters

a	The `LVectorQuaternionAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ eq() [2/2]

bool CDPL.Math.LVectorQuaternionAdapter.__eq__ ( ConstLQuaternionExpression q )

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

Parameters

q	The `ConstLQuaternionExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [1/2]

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

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

Parameters

a	The `LVectorQuaternionAdapter` instance to be compared with.

Returns: The result of the comparison operation.

◆ ne() [2/2]

bool CDPL.Math.LVectorQuaternionAdapter.__ne__ ( ConstLQuaternionExpression q )

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

Parameters

q	The `ConstLQuaternionExpression` instance to be compared with.

Returns: The result of the comparison operation.

◆ str()

str CDPL.Math.LVectorQuaternionAdapter.__str__ ( )

Returns a string representation of the LVectorQuaternionAdapter instance.

Returns: The generated string representation.

◆ add() [1/2]

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__add__ ( int t )

Returns the result of the addition operation self + t.

Parameters

t	Specifies the second addend.

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

◆ add() [2/2]

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__add__ ( ConstLQuaternionExpression e )

Returns the result of the addition operation self + e.

Parameters

e	Specifies the second addend.

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

◆ sub() [1/2]

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__sub__ ( int t )

Returns the result of the subtraction operation self - t.

Parameters

t	Specifies the subtrahend.

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

◆ sub() [2/2]

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__sub__ ( ConstLQuaternionExpression e )

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

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

◆ mul() [1/2]

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__mul__ ( int t )

Returns the result of the multiplication operation self * t.

Parameters

t	Specifies the multiplier.

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

◆ mul() [2/2]

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__mul__ ( ConstLQuaternionExpression e )

Returns the result of the multiplication operation self * e.

Parameters

e	Specifies the multiplier.

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

◆ rmul()

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__rmul__ ( int t )

Returns the result of the multiplication operation t * self.

Parameters

t	Specifies the multiplicand.

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

◆ div() [1/2]

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__div__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ div() [2/2]

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__div__ ( ConstLQuaternionExpression e )

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

Parameters

e	Specifies the divisor.

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

◆ truediv()

ConstLQuaternionExpression CDPL.Math.LVectorQuaternionAdapter.__truediv__ ( int t )

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

Parameters

t	Specifies the divisor.

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

◆ iadd() [1/3]

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

Adds the scalar t to component C1 of this view.

Parameters

t	The scalar summand.

Returns: self

◆ iadd() [2/3]

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.__iadd__ ( LVectorQuaternionAdapter a )

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

Parameters

a	Specifies the second addend.

Returns: The updated LVectorQuaternionAdapter instance self.

◆ iadd() [3/3]

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.__iadd__ ( ConstLQuaternionExpression q )

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

Parameters

q	Specifies the second addend.

Returns: The updated LVectorQuaternionAdapter instance self.

◆ isub() [1/3]

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

Subtracts the scalar t from component C1 of this view.

Parameters

t	The scalar subtrahend.

Returns: self

◆ isub() [2/3]

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.__isub__ ( LVectorQuaternionAdapter a )

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

Parameters

a	Specifies the subtrahend.

Returns: The updated LVectorQuaternionAdapter instance self.

◆ isub() [3/3]

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.__isub__ ( ConstLQuaternionExpression q )

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

Parameters

q	Specifies the subtrahend.

Returns: The updated LVectorQuaternionAdapter instance self.

◆ imul() [1/3]

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

Multiplies every component of this view by the scalar t.

Parameters

t	The scalar multiplier.

Returns: self

◆ imul() [2/3]

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.__imul__ ( LVectorQuaternionAdapter a )

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

Parameters

a	Specifies the multiplier.

Returns: The updated LVectorQuaternionAdapter instance self.

◆ imul() [3/3]

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.__imul__ ( ConstLQuaternionExpression q )

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

Parameters

q	Specifies the multiplier.

Returns: The updated LVectorQuaternionAdapter instance self.

◆ idiv() [1/3]

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

Divides every component of this view by the scalar t.

Parameters

t	The scalar divisor.

Returns: self

◆ idiv() [2/3]

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.__idiv__ ( LVectorQuaternionAdapter a )

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

Parameters

a	Specifies the divisor.

Returns: The updated LVectorQuaternionAdapter instance self.

◆ idiv() [3/3]

LVectorQuaternionAdapter CDPL.Math.LVectorQuaternionAdapter.__idiv__ ( ConstLQuaternionExpression q )

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

Parameters

q	Specifies the divisor.

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