Brief Index      Full Index      I.M. Reference

Filter_Circumcuboid


Functions

HC_BOOLEAN Filter_Circumcuboid (const char *segment, const char *options, HC_POINT *min, HC_POINT *max)
HC_BOOLEAN Filter_Circumcuboid_By_Key (HC_KEY segKey, const char *options, HC_POINT *min, HC_POINT *max)

Function Documentation

HC_BOOLEAN Filter_Circumcuboid ( const char *  segment,
const char *  options,
HC_POINT *  min,
HC_POINT *  max 
)

Determines the bounding cuboid for a particular segment, based on visibility settings in the segment tree.

Parameters:
segment - The segment that the bounding box should be calculated for.
options - The initial visibility settings that the segment should be considered to be inheriting
min - Lower left corner of the bounding cuboid. Returned to the user.
max - Upper right corner of the bounding cuboid. Returned to the user.
Returns:
success

DETAILS

This function behaves very similarly to Compute_Circumcuboid() except that it honors visibility settings in the segment tree.

Options acts as a temporary visibility setting at the starting segment for the purpose of this calculation. An empty options string corresponds to the default setting, "visibility = (everything=on)".

NOTES

The options parameter for Filter_Circumcuboid() and also for Filter_Circumsphere() accepts a special visibility option -- "detailed" -- that is not part of the standard settings as described in Set_Visibility(). When set, detailed tells the calculation to honor visibility settings within shells and meshes.

RESTRICTIONS

See also:
Compute_Circumcuboid

HC_BOOLEAN Filter_Circumcuboid_By_Key ( HC_KEY  segKey,
const char *  options,
HC_POINT *  min,
HC_POINT *  max 
)

Similar to Filter_Circumcuboid(), but operates on an object referenced by an HC_KEY.

Parameters:
segKey - The key to the segment that the bounding box should be calculated for.
options - The initial visibility settings that the segment should be considered to be inheriting
min - Lower left corner of the bounding cuboid. Returned to the user.
max - Upper right corner of the bounding cuboid. Returned to the user.
Returns:
success

DETAILS

No additional details. See Filter_Circumcuboid()

Main Index
Brief Index      Full Index      I.M. Functions