
Public Member Functions | |
void | Consume (HPS.SegmentOptimizationOptionsKit in_kit) |
Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit and resets the source kit. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this SegmentOptimizationOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.SegmentOptimizationOptionsKit in_kit) |
Check if the source SegmentOptimizationOptionsKit is equivalent to this SegmentOptimizationOptionsKit. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
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... | |
void | Set (HPS.SegmentOptimizationOptionsKit in_kit) |
Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit. More... | |
HPS.SegmentOptimizationOptionsKit | SetAttributeDelocalization (bool in_attribute_delocalization) |
Controls whether or not local attributes will be pulled out of geometry. More... | |
HPS.SegmentOptimizationOptionsKit | SetExpansion (HPS.SegmentOptimizationOptions.Expansion in_expansion) |
Controls whether or not includes or references are expanded. More... | |
HPS.SegmentOptimizationOptionsKit | SetMatrix (HPS.SegmentOptimizationOptions.Matrix in_matrix) |
Controls whether or not matrices are localized, collapsed, or left as is. More... | |
HPS.SegmentOptimizationOptionsKit | SetReorganization (HPS.SegmentOptimizationOptions.Reorganization in_reorganization) |
Controls how the tree is reorganized. More... | |
HPS.SegmentOptimizationOptionsKit | SetScope (HPS.SegmentOptimizationOptions.Scope in_scope) |
Controls the traversal scope of the optimization operation. 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 are merged into consolidated shells. 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... | |
void | Show (out HPS.SegmentOptimizationOptionsKit out_kit) |
Copies this SegmentOptimizationOptionsKit into the given SegmentOptimizationOptionsKit. More... | |
bool | ShowAttributeDelocalization (out bool out_attribute_delocalization) |
Shows the Attribute Delocalization setting. More... | |
bool | ShowExpansion (out HPS.SegmentOptimizationOptions.Expansion out_expansion) |
Shows the Expansion setting. More... | |
bool | ShowMatrix (out HPS.SegmentOptimizationOptions.Matrix out_matrix) |
Shows the Matrix setting. More... | |
bool | ShowReorganization (out HPS.SegmentOptimizationOptions.Reorganization out_reorganization) |
Shows the Reorganization setting. More... | |
bool | ShowScope (out HPS.SegmentOptimizationOptions.Scope out_scope) |
Shows the Scope setting. More... | |
bool | ShowShellInstancing (out bool out_shell_instancing) |
Shows the Shell Instancing setting. More... | |
bool | ShowShellMerging (out bool out_shell_merging) |
Shows the Shell Merging setting. More... | |
bool | ShowUserData (out HPS.SegmentOptimizationOptions.UserData out_user_data) |
Shows the User Data setting. More... | |
HPS.SegmentOptimizationOptionsKit | UnsetAttributeDelocalization () |
Unsets the ttributeDelocalization value on this kit. More... | |
HPS.SegmentOptimizationOptionsKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.SegmentOptimizationOptionsKit | UnsetExpansion () |
Unsets the Expansion value on this kit. More... | |
HPS.SegmentOptimizationOptionsKit | UnsetMatrix () |
Unsets the Matrix value on this kit. More... | |
HPS.SegmentOptimizationOptionsKit | UnsetReorganization () |
Unsets the Reorganization value on this kit. More... | |
HPS.SegmentOptimizationOptionsKit | UnsetScope () |
Unsets the Scope value on this kit. More... | |
HPS.SegmentOptimizationOptionsKit | UnsetShellInstancing () |
Unsets the ShellInstancing value on this kit. More... | |
HPS.SegmentOptimizationOptionsKit | UnsetShellMerging () |
Unsets the ShellMerging value on this kit. More... | |
HPS.SegmentOptimizationOptionsKit | UnsetUserData () |
Unsets the UserData value on this kit. More... | |
![]() | |
Kit (HPS.Kit in_that) | |
override 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... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns the object's database handle, which can be used to determine which instance of a class the object is. For example, controls are simply aliases for segment keys that group related functions. Therefore, a SegmentKey and all of its controls would return the same instance id. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
Static Public Member Functions | |
static bool | operator!= (HPS.SegmentOptimizationOptionsKit a, HPS.SegmentOptimizationOptionsKit b) |
static bool | operator== (HPS.SegmentOptimizationOptionsKit a, HPS.SegmentOptimizationOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
Configuration options kit for controlling HPS.Segment.Optimize behavior.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty SegmentOptimizationOptionsKit object.
|
inline |
The copy constructor creates a new SegmentOptimizationOptionsKit object that contains the same settings as the source SegmentOptimizationOptionsKit.
- Parameters
-
in_kit The source SegmentOptimizationOptionsKit to copy.
Member Function Documentation
|
inline |
Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit and resets the source kit.
- Parameters
-
in_kit The source SegmentOptimizationOptionsKit to consume.
|
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.
|
inline |
Check if the source SegmentOptimizationOptionsKit is equivalent to this SegmentOptimizationOptionsKit.
- Parameters
-
in_kit The source SegmentOptimizationOptionsKit to compare to this SegmentOptimizationOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inline |
Copies the source SegmentOptimizationOptionsKit into this SegmentOptimizationOptionsKit.
- Parameters
-
in_kit The source SegmentOptimizationOptionsKit to copy.
|
inline |
Controls whether or not local attributes will be pulled out of geometry.
- Parameters
-
in_attribute_delocalization Denotes whether or not local attributes will be pulled out of geometry.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
|
inline |
Controls whether or not includes or references are expanded.
- Parameters
-
in_expansion The enum value describing how to handle includes and references.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
|
inline |
Controls whether or not matrices are localized, collapsed, or left as is.
- Parameters
-
in_matrix The enum value describing how to handle matrices.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
|
inline |
Controls how the tree is reorganized.
- Parameters
-
in_reorganization The enum value describing how to reorganize the tree.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
|
inline |
Controls the traversal scope of the optimization operation.
- Parameters
-
in_scope The enum value describing the traversal scope of the optimization.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
|
inline |
Controls whether or not duplicate shells are instanced.
- Parameters
-
in_shell_instancing Denotes whether or not shells will be instanced.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
|
inline |
Controls whether or not distinct shells are merged into consolidated shells.
- Parameters
-
in_shell_merging Denotes whether or not shells will be merged.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
|
inline |
Controls whether or not user data is discarded, preserved, merged, localized, or left as is.
- Parameters
-
in_user_data The enum value describing how to handle user data.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
|
inline |
Copies this SegmentOptimizationOptionsKit into the given SegmentOptimizationOptionsKit.
- Parameters
-
out_kit The SegmentOptimizationOptionsKit to populate with the contents of this SegmentOptimizationOptionsKit.
|
inline |
Shows the Attribute Delocalization setting.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the Expansion setting.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the Matrix setting.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the Reorganization setting.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the Scope setting.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the Shell Instancing setting.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the Shell Merging setting.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the User Data setting.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Unsets the ttributeDelocalization value on this kit.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
|
inline |
Unsets the Expansion value on this kit.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
|
inline |
Unsets the Matrix value on this kit.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
|
inline |
Unsets the Reorganization value on this kit.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
|
inline |
Unsets the Scope value on this kit.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
|
inline |
Unsets the ShellInstancing value on this kit.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
|
inline |
Unsets the ShellMerging value on this kit.
- Returns
- A reference to this SegmentOptimizationOptionsKit.
|
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