REFERENCE MANUAL
#include <sprk_exchange.h>
Public Member Functions | |
bool | Empty () const |
bool | Equals (ExportJTOptionsKit const &in_kit) const |
ExportJTOptionsKit () | |
ExportJTOptionsKit (ExportJTOptionsKit const &in_kit) | |
ExportJTOptionsKit (ExportJTOptionsKit &&in_that) | |
Type | ObjectType () const |
bool | operator!= (ExportJTOptionsKit const &in_kit) const |
ExportJTOptionsKit & | operator= (ExportJTOptionsKit const &in_kit) |
ExportJTOptionsKit & | operator= (ExportJTOptionsKit &&in_that) |
bool | operator== (ExportJTOptionsKit const &in_kit) const |
void | Set (ExportJTOptionsKit const &in_kit) |
ExportJTOptionsKit & | SetContent (JT::Content in_content) |
ExportJTOptionsKit & | SetHiddenObjects (bool in_state) |
ExportJTOptionsKit & | SetPMI (bool in_state) |
void | Show (ExportJTOptionsKit &out_kit) const |
bool | ShowContent (JT::Content &out_content) const |
bool | ShowHiddenObjects (bool &out_state) const |
bool | ShowPMI (bool &out_state) const |
ExportJTOptionsKit & | UnsetContent () |
ExportJTOptionsKit & | UnsetEverything () |
ExportJTOptionsKit & | UnsetHiddenObjects () |
ExportJTOptionsKit & | UnsetPMI () |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (Type in_mask) const |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
Type | Type () const |
Static Public Member Functions | |
static ExportJTOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
The Exchange::ExportJTOptionsKit class is a user space object. It contains settings controlling how JT data is exported via Exchange. Calling Exchange::ExportJTOptionsKit::GetDefault() will return an options kit with values found in here.
Exchange::ExportJTOptionsKit::ExportJTOptionsKit | ( | ) |
The default constructor creates an empty ExportJTOptionsKit object.
Exchange::ExportJTOptionsKit::ExportJTOptionsKit | ( | ExportJTOptionsKit const & | in_kit | ) |
The copy constructor creates a new ExportJTOptionsKit object that contains the same settings as the source ExportJTOptionsKit.
in_kit | The source ExportJTOptionsKit to copy. |
Exchange::ExportJTOptionsKit::ExportJTOptionsKit | ( | ExportJTOptionsKit && | in_that | ) |
The move constructor creates an ExportJTOptionsKit by transferring the underlying object of the rvalue reference to this ExportJTOptionsKit.
in_that | An rvalue reference to an ExportJTOptionsKit to take the underlying object from. |
|
virtual |
Indicates whether this ExportJTOptionsKit has any values set on it.
Reimplemented from Object.
bool Exchange::ExportJTOptionsKit::Equals | ( | ExportJTOptionsKit const & | in_kit | ) | const |
Check if the source ExportJTOptionsKit is equivalent to this ExportJTOptionsKit.
in_kit | The source ExportJTOptionsKit to compare to this ExportJTOptionsKit. |
|
static |
Creates an ExportJTOptionsKit 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::ExportJT.
|
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::ExportJTOptionsKit::operator!= | ( | ExportJTOptionsKit const & | in_kit | ) | const |
Check if the source ExportJTOptionsKit is not equivalent to this ExportJTOptionsKit.
in_kit | The source ExportJTOptionsKit to compare to this ExportJTOptionsKit. |
ExportJTOptionsKit& Exchange::ExportJTOptionsKit::operator= | ( | ExportJTOptionsKit const & | in_kit | ) |
Copies the source ExportJTOptionsKit into this ExportJTOptionsKit.
in_kit | The source ExportJTOptionsKit to copy. |
ExportJTOptionsKit& Exchange::ExportJTOptionsKit::operator= | ( | ExportJTOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this ExportJTOptionsKit.
in_that | An rvalue reference to an ExportJTOptionsKit to take the underlying object from. |
bool Exchange::ExportJTOptionsKit::operator== | ( | ExportJTOptionsKit const & | in_kit | ) | const |
Check if the source ExportJTOptionsKit is equivalent to this ExportJTOptionsKit.
in_kit | The source ExportJTOptionsKit to compare to this ExportJTOptionsKit. |
void Exchange::ExportJTOptionsKit::Set | ( | ExportJTOptionsKit const & | in_kit | ) |
Copies the source ExportJTOptionsKit into this ExportJTOptionsKit.
in_kit | The source ExportJTOptionsKit to copy. |
ExportJTOptionsKit& Exchange::ExportJTOptionsKit::SetContent | ( | JT::Content | in_content | ) |
Sets the type of data to export. This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_eWriteGeomTessMode.
in_content | The type of data to export. |
ExportJTOptionsKit& Exchange::ExportJTOptionsKit::SetHiddenObjects | ( | bool | in_state | ) |
Sets whether to export hidden objects. This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_bWriteHiddenObjects.
in_state | Whether to export hidden objects. |
ExportJTOptionsKit& Exchange::ExportJTOptionsKit::SetPMI | ( | bool | in_state | ) |
Sets whether to export PMI. This corresponds to the value that will be passed to A3DRWParamsExportJTData::m_bWritePMI.
in_state | Whether to export PMI. |
void Exchange::ExportJTOptionsKit::Show | ( | ExportJTOptionsKit & | out_kit | ) | const |
Copies this ExportJTOptionsKit into the given ExportJTOptionsKit.
out_kit | The ExportJTOptionsKit to populate with the contents of this ExportJTOptionsKit. |
bool Exchange::ExportJTOptionsKit::ShowContent | ( | JT::Content & | out_content | ) | const |
Shows the content export setting.
out_content | The type of data to export. |
bool Exchange::ExportJTOptionsKit::ShowHiddenObjects | ( | bool & | out_state | ) | const |
Shows the hidden object export setting.
out_state | Whether to export hidden objects. |
bool Exchange::ExportJTOptionsKit::ShowPMI | ( | bool & | out_state | ) | const |
Shows the PMI export setting.
out_state | Whether to export PMI. |
ExportJTOptionsKit& Exchange::ExportJTOptionsKit::UnsetContent | ( | ) |
Removes the content export setting.
ExportJTOptionsKit& Exchange::ExportJTOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ExportJTOptionsKit.
ExportJTOptionsKit& Exchange::ExportJTOptionsKit::UnsetHiddenObjects | ( | ) |
Removes the hidden objects export setting.
ExportJTOptionsKit& Exchange::ExportJTOptionsKit::UnsetPMI | ( | ) |
Removes the PMI export setting.