
Public Member Functions | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this ExportPRCOptionsKit has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.Exchange.ExportPRCOptionsKit in_kit) |
Check if the source ExportPRCOptionsKit is equivalent to this ExportPRCOptionsKit. More... | |
ExportPRCOptionsKit () | |
The default constructor creates an empty ExportPRCOptionsKit object. More... | |
ExportPRCOptionsKit (HPS.Exchange.ExportPRCOptionsKit in_kit) | |
The copy constructor creates a new ExportPRCOptionsKit object that contains the same settings as the source ExportPRCOptionsKit. More... | |
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). More... | |
void | Set (HPS.Exchange.ExportPRCOptionsKit in_kit) |
Copies the source ExportPRCOptionsKit into this ExportPRCOptionsKit. More... | |
HPS.Exchange.ExportPRCOptionsKit | SetAdditionalKeyPaths (HPS.KeyPath[] in_additional_key_paths) |
Sets an array of key paths which will be exported to PRC in addition to the model. Use this setting to export Visualize geometry to PRC. More... | |
HPS.Exchange.ExportPRCOptionsKit | SetAttributeRemoval (bool in_state) |
Sets whether to remove the attribute information for export. This corresponds to the value that will be passed to A3DRWParamsExportPrcData::m_bRemoveAttributes. More... | |
HPS.Exchange.ExportPRCOptionsKit | SetBRepCompression (HPS.Exchange.PRC.BRepCompression in_level) |
Sets the level of compression to apply to BRep data for export. This corresponds to the values that will be passed to A3DRWParamsExportPrcData::m_bCompressBrep and A3DRWParamsExportPrcData::m_eCompressBrepType. More... | |
HPS.Exchange.ExportPRCOptionsKit | SetBRepRemoval (bool in_state) |
Sets whether to remove the BRep information for export. This corresponds to the value that will be passed to A3DRWParamsExportPrcData::m_bRemoveBRep. More... | |
HPS.Exchange.ExportPRCOptionsKit | SetTessellationCompression (bool in_state) |
Sets whether to compress tessellation for export. This corresponds to the value that will be passed to A3DRWParamsExportPrcData::m_bCompressTessellation. More... | |
void | Show (out HPS.Exchange.ExportPRCOptionsKit out_kit) |
Copies this ExportPRCOptionsKit into the given ExportPRCOptionsKit. More... | |
bool | ShowAdditionalKeyPaths (out HPS.KeyPath[] out_additional_key_paths) |
Shows the additional key paths setting. More... | |
bool | ShowAttributeRemoval (out bool out_state) |
Shows the attribute removal setting. More... | |
bool | ShowBRepCompression (out HPS.Exchange.PRC.BRepCompression out_level) |
Shows the BRep compression level setting. More... | |
bool | ShowBRepRemoval (out bool out_state) |
Shows the BRep removal setting. More... | |
bool | ShowTessellationCompression (out bool out_state) |
Shows the tessellation compression setting. More... | |
HPS.Exchange.ExportPRCOptionsKit | UnsetAdditionalKeyPaths () |
Removes the additional key paths setting. More... | |
HPS.Exchange.ExportPRCOptionsKit | UnsetAttributeRemoval () |
Removes the attribute removal setting. More... | |
HPS.Exchange.ExportPRCOptionsKit | UnsetBRepCompression () |
Removes the BRep compression level setting. More... | |
HPS.Exchange.ExportPRCOptionsKit | UnsetBRepRemoval () |
Removes the BRep removal setting. More... | |
HPS.Exchange.ExportPRCOptionsKit | UnsetEverything () |
Removes all settings from this ExportPRCOptionsKit. More... | |
HPS.Exchange.ExportPRCOptionsKit | UnsetTessellationCompression () |
Removes the tessellation compression setting. More... | |
![]() | |
SprocketKit (HPS.SprocketKit in_that) | |
![]() | |
Sprocket (HPS.Sprocket in_that) | |
![]() | |
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... | |
virtual 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... | |
Static Public Member Functions | |
static HPS.Exchange.ExportPRCOptionsKit | GetDefault () |
Creates an ExportPRCOptionsKit 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. These values will be used for import unless an option is overridden by the options passed to File.ExportPRC. More... | |
static bool | operator!= (HPS.Exchange.ExportPRCOptionsKit a, HPS.Exchange.ExportPRCOptionsKit b) |
static bool | operator== (HPS.Exchange.ExportPRCOptionsKit a, HPS.Exchange.ExportPRCOptionsKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The HPS.Exchange.ExportPRCOptionsKit class is a user space object. It contains settings controlling how PRC data is exported via Exchange. Calling HPS.Exchange.ExportPRCOptionsKit.GetDefault() will return an options kit with values found in here.
Constructor & Destructor Documentation
|
inline |
The default constructor creates an empty ExportPRCOptionsKit object.
|
inline |
The copy constructor creates a new ExportPRCOptionsKit object that contains the same settings as the source ExportPRCOptionsKit.
- Parameters
-
in_kit The source ExportPRCOptionsKit to copy.
Member Function Documentation
|
inlinevirtual |
Indicates whether this ExportPRCOptionsKit has any values set on it.
- Returns
- true if no values are set on this ExportPRCOptionsKit, false otherwise.
Reimplemented from HPS.Object.
|
inline |
Check if the source ExportPRCOptionsKit is equivalent to this ExportPRCOptionsKit.
- Parameters
-
in_kit The source ExportPRCOptionsKit to compare to this ExportPRCOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
|
inlinestatic |
Creates an ExportPRCOptionsKit 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. These values will be used for import unless an option is overridden by the options passed to File.ExportPRC.
- Returns
- An ExportPRCOptionsKit with the default settings.
|
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.SprocketKit.
|
inline |
Copies the source ExportPRCOptionsKit into this ExportPRCOptionsKit.
- Parameters
-
in_kit The source ExportPRCOptionsKit to copy.
|
inline |
|
inline |
Sets whether to remove the attribute information for export. This corresponds to the value that will be passed to A3DRWParamsExportPrcData::m_bRemoveAttributes.
- Parameters
-
in_state Whether to remove the attribute information in the PRC data for this annotation.
- Returns
- A reference to this AnnotationKit.
Default value
|
inline |
Sets the level of compression to apply to BRep data for export. This corresponds to the values that will be passed to A3DRWParamsExportPrcData::m_bCompressBrep and A3DRWParamsExportPrcData::m_eCompressBrepType.
- Parameters
-
in_level The level of compression to apply to BRep data for export.
- Returns
- A reference to this ExportPRCOptionsKit.
Default value
|
inline |
Sets whether to remove the BRep information for export. This corresponds to the value that will be passed to A3DRWParamsExportPrcData::m_bRemoveBRep.
- Parameters
-
in_state Whether to remove BRep information in the PRC data for this annotation.
- Returns
- A reference to this AnnotationKit.
Default value
|
inline |
Sets whether to compress tessellation for export. This corresponds to the value that will be passed to A3DRWParamsExportPrcData::m_bCompressTessellation.
- Parameters
-
in_state Whether to compress tessellation for export.
- Returns
- A reference to this ExportPRCOptionsKit.
Default value
|
inline |
Copies this ExportPRCOptionsKit into the given ExportPRCOptionsKit.
- Parameters
-
out_kit The ExportPRCOptionsKit to populate with the contents of this ExportPRCOptionsKit.
|
inline |
Shows the additional key paths setting.
- Parameters
-
out_additional_key_paths The key paths which will be added to the model
- Returns
- true if an additional key paths setting was specified, false otherwise.
|
inline |
Shows the attribute removal setting.
- Parameters
-
out_state Whether to remove attribute information for export.
- Returns
- true if an attribute removal setting was specified, false otherwise.
|
inline |
Shows the BRep compression level setting.
- Parameters
-
out_level The level of compression to apply to BRep data for export.
- Returns
- true if a BRep compression level setting was specified, false otherwise.
|
inline |
Shows the BRep removal setting.
- Parameters
-
out_state Whether to remove BRep information for export.
- Returns
- true if a BRep removal setting was specified, false otherwise.
|
inline |
Shows the tessellation compression setting.
- Parameters
-
out_state Whether to compress tessellation for export.
- Returns
- true if a tessellation compression setting was specified, false otherwise.
|
inline |
Removes the additional key paths setting.
- Returns
- A reference to this ExportPRCOptionsKit.
|
inline |
Removes the attribute removal setting.
- Returns
- A reference to this ExportPRCOptionsKit.
|
inline |
Removes the BRep compression level setting.
- Returns
- A reference to this ExportPRCOptionsKit.
|
inline |
Removes the BRep removal setting.
- Returns
- A reference to this ExportPRCOptionsKit.
|
inline |
Removes all settings from this ExportPRCOptionsKit.
- Returns
- A reference to this ExportPRCOptionsKit.
|
inline |
Removes the tessellation compression setting.
- Returns
- A reference to this ExportPRCOptionsKit.
The documentation for this class was generated from the following file:
- internals/hps_sprk_exchange/source/cs/HPS.Exchange.cs