REFERENCE MANUAL
The ShellKit class is a user space object. More...
Public Member Functions | |
void | Consume (HPS.ShellRelationResultsKit in_kit) |
Copies the source ShellRelationResultsKit into this ShellRelationResultsKit and resets the source kit. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ShellRelationResultsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.ShellRelationResultsKit in_kit) |
Check if the source ShellRelationResultsKit is equivalent to this ShellRelationResultsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
void | Set (HPS.ShellRelationResultsKit in_kit) |
Copies the source ShellRelationResultsKit into this ShellRelationResultsKit. More... | |
ShellRelationResultsKit () | |
The default constructor creates an empty ShellRelationResultsKit object. More... | |
ShellRelationResultsKit (HPS.ShellRelationResultsKit in_kit) | |
The copy constructor creates a new ShellRelationResultsKit object that contains the same settings as the source ShellRelationResultsKit. More... | |
void | Show (out HPS.ShellRelationResultsKit out_kit) |
Copies this ShellRelationResultsKit into the given ShellRelationResultsKit. More... | |
bool | ShowDistances (out float[] out_distances) |
Shows the smallest distance of each point in a shell relation computation to the target shell. More... | |
bool | ShowNearestFaces (out ulong[] out_faces) |
Shows the nearest face in the target shell for each of a set of points. More... | |
bool | ShowRelations (out HPS.Shell.Relation[] out_results) |
Shows the relation of each point in a shell relation computation to the target shell. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.ShellRelationResultsKit a, HPS.ShellRelationResultsKit b) |
static bool | operator== (HPS.ShellRelationResultsKit a, HPS.ShellRelationResultsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The ShellKit class is a user space object.
It contains results from a shell relation operation.
HPS.ShellRelationResultsKit.ShellRelationResultsKit | ( | ) |
The default constructor creates an empty ShellRelationResultsKit object.
HPS.ShellRelationResultsKit.ShellRelationResultsKit | ( | HPS.ShellRelationResultsKit | in_kit | ) |
The copy constructor creates a new ShellRelationResultsKit object that contains the same settings as the source ShellRelationResultsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_shell_relation_results_kit" kindref="compound">ShellRelationResultsKit</ref> to copy. |
void HPS.ShellRelationResultsKit.Consume | ( | HPS.ShellRelationResultsKit | in_kit | ) |
Copies the source ShellRelationResultsKit into this ShellRelationResultsKit and resets the source kit.
in_kit | The source <ref refid="class_h_p_s_1_1_shell_relation_results_kit" kindref="compound">ShellRelationResultsKit</ref> to consume. |
|
virtual |
Indicates whether this ShellRelationResultsKit has any values set on it.
Reimplemented from HPS.Object.
bool HPS.ShellRelationResultsKit.Equals | ( | HPS.ShellRelationResultsKit | in_kit | ) |
Check if the source ShellRelationResultsKit is equivalent to this ShellRelationResultsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_shell_relation_results_kit" kindref="compound">ShellRelationResultsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_shell_relation_results_kit" kindref="compound">ShellRelationResultsKit</ref>. |
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
void HPS.ShellRelationResultsKit.Set | ( | HPS.ShellRelationResultsKit | in_kit | ) |
Copies the source ShellRelationResultsKit into this ShellRelationResultsKit.
in_kit | The source <ref refid="class_h_p_s_1_1_shell_relation_results_kit" kindref="compound">ShellRelationResultsKit</ref> to copy. |
void HPS.ShellRelationResultsKit.Show | ( | out HPS.ShellRelationResultsKit | out_kit | ) |
Copies this ShellRelationResultsKit into the given ShellRelationResultsKit.
out_kit | The <ref refid="class_h_p_s_1_1_shell_relation_results_kit" kindref="compound">ShellRelationResultsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_shell_relation_results_kit" kindref="compound">ShellRelationResultsKit</ref>. |
bool HPS.ShellRelationResultsKit.ShowDistances | ( | out float[] | out_distances | ) |
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 HPS.ShellRelationResultsKit.ShowNearestFaces | ( | out ulong[] | out_faces | ) |
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 HPS.ShellRelationResultsKit.ShowRelations | ( | out HPS.Shell.Relation[] | out_results | ) |
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. |