Inheritance diagram for HPS.ShellRelationResultsKit:
HPS.Kit HPS.Object

Public Member Functions

void Consume (HPS.ShellRelationResultsKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.ShellRelationResultsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.ShellRelationResultsKit in_kit)
 
 ShellRelationResultsKit ()
 
 ShellRelationResultsKit (HPS.ShellRelationResultsKit in_kit)
 
void Show (out HPS.ShellRelationResultsKit out_kit)
 
bool ShowDistances (out float[] out_distances)
 
bool ShowNearestFaces (out ulong[] out_faces)
 
bool ShowRelations (out HPS.Shell.Relation[] out_results)
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static bool operator!= (HPS.ShellRelationResultsKit a, HPS.ShellRelationResultsKit b)
 
static bool operator== (HPS.ShellRelationResultsKit a, HPS.ShellRelationResultsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

The ShellKit class is a user space object. It contains results from a shell relation operation.

Constructor & Destructor Documentation

◆ ShellRelationResultsKit() [1/2]

HPS.ShellRelationResultsKit.ShellRelationResultsKit ( )
inline

The default constructor creates an empty ShellRelationResultsKit object.

◆ ShellRelationResultsKit() [2/2]

HPS.ShellRelationResultsKit.ShellRelationResultsKit ( HPS.ShellRelationResultsKit  in_kit)
inline

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

Parameters
in_kitThe source ShellRelationResultsKit to copy.

Member Function Documentation

◆ Consume()

void HPS.ShellRelationResultsKit.Consume ( HPS.ShellRelationResultsKit  in_kit)
inline

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

Parameters
in_kitThe source ShellRelationResultsKit to consume.

◆ Empty()

override bool HPS.ShellRelationResultsKit.Empty ( )
inlinevirtual

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 ( HPS.ShellRelationResultsKit  in_kit)
inline

Check if the source ShellRelationResultsKit is equivalent to this ShellRelationResultsKit.

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

◆ ObjectType()

override HPS.Type HPS.ShellRelationResultsKit.ObjectType ( )
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.

◆ Set()

void HPS.ShellRelationResultsKit.Set ( HPS.ShellRelationResultsKit  in_kit)
inline

Copies the source ShellRelationResultsKit into this ShellRelationResultsKit.

Parameters
in_kitThe source ShellRelationResultsKit to copy.

◆ Show()

void HPS.ShellRelationResultsKit.Show ( out HPS.ShellRelationResultsKit  out_kit)
inline

Copies this ShellRelationResultsKit into the given ShellRelationResultsKit.

Parameters
out_kitThe ShellRelationResultsKit to populate with the contents of this ShellRelationResultsKit.

◆ ShowDistances()

bool HPS.ShellRelationResultsKit.ShowDistances ( out float []  out_distances)
inline

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

Parameters
out_distancesThe 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 ( out ulong []  out_faces)
inline

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

Parameters
out_facesThe 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 ( out HPS.Shell.Relation []  out_results)
inline

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

Parameters
out_resultsThe relations, one per point, of points to a target shell.
Returns
true if any relations were requested and computed, false otherwise.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.ShellRelationResultsKit.cs