Inheritance diagram for HPS.ShellRelationOptionsKit:
HPS.Kit HPS.Object

Public Member Functions

void Consume (HPS.ShellRelationOptionsKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.ShellRelationOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.ShellRelationOptionsKit in_kit)
 
HPS.ShellRelationOptionsKit SetNearestFaceCalculation (bool in_state)
 
HPS.ShellRelationOptionsKit SetTest (HPS.Shell.RelationTest in_test)
 
HPS.ShellRelationOptionsKit SetTolerance (float in_tolerance)
 
HPS.ShellRelationOptionsKit SetTreeContext (HPS.TreeContext in_tree_context)
 
 ShellRelationOptionsKit ()
 
 ShellRelationOptionsKit (HPS.ShellRelationOptionsKit in_kit)
 
void Show (out HPS.ShellRelationOptionsKit out_kit)
 
bool ShowNearestFaceCalculation (out bool out_state)
 
bool ShowTest (out HPS.Shell.RelationTest out_test)
 
bool ShowTolerance (out float out_tolerance)
 
bool ShowTreeContext (out HPS.TreeContext out_tree_context)
 
HPS.ShellRelationOptionsKit UnsetEverything ()
 
HPS.ShellRelationOptionsKit UnsetNearestFaceCalculation ()
 
HPS.ShellRelationOptionsKit UnsetTest ()
 
HPS.ShellRelationOptionsKit UnsetTolerance ()
 
HPS.ShellRelationOptionsKit UnsetTreeContext ()
 
- Public Member Functions inherited from HPS.Kit
 Kit (HPS.Kit in_that)
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.ShellRelationOptionsKit GetDefault ()
 
static bool operator!= (HPS.ShellRelationOptionsKit a, HPS.ShellRelationOptionsKit b)
 
static bool operator== (HPS.ShellRelationOptionsKit a, HPS.ShellRelationOptionsKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ ShellRelationOptionsKit() [1/2]

HPS.ShellRelationOptionsKit.ShellRelationOptionsKit ( )
inline

The default constructor creates an empty ShellRelationOptionsKit object.

◆ ShellRelationOptionsKit() [2/2]

HPS.ShellRelationOptionsKit.ShellRelationOptionsKit ( HPS.ShellRelationOptionsKit  in_kit)
inline

The copy constructor creates a new ShellRelationOptionsKit object that contains the same settings as the source ShellRelationOptionsKit.

Parameters
in_kitThe source ShellRelationOptionsKit to copy.

Member Function Documentation

◆ Consume()

void HPS.ShellRelationOptionsKit.Consume ( HPS.ShellRelationOptionsKit  in_kit)
inline

Copies the source ShellRelationOptionsKit into this ShellRelationOptionsKit and resets the source kit.

Parameters
in_kitThe source ShellRelationOptionsKit to consume.

◆ Empty()

override bool HPS.ShellRelationOptionsKit.Empty ( )
inlinevirtual

Indicates whether this ShellRelationOptionsKit has any values set on it.

Returns
true if no values are set on this ShellRelationOptionsKit, false otherwise.

Reimplemented from HPS.Object.

◆ Equals()

bool HPS.ShellRelationOptionsKit.Equals ( HPS.ShellRelationOptionsKit  in_kit)
inline

Check if the source ShellRelationOptionsKit is equivalent to this ShellRelationOptionsKit.

Parameters
in_kitThe source ShellRelationOptionsKit to compare to this ShellRelationOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.ShellRelationOptionsKit HPS.ShellRelationOptionsKit.GetDefault ( )
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.

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()

void HPS.ShellRelationOptionsKit.Set ( HPS.ShellRelationOptionsKit  in_kit)
inline

Copies the source ShellRelationOptionsKit into this ShellRelationOptionsKit.

Parameters
in_kitThe source ShellRelationOptionsKit to copy.

◆ SetNearestFaceCalculation()

HPS.ShellRelationOptionsKit HPS.ShellRelationOptionsKit.SetNearestFaceCalculation ( bool  in_state)
inline

Sets whether the nearest face should be calculated in addition to the primary relation test.

Parameters
in_stateWhether to perform nearest face calculation.
Returns
A reference to this object.

◆ SetTest()

HPS.ShellRelationOptionsKit HPS.ShellRelationOptionsKit.SetTest ( HPS.Shell.RelationTest  in_test)
inline

Sets the type of relation test that should be performed. This determines what kind of information is available from the results.

Parameters
in_testThe relation test to be performed.
Returns
A reference to this object.

◆ SetTolerance()

HPS.ShellRelationOptionsKit HPS.ShellRelationOptionsKit.SetTolerance ( float  in_tolerance)
inline

Sets the tolerance within which points will be considered on the shell.

Parameters
in_toleranceThe tolerance, in world space units, to use for this relation test.
Returns
A reference to this object.

◆ SetTreeContext()

HPS.ShellRelationOptionsKit HPS.ShellRelationOptionsKit.SetTreeContext ( HPS.TreeContext  in_tree_context)
inline

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_contextThe tree context to use for this relation test.
Returns
A reference to this object.

◆ Show()

void HPS.ShellRelationOptionsKit.Show ( out HPS.ShellRelationOptionsKit  out_kit)
inline

Copies this ShellRelationOptionsKit into the given ShellRelationOptionsKit.

Parameters
out_kitThe ShellRelationOptionsKit to populate with the contents of this ShellRelationOptionsKit.

◆ ShowNearestFaceCalculation()

bool HPS.ShellRelationOptionsKit.ShowNearestFaceCalculation ( out bool  out_state)
inline

Shows the nearest face calculation setting for this ShellRelationOptionsKit.

Parameters
out_stateWhether to perform nearest face calculation.
Returns
true if nearest face calculation was specified, false otherwise.

◆ ShowTest()

bool HPS.ShellRelationOptionsKit.ShowTest ( out HPS.Shell.RelationTest  out_test)
inline

Shows the relation test for this ShellRelationOptionsKit.

Parameters
out_testThe 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
out_toleranceThe tolerance, in world units, for this ShellOptimizationOptionsKit.
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_contextThe tree context to use for this relation test.
Returns
true if a tree context was set, false otherwise.

◆ UnsetEverything()

HPS.ShellRelationOptionsKit HPS.ShellRelationOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ShellRelationOptionsKit.

Returns
A reference to this object.

◆ UnsetNearestFaceCalculation()

HPS.ShellRelationOptionsKit HPS.ShellRelationOptionsKit.UnsetNearestFaceCalculation ( )
inline

Removes the nearest face calculation setting from this ShellRelationOptionsKit.

Returns
A reference to this object.

◆ UnsetTest()

HPS.ShellRelationOptionsKit HPS.ShellRelationOptionsKit.UnsetTest ( )
inline

Removes the test value from this ShellRelationOptionsKit.

Returns
A reference to this object.

◆ UnsetTolerance()

HPS.ShellRelationOptionsKit HPS.ShellRelationOptionsKit.UnsetTolerance ( )
inline

Removes the tolerance value from this ShellRelationOptionsKit.

Returns
A reference to this object.

◆ UnsetTreeContext()

HPS.ShellRelationOptionsKit HPS.ShellRelationOptionsKit.UnsetTreeContext ( )
inline

Removes the tree context from this ShellRelationOptionsKit.

Returns
A reference to this object.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.ShellRelationOptionsKit.cs