#include <hps.h>
Public Member Functions | |
| BoundingControl (SegmentKey &in_seg) | |
| BoundingControl (BoundingControl const &in_that) | |
| BoundingControl (BoundingControl &&in_that) | |
| BoundingControl & | operator= (BoundingControl &&in_that) |
| ~BoundingControl () | |
| HPS::Type | ObjectType () const |
| BoundingControl & | operator= (BoundingControl const &in_that) |
| BoundingControl & | SetVolume (SimpleSphere const &in_sphere, SimpleCuboid const &in_cuboid) |
| BoundingControl & | SetVolume (SimpleSphere const &in_sphere) |
| BoundingControl & | SetVolume (SimpleCuboid const &in_cuboid) |
| BoundingControl & | SetExclusion (bool in_exclusion) |
| BoundingControl & | UnsetVolume () |
| BoundingControl & | UnsetExclusion () |
| BoundingControl & | UnsetEverything () |
| bool | ShowVolume (SimpleSphere &out_sphere, SimpleCuboid &out_cuboid) const |
| bool | ShowExclusion (bool &out_exclusion) const |
Public Member Functions inherited from HPS::Object | |
| Object & | operator= (Object const &other_object) |
| Object (Object &&in_that) | |
| Object & | operator= (Object &&in_that) |
| HPS::Type | Type () const |
| virtual bool | Empty () const |
| virtual void | Reset () |
| bool | HasType (HPS::Type in_mask) const |
| intptr_t | GetClassID () const |
| intptr_t | GetInstanceID () const |
Additional Inherited Members | |
Static Public Member Functions inherited from HPS::Object | |
| template<typename T > | |
| static intptr_t | ClassID () |
Protected Member Functions inherited from HPS::Control | |
| Control (Control &&in_that) | |
| Control & | operator= (Control &&in_that) |
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.
|
explicit |
Initializes a control tied to the segment in_seg.
| HPS::BoundingControl::BoundingControl | ( | BoundingControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
| HPS::BoundingControl::BoundingControl | ( | BoundingControl && | in_that | ) |
The move constructor creates a BoundingControl by transferring the underlying impl of the rvalue reference to this BoundingControl thereby avoiding a copy and allocation.
| in_that | An rvalue reference to a BoundingControl to take the impl from. |
| HPS::BoundingControl::~BoundingControl | ( | ) |
Releases a reference to the database object this control is tied to.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Control.
| BoundingControl& HPS::BoundingControl::operator= | ( | BoundingControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this BoundingControl thereby avoiding a copy.
| in_that | An rvalue reference to a BoundingControl to take the impl from. |
| BoundingControl& HPS::BoundingControl::operator= | ( | BoundingControl const & | in_that | ) |
Share the smart-pointer.
| BoundingControl& HPS::BoundingControl::SetExclusion | ( | bool | in_exclusion | ) |
Controls whether this segment should be excluded when computing bounding volumes.
| in_state | Whether to exclude this segment when computing bounding volumes. |
| BoundingControl& HPS::BoundingControl::SetVolume | ( | SimpleSphere const & | in_sphere, |
| SimpleCuboid const & | 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. |
| BoundingControl& HPS::BoundingControl::SetVolume | ( | SimpleSphere const & | in_sphere | ) |
Explicitly sets the local bounding.
| in_sphere | The SimpleSphere to set the bounding volume to. |
| BoundingControl& HPS::BoundingControl::SetVolume | ( | SimpleCuboid const & | in_cuboid | ) |
Explicitly sets the local bounding.
| in_cuboid | The SimpleCuboid to set the bounding volume to. |
| bool HPS::BoundingControl::ShowExclusion | ( | bool & | out_exclusion | ) | const |
Shows the bounding exclusion setting.
| out_exclusion | Whether to exclude this segment when computing bounding volumes. |
| bool HPS::BoundingControl::ShowVolume | ( | SimpleSphere & | out_sphere, |
| SimpleCuboid & | out_cuboid | ||
| ) | const |
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. |
| BoundingControl& HPS::BoundingControl::UnsetEverything | ( | ) |
Removes all bounding settings from this object.
| BoundingControl& HPS::BoundingControl::UnsetExclusion | ( | ) |
Removes a bounding exclusion setting.
| BoundingControl& HPS::BoundingControl::UnsetVolume | ( | ) |
Removes an explicitly set bounding, reverting to the automatically generated one.