The HPS::BoundingKit class is a user space object, useful for carrying a group of attribute settings. More...

#include <hps.h>

Inheritance diagram for HPS::BoundingKit:

Collaboration diagram for HPS::BoundingKit:

Public Member Functions
	BoundingKit ()
	Initializes an empty kit. More...

	BoundingKit (BoundingKit const &in_kit)
	The copy constructor creates a new BoundingKit object that contains the same settings as the source object. More...

	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. More...

BoundingKit &	operator= (BoundingKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this BoundingKit thereby avoiding a copy. More...

virtual	~BoundingKit ()
	Destroy this kit. More...

HPS::Type	ObjectType () const

void	Set (BoundingKit const &in_kit)
	Copies all settings from the source BoundingKit into this object. More...

void	Show (BoundingKit &out_kit) const
	Copies all settings from this BoundingKit into the given BoundingKit. More...

BoundingKit &	operator= (BoundingKit const &in_kit)
	Copies the source BoundingKit into this object. More...

bool	Empty () const
	Indicates whether this object has any values set on it. More...

bool	Equals (BoundingKit const &in_kit) const
	Check if the source BoundingKit is equivalent to this object. More...

bool	operator== (BoundingKit const &in_kit) const
	Check if the source BoundingKit is equivalent to this object. More...

bool	operator!= (BoundingKit const &in_kit) const
	Check if the source BoundingKit is not equivalent to this object. More...

BoundingKit &	SetVolume (SimpleSphere const &in_sphere)
	Explicitly sets the local bounding. More...

BoundingKit &	SetVolume (SimpleCuboid const &in_cuboid)
	Explicitly sets the local bounding. More...

BoundingKit &	SetExclusion (bool in_exclude)
	Controls whether this segment should be excluded when computing bounding volumes. More...

BoundingKit &	UnsetVolume ()
	Removes an explicitly set bounding, reverting to the automatically generated one. More...

BoundingKit &	UnsetExclusion ()
	Removes a bounding exclusion setting. More...

BoundingKit &	UnsetEverything ()
	Removes all bounding settings from this object. More...

bool	ShowVolume (SimpleSphere &out_sphere, SimpleCuboid &out_cuboid) const
	Shows the bounding volume. More...

bool	ShowExclusion (bool &out_exclusion) const
	Shows the bounding exclusion setting. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static BoundingKit	GetDefault ()
	Creates a BoundingKit which contains the default settings. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::BoundingKit

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_kit The 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_that An rvalue reference to a BoundingKit to take the impl from.

◆ ~BoundingKit()

virtual HPS::BoundingKit::~BoundingKit ( )

virtual

Destroy this kit.

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ 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_kit The source BoundingKit to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

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

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::BoundingKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The 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_that An 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_kit The 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_kit The source BoundingKit to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

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

Copies all settings from the source BoundingKit into this object.

Parameters

in_kit The 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_exclude Whether 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_sphere The 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_cuboid The 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_kit The 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_exclusion Whether 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_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::Kit::Type ( ) const

inlinevirtualinherited

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()

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.

Member Data Documentation

◆ staticType

const HPS::Type HPS::BoundingKit::staticType = HPS::Type::BoundingKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BoundingKit() [1/3]

◆ BoundingKit() [2/3]

◆ BoundingKit() [3/3]

◆ ~BoundingKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetExclusion()

◆ SetVolume() [1/2]

◆ SetVolume() [2/2]

◆ Show()

◆ ShowExclusion()

◆ ShowVolume()

◆ Type()

◆ UnsetEverything()

◆ UnsetExclusion()

◆ UnsetVolume()

Member Data Documentation

◆ staticType