ShellRelationResultsKit
- class HPS.ShellRelationResultsKit : public HPS.Kit
The ShellKit class is a user space object. It contains results from a shell relation operation.
Public Functions
- void Consume (HPS.ShellRelationResultsKit in_kit)
Copies the source ShellRelationResultsKit into this ShellRelationResultsKit and resets the source kit.
- Param in_kit
The source ShellRelationResultsKit to consume.
- override void Dispose ()
- override bool Empty ()
Indicates whether this ShellRelationResultsKit has any values set on it.
- Return
true if no values are set on this ShellRelationResultsKit, false otherwise.
- bool Equals (HPS.ShellRelationResultsKit in_kit)
Check if the source ShellRelationResultsKit is equivalent to this ShellRelationResultsKit.
- Param in_kit
The source ShellRelationResultsKit to compare to this ShellRelationResultsKit.
- Return
true if the objects are equivalent, false otherwise.
- override bool Equals (Object obj)
- override int GetHashCode ()
- override HPS.Type ObjectType ()
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).
- Return
The declared type of the object in question, which may differ from the true, underlying type.
- void Set (HPS.ShellRelationResultsKit in_kit)
Copies the source ShellRelationResultsKit into this ShellRelationResultsKit.
- Param in_kit
The source ShellRelationResultsKit to copy.
- ShellRelationResultsKit ()
The default constructor creates an empty ShellRelationResultsKit object.
- ShellRelationResultsKit (HPS.ShellRelationResultsKit in_kit)
The copy constructor creates a new ShellRelationResultsKit object that contains the same settings as the source ShellRelationResultsKit.
- Param in_kit
The source ShellRelationResultsKit to copy.
- void Show (out HPS.ShellRelationResultsKit out_kit)
Copies this ShellRelationResultsKit into the given ShellRelationResultsKit.
- Param out_kit
The ShellRelationResultsKit to populate with the contents of this ShellRelationResultsKit.
- bool ShowDistances (out float[] out_distances)
Shows the smallest distance of each point in a shell relation computation to the target shell.
- Param out_distances
The smallest distances, one per point, of points to a target shell.
- Return
true if distances were requested and computed, false otherwise.
- bool ShowNearestFaces (out ulong[] out_faces)
Shows the nearest face in the target shell for each of a set of points.
- Param out_faces
The nearest faces, one per point, in the target shell to a set of points.
- Return
true if nearest faces were requested and computed, false otherwise.
- bool ShowRelations (out HPS.Shell.Relation[] out_results)
Shows the relation of each point in a shell relation computation to the target shell.
- Param out_results
The relations, one per point, of points to a target shell.
- Return
true if any relations were requested and computed, false otherwise.
Public Static Functions
- bool operator!= (HPS.ShellRelationResultsKit a, HPS.ShellRelationResultsKit b)
- bool operator== (HPS.ShellRelationResultsKit a, HPS.ShellRelationResultsKit b)