clump.template.euler

Syntax

v = clump.template.euler(cp) (3D ONLY)

Get the clump template relative orientation. This is the orientation relative to the clump template. The convention \(\big\{X,Y^{'},Z^{''}\big\}\) is used (i.e., the \(x\)-, \(y\)-, and \(z\)-components correspond to the sequential rotations about the \(X\), \(Y^{'}\), and \(Z^{''}\) axes).

Note

The orientation is updated whenever the clump rotates.

Returns:

v - clump template relative orientation vector

Arguments:

cp - clump pointer

Component Access

f = clump.template.euler (cp)->x

f = clump.template.euler.x(cp) (3D ONLY)

clump.template.euler.x(cp) = f (3D ONLY)

Get/set the \(x\)-component of the clump template relative orientation.

Returns:

f - \(x\)-component of the clump template relative orientation vector

Arguments:

cp - clump pointer

Access other vector components (\(y\), \(z\) (3D ONLY)) by substituting the component name where \(x\) appears above. See Member Access Operator for information about accessing members from data types using ->.

Deprecated Component Access

Component access by adding an optional integer in the function arguments (e.g., f = clump.template.euler(cp, 3)) is deprecated. It remains available but will not be supported in future versions. See Component Access with Integers in FISH on the Deprecated Commands and FISH page for details.

This is hidden. Added to include remaining vector component access functions for inline help.

f = clump.template.euler.y(cp) (3D ONLY)

f = clump.template.euler.z(cp) (3D ONLY)