struct.pile.ydir

Syntax

v := struct.pile.ydir(p)
struct.pile.ydir(p) := v

Get/set the \(y\)-axis of the pile element local system.

On assignment will adjust the vector v to be normal to the element direction.

Returns:v - local system \(y\)-axis vector
Accepts:v - local system \(y\)-axis vector.
Arguments:p - a pile pointer

Component Access

f := struct.pile.ydir (p)->x
struct.pile.ydir (p)->x := f

f := struct.pile.ydir.x(p)
struct.pile.ydir.x(p) := f

Get/set the \(x\)-component of the \(y\)-axis of the pile element local system.

Returns:f - \(x\)-component of the local system \(y\)-axis vector
Accepts:f - \(x\)-component of the local system \(y\)-axis vector
Arguments:p - a pile pointer

Access other vector components (\(y\), \(z\)) 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 (struct.pile.ydir(p,<int>)) 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 := struct.pile.ydir.y(p)
f := struct.pile.ydir.z(p)