REFERENCE MANUAL
#include <sprk_exchange.h>
Static Public Member Functions | |
static ExportPRCOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
The Exchange::ExportPRCOptionsKit class is a user space object. It contains settings controlling how PRC data is exported via Exchange. Calling Exchange::ExportPRCOptionsKit::GetDefault() will return an options kit with values found in here.
Exchange::ExportPRCOptionsKit::ExportPRCOptionsKit | ( | ) |
The default constructor creates an empty ExportPRCOptionsKit object.
Exchange::ExportPRCOptionsKit::ExportPRCOptionsKit | ( | ExportPRCOptionsKit const & | in_kit | ) |
The copy constructor creates a new ExportPRCOptionsKit object that contains the same settings as the source ExportPRCOptionsKit.
in_kit | The source ExportPRCOptionsKit to copy. |
Exchange::ExportPRCOptionsKit::ExportPRCOptionsKit | ( | ExportPRCOptionsKit && | in_that | ) |
The move constructor creates an ExportPRCOptionsKit by transferring the underlying object of the rvalue reference to this ExportPRCOptionsKit.
in_that | An rvalue reference to an ExportPRCOptionsKit to take the underlying object from. |
|
virtual |
Indicates whether this ExportPRCOptionsKit has any values set on it.
Reimplemented from Object.
bool Exchange::ExportPRCOptionsKit::Equals | ( | ExportPRCOptionsKit const & | in_kit | ) | const |
Check if the source ExportPRCOptionsKit is equivalent to this ExportPRCOptionsKit.
in_kit | The source ExportPRCOptionsKit to compare to this ExportPRCOptionsKit. |
|
static |
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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from Object.
bool Exchange::ExportPRCOptionsKit::operator!= | ( | ExportPRCOptionsKit const & | in_kit | ) | const |
Check if the source ExportPRCOptionsKit is not equivalent to this ExportPRCOptionsKit.
in_kit | The source ExportPRCOptionsKit to compare to this ExportPRCOptionsKit. |
ExportPRCOptionsKit& Exchange::ExportPRCOptionsKit::operator= | ( | ExportPRCOptionsKit const & | in_kit | ) |
Copies the source ExportPRCOptionsKit into this ExportPRCOptionsKit.
in_kit | The source ExportPRCOptionsKit to copy. |
ExportPRCOptionsKit& Exchange::ExportPRCOptionsKit::operator= | ( | ExportPRCOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this ExportPRCOptionsKit.
in_that | An rvalue reference to an ExportPRCOptionsKit to take the underlying object from. |
bool Exchange::ExportPRCOptionsKit::operator== | ( | ExportPRCOptionsKit const & | in_kit | ) | const |
Check if the source ExportPRCOptionsKit is equivalent to this ExportPRCOptionsKit.
in_kit | The source ExportPRCOptionsKit to compare to this ExportPRCOptionsKit. |
void Exchange::ExportPRCOptionsKit::Set | ( | ExportPRCOptionsKit const & | in_kit | ) |
Copies the source ExportPRCOptionsKit into this ExportPRCOptionsKit.
in_kit | The source ExportPRCOptionsKit to copy. |
ExportPRCOptionsKit& 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.
in_state | Whether to remove the attribute information in the PRC data for this annotation. |
ExportPRCOptionsKit& Exchange::ExportPRCOptionsKit::SetBRepCompression | ( | 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.
in_level | The level of compression to apply to BRep data for export. |
ExportPRCOptionsKit& 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.
in_state | Whether to remove BRep information in the PRC data for this annotation. |
ExportPRCOptionsKit& 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.
in_state | Whether to compress tessellation for export. |
void Exchange::ExportPRCOptionsKit::Show | ( | ExportPRCOptionsKit & | out_kit | ) | const |
Copies this ExportPRCOptionsKit into the given ExportPRCOptionsKit.
out_kit | The ExportPRCOptionsKit to populate with the contents of this ExportPRCOptionsKit. |
bool Exchange::ExportPRCOptionsKit::ShowAttributeRemoval | ( | bool & | out_state | ) | const |
Shows the attribute removal setting.
out_state | Whether to remove attribute information for export. |
bool Exchange::ExportPRCOptionsKit::ShowBRepCompression | ( | PRC::BRepCompression & | out_level | ) | const |
Shows the BRep compression level setting.
out_level | The level of compression to apply to BRep data for export. |
bool Exchange::ExportPRCOptionsKit::ShowBRepRemoval | ( | bool & | out_state | ) | const |
Shows the BRep removal setting.
out_state | Whether to remove BRep information for export. |
bool Exchange::ExportPRCOptionsKit::ShowTessellationCompression | ( | bool & | out_state | ) | const |
Shows the tessellation compression setting.
out_state | Whether to compress tessellation for export. |
ExportPRCOptionsKit& Exchange::ExportPRCOptionsKit::UnsetAttributeRemoval | ( | ) |
Removes the attribute removal setting.
ExportPRCOptionsKit& Exchange::ExportPRCOptionsKit::UnsetBRepCompression | ( | ) |
Removes the BRep compression level setting.
ExportPRCOptionsKit& Exchange::ExportPRCOptionsKit::UnsetBRepRemoval | ( | ) |
Removes the BRep removal setting.
ExportPRCOptionsKit& Exchange::ExportPRCOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ExportPRCOptionsKit.
ExportPRCOptionsKit& Exchange::ExportPRCOptionsKit::UnsetTessellationCompression | ( | ) |
Removes the tessellation compression setting.