Retrieves the value of a specific axis from an STBox.
Returns the coordinate or temporal value of a specified axis from the stbox. The axis is determined by the axis
parameter, and whether the value is from the lower or upper bound of that axis is specified by the upper
parameter. The function supports the X, Y, Z spatial axes and the temporal axis.
- Parameters
-
[in] | box | The STBox structure from which the axis value is to be retrieved. |
[in] | axis | The axis to retrieve (0 = X, 1 = Y, 2 = time, 3 = Z). |
[in] | upper | A boolean indicating whether to retrieve the upper (true ) or lower (false ) bound of the specified axis. |
- Returns
- The value of the specified axis and bound as a double. Returns 0.0 if the axis is invalid.