HPS::Exchange::ExportPRCOptionsKit

class HPS.Exchange.ExportPRCOptionsKit : public HPS.SprocketKit 

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.

Public Functions

override void Dispose ()

override bool Empty ()

Indicates whether this ExportPRCOptionsKit has any values set on it.

Return: true if no values are set on this ExportPRCOptionsKit, false otherwise.

bool Equals (HPS.Exchange.ExportPRCOptionsKit in_kit)

Check if the source ExportPRCOptionsKit is equivalent to this ExportPRCOptionsKit.

Param in_kit: The source ExportPRCOptionsKit to compare to this ExportPRCOptionsKit.
Return: true if the objects are equivalent, false otherwise.

override bool Equals (Object obj)

ExportPRCOptionsKit (): The default constructor creates an empty ExportPRCOptionsKit object.

ExportPRCOptionsKit (HPS.Exchange.ExportPRCOptionsKit in_kit)

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

Param in_kit: The source ExportPRCOptionsKit to copy.

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.

void Set (HPS.Exchange.ExportPRCOptionsKit in_kit)

Copies the source ExportPRCOptionsKit into this ExportPRCOptionsKit.

Param in_kit: The source ExportPRCOptionsKit to copy.

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.

Param in_additional_key_paths: The key paths to be exported.
Return: A reference to this AnnotationKit.

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.

See: Default value

Param in_state: Whether to remove the attribute information in the PRC data for this annotation.
Return: A reference to this AnnotationKit.

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.

See: Default value

Param in_level: The level of compression to apply to BRep data for export.
Return: A reference to this ExportPRCOptionsKit.

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.

See: Default value

Param in_state: Whether to remove BRep information in the PRC data for this annotation.
Return: A reference to this AnnotationKit.

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.

See: Default value

Param in_state: Whether to compress tessellation for export.
Return: A reference to this ExportPRCOptionsKit.

void Show (out HPS.Exchange.ExportPRCOptionsKit out_kit)

Copies this ExportPRCOptionsKit into the given ExportPRCOptionsKit.

Param out_kit: The ExportPRCOptionsKit to populate with the contents of this ExportPRCOptionsKit.

bool ShowAdditionalKeyPaths (out HPS.KeyPath[] out_additional_key_paths)

Shows the additional key paths setting.

Param out_additional_key_paths: The key paths which will be added to the model
Return: true if an additional key paths setting was specified, false otherwise.

bool ShowAttributeRemoval (out bool out_state)

Shows the attribute removal setting.

Param out_state: Whether to remove attribute information for export.
Return: true if an attribute removal setting was specified, false otherwise.

bool ShowBRepCompression (out HPS.Exchange.PRC.BRepCompression out_level)

Shows the BRep compression level setting.

Param out_level: The level of compression to apply to BRep data for export.
Return: true if a BRep compression level setting was specified, false otherwise.

bool ShowBRepRemoval (out bool out_state)

Shows the BRep removal setting.

Param out_state: Whether to remove BRep information for export.
Return: true if a BRep removal setting was specified, false otherwise.

bool ShowTessellationCompression (out bool out_state)

Shows the tessellation compression setting.

Param out_state: Whether to compress tessellation for export.
Return: true if a tessellation compression setting was specified, false otherwise.

HPS.Exchange.ExportPRCOptionsKit UnsetAdditionalKeyPaths ()

Removes the additional key paths setting.

Return: A reference to this ExportPRCOptionsKit.

HPS.Exchange.ExportPRCOptionsKit UnsetAttributeRemoval ()

Removes the attribute removal setting.

Return: A reference to this ExportPRCOptionsKit.

HPS.Exchange.ExportPRCOptionsKit UnsetBRepCompression ()

Removes the BRep compression level setting.

Return: A reference to this ExportPRCOptionsKit.

HPS.Exchange.ExportPRCOptionsKit UnsetBRepRemoval ()

Removes the BRep removal setting.

Return: A reference to this ExportPRCOptionsKit.

HPS.Exchange.ExportPRCOptionsKit UnsetEverything ()

Removes all settings from this ExportPRCOptionsKit.

Return: A reference to this ExportPRCOptionsKit.

HPS.Exchange.ExportPRCOptionsKit UnsetTessellationCompression ()

Removes the tessellation compression setting.

Return: A reference to this ExportPRCOptionsKit.

Public Static Functions

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.

Return: An ExportPRCOptionsKit with the default settings.

bool operator!= (HPS.Exchange.ExportPRCOptionsKit a, HPS.Exchange.ExportPRCOptionsKit b)

bool operator== (HPS.Exchange.ExportPRCOptionsKit a, HPS.Exchange.ExportPRCOptionsKit b)