REFERENCE MANUAL
#include <hps.h>
Public Member Functions | |
void | Consume (ShellRelationResultsKit &in_kit) |
bool | Empty () const |
bool | Equals (ShellRelationResultsKit const &in_kit) const |
Type | ObjectType () const |
bool | operator!= (ShellRelationResultsKit const &in_kit) const |
ShellRelationResultsKit & | operator= (ShellRelationResultsKit &&in_that) |
ShellRelationResultsKit & | operator= (ShellRelationResultsKit const &in_kit) |
bool | operator== (ShellRelationResultsKit const &in_kit) const |
void | Set (ShellRelationResultsKit const &in_kit) |
ShellRelationResultsKit () | |
ShellRelationResultsKit (ShellRelationResultsKit const &in_kit) | |
ShellRelationResultsKit (ShellRelationResultsKit &&in_that) | |
void | Show (ShellRelationResultsKit &out_kit) const |
bool | ShowDistances (FloatArray &out_distances) const |
bool | ShowNearestFaces (SizeTArray &out_faces) const |
bool | ShowRelations (ShellRelationArray &out_results) const |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
The ShellKit class is a user space object. It contains results from a shell relation operation.
ShellRelationResultsKit::ShellRelationResultsKit | ( | ) |
The default constructor creates an empty ShellRelationResultsKit object.
ShellRelationResultsKit::ShellRelationResultsKit | ( | ShellRelationResultsKit const & | in_kit | ) |
The copy constructor creates a new ShellRelationResultsKit object that contains the same settings as the source ShellRelationResultsKit.
in_kit | The source ShellRelationResultsKit to copy. |
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.
in_that | An rvalue reference to a ShellRelationResultsKit to take the impl from. |
void ShellRelationResultsKit::Consume | ( | ShellRelationResultsKit & | in_kit | ) |
Copies the source ShellRelationResultsKit into this ShellRelationResultsKit and resets the source kit.
in_kit | The source ShellRelationResultsKit to consume. |
|
virtual |
Indicates whether this ShellRelationResultsKit has any values set on it.
Reimplemented from Object.
bool ShellRelationResultsKit::Equals | ( | ShellRelationResultsKit const & | in_kit | ) | const |
Check if the source ShellRelationResultsKit is equivalent to this ShellRelationResultsKit.
in_kit | The source ShellRelationResultsKit to compare to this ShellRelationResultsKit. |
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
bool ShellRelationResultsKit::operator!= | ( | ShellRelationResultsKit const & | in_kit | ) | const |
Check if the source ShellRelationResultsKit is not equivalent to this ShellRelationResultsKit.
in_kit | The source ShellRelationResultsKit to compare to this ShellRelationResultsKit. |
ShellRelationResultsKit& ShellRelationResultsKit::operator= | ( | ShellRelationResultsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ShellRelationResultsKit thereby avoiding a copy.
in_that | An rvalue reference to a ShellRelationResultsKit to take the impl from. |
ShellRelationResultsKit& ShellRelationResultsKit::operator= | ( | ShellRelationResultsKit const & | in_kit | ) |
Copies the source ShellRelationResultsKit into this ShellRelationResultsKit.
in_kit | The source ShellRelationResultsKit to copy. |
bool ShellRelationResultsKit::operator== | ( | ShellRelationResultsKit const & | in_kit | ) | const |
Check if the source ShellRelationResultsKit is equivalent to this ShellRelationResultsKit.
in_kit | The source ShellRelationResultsKit to compare to this ShellRelationResultsKit. |
void ShellRelationResultsKit::Set | ( | ShellRelationResultsKit const & | in_kit | ) |
Copies the source ShellRelationResultsKit into this ShellRelationResultsKit.
in_kit | The source ShellRelationResultsKit to copy. |
void ShellRelationResultsKit::Show | ( | ShellRelationResultsKit & | out_kit | ) | const |
Copies this ShellRelationResultsKit into the given ShellRelationResultsKit.
out_kit | The ShellRelationResultsKit to populate with the contents of this ShellRelationResultsKit. |
bool ShellRelationResultsKit::ShowDistances | ( | FloatArray & | out_distances | ) | const |
Shows the smallest distance of each point in a shell relation computation to the target shell.
out_distances | The smallest distances, one per point, of points to a target shell. |
bool ShellRelationResultsKit::ShowNearestFaces | ( | SizeTArray & | out_faces | ) | const |
Shows the nearest face in the target shell for each of a set of points.
out_faces | The nearest faces, one per point, in the target shell to a set of points. |
bool ShellRelationResultsKit::ShowRelations | ( | ShellRelationArray & | out_results | ) | const |
Shows the relation of each point in a shell relation computation to the target shell.
out_results | The relations, one per point, of points to a target shell. |