DualQuaternion

Inheritance diagram

Classes

DualQuaternion

class ORSModel.ors.DualQuaternion

Bases: Unmanaged

A wrapper to a DualQuaternion.

add(self, aVector: ORSModel.ors.DualQuaternion)

Adds a vector to the receiver.

Parameters:

aVector (ORSModel.ors.DualQuaternion) – a vector (an Vector3)

copy(self) → ORSModel.ors.DualQuaternion

Returns a new vector identical to the receiver (a copy).

Returns:

output (ORSModel.ors.DualQuaternion) –

createFromPythonRepresentation(aPythonRepresentation: str) → ORSModel.ors.DualQuaternion

Parameters:

aPythonRepresentation (str) –

Returns:

output (ORSModel.ors.DualQuaternion) –

getAdditionWith(self, aVector: ORSModel.ors.DualQuaternion) → ORSModel.ors.DualQuaternion

Gets the result of adding a vector to the receiver.

Note

The receiver is not modified.

Parameters:

aVector (ORSModel.ors.DualQuaternion) – a vector (an Vector3)

Returns:

output (ORSModel.ors.DualQuaternion) – the resulting vector (an Vector3)

getClassNameStatic() → str

getClassNameStatic

Returns:

output (str) –

getIsEqualTo(self, aVector: ORSModel.ors.DualQuaternion) → bool

Parameters:

aVector (ORSModel.ors.DualQuaternion) –

Returns:

output (bool) –

getLinearInterpolationWith(self, point1: ORSModel.ors.DualQuaternion, normalizePosition: float) → ORSModel.ors.DualQuaternion

Computes the lerp with another vector.

See also

getDotProductWith(), getAngleWith(), getDistanceFrom()

Parameters:

• point1 (ORSModel.ors.DualQuaternion) – a vector (an Vector3)

• normalizePosition (float) – a interpolation factor [0,1](a double)

Returns:

output (ORSModel.ors.DualQuaternion) – the lerp vector (an Vector3)

getNegated(self) → ORSModel.ors.DualQuaternion

Gets the receiver negated in a new vector.

Note

The receiver is not modified.

Returns:

output (ORSModel.ors.DualQuaternion) – the resulting vector (an Vector3)

getNormalized(self) → ORSModel.ors.DualQuaternion

Returns:

output (ORSModel.ors.DualQuaternion) –

getScaledBy(self, scaleFactor: float) → ORSModel.ors.DualQuaternion

Gets the result of sacling a vector to the receiver.

Note

The receiver is not modified.

Parameters:

scaleFactor (float) – a scale a double

Returns:

output (ORSModel.ors.DualQuaternion) – the resulting vector (an Vector3)

getSphericalInterpolationWith(self, point1: ORSModel.ors.DualQuaternion, normalizePosition: float) → ORSModel.ors.DualQuaternion

Computes the lerp with another vector.

See also

getDotProductWith(), getAngleWith(), getDistanceFrom()

Parameters:

• point1 (ORSModel.ors.DualQuaternion) – a vector (an Vector3)

• normalizePosition (float) – a interpolation factor [0,1](a double)

Returns:

output (ORSModel.ors.DualQuaternion) – the lerp vector (an Vector3)

getSubtractionFrom(self, aVector: ORSModel.ors.DualQuaternion) → ORSModel.ors.DualQuaternion

Gets the result of subtracting a vector from the receiver.

Note

The receiver is not modified.

Parameters:

aVector (ORSModel.ors.DualQuaternion) – a vector (an Vector3)

Returns:

output (ORSModel.ors.DualQuaternion) – the resulting vector (an Vector3)

negate(self)

Negates the vector.

none() → DualQuaternion

Returns:

output (DualQuaternion) –

normalize(self)

Normalizes the vector.

Note

A normalized vector has norm (length) 1.

scale(self, scaleFactor: float)

Scales the vector.

Parameters:

scaleFactor (float) – a scale factor (a double)

subtract(self, aVector: ORSModel.ors.DualQuaternion)

Subtracts a vector from the receiver.

Parameters:

aVector (ORSModel.ors.DualQuaternion) – a vector (an Vector3)

Unmanaged

class ORSModel.ors.Unmanaged

Bases: ORSBaseClass

Abstract class for objects that are not managed by the core library. Unmanaged objects are transient objects.

atomicLoad(sFilename: str) → Unmanaged

Creates an object from a file where an object was saved.

Parameters:

sFilename (str) – path of the file to load

Returns:

output (Unmanaged) – an unmanaged object, or none() if the load fails

atomicSave(self, aFilename: str) → int

Saves the object to a file.

Parameters:

aFilename (str) – path of the file to save

Returns:

output (int) – 0 if successful, otherwise an error code

createFromPythonRepresentation(aPythonRepresentation: str) → ORSModel.ors.Unmanaged

Create aUnmanaged Object from a python representation a static method.

Parameters:

aPythonRepresentation (str) –

Returns:

output (ORSModel.ors.Unmanaged) –

fromPythonRepresentation(self, aPythonRepresentation: str) → bool

Create aUnmanaged object from a Python string representation.

Parameters:

aPythonRepresentation (str) – a Python evaluable string representation (a string)

Returns:

output (bool) – true if parsing worked, false otherwise (a bool)

getClassName(self) → str

Retrieves the class name of the core object wrapped by this Interface object.

Returns:

output (str) –

getClassNameStatic() → str

getClassNameStatic

Returns:

output (str) –

getDataChecksum(self) → str

Returns:

output (str) –

getIsInstanceOf(self, pProgId: str) → bool

Queries the object to know if it is an instance of a certain class.

Parameters:

pProgId (str) –

Returns:

output (bool) –

getPythonRepresentation(self) → str

Gets a Python evaluable string representation.

Returns:

output (str) –

isNone(self) → bool

Checks if the receiver is none.

Returns:

output (bool) –

isNotNone(self) → bool

Checks if the receiver is not none.

Returns:

output (bool) –

none() → Unmanaged

Returns:

output (Unmanaged) –

ORSBaseClass

class ORSModel.ors.ORSBaseClass

An abstract class from which all objects issued from the ORS Core Library inherit.

getPythonTraceBack() → List[str]

Set the python traceback for a call from python.

Returns:

output (List[str]) –

isManaged(self) → bool

Returns:

output (bool) –

isNone(self) → bool

Returns:

output (bool) –

setPythonTraceBack(tb: List[str])

Set the python traceback for a call from python.

Parameters:

tb (List[str]) –