Filter_Circumcuboid

Functions

HC_BOOLEAN DFilter_Circumcuboid (const char *segment, const char *options, HC_DPOINT *min, HC_DPOINT *max)
 Similar to Filter_Circumcuboid(), but operates on double-precision data. More...
 
HC_BOOLEAN DFilter_Circumcuboid_By_Key (HC_KEY segKey, const char *options, HC_DPOINT *min, HC_DPOINT *max)
 Similar to Filter_Circumcuboid_By_Key(), but operates on double-precision data. More...
 
HC_BOOLEAN DFilter_Circumcuboid_By_Path (int count, HC_KEY const *keys, const char *options, HC_DPOINT *min, HC_DPOINT *max)
 Similar to Filter_Circumcuboid_By_Path(), but operates on double-precision data. More...
 
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. More...
 
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. More...
 
HC_BOOLEAN Filter_Circumcuboid_By_Path (int count, HC_KEY const *keys, const char *options, HC_POINT *min, HC_POINT *max)
 Similar to Filter_Circumcuboid(), but operates on a keypath instead of a single segment. More...
 

Detailed Description

Function Documentation

◆ DFilter_Circumcuboid()

HC_BOOLEAN DFilter_Circumcuboid ( const char *  segment,
const char *  options,
HC_DPOINT *  min,
HC_DPOINT *  max 
)

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

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 or failure

◆ DFilter_Circumcuboid_By_Key()

HC_BOOLEAN DFilter_Circumcuboid_By_Key ( HC_KEY  segKey,
const char *  options,
HC_DPOINT *  min,
HC_DPOINT *  max 
)

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

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 or failure

◆ DFilter_Circumcuboid_By_Path()

HC_BOOLEAN DFilter_Circumcuboid_By_Path ( int  count,
HC_KEY const *  keys,
const char *  options,
HC_DPOINT *  min,
HC_DPOINT *  max 
)

Similar to Filter_Circumcuboid_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
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 or failure

◆ Filter_Circumcuboid()

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 or failure

DETAILS

This function behaves very similarly to Compute_Circumcuboid(); 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_Circumcuboid

◆ Filter_Circumcuboid_By_Key()

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 or failure

DETAILS

No additional details. See Filter_Circumcuboid()

◆ Filter_Circumcuboid_By_Path()

HC_BOOLEAN Filter_Circumcuboid_By_Path ( int  count,
HC_KEY const *  keys,
const char *  options,
HC_POINT *  min,
HC_POINT *  max 
)

Similar to Filter_Circumcuboid(), 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
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 or failure

DETAILS

The keys array contains the leaf node at the 0 element.

For more details, see Filter_Circumcuboid()