|
override void | deleteCptr () |
|
virtual IntPtr | GetNonDirectorClassID () |
|
|
bool | cMemOwn |
|
HandleRef | cptr |
|
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.
◆ ShellRelationOptionsKit() [1/2]
HPS.ShellRelationOptionsKit.ShellRelationOptionsKit |
( |
| ) |
|
|
inline |
◆ ShellRelationOptionsKit() [2/2]
◆ Consume()
◆ Empty()
override bool HPS.ShellRelationOptionsKit.Empty |
( |
| ) |
|
|
inlinevirtual |
◆ Equals()
◆ 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.
- Returns
- A ShellRelationOptionsKit with the default settings.
◆ ObjectType()
override HPS.Type HPS.ShellRelationOptionsKit.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()
◆ SetNearestFaceCalculation()
Sets whether the nearest face should be calculated in addition to the primary relation test.
- Parameters
-
in_state | Whether to perform nearest face calculation. |
- Returns
- A reference to this object.
◆ SetTest()
Sets the type of relation test that should be performed. This determines what kind of information is available from the results.
- Parameters
-
in_test | The relation test to be performed. |
- Returns
- A reference to this object.
◆ SetTolerance()
Sets the tolerance within which points will be considered on the shell.
- Parameters
-
in_tolerance | The tolerance, in world space units, to use for this relation test. |
- Returns
- A reference to this object.
◆ SetTreeContext()
Sets a TreeContext 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 a TreeContext is not specified, a new one is computed each time.
- Parameters
-
in_tree_context | The tree context to use for this relation test. |
- Returns
- A reference to this object.
◆ Show()
◆ ShowNearestFaceCalculation()
bool HPS.ShellRelationOptionsKit.ShowNearestFaceCalculation |
( |
out bool |
out_state | ) |
|
|
inline |
Shows the nearest face calculation setting for this ShellRelationOptionsKit.
- Parameters
-
out_state | Whether to perform nearest face calculation. |
- Returns
- true if nearest face calculation was specified, false otherwise.
◆ ShowTest()
Shows the relation test for this ShellRelationOptionsKit.
- Parameters
-
out_test | The relation test to be performed. |
- Returns
- true if test was set, false otherwise.
◆ ShowTolerance()
bool HPS.ShellRelationOptionsKit.ShowTolerance |
( |
out float |
out_tolerance | ) |
|
|
inline |
Shows the value of the tolerance for this ShellRelationOptionsKit.
- Parameters
-
- Returns
- true if tolerance was set, false otherwise.
◆ ShowTreeContext()
bool HPS.ShellRelationOptionsKit.ShowTreeContext |
( |
out HPS.TreeContext |
out_tree_context | ) |
|
|
inline |
Shows the tree context for this ShellRelationOptionsKit.
- Parameters
-
out_tree_context | The tree context to use for this relation test. |
- Returns
- true if a tree context was set, false otherwise.
◆ UnsetEverything()
◆ UnsetNearestFaceCalculation()
◆ UnsetTest()
◆ UnsetTolerance()
◆ UnsetTreeContext()
The documentation for this class was generated from the following file:
- internals/hps_core/source/cs/HPS.ShellRelationOptionsKit.cs