
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 (if the object is derived, this does not give the true type of the derived object). 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... | |
![]() | |
Kit (HPS.Kit in_that) | |
override HPS.Type | Type () |
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. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. 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 |
Detailed Description
The ShellKit class is a user space object. It contains results from a shell relation operation.
Constructor & Destructor Documentation
◆ ShellRelationResultsKit() [1/2]
|
inline |
The default constructor creates an empty ShellRelationResultsKit object.
◆ ShellRelationResultsKit() [2/2]
|
inline |
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.
Member Function Documentation
◆ Consume()
|
inline |
Copies the source ShellRelationResultsKit into this ShellRelationResultsKit and resets the source kit.
- Parameters
-
in_kit The source ShellRelationResultsKit to consume.
◆ 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()
|
inline |
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.
◆ 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()
|
inline |
Copies the source ShellRelationResultsKit into this ShellRelationResultsKit.
- Parameters
-
in_kit The source ShellRelationResultsKit to copy.
◆ Show()
|
inline |
Copies this ShellRelationResultsKit into the given ShellRelationResultsKit.
- Parameters
-
out_kit The ShellRelationResultsKit to populate with the contents of this ShellRelationResultsKit.
◆ ShowDistances()
|
inline |
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()
|
inline |
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()
|
inline |
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.
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.ShellRelationResultsKit.cs