The HPS::ShellRelationOptionsKit class is a user space object. It is used for setting options for a shell relation operation. Calling HPS::ShellRelationOptionsKit::GetDefault() will return an options kit with values found in this table. More...
Public Member Functions | |
void | Consume (HPS.ShellRelationOptionsKit in_kit) |
Copies the source ShellRelationOptionsKit into this ShellRelationOptionsKit and resets the source kit. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ShellRelationOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.ShellRelationOptionsKit in_kit) |
Check if the source ShellRelationOptionsKit is equivalent to this ShellRelationOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.ShellRelationOptionsKit in_kit) |
Copies the source ShellRelationOptionsKit into this ShellRelationOptionsKit. More... | |
HPS.ShellRelationOptionsKit | SetNearestFaceCalculation (bool in_state) |
Sets whether the nearest face should be calculated in addition to the primary relation test. More... | |
HPS.ShellRelationOptionsKit | SetTest (HPS.Shell.RelationTest in_test) |
Sets the type of relation test that should be performed. This determines what kind of information is available from the results. More... | |
HPS.ShellRelationOptionsKit | SetTolerance (float in_tolerance) |
Sets the tolerance within which points will be considered on the shell. More... | |
HPS.ShellRelationOptionsKit | SetTreeContext (HPS.TreeContext in_tree_context) |
Sets a tree context to be used for this relation test. If many relation or selections are going to be computed without modifying the segment tree, using the same tree context for all of them can be a significant optimization. If one is not specified, a new one is computed each time. More... | |
ShellRelationOptionsKit () | |
The default constructor creates an empty ShellRelationOptionsKit object. More... | |
ShellRelationOptionsKit (HPS.ShellRelationOptionsKit in_kit) | |
The copy constructor creates a new ShellRelationOptionsKit object that contains the same settings as the source ShellRelationOptionsKit. More... | |
void | Show (out HPS.ShellRelationOptionsKit out_kit) |
Copies this ShellRelationOptionsKit into the given ShellRelationOptionsKit. More... | |
bool | ShowNearestFaceCalculation (out bool out_state) |
Shows the nearest face calculation setting for this ShellRelationOptionsKit. More... | |
bool | ShowTest (out HPS.Shell.RelationTest out_test) |
Shows the relation test for this ShellRelationOptionsKit. More... | |
bool | ShowTolerance (out float out_tolerance) |
Shows the value of the tolerance for this ShellRelationOptionsKit. More... | |
bool | ShowTreeContext (out HPS.TreeContext out_tree_context) |
Shows the tree context for this ShellRelationOptionsKit. More... | |
HPS.ShellRelationOptionsKit | UnsetEverything () |
Removes all settings from this ShellRelationOptionsKit. More... | |
HPS.ShellRelationOptionsKit | UnsetNearestFaceCalculation () |
Removes the nearest face calculation setting from this ShellRelationOptionsKit. More... | |
HPS.ShellRelationOptionsKit | UnsetTest () |
Removes the test value from this ShellRelationOptionsKit. More... | |
HPS.ShellRelationOptionsKit | UnsetTolerance () |
Removes the tolerance value from this ShellRelationOptionsKit. More... | |
HPS.ShellRelationOptionsKit | UnsetTreeContext () |
Removes the tree context from this ShellRelationOptionsKit. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. 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... | |
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... | |
Static Public Member Functions | |
static HPS.ShellRelationOptionsKit | GetDefault () |
Creates a ShellRelationOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default. More... | |
static bool | operator!= (HPS.ShellRelationOptionsKit a, HPS.ShellRelationOptionsKit b) |
static bool | operator== (HPS.ShellRelationOptionsKit a, HPS.ShellRelationOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The HPS::ShellRelationOptionsKit class is a user space object. It is used for setting options for a shell relation operation. Calling HPS::ShellRelationOptionsKit::GetDefault() will return an options kit with values found in this table.
|
inline |
The default constructor creates an empty ShellRelationOptionsKit object.
|
inline |
The copy constructor creates a new ShellRelationOptionsKit object that contains the same settings as the source ShellRelationOptionsKit.
in_kit | The source ShellRelationOptionsKit to copy. |
|
inline |
Copies the source ShellRelationOptionsKit into this ShellRelationOptionsKit and resets the source kit.
in_kit | The source ShellRelationOptionsKit to consume. |
|
inlinevirtual |
Indicates whether this ShellRelationOptionsKit has any values set on it.
Reimplemented from HPS.Object.
|
inline |
Check if the source ShellRelationOptionsKit is equivalent to this ShellRelationOptionsKit.
in_kit | The source ShellRelationOptionsKit to compare to this ShellRelationOptionsKit. |
|
inlinestatic |
Creates a ShellRelationOptionsKit which contains the default settings. The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.
|
inlinevirtual |
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.
|
inline |
Copies the source ShellRelationOptionsKit into this ShellRelationOptionsKit.
in_kit | The source ShellRelationOptionsKit to copy. |
|
inline |
Sets whether the nearest face should be calculated in addition to the primary relation test.
in_state | Whether to perform nearest face calculation. |
|
inline |
Sets the type of relation test that should be performed. This determines what kind of information is available from the results.
in_test | The relation test to be performed. |
|
inline |
Sets the tolerance within which points will be considered on the shell.
in_tolerance | The tolerance, in world space units, to use for this relation test. |
|
inline |
Sets a tree context to be used for this relation test. If many relation or selections are going to be computed without modifying the segment tree, using the same tree context for all of them can be a significant optimization. If one is not specified, a new one is computed each time.
in_tree_context | The tree context to use for this relation test. |
|
inline |
Copies this ShellRelationOptionsKit into the given ShellRelationOptionsKit.
out_kit | The ShellRelationOptionsKit to populate with the contents of this ShellRelationOptionsKit. |
|
inline |
Shows the nearest face calculation setting for this ShellRelationOptionsKit.
out_state | Whether to perform nearest face calculation. |
|
inline |
Shows the relation test for this ShellRelationOptionsKit.
out_test | The relation test to be performed. |
|
inline |
Shows the value of the tolerance for this ShellRelationOptionsKit.
out_tolerance | The tolerance, in world units, for this ShellOptimizationOptionsKit. |
|
inline |
Shows the tree context for this ShellRelationOptionsKit.
out_tree_context | The tree context to use for this relation test. |
|
inline |
Removes all settings from this ShellRelationOptionsKit.
|
inline |
Removes the nearest face calculation setting from this ShellRelationOptionsKit.
|
inline |
Removes the test value from this ShellRelationOptionsKit.
|
inline |
Removes the tolerance value from this ShellRelationOptionsKit.
|
inline |
Removes the tree context from this ShellRelationOptionsKit.