Inheritance diagram for HPS.Exchange.ExportPRCOptionsKit:
HPS.SprocketKit HPS.Sprocket HPS.Object

Public Member Functions

override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.Exchange.ExportPRCOptionsKit in_kit)
 
 ExportPRCOptionsKit ()
 
 ExportPRCOptionsKit (HPS.Exchange.ExportPRCOptionsKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.Exchange.ExportPRCOptionsKit in_kit)
 
HPS.Exchange.ExportPRCOptionsKit SetAdditionalKeyPaths (HPS.KeyPath[] in_additional_key_paths)
 
HPS.Exchange.ExportPRCOptionsKit SetAttributeRemoval (bool in_state)
 
HPS.Exchange.ExportPRCOptionsKit SetBRepCompression (HPS.Exchange.PRC.BRepCompression in_level)
 
HPS.Exchange.ExportPRCOptionsKit SetBRepRemoval (bool in_state)
 
HPS.Exchange.ExportPRCOptionsKit SetTessellationCompression (bool in_state)
 
void Show (out HPS.Exchange.ExportPRCOptionsKit out_kit)
 
bool ShowAdditionalKeyPaths (out HPS.KeyPath[] out_additional_key_paths)
 
bool ShowAttributeRemoval (out bool out_state)
 
bool ShowBRepCompression (out HPS.Exchange.PRC.BRepCompression out_level)
 
bool ShowBRepRemoval (out bool out_state)
 
bool ShowTessellationCompression (out bool out_state)
 
HPS.Exchange.ExportPRCOptionsKit UnsetAdditionalKeyPaths ()
 
HPS.Exchange.ExportPRCOptionsKit UnsetAttributeRemoval ()
 
HPS.Exchange.ExportPRCOptionsKit UnsetBRepCompression ()
 
HPS.Exchange.ExportPRCOptionsKit UnsetBRepRemoval ()
 
HPS.Exchange.ExportPRCOptionsKit UnsetEverything ()
 
HPS.Exchange.ExportPRCOptionsKit UnsetTessellationCompression ()
 
- Public Member Functions inherited from HPS.SprocketKit
SprocketKit (HPS.SprocketKit in_that)
 
- Public Member Functions inherited from HPS.Sprocket
Sprocket (HPS.Sprocket in_that)
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
Object (HPS.Object that)
 
virtual void Reset ()
 
virtual HPS.Type Type ()
 

Static Public Member Functions

static HPS.Exchange.ExportPRCOptionsKit GetDefault ()
 
static bool operator!= (HPS.Exchange.ExportPRCOptionsKit a, HPS.Exchange.ExportPRCOptionsKit b)
 
static bool operator== (HPS.Exchange.ExportPRCOptionsKit a, HPS.Exchange.ExportPRCOptionsKit 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
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

◆ ExportPRCOptionsKit() [1/2]

HPS.Exchange.ExportPRCOptionsKit.ExportPRCOptionsKit ( )
inline

The default constructor creates an empty ExportPRCOptionsKit object.

◆ ExportPRCOptionsKit() [2/2]

HPS.Exchange.ExportPRCOptionsKit.ExportPRCOptionsKit ( HPS.Exchange.ExportPRCOptionsKit  in_kit)
inline

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

Parameters
in_kitThe source ExportPRCOptionsKit to copy.

Member Function Documentation

◆ Empty()

override bool HPS.Exchange.ExportPRCOptionsKit.Empty ( )
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.

◆ Equals()

bool HPS.Exchange.ExportPRCOptionsKit.Equals ( HPS.Exchange.ExportPRCOptionsKit  in_kit)
inline

Check if the source ExportPRCOptionsKit is equivalent to this ExportPRCOptionsKit.

Parameters
in_kitThe source ExportPRCOptionsKit to compare to this ExportPRCOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.Exchange.ExportPRCOptionsKit HPS.Exchange.ExportPRCOptionsKit.GetDefault ( )
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.

◆ ObjectType()

override HPS.Type HPS.Exchange.ExportPRCOptionsKit.ObjectType ( )
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.

◆ Set()

void HPS.Exchange.ExportPRCOptionsKit.Set ( HPS.Exchange.ExportPRCOptionsKit  in_kit)
inline

Copies the source ExportPRCOptionsKit into this ExportPRCOptionsKit.

Parameters
in_kitThe source ExportPRCOptionsKit to copy.

◆ SetAdditionalKeyPaths()

HPS.Exchange.ExportPRCOptionsKit HPS.Exchange.ExportPRCOptionsKit.SetAdditionalKeyPaths ( HPS.KeyPath []  in_additional_key_paths)
inline

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.

Parameters
in_additional_key_pathsThe key paths to be exported.
Returns
A reference to this AnnotationKit.

◆ SetAttributeRemoval()

HPS.Exchange.ExportPRCOptionsKit HPS.Exchange.ExportPRCOptionsKit.SetAttributeRemoval ( bool  in_state)
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_stateWhether to remove the attribute information in the PRC data for this annotation.
Returns
A reference to this AnnotationKit.
See also
Default value

◆ SetBRepCompression()

HPS.Exchange.ExportPRCOptionsKit HPS.Exchange.ExportPRCOptionsKit.SetBRepCompression ( HPS.Exchange.PRC.BRepCompression  in_level)
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_levelThe level of compression to apply to BRep data for export.
Returns
A reference to this ExportPRCOptionsKit.
See also
Default value

◆ SetBRepRemoval()

HPS.Exchange.ExportPRCOptionsKit HPS.Exchange.ExportPRCOptionsKit.SetBRepRemoval ( bool  in_state)
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_stateWhether to remove BRep information in the PRC data for this annotation.
Returns
A reference to this AnnotationKit.
See also
Default value

◆ SetTessellationCompression()

HPS.Exchange.ExportPRCOptionsKit HPS.Exchange.ExportPRCOptionsKit.SetTessellationCompression ( bool  in_state)
inline

Sets whether to compress tessellation for export. This corresponds to the value that will be passed to A3DRWParamsExportPrcData::m_bCompressTessellation.

Parameters
in_stateWhether to compress tessellation for export.
Returns
A reference to this ExportPRCOptionsKit.
See also
Default value

◆ Show()

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

Copies this ExportPRCOptionsKit into the given ExportPRCOptionsKit.

Parameters
out_kitThe ExportPRCOptionsKit to populate with the contents of this ExportPRCOptionsKit.

◆ ShowAdditionalKeyPaths()

bool HPS.Exchange.ExportPRCOptionsKit.ShowAdditionalKeyPaths ( out HPS.KeyPath []  out_additional_key_paths)
inline

Shows the additional key paths setting.

Parameters
out_additional_key_pathsThe key paths which will be added to the model
Returns
true if an additional key paths setting was specified, false otherwise.

◆ ShowAttributeRemoval()

bool HPS.Exchange.ExportPRCOptionsKit.ShowAttributeRemoval ( out bool  out_state)
inline

Shows the attribute removal setting.

Parameters
out_stateWhether to remove attribute information for export.
Returns
true if an attribute removal setting was specified, false otherwise.

◆ ShowBRepCompression()

bool HPS.Exchange.ExportPRCOptionsKit.ShowBRepCompression ( out HPS.Exchange.PRC.BRepCompression  out_level)
inline

Shows the BRep compression level setting.

Parameters
out_levelThe level of compression to apply to BRep data for export.
Returns
true if a BRep compression level setting was specified, false otherwise.

◆ ShowBRepRemoval()

bool HPS.Exchange.ExportPRCOptionsKit.ShowBRepRemoval ( out bool  out_state)
inline

Shows the BRep removal setting.

Parameters
out_stateWhether to remove BRep information for export.
Returns
true if a BRep removal setting was specified, false otherwise.

◆ ShowTessellationCompression()

bool HPS.Exchange.ExportPRCOptionsKit.ShowTessellationCompression ( out bool  out_state)
inline

Shows the tessellation compression setting.

Parameters
out_stateWhether to compress tessellation for export.
Returns
true if a tessellation compression setting was specified, false otherwise.

◆ UnsetAdditionalKeyPaths()

HPS.Exchange.ExportPRCOptionsKit HPS.Exchange.ExportPRCOptionsKit.UnsetAdditionalKeyPaths ( )
inline

Removes the additional key paths setting.

Returns
A reference to this ExportPRCOptionsKit.

◆ UnsetAttributeRemoval()

HPS.Exchange.ExportPRCOptionsKit HPS.Exchange.ExportPRCOptionsKit.UnsetAttributeRemoval ( )
inline

Removes the attribute removal setting.

Returns
A reference to this ExportPRCOptionsKit.

◆ UnsetBRepCompression()

HPS.Exchange.ExportPRCOptionsKit HPS.Exchange.ExportPRCOptionsKit.UnsetBRepCompression ( )
inline

Removes the BRep compression level setting.

Returns
A reference to this ExportPRCOptionsKit.

◆ UnsetBRepRemoval()

HPS.Exchange.ExportPRCOptionsKit HPS.Exchange.ExportPRCOptionsKit.UnsetBRepRemoval ( )
inline

Removes the BRep removal setting.

Returns
A reference to this ExportPRCOptionsKit.

◆ UnsetEverything()

HPS.Exchange.ExportPRCOptionsKit HPS.Exchange.ExportPRCOptionsKit.UnsetEverything ( )
inline

Removes all settings from this ExportPRCOptionsKit.

Returns
A reference to this ExportPRCOptionsKit.

◆ UnsetTessellationCompression()

HPS.Exchange.ExportPRCOptionsKit HPS.Exchange.ExportPRCOptionsKit.UnsetTessellationCompression ( )
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