building_blocks.edge.direction

Syntax

v = building_blocks.edge.direction(ep)

Get edge direction. The return value is a 3D vector from start point to the end point of the edge.

Returns:

v - direction of the edge (3D vector)

Arguments:

ep - edge pointer

Component Access

f = building_blocks.edge.direction (ep)->x

f = building_blocks.edge.direction.x(ep)

Get the \(x\)-component of edge direction. The return value is a 3D vector from start point to the end point of the edge.

Returns:

f - \(x\)-component of the direction of the edge (3D vector)

Arguments:

ep - edge 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 (building_blocks.edge.direction(ep,<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 = building_blocks.edge.direction.y(ep)

f = building_blocks.edge.direction.z(ep)