REFERENCE MANUAL
#include <sprk_parasolid.h>
Public Member Functions | |
bool | Empty () const |
bool | Equals (ExportOptionsKit const &in_kit) const |
ExportOptionsKit () | |
ExportOptionsKit (ExportOptionsKit const &in_kit) | |
ExportOptionsKit (ExportOptionsKit &&in_that) | |
Type | ObjectType () const |
bool | operator!= (ExportOptionsKit const &in_kit) const |
ExportOptionsKit & | operator= (ExportOptionsKit &&in_that) |
ExportOptionsKit & | operator= (ExportOptionsKit const &in_kit) |
bool | operator== (ExportOptionsKit const &in_kit) const |
void | Set (ExportOptionsKit const &in_kit) |
ExportOptionsKit & | SetFormat (Parasolid::Format in_format) |
ExportOptionsKit & | SetUserFields (bool in_export_user_fields) |
void | Show (ExportOptionsKit &out_kit) const |
bool | ShowFormat (Parasolid::Format &out_format) const |
bool | ShowUserFields (bool &out_user_fields) const |
ExportOptionsKit & | UnsetEverything () |
ExportOptionsKit & | UnsetFormat () |
ExportOptionsKit & | UnsetUserFields () |
![]() | |
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 ExportOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
enum | UpdateType { Synchronous, Asynchronous } |
The ExportOptionsKit class is a user space object. It contains settings controlling what and how data is exported via Parasolid. Default values for the various fields of this class can be found here.
Parasolid::ExportOptionsKit::ExportOptionsKit | ( | ) |
The default constructor creates an empty ExportOptionsKit object.
Parasolid::ExportOptionsKit::ExportOptionsKit | ( | ExportOptionsKit const & | in_kit | ) |
The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit.
in_kit | The source ExportOptionsKit to copy. |
Parasolid::ExportOptionsKit::ExportOptionsKit | ( | ExportOptionsKit && | in_that | ) |
The move constructor creates an ExportOptionsKit by transferring the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy and allocation.
in_that | An rvalue reference to an ExportOptionsKit to take the impl from. |
|
virtual |
Indicates whether this ExportOptionsKit has any values set on it.
Reimplemented from Object.
bool Parasolid::ExportOptionsKit::Equals | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
in_kit | The source ExportOptionsKit to compare to this ExportOptionsKit. |
|
static |
Creates an ExportOptionsKit 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::Export.
|
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 Parasolid::ExportOptionsKit::operator!= | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is not equivalent to this ExportOptionsKit.
in_kit | The source ExportOptionsKit to compare to this ExportOptionsKit. |
ExportOptionsKit& Parasolid::ExportOptionsKit::operator= | ( | ExportOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy.
in_that | An rvalue reference to an ExportOptionsKit to take the impl from. |
ExportOptionsKit& Parasolid::ExportOptionsKit::operator= | ( | ExportOptionsKit const & | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
in_kit | The source ExportOptionsKit to copy. |
bool Parasolid::ExportOptionsKit::operator== | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
in_kit | The source ExportOptionsKit to compare to this ExportOptionsKit. |
void Parasolid::ExportOptionsKit::Set | ( | ExportOptionsKit const & | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
in_kit | The source ExportOptionsKit to copy. |
ExportOptionsKit& Parasolid::ExportOptionsKit::SetFormat | ( | Parasolid::Format | in_format | ) |
Sets the format type to be exported. This corresponds to the value that will be passed to PK_PART_transmit_o_t.transmit_format.
in_format | The format of the file to be exported. |
ExportOptionsKit& Parasolid::ExportOptionsKit::SetUserFields | ( | bool | in_export_user_fields | ) |
Sets whether to export user fields from the CAD file. This corresponds to the value that will be passed to PK_PART_transmit_o_t.receive_user_fields.
in_export_user_fields | Whether to export user fields from the CAD file. |
void Parasolid::ExportOptionsKit::Show | ( | ExportOptionsKit & | out_kit | ) | const |
Copies this ExportOptionsKit into the given ExportOptionsKit.
out_kit | The ExportOptionsKit to populate with the contents of this ExportOptionsKit. |
bool Parasolid::ExportOptionsKit::ShowFormat | ( | Parasolid::Format & | out_format | ) | const |
Shows the format export setting.
out_format | The format setting for this export. |
bool Parasolid::ExportOptionsKit::ShowUserFields | ( | bool & | out_user_fields | ) | const |
Shows the user fields export setting.
out_user_fields | The user fields setting for this export. |
ExportOptionsKit& Parasolid::ExportOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ExportOptionsKit.
ExportOptionsKit& Parasolid::ExportOptionsKit::UnsetFormat | ( | ) |
Removes the format export state.
ExportOptionsKit& Parasolid::ExportOptionsKit::UnsetUserFields | ( | ) |
Removes the user fields export state.