Brief Index      Full Index      Events Index      I.M. Reference

Filter_Circumsphere


Functions

HC_BOOLEAN Filter_Circumsphere (const char *segment, const char *options, HC_POINT *center, float *radius)
HC_BOOLEAN DFilter_Circumsphere (const char *segment, const char *options, HC_DPOINT *center, double *radius)
HC_BOOLEAN Filter_Circumsphere_By_Key (HC_KEY segKey, const char *options, HC_POINT *center, float *radius)
HC_BOOLEAN DFilter_Circumsphere_By_Key (HC_KEY segKey, const char *options, HC_DPOINT *center, double *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() however you can also pass in additional parameters which affect the calculation of the bounding volume. These options include:

visibility [string]

This visiblity will be used as the starting set of visibility settings on the provided segment tree. An empty string corresponds to the default setting, "visibility = (everything=on)".

detailed

Honor the subshell visibility settings when determining the bounding volume.

minimal

Use best efforts to determine the tightest bounding volume.

NOTES

RESTRICTIONS

See also:
Compute_Circumsphere

HC_BOOLEAN DFilter_Circumsphere ( const char *  segment,
const char *  options,
HC_DPOINT *  center,
double *  radius 
)

Similar to Filter_Circumsphere(), but operates on double-precision data.

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

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()

HC_BOOLEAN DFilter_Circumsphere_By_Key ( HC_KEY  segKey,
const char *  options,
HC_DPOINT *  center,
double *  radius 
)

Similar to Filter_Circumsphere(), but operates on double-precision data.

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()

Brief Index      Full Index      Events Index      I.M. Reference