ShellRelationOptionsKit

class HPS.ShellRelationOptionsKit : HPS.Kit

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.

Public Functions

void Consume (HPS.ShellRelationOptionsKit in_kit)

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

Param in_kit:The source ShellRelationOptionsKit to consume.

override void Dispose ()

override bool Empty ()

Indicates whether this ShellRelationOptionsKit has any values set on it.

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

bool Equals (HPS.ShellRelationOptionsKit in_kit)

Check if the source ShellRelationOptionsKit is equivalent to this ShellRelationOptionsKit.

Param in_kit:The source ShellRelationOptionsKit to compare to this ShellRelationOptionsKit. Return:true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

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

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

void Set (HPS.ShellRelationOptionsKit in_kit)

Copies the source ShellRelationOptionsKit into this ShellRelationOptionsKit.

Param in_kit:The source ShellRelationOptionsKit to copy.

HPS.ShellRelationOptionsKit SetNearestFaceCalculation (bool in_state)

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

Param in_state:Whether to perform nearest face calculation. Return:A reference to this object.

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.

Param in_test:The relation test to be performed. Return:A reference to this object.

HPS.ShellRelationOptionsKit SetTolerance (float in_tolerance)

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

Param in_tolerance:  The tolerance, in world space units, to use for this relation test. Return:A reference to this object.

HPS.ShellRelationOptionsKit SetTreeContext (HPS.TreeContext in_tree_context)

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.

Param in_tree_context:  The tree context to use for this relation test. Return:A reference to this object.

ShellRelationOptionsKit ()

The default constructor creates an empty ShellRelationOptionsKit object.

ShellRelationOptionsKit (HPS.ShellRelationOptionsKit in_kit)

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

Param in_kit:The source ShellRelationOptionsKit to copy.

void Show (out HPS.ShellRelationOptionsKit out_kit)

Copies this ShellRelationOptionsKit into the given ShellRelationOptionsKit.

Param out_kit:The ShellRelationOptionsKit to populate with the contents of this ShellRelationOptionsKit.

bool ShowNearestFaceCalculation (out bool out_state)

Shows the nearest face calculation setting for this ShellRelationOptionsKit.

Param out_state:  Whether to perform nearest face calculation. Return:true if nearest face calculation was specified, false otherwise.

bool ShowTest (out HPS.Shell.RelationTest out_test)

Shows the relation test for this ShellRelationOptionsKit.

Param out_test:The relation test to be performed. Return:true if test was set, false otherwise.

bool ShowTolerance (out float out_tolerance)

Shows the value of the tolerance for this ShellRelationOptionsKit.

Param out_tolerance:  The tolerance, in world units, for this ShellOptimizationOptionsKit. Return:true if tolerance was set, false otherwise.

bool ShowTreeContext (out HPS.TreeContext out_tree_context)

Shows the tree context for this ShellRelationOptionsKit.

Param out_tree_context:  The tree context to use for this relation test. Return:true if a tree context was set, false otherwise.

HPS.ShellRelationOptionsKit UnsetEverything ()

Removes all settings from this ShellRelationOptionsKit.

Return:A reference to this object.

HPS.ShellRelationOptionsKit UnsetNearestFaceCalculation ()

Removes the nearest face calculation setting from this ShellRelationOptionsKit.

Return:A reference to this object.

HPS.ShellRelationOptionsKit UnsetTest ()

Removes the test value from this ShellRelationOptionsKit.

Return:A reference to this object.

HPS.ShellRelationOptionsKit UnsetTolerance ()

Removes the tolerance value from this ShellRelationOptionsKit.

Return:A reference to this object.

HPS.ShellRelationOptionsKit UnsetTreeContext ()

Removes the tree context from this ShellRelationOptionsKit.

Return:A reference to this object.

Public Static Functions

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.

Return:A ShellRelationOptionsKit with the default settings.

bool operator!= (HPS.ShellRelationOptionsKit a, HPS.ShellRelationOptionsKit b)

bool operator== (HPS.ShellRelationOptionsKit a, HPS.ShellRelationOptionsKit b)