#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::BoundingControl |
|
static const HPS::Type | staticType = HPS::Type::Control |
|
static const HPS::Type | staticType = HPS::Type::None |
|
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/3]
HPS::BoundingControl::BoundingControl |
( |
SegmentKey & |
in_seg | ) |
|
|
explicit |
Initializes a control tied to the segment in_seg.
◆ BoundingControl() [2/3]
Initializes a control tied to the same object as in_that.
◆ BoundingControl() [3/3]
The move constructor creates a BoundingControl by transferring the underlying impl of the rvalue reference to this BoundingControl thereby avoiding a copy and allocation.
- Parameters
-
◆ ~BoundingControl()
HPS::BoundingControl::~BoundingControl |
( |
| ) |
|
Releases a reference to the database object this control is tied to.
◆ ObjectType()
HPS::Type HPS::BoundingControl::ObjectType |
( |
| ) |
const |
|
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::Control.
◆ operator=() [1/2]
The move assignment operator transfers the underlying impl of the rvalue reference to this BoundingControl thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this BoundingControl.
◆ operator=() [2/2]
◆ SetExclusion()
Controls whether this segment should be excluded when computing bounding volumes.
- Parameters
-
in_exclude | Whether to exclude this segment when computing bounding volumes. |
- Returns
- A reference to this object.
◆ SetVolume() [1/3]
Explicitly sets the local bounding.
- Parameters
-
in_sphere | The SimpleSphere to set the bounding volume to. |
in_cuboid | The SimpleCuboid to set the bounding volume to. |
- Returns
- A reference to this object.
◆ SetVolume() [2/3]
Explicitly sets the local bounding.
- Parameters
-
in_sphere | The SimpleSphere to set the bounding volume to. |
- Returns
- A reference to this object.
◆ SetVolume() [3/3]
Explicitly sets the local bounding.
- Parameters
-
in_cuboid | The SimpleCuboid to set the bounding volume to. |
- Returns
- A reference to this object.
◆ ShowExclusion()
bool HPS::BoundingControl::ShowExclusion |
( |
bool & |
out_exclusion | ) |
const |
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()
virtual HPS::Type HPS::BoundingControl::Type |
( |
| ) |
const |
|
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.
- Warning
- This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
- Returns
- The true type of the object in question.
Reimplemented from HPS::Control.
◆ 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: