More...
|
| 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 (if the object is derived, this does not give the true type of the derived object). 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...
|
|
override HPS.Type | Type () |
| 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. More...
|
|
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(). More...
|
|
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(). More...
|
|
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(). More...
|
|
| Control (HPS.Control in_that) |
|
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). More...
|
|
override HPS.Type | Type () |
| 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. More...
|
|
virtual bool | Empty () |
| Indicates whether this object has any values set on it. More...
|
|
IntPtr | GetClassID () |
|
IntPtr | GetInstanceID () |
| Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More...
|
|
bool | HasType (HPS.Type in_mask) |
| This function indicates whether this Object has the given Type mask. More...
|
|
| Object (HPS.Object that) |
|
virtual void | Reset () |
| Resets this object to its initial, uninitialized state. More...
|
|
|
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