#include <hps.h>
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.
HPS::Image::ExportOptionsKit::ExportOptionsKit |
( |
| ) |
|
HPS::Image::ExportOptionsKit::ExportOptionsKit |
( |
ExportOptionsKit const & |
in_kit | ) |
|
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
-
bool HPS::Image::ExportOptionsKit::Empty |
( |
| ) |
const |
|
virtual |
bool HPS::Image::ExportOptionsKit::Equals |
( |
ExportOptionsKit const & |
in_kit | ) |
const |
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.
HPS::Type HPS::Image::ExportOptionsKit::ObjectType |
( |
| ) |
const |
|
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::Object.
bool HPS::Image::ExportOptionsKit::operator!= |
( |
ExportOptionsKit const & |
in_kit | ) |
const |
The move assignment operator transfers the underlying impl of the rvalue reference to this ExportOptionsKit thereby avoiding a copy.
- Parameters
-
- Returns
- A reference to this ExportOptionsKit.
bool HPS::Image::ExportOptionsKit::operator== |
( |
ExportOptionsKit const & |
in_kit | ) |
const |
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.
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.
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:
- C:/git/visualize/hps/include/hps.h