SegmentOptimizationOptionsKit

class HPS.SegmentOptimizationOptionsKit : public HPS.Kit

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

Public Functions

void Consume (HPS.SegmentOptimizationOptionsKit in_kit)

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

Param in_kit

The source SegmentOptimizationOptionsKit to consume.

override void Dispose ()

override bool Empty ()

Indicates whether this SegmentOptimizationOptionsKit has any values set on it.

Return

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

bool Equals (HPS.SegmentOptimizationOptionsKit in_kit)

Check if the source SegmentOptimizationOptionsKit is equivalent to this SegmentOptimizationOptionsKit.

Param in_kit

The source SegmentOptimizationOptionsKit to compare to this SegmentOptimizationOptionsKit.

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.

SegmentOptimizationOptionsKit ()

The default constructor creates an empty SegmentOptimizationOptionsKit object.

SegmentOptimizationOptionsKit (HPS.SegmentOptimizationOptionsKit in_kit)

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

Param in_kit

The source SegmentOptimizationOptionsKit to copy.

void Set (HPS.SegmentOptimizationOptionsKit in_kit)

Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit.

Param in_kit

The source SegmentOptimizationOptionsKit to copy.

HPS.SegmentOptimizationOptionsKit SetAttributeDelocalization (bool in_attribute_delocalization)

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

Param in_attribute_delocalization

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

Return

A reference to this SegmentOptimizationOptionsKit.

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

Controls whether or not includes or references are expanded.

Param in_expansion

The enum value describing how to handle includes and references.

Return

A reference to this SegmentOptimizationOptionsKit.

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

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

Param in_matrix

The enum value describing how to handle matrices.

Return

A reference to this SegmentOptimizationOptionsKit.

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

Controls how the tree is reorganized.

Param in_reorganization

The enum value describing how to reorganize the tree.

Return

A reference to this SegmentOptimizationOptionsKit.

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

Controls the traversal scope of the optimization operation.

Param in_scope

The enum value describing the traversal scope of the optimization.

Return

A reference to this SegmentOptimizationOptionsKit.

HPS.SegmentOptimizationOptionsKit SetShellInstancing (bool in_shell_instancing)

Controls whether or not duplicate shells are instanced.

Param in_shell_instancing

Denotes whether or not shells will be instanced.

Return

A reference to this SegmentOptimizationOptionsKit.

HPS.SegmentOptimizationOptionsKit SetShellMerging (bool in_shell_merging)

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

Param in_shell_merging

Denotes whether or not shells will be merged.

Return

A reference to this SegmentOptimizationOptionsKit.

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

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

Param in_user_data

The enum value describing how to handle user data.

Return

A reference to this SegmentOptimizationOptionsKit.

void Show (out HPS.SegmentOptimizationOptionsKit out_kit)

Copies this SegmentOptimizationOptionsKit into the given SegmentOptimizationOptionsKit.

Param out_kit

The SegmentOptimizationOptionsKit to populate with the contents of this SegmentOptimizationOptionsKit.

bool ShowAttributeDelocalization (out bool out_attribute_delocalization)

Shows the Attribute Delocalization setting.

Return

true if the setting is valid, false otherwise.

bool ShowExpansion (out HPS.SegmentOptimizationOptions.Expansion out_expansion)

Shows the Expansion setting.

Return

true if the setting is valid, false otherwise.

bool ShowMatrix (out HPS.SegmentOptimizationOptions.Matrix out_matrix)

Shows the Matrix setting.

Return

true if the setting is valid, false otherwise.

bool ShowReorganization (out HPS.SegmentOptimizationOptions.Reorganization out_reorganization)

Shows the Reorganization setting.

Return

true if the setting is valid, false otherwise.

bool ShowScope (out HPS.SegmentOptimizationOptions.Scope out_scope)

Shows the Scope setting.

Return

true if the setting is valid, false otherwise.

bool ShowShellInstancing (out bool out_shell_instancing)

Shows the Shell Instancing setting.

Return

true if the setting is valid, false otherwise.

bool ShowShellMerging (out bool out_shell_merging)

Shows the Shell Merging setting.

Return

true if the setting is valid, false otherwise.

bool ShowUserData (out HPS.SegmentOptimizationOptions.UserData out_user_data)

Shows the User Data setting.

Return

true if the setting is valid, false otherwise.

HPS.SegmentOptimizationOptionsKit UnsetAttributeDelocalization ()

Unsets the ttributeDelocalization value on this kit.

Return

A reference to this SegmentOptimizationOptionsKit.

HPS.SegmentOptimizationOptionsKit UnsetEverything ()

Removes all settings from this object.

Return

A reference to this object.

HPS.SegmentOptimizationOptionsKit UnsetExpansion ()

Unsets the Expansion value on this kit.

Return

A reference to this SegmentOptimizationOptionsKit.

HPS.SegmentOptimizationOptionsKit UnsetMatrix ()

Unsets the Matrix value on this kit.

Return

A reference to this SegmentOptimizationOptionsKit.

HPS.SegmentOptimizationOptionsKit UnsetReorganization ()

Unsets the Reorganization value on this kit.

Return

A reference to this SegmentOptimizationOptionsKit.

HPS.SegmentOptimizationOptionsKit UnsetScope ()

Unsets the Scope value on this kit.

Return

A reference to this SegmentOptimizationOptionsKit.

HPS.SegmentOptimizationOptionsKit UnsetShellInstancing ()

Unsets the ShellInstancing value on this kit.

Return

A reference to this SegmentOptimizationOptionsKit.

HPS.SegmentOptimizationOptionsKit UnsetShellMerging ()

Unsets the ShellMerging value on this kit.

Return

A reference to this SegmentOptimizationOptionsKit.

HPS.SegmentOptimizationOptionsKit UnsetUserData ()

Unsets the UserData value on this kit.

Return

A reference to this SegmentOptimizationOptionsKit.

Public Static Functions

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

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