Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
HPS.SegmentOptimizationOptionsKit Class Reference

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

Inheritance diagram for HPS.SegmentOptimizationOptionsKit:
HPS.Object

Public Member Functions

override void Dispose ()
 
 SegmentOptimizationOptionsKit ()
 The default constructor creates an empty SegmentOptimizationOptionsKit object. More...
 
 SegmentOptimizationOptionsKit (HPS.SegmentOptimizationOptionsKit in_kit)
 The copy constructor creates a new SegmentOptimizationOptionsKit object that contains the same settings as the source SegmentOptimizationOptionsKit. More...
 
override HPS.Type ObjectType ()
 This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More...
 
void Consume (HPS.SegmentOptimizationOptionsKit in_kit)
 Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit and resets the source kit. More...
 
void Set (HPS.SegmentOptimizationOptionsKit in_kit)
 Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit. More...
 
void Show (out HPS.SegmentOptimizationOptionsKit out_kit)
 Copies this SegmentOptimizationOptionsKit into the given SegmentOptimizationOptionsKit. More...
 
override bool Empty ()
 Indicates whether this SegmentOptimizationOptionsKit has any values set on it. More...
 
override bool Equals (System.Object obj)
 
override int GetHashCode ()
 
bool Equals (HPS.SegmentOptimizationOptionsKit in_kit)
 Check if the source SegmentOptimizationOptionsKit is equivalent to this SegmentOptimizationOptionsKit. More...
 
HPS.SegmentOptimizationOptionsKit SetUserData (HPS.SegmentOptimizationOptions.UserData in_user_data)
 Controls whether or not user data is discarded, preserved, merged, localized, or left as is. More...
 
HPS.SegmentOptimizationOptionsKit SetMatrix (HPS.SegmentOptimizationOptions.Matrix in_matrix)
 Controls whether or not matrices are localized, collapsed, or left as is. More...
 
HPS.SegmentOptimizationOptionsKit SetExpansion (HPS.SegmentOptimizationOptions.Expansion in_expansion)
 Controls whether or not includes or references are expanded. More...
 
HPS.SegmentOptimizationOptionsKit SetScope (HPS.SegmentOptimizationOptions.Scope in_scope)
 Controls the traversal scope of the optimization operation. More...
 
HPS.SegmentOptimizationOptionsKit SetReorganization (HPS.SegmentOptimizationOptions.Reorganization in_reorganization)
 Controls how the tree is reorganized. More...
 
HPS.SegmentOptimizationOptionsKit SetShellInstancing (bool in_shell_instancing)
 Controls whether or not duplicate shells are instanced. More...
 
HPS.SegmentOptimizationOptionsKit SetShellMerging (bool in_shell_merging)
 Controls whether or not distinct shells can be merged into aggrogate shells. More...
 
HPS.SegmentOptimizationOptionsKit SetAttributeDelocalization (bool in_attribute_delocalization)
 Controls whether or not local attributes will be pulled out of geometry. More...
 
HPS.SegmentOptimizationOptionsKit UnsetUserData ()
 
Returns
A reference to this SegmentOptimizationOptionsKit.

 
HPS.SegmentOptimizationOptionsKit UnsetMatrix ()
 
Returns
A reference to this SegmentOptimizationOptionsKit.

 
HPS.SegmentOptimizationOptionsKit UnsetExpansion ()
 
Returns
A reference to this SegmentOptimizationOptionsKit.

 
HPS.SegmentOptimizationOptionsKit UnsetScope ()
 
Returns
A reference to this SegmentOptimizationOptionsKit.

 
HPS.SegmentOptimizationOptionsKit UnsetReorganization ()
 
Returns
A reference to this SegmentOptimizationOptionsKit.

 
HPS.SegmentOptimizationOptionsKit UnsetShellInstancing ()
 
Returns
A reference to this SegmentOptimizationOptionsKit.

 
HPS.SegmentOptimizationOptionsKit UnsetShellMerging ()
 
Returns
A reference to this SegmentOptimizationOptionsKit.

 
HPS.SegmentOptimizationOptionsKit UnsetAttributeDelocalization ()
 
Returns
A reference to this SegmentOptimizationOptionsKit.

 
HPS.SegmentOptimizationOptionsKit UnsetEverything ()
 Removes all settings from this object. More...
 
bool ShowUserData (out HPS.SegmentOptimizationOptions.UserData out_user_data)
 
bool ShowMatrix (out HPS.SegmentOptimizationOptions.Matrix out_matrix)
 
bool ShowExpansion (out HPS.SegmentOptimizationOptions.Expansion out_expansion)
 
bool ShowScope (out HPS.SegmentOptimizationOptions.Scope out_scope)
 
bool ShowReorganization (out HPS.SegmentOptimizationOptions.Reorganization out_reorganization)
 
bool ShowShellInstancing (out bool out_shell_instancing)
 
bool ShowShellMerging (out bool out_shell_merging)
 
bool ShowAttributeDelocalization (out bool out_attribute_delocalization)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
 Object (HPS.Object that)
 
HPS.Type Type ()
 This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More...
 
virtual void Reset ()
 Resets this object to its initial, uninitialized state. More...
 
bool HasType (HPS.Type in_mask)
 This function indicates whether this Object has the given Type mask. More...
 
IntPtr GetInstanceID ()
 Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More...
 

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
HandleRef cptr
 
HandleRef scptr
 
bool cMemOwn
 

Detailed Description

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

Constructor & Destructor Documentation

HPS.SegmentOptimizationOptionsKit.SegmentOptimizationOptionsKit ( )
inline

The default constructor creates an empty SegmentOptimizationOptionsKit object.

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

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

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.
override HPS.Type HPS.SegmentOptimizationOptionsKit.ObjectType ( )
inlinevirtual

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

Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit.

Parameters
in_kitThe source SegmentOptimizationOptionsKit to copy.
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.
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.
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.
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.
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.
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.
HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.SetShellMerging ( bool  in_shell_merging)
inline

Controls whether or not distinct shells can be merged into aggrogate shells.

Returns
A reference to this SegmentOptimizationOptionsKit.
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.
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.
HPS.SegmentOptimizationOptionsKit HPS.SegmentOptimizationOptionsKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

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