< Home

< Table of Contents

REFERENCE MANUAL

HPS.ShellRelationOptionsKit Class Reference

The ShellRelationOptionsKit class is a user space object. More...

Inheritance diagram for HPS.ShellRelationOptionsKit:
HPS.Object

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. 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. 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. 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...
 
- Public Member Functions inherited from HPS.Object
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 HPS.ShellRelationOptionsKit GetDefault ()
 Creates a ShellRelationOptionsKit which contains the default settings. More...
 
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
 
HandleRef scptr
 

Detailed Description

The ShellRelationOptionsKit class is a user space object.

It is used for setting options for a shell relation operation. Calling ShellRelationOptionsKit::GetDefault() will return an options kit with values found in this table.

Constructor & Destructor Documentation

HPS.ShellRelationOptionsKit.ShellRelationOptionsKit ( )

The default constructor creates an empty ShellRelationOptionsKit object.

HPS.ShellRelationOptionsKit.ShellRelationOptionsKit ( HPS.ShellRelationOptionsKit  in_kit)

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_shell_relation_options_kit" kindref="compound">ShellRelationOptionsKit</ref> to copy.

Member Function Documentation

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

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

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_shell_relation_options_kit" kindref="compound">ShellRelationOptionsKit</ref> to consume.
override bool HPS.ShellRelationOptionsKit.Empty ( )
virtual

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.

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

Check if the source ShellRelationOptionsKit is equivalent to this ShellRelationOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_shell_relation_options_kit" kindref="compound">ShellRelationOptionsKit</ref> to compare to this <ref refid="class_h_p_s_1_1_shell_relation_options_kit" kindref="compound">ShellRelationOptionsKit</ref>.
Returns
true if the objects are equivalent, false otherwise.
static HPS.ShellRelationOptionsKit HPS.ShellRelationOptionsKit.GetDefault ( )
static

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.
override HPS.Type HPS.ShellRelationOptionsKit.ObjectType ( )
virtual

This function returns the type the object, as declared.

This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS.Object.

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

Copies the source ShellRelationOptionsKit into this ShellRelationOptionsKit.

Parameters
in_kitThe source <ref refid="class_h_p_s_1_1_shell_relation_options_kit" kindref="compound">ShellRelationOptionsKit</ref> to copy.
HPS.ShellRelationOptionsKit HPS.ShellRelationOptionsKit.SetNearestFaceCalculation ( bool  in_state)

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.
HPS.ShellRelationOptionsKit 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.

Parameters
in_testThe relation test to be performed.
Returns
A reference to this object.
HPS.ShellRelationOptionsKit HPS.ShellRelationOptionsKit.SetTolerance ( float  in_tolerance)

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.
HPS.ShellRelationOptionsKit 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.

Parameters
in_tree_contextThe tree context to use for this relation test.
Returns
A reference to this object.
void HPS.ShellRelationOptionsKit.Show ( out HPS.ShellRelationOptionsKit  out_kit)

Copies this ShellRelationOptionsKit into the given ShellRelationOptionsKit.

Parameters
out_kitThe <ref refid="class_h_p_s_1_1_shell_relation_options_kit" kindref="compound">ShellRelationOptionsKit</ref> to populate with the contents of this <ref refid="class_h_p_s_1_1_shell_relation_options_kit" kindref="compound">ShellRelationOptionsKit</ref>.
bool HPS.ShellRelationOptionsKit.ShowNearestFaceCalculation ( out bool  out_state)

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.
bool HPS.ShellRelationOptionsKit.ShowTest ( out HPS.Shell.RelationTest  out_test)

Shows the relation test for this ShellRelationOptionsKit.

Parameters
out_testThe relation test to be performed.
Returns
true if test was set, false otherwise.
bool HPS.ShellRelationOptionsKit.ShowTolerance ( out float  out_tolerance)

Shows the value of the tolerance for this ShellRelationOptionsKit.

Parameters
out_toleranceThe tolerance, in world units, for this <ref refid="class_h_p_s_1_1_shell_optimization_options_kit" kindref="compound">ShellOptimizationOptionsKit</ref>.
Returns
true if tolerance was set, false otherwise.
bool HPS.ShellRelationOptionsKit.ShowTreeContext ( out HPS.TreeContext  out_tree_context)

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

Removes all settings from this ShellRelationOptionsKit.

Returns
A reference to this object.
HPS.ShellRelationOptionsKit HPS.ShellRelationOptionsKit.UnsetNearestFaceCalculation ( )

Removes the nearest face calculation setting from this ShellRelationOptionsKit.

Returns
A reference to this object.
HPS.ShellRelationOptionsKit HPS.ShellRelationOptionsKit.UnsetTest ( )

Removes the test value from this ShellRelationOptionsKit.

Returns
A reference to this object.
HPS.ShellRelationOptionsKit HPS.ShellRelationOptionsKit.UnsetTolerance ( )

Removes the tolerance value from this ShellRelationOptionsKit.

Returns
A reference to this object.
HPS.ShellRelationOptionsKit HPS.ShellRelationOptionsKit.UnsetTreeContext ( )

Removes the tree context from this ShellRelationOptionsKit.

Returns
A reference to this object.

The documentation for this class was generated from the following file: