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

Public Member Functions

void Consume (HPS.SegmentOptimizationOptionsKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.SegmentOptimizationOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
 SegmentOptimizationOptionsKit ()
 
 SegmentOptimizationOptionsKit (HPS.SegmentOptimizationOptionsKit in_kit)
 
void Set (HPS.SegmentOptimizationOptionsKit in_kit)
 
HPS.SegmentOptimizationOptionsKit SetAttributeDelocalization (bool in_attribute_delocalization)
 
HPS.SegmentOptimizationOptionsKit SetExpansion (HPS.SegmentOptimizationOptions.Expansion in_expansion)
 
HPS.SegmentOptimizationOptionsKit SetMatrix (HPS.SegmentOptimizationOptions.Matrix in_matrix)
 
HPS.SegmentOptimizationOptionsKit SetReorganization (HPS.SegmentOptimizationOptions.Reorganization in_reorganization)
 
HPS.SegmentOptimizationOptionsKit SetScope (HPS.SegmentOptimizationOptions.Scope in_scope)
 
HPS.SegmentOptimizationOptionsKit SetShellInstancing (bool in_shell_instancing)
 
HPS.SegmentOptimizationOptionsKit SetShellMerging (bool in_shell_merging)
 
HPS.SegmentOptimizationOptionsKit SetUserData (HPS.SegmentOptimizationOptions.UserData in_user_data)
 
void Show (out HPS.SegmentOptimizationOptionsKit out_kit)
 
bool ShowAttributeDelocalization (out bool out_attribute_delocalization)
 
bool ShowExpansion (out HPS.SegmentOptimizationOptions.Expansion out_expansion)
 
bool ShowMatrix (out HPS.SegmentOptimizationOptions.Matrix out_matrix)
 
bool ShowReorganization (out HPS.SegmentOptimizationOptions.Reorganization out_reorganization)
 
bool ShowScope (out HPS.SegmentOptimizationOptions.Scope out_scope)
 
bool ShowShellInstancing (out bool out_shell_instancing)
 
bool ShowShellMerging (out bool out_shell_merging)
 
bool ShowUserData (out HPS.SegmentOptimizationOptions.UserData out_user_data)
 
HPS.SegmentOptimizationOptionsKit UnsetAttributeDelocalization ()
 
HPS.SegmentOptimizationOptionsKit UnsetEverything ()
 
HPS.SegmentOptimizationOptionsKit UnsetExpansion ()
 
HPS.SegmentOptimizationOptionsKit UnsetMatrix ()
 
HPS.SegmentOptimizationOptionsKit UnsetReorganization ()
 
HPS.SegmentOptimizationOptionsKit UnsetScope ()
 
HPS.SegmentOptimizationOptionsKit UnsetShellInstancing ()
 
HPS.SegmentOptimizationOptionsKit UnsetShellMerging ()
 
HPS.SegmentOptimizationOptionsKit UnsetUserData ()
 
- 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 bool operator!= (HPS.SegmentOptimizationOptionsKit a, HPS.SegmentOptimizationOptionsKit b)
 
static bool operator== (HPS.SegmentOptimizationOptionsKit a, HPS.SegmentOptimizationOptionsKit 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

Configuration options kit for controlling HPS.Segment.Optimize behavior.

Constructor & Destructor Documentation

◆ SegmentOptimizationOptionsKit() [1/2]

HPS.SegmentOptimizationOptionsKit.SegmentOptimizationOptionsKit ( )
inline

The default constructor creates an empty SegmentOptimizationOptionsKit object.

◆ SegmentOptimizationOptionsKit() [2/2]

HPS.SegmentOptimizationOptionsKit.SegmentOptimizationOptionsKit ( HPS.SegmentOptimizationOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source SegmentOptimizationOptionsKit to copy.

Member Function Documentation

◆ Consume()

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

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

Parameters
in_kitThe source SegmentOptimizationOptionsKit to consume.

◆ Empty()

override bool HPS.SegmentOptimizationOptionsKit.Empty ( )
inlinevirtual

Indicates whether this SegmentOptimizationOptionsKit has any values set on it.

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

Reimplemented from HPS.Object.

◆ Equals()

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

Check if the source SegmentOptimizationOptionsKit is equivalent to this SegmentOptimizationOptionsKit.

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

◆ ObjectType()

override HPS.Type HPS.SegmentOptimizationOptionsKit.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.SegmentOptimizationOptionsKit.Set ( HPS.SegmentOptimizationOptionsKit  in_kit)
inline

Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit.

Parameters
in_kitThe source SegmentOptimizationOptionsKit to copy.

◆ SetAttributeDelocalization()

HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.SetAttributeDelocalization ( bool  in_attribute_delocalization)
inline

Controls whether or not local attributes will be pulled out of geometry.

Parameters
in_attribute_delocalizationDenotes whether or not local attributes will be pulled out of geometry.
Returns
A reference to this SegmentOptimizationOptionsKit.

◆ SetExpansion()

HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.SetExpansion ( HPS.SegmentOptimizationOptions.Expansion  in_expansion)
inline

Controls whether or not includes or references are expanded.

Parameters
in_expansionThe enum value describing how to handle includes and references.
Returns
A reference to this SegmentOptimizationOptionsKit.

◆ SetMatrix()

HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.SetMatrix ( HPS.SegmentOptimizationOptions.Matrix  in_matrix)
inline

Controls whether or not matrices are localized, collapsed, or left as is.

Parameters
in_matrixThe enum value describing how to handle matrices.
Returns
A reference to this SegmentOptimizationOptionsKit.

◆ SetReorganization()

HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.SetReorganization ( HPS.SegmentOptimizationOptions.Reorganization  in_reorganization)
inline

Controls how the tree is reorganized.

Parameters
in_reorganizationThe enum value describing how to reorganize the tree.
Returns
A reference to this SegmentOptimizationOptionsKit.

◆ SetScope()

HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.SetScope ( HPS.SegmentOptimizationOptions.Scope  in_scope)
inline

Controls the traversal scope of the optimization operation.

Parameters
in_scopeThe enum value describing the traversal scope of the optimization.
Returns
A reference to this SegmentOptimizationOptionsKit.

◆ SetShellInstancing()

HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.SetShellInstancing ( bool  in_shell_instancing)
inline

Controls whether or not duplicate shells are instanced.

Parameters
in_shell_instancingDenotes whether or not shells will be instanced.
Returns
A reference to this SegmentOptimizationOptionsKit.

◆ SetShellMerging()

HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.SetShellMerging ( bool  in_shell_merging)
inline

Controls whether or not distinct shells are merged into consolidated shells.

Parameters
in_shell_mergingDenotes whether or not shells will be merged.
Returns
A reference to this SegmentOptimizationOptionsKit.

◆ SetUserData()

HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.SetUserData ( HPS.SegmentOptimizationOptions.UserData  in_user_data)
inline

Controls whether or not user data is discarded, preserved, merged, localized, or left as is.

Parameters
in_user_dataThe enum value describing how to handle user data.
Returns
A reference to this SegmentOptimizationOptionsKit.

◆ Show()

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

Copies this SegmentOptimizationOptionsKit into the given SegmentOptimizationOptionsKit.

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

◆ ShowAttributeDelocalization()

bool HPS.SegmentOptimizationOptionsKit.ShowAttributeDelocalization ( out bool  out_attribute_delocalization)
inline

Shows the Attribute Delocalization setting.

Returns
true if the setting is valid, false otherwise.

◆ ShowExpansion()

bool HPS.SegmentOptimizationOptionsKit.ShowExpansion ( out HPS.SegmentOptimizationOptions.Expansion  out_expansion)
inline

Shows the Expansion setting.

Returns
true if the setting is valid, false otherwise.

◆ ShowMatrix()

bool HPS.SegmentOptimizationOptionsKit.ShowMatrix ( out HPS.SegmentOptimizationOptions.Matrix  out_matrix)
inline

Shows the Matrix setting.

Returns
true if the setting is valid, false otherwise.

◆ ShowReorganization()

bool HPS.SegmentOptimizationOptionsKit.ShowReorganization ( out HPS.SegmentOptimizationOptions.Reorganization  out_reorganization)
inline

Shows the Reorganization setting.

Returns
true if the setting is valid, false otherwise.

◆ ShowScope()

bool HPS.SegmentOptimizationOptionsKit.ShowScope ( out HPS.SegmentOptimizationOptions.Scope  out_scope)
inline

Shows the Scope setting.

Returns
true if the setting is valid, false otherwise.

◆ ShowShellInstancing()

bool HPS.SegmentOptimizationOptionsKit.ShowShellInstancing ( out bool  out_shell_instancing)
inline

Shows the Shell Instancing setting.

Returns
true if the setting is valid, false otherwise.

◆ ShowShellMerging()

bool HPS.SegmentOptimizationOptionsKit.ShowShellMerging ( out bool  out_shell_merging)
inline

Shows the Shell Merging setting.

Returns
true if the setting is valid, false otherwise.

◆ ShowUserData()

bool HPS.SegmentOptimizationOptionsKit.ShowUserData ( out HPS.SegmentOptimizationOptions.UserData  out_user_data)
inline

Shows the User Data setting.

Returns
true if the setting is valid, false otherwise.

◆ UnsetAttributeDelocalization()

HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.UnsetAttributeDelocalization ( )
inline

Unsets the ttributeDelocalization value on this kit.

Returns
A reference to this SegmentOptimizationOptionsKit.

◆ UnsetEverything()

HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetExpansion()

HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.UnsetExpansion ( )
inline

Unsets the Expansion value on this kit.

Returns
A reference to this SegmentOptimizationOptionsKit.

◆ UnsetMatrix()

HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.UnsetMatrix ( )
inline

Unsets the Matrix value on this kit.

Returns
A reference to this SegmentOptimizationOptionsKit.

◆ UnsetReorganization()

HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.UnsetReorganization ( )
inline

Unsets the Reorganization value on this kit.

Returns
A reference to this SegmentOptimizationOptionsKit.

◆ UnsetScope()

HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.UnsetScope ( )
inline

Unsets the Scope value on this kit.

Returns
A reference to this SegmentOptimizationOptionsKit.

◆ UnsetShellInstancing()

HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.UnsetShellInstancing ( )
inline

Unsets the ShellInstancing value on this kit.

Returns
A reference to this SegmentOptimizationOptionsKit.

◆ UnsetShellMerging()

HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.UnsetShellMerging ( )
inline

Unsets the ShellMerging value on this kit.

Returns
A reference to this SegmentOptimizationOptionsKit.

◆ UnsetUserData()

HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.UnsetUserData ( )
inline

Unsets the UserData value on this kit.

Returns
A reference to this SegmentOptimizationOptionsKit.

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