Brief Index      Full Index      Events 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 DFilter_Circumcuboid (const char *segment, const char *options, HC_DPOINT *min, HC_DPOINT *max)
HC_BOOLEAN Filter_Circumcuboid_By_Key (HC_KEY segKey, const char *options, HC_POINT *min, HC_POINT *max)
HC_BOOLEAN DFilter_Circumcuboid_By_Key (HC_KEY segKey, const char *options, HC_DPOINT *min, HC_DPOINT *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() 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

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

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

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

Brief Index      Full Index      Events Index      I.M. Reference