Brief Index      Full Index      I.M. Reference

Filter_Circumsphere


Functions

HC_BOOLEAN Filter_Circumsphere (const char *segment, const char *options, HC_POINT *center, float *radius)
HC_BOOLEAN Filter_Circumsphere_By_Key (HC_KEY segKey, const char *options, HC_POINT *center, float *radius)

Function Documentation

HC_BOOLEAN Filter_Circumsphere ( const char *  segment,
const char *  options,
HC_POINT *  center,
float *  radius 
)

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

Parameters:
segment - The segment that the bounding sphere should be calculated for.
options - The initial visibility settings that the segment should be considered to be inheriting
center - Center of the circumsphere
radius - Radius of the circumsphere
Returns:
success

DETAILS

This function behaves very similarly to Compute_Circumsphere() 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_Circumsphere() and also for Filter_Circumcuboid() 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_Circumsphere

HC_BOOLEAN Filter_Circumsphere_By_Key ( HC_KEY  segKey,
const char *  options,
HC_POINT *  center,
float *  radius 
)

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

Parameters:
segKey - The key to the segment that the bounding sphere should be calculated for.
options - The initial visibility settings that the segment should be considered to be inheriting
center - Center of the circumsphere
radius - Radius of the circumsphere
Returns:
success

DETAILS

No additional details. See Filter_Circumsphere()

Main Index
Brief Index      Full Index      I.M. Functions