clump.euler

Syntax

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

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

Get/set the clump orientation. 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 when orientation tracking is enabled (see the model orientation-tracking command).

Returns:

v - clump orientation vector

Accepts:

v - clump orientation vector

Arguments:

cp - clump pointer

Component Access

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

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

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

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

Returns:

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

Accepts:

f - \(x\)-component of the clump 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.euler(bp,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 tensor component access functions for inline help.

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

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