BoundingControl

class HPS.BoundingControl : public HPS.Control 

The HPS.BoundingControl class is a smart pointer that is tied to a database object. This object allows you to manipulate settings related to bounding, such as volume and exclusion. This table lists default values for the various segment attributes accessible from HPS.BoundingControl.

Public Functions

BoundingControl (HPS.BoundingControl in_that): Initializes a control tied to the same object as in_that.

BoundingControl (HPS.SegmentKey in_seg): Initializes a control tied to the segment in_seg.

override void Dispose ()

override HPS.Type ObjectType ()

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Return: The declared type of the object in question, which may differ from the true, underlying type.

HPS.BoundingControl SetExclusion (bool in_exclusion)

Controls whether this segment should be excluded when computing bounding volumes.

Return: A reference to this object.

HPS.BoundingControl SetVolume (HPS.SimpleCuboid in_cuboid)

Explicitly sets the local bounding.

Param in_cuboid: The SimpleCuboid to set the bounding volume to.
Return: A reference to this object.

HPS.BoundingControl SetVolume (HPS.SimpleSphere in_sphere)

Explicitly sets the local bounding.

Param in_sphere: The SimpleSphere to set the bounding volume to.
Return: A reference to this object.

HPS.BoundingControl SetVolume (HPS.SimpleSphere in_sphere, HPS.SimpleCuboid in_cuboid)

Explicitly sets the local bounding.

Param in_sphere: The SimpleSphere to set the bounding volume to.
Param in_cuboid: The SimpleCuboid to set the bounding volume to.
Return: A reference to this object.

bool ShowExclusion (out bool out_exclusion)

Shows the bounding exclusion setting.

Param out_exclusion: Whether to exclude this segment when computing bounding volumes.
Return: true if the setting is valid, false otherwise.

bool ShowVolume (out HPS.SimpleSphere out_sphere, out HPS.SimpleCuboid out_cuboid)

Shows the bounding volume.

Param out_sphere: A sphere to show the volume into. If the bounding is not a sphere, this argument will be invalidated.
Param out_cuboid: A cuboid to show the volume into. If the bounding is not a cuboid, this argument will be invalidated.
Return: true if the setting is valid, false otherwise.

HPS.BoundingControl UnsetEverything ()

Removes all bounding settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by BoundingKit.GetDefault().

Return: A reference to this object.

HPS.BoundingControl UnsetExclusion ()

Removes a bounding exclusion setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by BoundingKit.GetDefault().

Return: A reference to this object.

HPS.BoundingControl UnsetVolume ()

Removes an explicitly set bounding, reverting to the automatically generated one. If the control is attached to a WindowKey this function restores the default value of this setting as specified by BoundingKit.GetDefault().

Return: A reference to this object.