HPS::BoundingControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::BoundingControl:
HPS::Control HPS::Object

Public Member Functions

 BoundingControl (SegmentKey &in_seg)
 
 BoundingControl (BoundingControl const &in_that)
 
 BoundingControl (BoundingControl &&in_that)
 
HPS::Type ObjectType () const
 
BoundingControloperator= (BoundingControl &&in_that)
 
BoundingControloperator= (BoundingControl const &in_that)
 
BoundingControlSetExclusion (bool in_exclusion)
 
BoundingControlSetVolume (SimpleSphere const &in_sphere, SimpleCuboid const &in_cuboid)
 
BoundingControlSetVolume (SimpleSphere const &in_sphere)
 
BoundingControlSetVolume (SimpleCuboid const &in_cuboid)
 
bool ShowExclusion (bool &out_exclusion) const
 
bool ShowVolume (SimpleSphere &out_sphere, SimpleCuboid &out_cuboid) const
 
virtual HPS::Type Type () const
 
BoundingControlUnsetEverything ()
 
BoundingControlUnsetExclusion ()
 
BoundingControlUnsetVolume ()
 
 ~BoundingControl ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::BoundingControl
 
- Static Public Attributes inherited from HPS::Control
static const HPS::Type staticType = HPS::Type::Control
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

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)
 
Controloperator= (Control &&in_that)
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ BoundingControl() [1/3]

HPS::BoundingControl::BoundingControl ( SegmentKey in_seg)
explicit

Initializes a control tied to the segment in_seg.

◆ BoundingControl() [2/3]

HPS::BoundingControl::BoundingControl ( BoundingControl const &  in_that)

Initializes a control tied to the same object as in_that.

◆ BoundingControl() [3/3]

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.

Parameters
in_thatAn rvalue reference to a BoundingControl to take the impl from.

◆ ~BoundingControl()

HPS::BoundingControl::~BoundingControl ( )

Releases a reference to the database object this control is tied to.

Member Function Documentation

◆ 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]

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.

Parameters
in_thatAn rvalue reference to a BoundingControl to take the impl from.
Returns
A reference to this BoundingControl.

◆ operator=() [2/2]

BoundingControl& HPS::BoundingControl::operator= ( BoundingControl const &  in_that)

Share the underlying smart-pointer of the BoundingControl source.

Parameters
in_thatThe BoundingControl source of the assignment.
Returns
A reference to this BoundingControl.

◆ SetExclusion()

BoundingControl& HPS::BoundingControl::SetExclusion ( bool  in_exclusion)

Controls whether this segment should be excluded when computing bounding volumes.

Parameters
in_excludeWhether to exclude this segment when computing bounding volumes.
Returns
A reference to this object.

◆ SetVolume() [1/3]

BoundingControl& HPS::BoundingControl::SetVolume ( SimpleSphere const &  in_sphere,
SimpleCuboid const &  in_cuboid 
)

Explicitly sets the local bounding.

Parameters
in_sphereThe SimpleSphere to set the bounding volume to.
in_cuboidThe SimpleCuboid to set the bounding volume to.
Returns
A reference to this object.

◆ SetVolume() [2/3]

BoundingControl& HPS::BoundingControl::SetVolume ( SimpleSphere const &  in_sphere)

Explicitly sets the local bounding.

Parameters
in_sphereThe SimpleSphere to set the bounding volume to.
Returns
A reference to this object.

◆ SetVolume() [3/3]

BoundingControl& HPS::BoundingControl::SetVolume ( SimpleCuboid const &  in_cuboid)

Explicitly sets the local bounding.

Parameters
in_cuboidThe 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_exclusionWhether to exclude this segment when computing bounding volumes.
Returns
true if the setting is valid, false otherwise.

◆ ShowVolume()

bool HPS::BoundingControl::ShowVolume ( SimpleSphere out_sphere,
SimpleCuboid out_cuboid 
) const

Shows the bounding volume.

Parameters
out_sphereA sphere to show the volume into. If the bounding is not a sphere, this argument will be invalidated.
out_cuboidA 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()

BoundingControl& 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().

Returns
A reference to this object.

◆ UnsetExclusion()

BoundingControl& 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().

Returns
A reference to this object.

◆ UnsetVolume()

BoundingControl& 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().

Returns
A reference to this object.

The documentation for this class was generated from the following file: