#include <hps.h>

Inheritance diagram for HPS::BoundingKit:
HPS::Kit HPS::Object

Public Member Functions

 BoundingKit ()
 
 BoundingKit (BoundingKit const &in_kit)
 
 BoundingKit (BoundingKit &&in_that)
 
bool Empty () const
 
bool Equals (BoundingKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (BoundingKit const &in_kit) const
 
BoundingKitoperator= (BoundingKit &&in_that)
 
BoundingKitoperator= (BoundingKit const &in_kit)
 
bool operator== (BoundingKit const &in_kit) const
 
void Set (BoundingKit const &in_kit)
 
BoundingKitSetExclusion (bool in_exclude)
 
BoundingKitSetVolume (SimpleSphere const &in_sphere)
 
BoundingKitSetVolume (SimpleCuboid const &in_cuboid)
 
void Show (BoundingKit &out_kit) const
 
bool ShowExclusion (bool &out_exclusion) const
 
bool ShowVolume (SimpleSphere &out_sphere, SimpleCuboid &out_cuboid) const
 
BoundingKitUnsetEverything ()
 
BoundingKitUnsetExclusion ()
 
BoundingKitUnsetVolume ()
 
virtual ~BoundingKit ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
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 Member Functions

static BoundingKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::BoundingKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

The HPS::BoundingKit class is a user space object, useful for carrying a group of attribute settings. Calling HPS::BoundingKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ BoundingKit() [1/3]

HPS::BoundingKit::BoundingKit ( )

Initializes an empty kit.

◆ BoundingKit() [2/3]

HPS::BoundingKit::BoundingKit ( BoundingKit const &  in_kit)

The copy constructor creates a new BoundingKit object that contains the same settings as the source object.

Parameters
in_kitThe source object to copy.

◆ BoundingKit() [3/3]

HPS::BoundingKit::BoundingKit ( BoundingKit &&  in_that)

The move constructor creates a BoundingKit by transferring the underlying impl of the rvalue reference to this BoundingKit thereby avoiding a copy and allocation.

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

◆ ~BoundingKit()

virtual HPS::BoundingKit::~BoundingKit ( )
virtual

Destroy this kit.

Member Function Documentation

◆ Empty()

bool HPS::BoundingKit::Empty ( ) const
virtual

Indicates whether this object has any values set on it.

Returns
true if no values are set on this object, false otherwise.

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::BoundingKit::Equals ( BoundingKit const &  in_kit) const

Check if the source BoundingKit is equivalent to this object.

Parameters
in_kitThe source BoundingKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static BoundingKit HPS::BoundingKit::GetDefault ( )
static

Creates a BoundingKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Returns
A BoundingKit with the default settings.

◆ ObjectType()

HPS::Type HPS::BoundingKit::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::Kit.

◆ operator!=()

bool HPS::BoundingKit::operator!= ( BoundingKit const &  in_kit) const

Check if the source BoundingKit is not equivalent to this object.

Parameters
in_kitThe source BoundingKit to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

BoundingKit& HPS::BoundingKit::operator= ( BoundingKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this BoundingKit thereby avoiding a copy.

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

◆ operator=() [2/2]

BoundingKit& HPS::BoundingKit::operator= ( BoundingKit const &  in_kit)

Copies the source BoundingKit into this object.

Parameters
in_kitThe source BoundingKit to copy.
Returns
A reference to this object.

◆ operator==()

bool HPS::BoundingKit::operator== ( BoundingKit const &  in_kit) const

Check if the source BoundingKit is equivalent to this object.

Parameters
in_kitThe source BoundingKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::BoundingKit::Set ( BoundingKit const &  in_kit)

Copies all settings from the source BoundingKit into this object.

Parameters
in_kitThe source BoundingKit to copy.

◆ SetExclusion()

BoundingKit& HPS::BoundingKit::SetExclusion ( bool  in_exclude)

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/2]

BoundingKit& HPS::BoundingKit::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() [2/2]

BoundingKit& HPS::BoundingKit::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.

◆ Show()

void HPS::BoundingKit::Show ( BoundingKit out_kit) const

Copies all settings from this BoundingKit into the given BoundingKit.

Parameters
out_kitThe BoundingKit to populate with the contents of this object.

◆ ShowExclusion()

bool HPS::BoundingKit::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::BoundingKit::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.

◆ UnsetEverything()

BoundingKit& HPS::BoundingKit::UnsetEverything ( )

Removes all bounding settings from this object.

Returns
A reference to this object.

◆ UnsetExclusion()

BoundingKit& HPS::BoundingKit::UnsetExclusion ( )

Removes a bounding exclusion setting.

Returns
A reference to this object.

◆ UnsetVolume()

BoundingKit& HPS::BoundingKit::UnsetVolume ( )

Removes an explicitly set bounding, reverting to the automatically generated one.

Returns
A reference to this object.

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