#include <hps.h>

Public Member Functions | |
bool | Empty () const |
bool | Equals (ExportOptionsKit const &in_kit) const |
ExportOptionsKit () | |
ExportOptionsKit (ExportOptionsKit const &in_kit) | |
ExportOptionsKit (ExportOptionsKit &&in_that) | |
HPS::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 (Image::Format in_format) |
ExportOptionsKit & | SetSize (unsigned int in_width, unsigned int in_height) |
void | Show (ExportOptionsKit &out_kit) const |
bool | ShowFormat (Image::Format &out_format) const |
bool | ShowSize (unsigned int &out_width, unsigned int &out_height) const |
ExportOptionsKit & | UnsetEverything () |
ExportOptionsKit & | UnsetFormat () |
ExportOptionsKit & | UnsetSize () |
![]() | |
virtual HPS::Type | Type () const |
![]() | |
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 () |
Static Public Member Functions | |
static ExportOptionsKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Additional Inherited Members | |
![]() | |
Kit (Kit &&in_that) | |
Kit & | operator= (Kit &&in_that) |
Detailed Description
The HPS::Image::ExportOptionsKit class contains options that will be used to export image files. Calling HPS::Image::ExportOptionsKit::GetDefault() will return an options kit with values found in this table.
Constructor & Destructor Documentation
HPS::Image::ExportOptionsKit::ExportOptionsKit | ( | ) |
The default constructor creates an empty ExportOptionsKit object.
HPS::Image::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.
HPS::Image::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.
- Parameters
-
in_that An rvalue reference to an ExportOptionsKit to take the impl from.
Member Function Documentation
|
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.
bool HPS::Image::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.
|
static |
Creates a 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.
- Returns
- A ExportOptionsKit with the default settings.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Kit.
bool HPS::Image::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.
ExportOptionsKit& HPS::Image::ExportOptionsKit::operator= | ( | ExportOptionsKit && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to an ExportOptionsKit to take the impl from.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Image::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.
bool HPS::Image::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.
void HPS::Image::ExportOptionsKit::Set | ( | ExportOptionsKit const & | in_kit | ) |
Copies the source ExportOptionsKit into this ExportOptionsKit.
- Parameters
-
in_kit The source ExportOptionsKit to copy.
ExportOptionsKit& HPS::Image::ExportOptionsKit::SetFormat | ( | Image::Format | in_format | ) |
Sets the format of the image. This must be specified when exporting any image.
- Parameters
-
in_format The format of the image.
- Returns
- A reference to this ExportOptionsKit.
- See also
- Export format default value
ExportOptionsKit& HPS::Image::ExportOptionsKit::SetSize | ( | unsigned int | in_width, |
unsigned int | in_height | ||
) |
Sets the width and height (in pixels) of the image. If this is not specified , an exception will be thrown on export.
- Parameters
-
in_width The width (in pixels) of the image. in_height The height (in pixels) of the image.
- Returns
- A reference to this ExportOptionsKit.
void HPS::Image::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.
bool HPS::Image::ExportOptionsKit::ShowFormat | ( | Image::Format & | out_format | ) | const |
Shows the format of the image.
- Parameters
-
out_format The format of the image.
- Returns
- true if the format is valid, false otherwise.
bool HPS::Image::ExportOptionsKit::ShowSize | ( | unsigned int & | out_width, |
unsigned int & | out_height | ||
) | const |
Shows the width and height (in pixels) of the image.
- Parameters
-
out_width The width (in pixels) of the image. out_height The height (in pixels) of the image.
- Returns
- true if the width and height are valid, false otherwise.
ExportOptionsKit& HPS::Image::ExportOptionsKit::UnsetEverything | ( | ) |
Removes all settings from this ExportOptionsKit.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Image::ExportOptionsKit::UnsetFormat | ( | ) |
Removes the format of the image.
- Returns
- A reference to this ExportOptionsKit.
ExportOptionsKit& HPS::Image::ExportOptionsKit::UnsetSize | ( | ) |
Removes the width and height of the image.
- Returns
- A reference to this ExportOptionsKit.
The documentation for this class was generated from the following file:
- include/hps.h