#include <sprk_publish.h>

Public Member Functions | |
bool | Empty () const |
bool | Equals (ExportOptionsKit const &in_kit) const |
ExportOptionsKit () | |
ExportOptionsKit (ExportOptionsKit const &in_kit) | |
ExportOptionsKit (ExportOptionsKit &&in_kit) | |
HPS::Type | ObjectType () const |
bool | operator!= (ExportOptionsKit const &in_kit) const |
ExportOptionsKit & | operator= (ExportOptionsKit const &in_kit) |
ExportOptionsKit & | operator= (ExportOptionsKit &&in_kit) |
bool | operator== (ExportOptionsKit const &in_kit) const |
void | Set (ExportOptionsKit const &in_kit) |
ExportOptionsKit & | SetDocumentToAppendTo (char const *in_filename) |
void | Show (ExportOptionsKit &out_kit) const |
bool | ShowDocumentToAppendTo (UTF8 &out_filename) const |
ExportOptionsKit & | UnsetDocumentToAppendTo () |
ExportOptionsKit & | UnsetEverything () |
![]() | |
Sprocket (Sprocket &&in_that) | |
![]() | |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::PublishExportOptionsKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::SprocketKit |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
SprocketKit & | operator= (SprocketKit &&in_that) |
SprocketKit (SprocketKit &&in_that) | |
Detailed Description
The ExportOptionsKit class is a user space object. It contains settings controlling how 3D PDF data is exported via Publish.
Constructor & Destructor Documentation
◆ ExportOptionsKit() [1/3]
HPS::Publish::ExportOptionsKit::ExportOptionsKit | ( | ) |
The default constructor creates an empty ExportOptionsKit object.
◆ ExportOptionsKit() [2/3]
HPS::Publish::ExportOptionsKit::ExportOptionsKit | ( | ExportOptionsKit const & | in_kit | ) |
The copy constructor creates a new ExportOptionsKit object that contains the same settings as the source ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to copy.
◆ ExportOptionsKit() [3/3]
HPS::Publish::ExportOptionsKit::ExportOptionsKit | ( | ExportOptionsKit && | in_kit | ) |
The move constructor creates an ExportOptionsKit by transferring the underlying object of the rvalue reference to this ExportOptionsKit.
- Parameters
-
in_kit An rvalue reference to an ExportOptionsKit to take the underlying object from.
Member Function Documentation
◆ Empty()
|
virtual |
Indicates whether this ExportOptionsKit has any values set on it.
- Returns
- true if no values are set on this ExportOptionsKit, false otherwise.
Reimplemented from HPS::Object.
◆ Equals()
bool HPS::Publish::ExportOptionsKit::Equals | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to compare to this ExportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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.
◆ operator!=()
bool HPS::Publish::ExportOptionsKit::operator!= | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is not equivalent to this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to compare to this ExportOptionsKit.
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
ExportOptionsKit& HPS::Publish::ExportOptionsKit::operator= | ( | ExportOptionsKit const & | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to copy.
- Returns
- A reference to this ExportOptionsKit.
◆ operator=() [2/2]
ExportOptionsKit& HPS::Publish::ExportOptionsKit::operator= | ( | ExportOptionsKit && | in_kit | ) |
The move assignment operator transfers the underlying object of the rvalue reference to this ExportOptionsKit.
- Parameters
-
in_kit An rvalue reference to an ExportOptionsKit to take the underlying object from.
- Returns
- A reference to this ExportOptionsKit.
◆ operator==()
bool HPS::Publish::ExportOptionsKit::operator== | ( | ExportOptionsKit const & | in_kit | ) | const |
Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to compare to this ExportOptionsKit.
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::Publish::ExportOptionsKit::Set | ( | ExportOptionsKit const & | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to copy.
◆ SetDocumentToAppendTo()
ExportOptionsKit& HPS::Publish::ExportOptionsKit::SetDocumentToAppendTo | ( | char const * | in_filename | ) |
Sets the PDF document to append to.
- Parameters
-
in_filename UTF8-encoded filename of the PDF document to append to.
- Returns
- A reference to this ExportOptionsKit.
◆ Show()
void HPS::Publish::ExportOptionsKit::Show | ( | ExportOptionsKit & | out_kit | ) | const |
Copies this ExportOptionsKit into the given ExportOptionsKit.
- Parameters
-
out_kit The ExportOptionsKit to populate with the contents of this ExportOptionsKit.
◆ ShowDocumentToAppendTo()
bool HPS::Publish::ExportOptionsKit::ShowDocumentToAppendTo | ( | UTF8 & | out_filename | ) | const |
Shows the PDF document to append to setting.
- Parameters
-
out_filename Filename of the PDF document to append to.
- Returns
- true if a PDF document to append to setting was specified, false otherwise.
◆ UnsetDocumentToAppendTo()
ExportOptionsKit& HPS::Publish::ExportOptionsKit::UnsetDocumentToAppendTo | ( | ) |
Removes the PDF document to append to setting.
- Returns
- A reference to this ExportOptionsKit.
◆ UnsetEverything()
ExportOptionsKit& HPS::Publish::ExportOptionsKit::UnsetEverything | ( | ) |
Removes all data from the options kit.
- Returns
- A reference to this ExportOptionsKit.
The documentation for this class was generated from the following file:
- include/sprk_publish.h