The ShellKit class is a user space object. More...

#include <hps.h>

Inheritance diagram for HPS::ShellRelationResultsKit:

Collaboration diagram for HPS::ShellRelationResultsKit:

Public Member Functions
	ShellRelationResultsKit ()
	The default constructor creates an empty ShellRelationResultsKit object. More...

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

	ShellRelationResultsKit (ShellRelationResultsKit &&in_that)
	The move constructor creates a ShellRelationResultsKit by transferring the underlying impl of the rvalue reference to this ShellRelationResultsKit thereby avoiding a copy and allocation. More...

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

virtual	~ShellRelationResultsKit ()

HPS::Type	ObjectType () const

void	Consume (ShellRelationResultsKit &in_kit)
	Copies the source ShellRelationResultsKit into this ShellRelationResultsKit and resets the source kit. More...

void	Set (ShellRelationResultsKit const &in_kit)
	Copies the source ShellRelationResultsKit into this ShellRelationResultsKit. More...

void	Show (ShellRelationResultsKit &out_kit) const
	Copies this ShellRelationResultsKit into the given ShellRelationResultsKit. More...

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

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

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

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

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

bool	ShowRelations (ShellRelationArray &out_results) const
	Shows the relation of each point in a shell relation computation to the target shell. More...

bool	ShowNearestFaces (SizeTArray &out_faces) const
	Shows the nearest face in the target shell for each of a set of points. More...

bool	ShowDistances (FloatArray &out_distances) const
	Shows the smallest distance of each point in a shell relation computation to the target shell. 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
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

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

Detailed Description

The ShellKit class is a user space object.

It contains results from a shell relation operation.

Constructor & Destructor Documentation

◆ ShellRelationResultsKit() [1/3]

HPS::ShellRelationResultsKit::ShellRelationResultsKit ( )

The default constructor creates an empty ShellRelationResultsKit object.

◆ ShellRelationResultsKit() [2/3]

HPS::ShellRelationResultsKit::ShellRelationResultsKit ( ShellRelationResultsKit const & in_kit )

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

Parameters

in_kit The source ShellRelationResultsKit to copy.

◆ ShellRelationResultsKit() [3/3]

HPS::ShellRelationResultsKit::ShellRelationResultsKit ( ShellRelationResultsKit && in_that )

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

Parameters

in_that An rvalue reference to a ShellRelationResultsKit to take the impl from.

◆ ~ShellRelationResultsKit()

virtual HPS::ShellRelationResultsKit::~ShellRelationResultsKit ( )

virtual

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.

◆ Consume()

void HPS::ShellRelationResultsKit::Consume ( ShellRelationResultsKit & in_kit )

Copies the source ShellRelationResultsKit into this ShellRelationResultsKit and resets the source kit.

Parameters

in_kit The source ShellRelationResultsKit to consume.

◆ Empty()

bool HPS::ShellRelationResultsKit::Empty ( ) const

virtual

Indicates whether this ShellRelationResultsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

Check if the source ShellRelationResultsKit is equivalent to this ShellRelationResultsKit.

Parameters

in_kit The source ShellRelationResultsKit to compare to this ShellRelationResultsKit.

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.

◆ 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::ShellRelationResultsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

Check if the source ShellRelationResultsKit is not equivalent to this ShellRelationResultsKit.

Parameters

in_kit The source ShellRelationResultsKit to compare to this ShellRelationResultsKit.

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

◆ operator=() [1/2]

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

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

Parameters

in_that An rvalue reference to a ShellRelationResultsKit to take the impl from.

Returns: A reference to this ShellRelationResultsKit.

◆ operator=() [2/2]

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

Copies the source ShellRelationResultsKit into this ShellRelationResultsKit.

Parameters

in_kit The source ShellRelationResultsKit to copy.

Returns: A reference to this ShellRelationResultsKit.

◆ operator==()

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

Check if the source ShellRelationResultsKit is equivalent to this ShellRelationResultsKit.

Parameters

in_kit The source ShellRelationResultsKit to compare to this ShellRelationResultsKit.

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::ShellRelationResultsKit::Set ( ShellRelationResultsKit const & in_kit )

Copies the source ShellRelationResultsKit into this ShellRelationResultsKit.

Parameters

in_kit The source ShellRelationResultsKit to copy.

◆ Show()

void HPS::ShellRelationResultsKit::Show ( ShellRelationResultsKit & out_kit ) const

Copies this ShellRelationResultsKit into the given ShellRelationResultsKit.

Parameters

out_kit The ShellRelationResultsKit to populate with the contents of this ShellRelationResultsKit.

◆ ShowDistances()

bool HPS::ShellRelationResultsKit::ShowDistances ( FloatArray & out_distances ) const

Shows the smallest distance of each point in a shell relation computation to the target shell.

Parameters

out_distances The smallest distances, one per point, of points to a target shell.

Returns: true if distances were requested and computed, false otherwise.

◆ ShowNearestFaces()

bool HPS::ShellRelationResultsKit::ShowNearestFaces ( SizeTArray & out_faces ) const

Shows the nearest face in the target shell for each of a set of points.

Parameters

out_faces The nearest faces, one per point, in the target shell to a set of points.

Returns: true if nearest faces were requested and computed, false otherwise.

◆ ShowRelations()

bool HPS::ShellRelationResultsKit::ShowRelations ( ShellRelationArray & out_results ) const

Shows the relation of each point in a shell relation computation to the target shell.

Parameters

out_results The relations, one per point, of points to a target shell.

Returns: true if any relations were requested and computed, 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.

Member Data Documentation

◆ staticType

const HPS::Type HPS::ShellRelationResultsKit::staticType = HPS::Type::ShellRelationResultsKit

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

◆ ShellRelationResultsKit() [1/3]

◆ ShellRelationResultsKit() [2/3]

◆ ShellRelationResultsKit() [3/3]

◆ ~ShellRelationResultsKit()

Member Function Documentation

◆ ClassID()

◆ Consume()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ Show()

◆ ShowDistances()

◆ ShowNearestFaces()

◆ ShowRelations()

◆ Type()

Member Data Documentation

◆ staticType