CDPL.Math.ULQuaternion Class Reference

Inheritance diagram for CDPL.Math.ULQuaternion:

Public Member Functions
None	__init__ ()
	Initializes the ULQuaternion instance.
None	__init__ (ULQuaternion q)
	Initializes a copy of the ULQuaternion instance q. More...
None	__init__ (int c1, int c2=0, int c3=0, int c4=0)
	Initializes the ULQuaternion instance. More...
None	__init__ (ConstFQuaternionExpression e)
	Initializes the ULQuaternion instance. More...
None	__init__ (ConstDQuaternionExpression e)
	Initializes the ULQuaternion instance. More...
None	__init__ (ConstLQuaternionExpression e)
	Initializes the ULQuaternion instance. More...
None	__init__ (ConstULQuaternionExpression e)
	Initializes the ULQuaternion instance. More...
None	__init__ (object a)
	Initializes the ULQuaternion instance. More...
int	getObjectID ()
	Returns the numeric identifier (ID) of the wrapped C++ class instance. More...
ULQuaternion	assign (ConstFQuaternionExpression e)
	Replaces the current state of self with a copy of the state of the ConstFQuaternionExpression instance e. More...
ULQuaternion	assign (ConstDQuaternionExpression e)
	Replaces the current state of self with a copy of the state of the ConstDQuaternionExpression instance e. More...
ULQuaternion	assign (ConstLQuaternionExpression e)
	Replaces the current state of self with a copy of the state of the ConstLQuaternionExpression instance e. More...
ULQuaternion	assign (ConstULQuaternionExpression e)
	Replaces the current state of self with a copy of the state of the ConstULQuaternionExpression instance e. More...
ULQuaternion	assign (ULQuaternion q)
	Replaces the current state of self with a copy of the state of the ULQuaternion instance q. More...
None	assign (object a)
	Replaces the current state of self with a copy of the state of the object instance a. More...
int	getC1 ()
int	getC2 ()
int	getC3 ()
int	getC4 ()
object	toArray ()
None	swap (ULQuaternion q)
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)
bool	__eq__ (ULQuaternion q)
	Returns the result of the comparison operation self == q. More...
bool	__eq__ (ConstULQuaternionExpression q)
	Returns the result of the comparison operation self == q. More...
bool	__ne__ (ULQuaternion q)
	Returns the result of the comparison operation self != q. More...
bool	__ne__ (ConstULQuaternionExpression q)
	Returns the result of the comparison operation self != q. More...
str	__str__ ()
	Returns a string representation of the ULQuaternion instance. More...
ULQuaternion	__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)
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)
ConstULQuaternionExpression	__rdiv__ (int t)
ULQuaternion	__iadd__ (int t)
	Performs the in-place addition operation self += t. More...
ULQuaternion	__iadd__ (ULQuaternion q)
	Performs the in-place addition operation self += q. More...
ULQuaternion	__iadd__ (ConstULQuaternionExpression q)
	Performs the in-place addition operation self += q. More...
ULQuaternion	__isub__ (int t)
	Performs the in-place subtraction operation self -= t. More...
ULQuaternion	__isub__ (ULQuaternion q)
	Performs the in-place subtraction operation self -= q. More...
ULQuaternion	__isub__ (ConstULQuaternionExpression q)
	Performs the in-place subtraction operation self -= q. More...
ULQuaternion	__imul__ (int t)
	Performs the in-place multiplication operation self *= t. More...
ULQuaternion	__imul__ (ULQuaternion q)
	Performs the in-place multiplication operation self *= q. More...
ULQuaternion	__imul__ (ConstULQuaternionExpression q)
	Performs the in-place multiplication operation self *= q. More...
ULQuaternion	__idiv__ (int t)
	Performs the in-place division operation self /= t. More...
ULQuaternion	__idiv__ (ULQuaternion q)
	Performs the in-place division operation self /= q. More...
ULQuaternion	__idiv__ (ConstULQuaternionExpression q)
	Performs the in-place division operation self /= q. More...
ULQuaternion	__itruediv__ (int t)
ULQuaternion	__itruediv__ (ULQuaternion q)
ULQuaternion	__itruediv__ (ConstULQuaternionExpression q)

Properties
	objectID = property(getObjectID)

Constructor & Destructor Documentation

__init__() [1/7]

None CDPL.Math.ULQuaternion.__init__

(

ULQuaternion

q

)

Initializes a copy of the ULQuaternion instance q.

Parameters

q	The ULQuaternion instance to copy.

__init__() [2/7]

None CDPL.Math.ULQuaternion.__init__	(	int	c1,
		int	c2 = 0,
		int	c3 = 0,
		int	c4 = 0
	)

Initializes the ULQuaternion instance.

Parameters

c1
c2
c3
c4

__init__() [3/7]

None CDPL.Math.ULQuaternion.__init__

(

ConstFQuaternionExpression

e

)

Initializes the ULQuaternion instance.

Parameters

e

__init__() [4/7]

None CDPL.Math.ULQuaternion.__init__

(

ConstDQuaternionExpression

e

)

Initializes the ULQuaternion instance.

Parameters

e

__init__() [5/7]

None CDPL.Math.ULQuaternion.__init__

(

ConstLQuaternionExpression

e

)

Initializes the ULQuaternion instance.

Parameters

e

__init__() [6/7]

None CDPL.Math.ULQuaternion.__init__

(

ConstULQuaternionExpression

e

)

Initializes the ULQuaternion instance.

Parameters

e

__init__() [7/7]

None CDPL.Math.ULQuaternion.__init__

(

object

a

)

Initializes the ULQuaternion instance.

Parameters

a

Member Function Documentation

getObjectID()

int CDPL.Math.ULQuaternion.getObjectID

(

)

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

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

ULQuaternion CDPL.Math.ULQuaternion.assign

(

ConstFQuaternionExpression

e

)

Replaces the current state of self with a copy of the state of the ConstFQuaternionExpression instance e.

Parameters

e	The ConstFQuaternionExpression instance to copy.

Returns

self

assign() [2/6]

ULQuaternion CDPL.Math.ULQuaternion.assign

(

ConstDQuaternionExpression

e

)

Replaces the current state of self with a copy of the state of the ConstDQuaternionExpression instance e.

Parameters

e	The ConstDQuaternionExpression instance to copy.

Returns

self

assign() [3/6]

ULQuaternion CDPL.Math.ULQuaternion.assign

(

ConstLQuaternionExpression

e

)

Replaces the current state of self with a copy of the state of the ConstLQuaternionExpression instance e.

Parameters

e	The ConstLQuaternionExpression instance to copy.

Returns

self

assign() [4/6]

ULQuaternion CDPL.Math.ULQuaternion.assign

(

ConstULQuaternionExpression

e

)

Replaces the current state of self with a copy of the state of the ConstULQuaternionExpression instance e.

Parameters

e	The ConstULQuaternionExpression instance to copy.

Returns

self

assign() [5/6]

ULQuaternion CDPL.Math.ULQuaternion.assign

(

ULQuaternion

q

)

Replaces the current state of self with a copy of the state of the ULQuaternion instance q.

Parameters

q	The ULQuaternion instance to copy.

Returns

self

assign() [6/6]

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

int CDPL.Math.ULQuaternion.getC1

(

)

Returns

getC2()

int CDPL.Math.ULQuaternion.getC2

(

)

Returns

getC3()

int CDPL.Math.ULQuaternion.getC3

(

)

Returns

getC4()

int CDPL.Math.ULQuaternion.getC4

(

)

Returns

toArray()

object CDPL.Math.ULQuaternion.toArray

(

)

Returns

swap()

None CDPL.Math.ULQuaternion.swap

(

ULQuaternion

q

)

Parameters

q

setC1()

None CDPL.Math.ULQuaternion.setC1

(

int

v

)

Parameters

v

setC2()

None CDPL.Math.ULQuaternion.setC2

(

int

v

)

Parameters

v

setC3()

None CDPL.Math.ULQuaternion.setC3

(

int

v

)

Parameters

v

setC4()

None CDPL.Math.ULQuaternion.setC4

(

int

v

)

Parameters

v

set()

None CDPL.Math.ULQuaternion.set	(	int	c1 = 0,
		int	c2 = 0,
		int	c3 = 0,
		int	c4 = 0
	)

Parameters

c1
c2
c3
c4

__eq__() [1/2]

bool CDPL.Math.ULQuaternion.__eq__

(

ULQuaternion

q

)

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

Parameters

q	The ULQuaternion instance to be compared with.

Returns

The result of the comparison operation.

__eq__() [2/2]

bool CDPL.Math.ULQuaternion.__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.ULQuaternion.__ne__

(

ULQuaternion

q

)

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

Parameters

q	The ULQuaternion instance to be compared with.

Returns

The result of the comparison operation.

__ne__() [2/2]

bool CDPL.Math.ULQuaternion.__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.ULQuaternion.__str__

(

)

Returns a string representation of the ULQuaternion instance.

Returns

The generated string representation.

__pos__()

ULQuaternion CDPL.Math.ULQuaternion.__pos__

(

)

Returns

__neg__()

ConstULQuaternionExpression CDPL.Math.ULQuaternion.__neg__

(

)

Returns

__add__() [1/2]

ConstULQuaternionExpression CDPL.Math.ULQuaternion.__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.ULQuaternion.__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.

__radd__()

ConstULQuaternionExpression CDPL.Math.ULQuaternion.__radd__

(

int

t

)

Parameters

t

Returns

__sub__() [1/2]

ConstULQuaternionExpression CDPL.Math.ULQuaternion.__sub__

(

int

t

)

Returns the result of the subtraction operation self - t.

Parameters

t	Specifies the subtrahend.

Returns

A ULQuaternion instance holding the result of the subtraction.

__sub__() [2/2]

ConstULQuaternionExpression CDPL.Math.ULQuaternion.__sub__

(

ConstULQuaternionExpression

e

)

Returns the result of the subtraction operation self - e.

Parameters

e	Specifies the subtrahend.

Returns

A ULQuaternion instance holding the result of the subtraction.

__rsub__()

ConstULQuaternionExpression CDPL.Math.ULQuaternion.__rsub__

(

int

t

)

Parameters

t

Returns

__mul__() [1/2]

ConstULQuaternionExpression CDPL.Math.ULQuaternion.__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.ULQuaternion.__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.ULQuaternion.__rmul__

(

int

t

)

Parameters

t

Returns

__div__() [1/2]

ConstULQuaternionExpression CDPL.Math.ULQuaternion.__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.ULQuaternion.__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.ULQuaternion.__truediv__

(

int

t

)

Parameters

t

Returns

__rdiv__()

ConstULQuaternionExpression CDPL.Math.ULQuaternion.__rdiv__

(

int

t

)

Parameters

t

Returns

__iadd__() [1/3]

ULQuaternion CDPL.Math.ULQuaternion.__iadd__

(

int

t

)

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

Parameters

t	Specifies the second addend.

Returns

The updated ULQuaternion instance self.

__iadd__() [2/3]

ULQuaternion CDPL.Math.ULQuaternion.__iadd__

(

ULQuaternion

q

)

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

Parameters

q	Specifies the second addend.

Returns

The updated ULQuaternion instance self.

__iadd__() [3/3]

ULQuaternion CDPL.Math.ULQuaternion.__iadd__

(

ConstULQuaternionExpression

q

)

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

Parameters

q	Specifies the second addend.

Returns

The updated ULQuaternion instance self.

__isub__() [1/3]

ULQuaternion CDPL.Math.ULQuaternion.__isub__

(

int

t

)

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

Parameters

t	Specifies the subtrahend.

Returns

The updated ULQuaternion instance self.

__isub__() [2/3]

ULQuaternion CDPL.Math.ULQuaternion.__isub__

(

ULQuaternion

q

)

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

Parameters

q	Specifies the subtrahend.

Returns

The updated ULQuaternion instance self.

__isub__() [3/3]

ULQuaternion CDPL.Math.ULQuaternion.__isub__

(

ConstULQuaternionExpression

q

)

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

Parameters

q	Specifies the subtrahend.

Returns

The updated ULQuaternion instance self.

__imul__() [1/3]

ULQuaternion CDPL.Math.ULQuaternion.__imul__

(

int

t

)

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

Parameters

t	Specifies the multiplier.

Returns

The updated ULQuaternion instance self.

__imul__() [2/3]

ULQuaternion CDPL.Math.ULQuaternion.__imul__

(

ULQuaternion

q

)

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

Parameters

q	Specifies the multiplier.

Returns

The updated ULQuaternion instance self.

__imul__() [3/3]

ULQuaternion CDPL.Math.ULQuaternion.__imul__

(

ConstULQuaternionExpression

q

)

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

Parameters

q	Specifies the multiplier.

Returns

The updated ULQuaternion instance self.

__idiv__() [1/3]

ULQuaternion CDPL.Math.ULQuaternion.__idiv__

(

int

t

)

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

Parameters

t	Specifies the divisor.

Returns

The updated ULQuaternion instance self.

__idiv__() [2/3]

ULQuaternion CDPL.Math.ULQuaternion.__idiv__

(

ULQuaternion

q

)

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

Parameters

q	Specifies the divisor.

Returns

The updated ULQuaternion instance self.

__idiv__() [3/3]

ULQuaternion CDPL.Math.ULQuaternion.__idiv__

(

ConstULQuaternionExpression

q

)

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

Parameters

q	Specifies the divisor.

Returns

The updated ULQuaternion instance self.

__itruediv__() [1/3]

ULQuaternion CDPL.Math.ULQuaternion.__itruediv__

(

int

t

)

Parameters

t

Returns

__itruediv__() [2/3]

ULQuaternion CDPL.Math.ULQuaternion.__itruediv__

(

ULQuaternion

q

)

Parameters

q

Returns

__itruediv__() [3/3]

ULQuaternion CDPL.Math.ULQuaternion.__itruediv__

(

ConstULQuaternionExpression

q

)

Parameters

q

Returns