Functions | |
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. More... | |
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. More... | |
HC_BOOLEAN | DFilter_Circumsphere_By_Path (int count, Key const keys[], char const *options, DPoint *center, double *radius) |
Similar to Filter_Circumsphere_By_Path(), but operates on double-precision data. More... | |
HC_BOOLEAN | Filter_Circumsphere (const char *segment, const char *options, HC_POINT *center, float *radius) |
Determines the bounding sphere for a particular segment, based on visibility settings in the tree. More... | |
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. More... | |
HC_BOOLEAN | Filter_Circumsphere_By_Path (int count, Key const keys[], char const *options, Point *center, float *radius) |
Similar to Filter_Circumsphere(), but operates on a keypath instead of a single segment. More... | |
Detailed Description
Function Documentation
◆ DFilter_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 or failure
◆ DFilter_Circumsphere_By_Key()
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 or failure
DETAILS
No additional details. See Filter_Circumsphere()
◆ DFilter_Circumsphere_By_Path()
HC_BOOLEAN DFilter_Circumsphere_By_Path | ( | int | count, |
Key const | keys[], | ||
char const * | options, | ||
DPoint * | center, | ||
double * | radius | ||
) |
Similar to Filter_Circumsphere_By_Path(), but operates on double-precision data.
- Parameters
-
count - The number of keys in the keys array keys - Array containing the keys of the objects (i.e., the keypath) to use in calculating the bounding sphere 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 or failure
DETAILS
No additional details. See Filter_Circumsphere_By_Path()
◆ Filter_Circumsphere()
HC_BOOLEAN Filter_Circumsphere | ( | const char * | segment, |
const char * | options, | ||
HC_POINT * | center, | ||
float * | radius | ||
) |
Determines the bounding sphere for a particular segment, based on 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 or failure
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
◆ Filter_Circumsphere_By_Key()
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 or failure
DETAILS
No additional details. See Filter_Circumsphere()
◆ Filter_Circumsphere_By_Path()
HC_BOOLEAN Filter_Circumsphere_By_Path | ( | int | count, |
Key const | keys[], | ||
char const * | options, | ||
Point * | center, | ||
float * | radius | ||
) |
Similar to Filter_Circumsphere(), but operates on a keypath instead of a single segment.
- Parameters
-
count - The number of keys in the keys array keys - Array containing the keys of the objects (i.e., the keypath) to use in calculating the bounding sphere 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 or failure
DETAILS
The keys array contains the leaf node at the 0 element.
For more details, see Filter_Circumsphere()
NOTES
RESTRICTIONS
- See also
- Compute_Circumsphere