|
override void | deleteCptr () |
|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
static IntPtr | ClassID< T > () |
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ BoundingControl() [1/2]
Initializes a control tied to the segment in_seg.
◆ BoundingControl() [2/2]
Initializes a control tied to the same object as in_that.
◆ ObjectType()
override HPS.Type HPS.BoundingControl.ObjectType |
( |
| ) |
|
|
inlinevirtual |
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).
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
◆ SetExclusion()
Controls whether this segment should be excluded when computing bounding volumes.
- Returns
- A reference to this object.
◆ SetVolume() [1/3]
Explicitly sets the local bounding.
- Parameters
-
- Returns
- A reference to this object.
◆ SetVolume() [2/3]
Explicitly sets the local bounding.
- Parameters
-
- Returns
- A reference to this object.
◆ SetVolume() [3/3]
Explicitly sets the local bounding.
- Parameters
-
- Returns
- A reference to this object.
◆ ShowExclusion()
bool HPS.BoundingControl.ShowExclusion |
( |
out bool |
out_exclusion | ) |
|
|
inline |
Shows the bounding exclusion setting.
- Parameters
-
out_exclusion | Whether to exclude this segment when computing bounding volumes. |
- Returns
- true if the setting is valid, false otherwise.
◆ ShowVolume()
Shows the bounding volume.
- Parameters
-
out_sphere | A sphere to show the volume into. If the bounding is not a sphere, this argument will be invalidated. |
out_cuboid | A cuboid to show the volume into. If the bounding is not a cuboid, this argument will be invalidated. |
- Returns
- true if the setting is valid, false otherwise.
◆ Type()
override HPS.Type HPS.BoundingControl.Type |
( |
| ) |
|
|
inlinevirtual |
This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Object.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
◆ 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().
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.BoundingControl.cs