REFERENCE MANUAL
The BoundingControl class is a smart pointer that is tied to a database object. More...
Public Member Functions | |
BoundingControl (HPS.SegmentKey in_seg) | |
Initializes a control tied to the segment in_seg. More... | |
BoundingControl (HPS.BoundingControl in_that) | |
Initializes a control tied to the same object as in_that. More... | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.BoundingControl | SetExclusion (bool in_exclusion) |
Controls whether this segment should be excluded when computing bounding volumes. More... | |
HPS.BoundingControl | SetVolume (HPS.SimpleSphere in_sphere, HPS.SimpleCuboid in_cuboid) |
Explicitly sets the local bounding. More... | |
HPS.BoundingControl | SetVolume (HPS.SimpleSphere in_sphere) |
Explicitly sets the local bounding. More... | |
HPS.BoundingControl | SetVolume (HPS.SimpleCuboid in_cuboid) |
Explicitly sets the local bounding. More... | |
bool | ShowExclusion (out bool out_exclusion) |
Shows the bounding exclusion setting. More... | |
bool | ShowVolume (out HPS.SimpleSphere out_sphere, out HPS.SimpleCuboid out_cuboid) |
Shows the bounding volume. More... | |
HPS.BoundingControl | UnsetEverything () |
Removes all bounding settings from this object. More... | |
HPS.BoundingControl | UnsetExclusion () |
Removes a bounding exclusion setting. More... | |
HPS.BoundingControl | UnsetVolume () |
Removes an explicitly set bounding, reverting to the automatically generated one. More... | |
![]() | |
Control (HPS.Control in_that) | |
override void | Dispose () |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The 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 BoundingControl.
HPS.BoundingControl.BoundingControl | ( | HPS.SegmentKey | in_seg | ) |
Initializes a control tied to the segment in_seg.
HPS.BoundingControl.BoundingControl | ( | HPS.BoundingControl | in_that | ) |
Initializes a control tied to the same object as in_that.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
HPS.BoundingControl HPS.BoundingControl.SetExclusion | ( | bool | in_exclusion | ) |
Controls whether this segment should be excluded when computing bounding volumes.
HPS.BoundingControl HPS.BoundingControl.SetVolume | ( | HPS.SimpleSphere | in_sphere, |
HPS.SimpleCuboid | in_cuboid | ||
) |
Explicitly sets the local bounding.
in_sphere | The SimpleSphere to set the bounding volume to. |
in_cuboid | The SimpleCuboid to set the bounding volume to. |
HPS.BoundingControl HPS.BoundingControl.SetVolume | ( | HPS.SimpleSphere | in_sphere | ) |
Explicitly sets the local bounding.
in_sphere | The SimpleSphere to set the bounding volume to. |
HPS.BoundingControl HPS.BoundingControl.SetVolume | ( | HPS.SimpleCuboid | in_cuboid | ) |
Explicitly sets the local bounding.
in_cuboid | The SimpleCuboid to set the bounding volume to. |
bool HPS.BoundingControl.ShowExclusion | ( | out bool | out_exclusion | ) |
Shows the bounding exclusion setting.
out_exclusion | Whether to exclude this segment when computing bounding volumes. |
bool HPS.BoundingControl.ShowVolume | ( | out HPS.SimpleSphere | out_sphere, |
out HPS.SimpleCuboid | out_cuboid | ||
) |
Shows the bounding volume.
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. |
HPS.BoundingControl HPS.BoundingControl.UnsetEverything | ( | ) |
Removes all bounding settings from this object.
HPS.BoundingControl HPS.BoundingControl.UnsetExclusion | ( | ) |
Removes a bounding exclusion setting.
HPS.BoundingControl HPS.BoundingControl.UnsetVolume | ( | ) |
Removes an explicitly set bounding, reverting to the automatically generated one.