#include <sprk_publish.h>
|
static const HPS::Type | staticType = HPS::Type::PublishImageKit |
|
static const HPS::Type | staticType = HPS::Type::SprocketKit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
The ImageKit class is a user space object. It acts as the container for all data that can be used to specify an image for a Publish PDF.
◆ ImageKit() [1/3]
HPS::Publish::ImageKit::ImageKit |
( |
| ) |
|
The default constructor creates an empty ImageKit object.
◆ ImageKit() [2/3]
HPS::Publish::ImageKit::ImageKit |
( |
ImageKit const & |
in_kit | ) |
|
The copy constructor creates a new ImageKit object that contains the same settings as the source ImageKit.
- Parameters
-
◆ ImageKit() [3/3]
HPS::Publish::ImageKit::ImageKit |
( |
ImageKit && |
in_kit | ) |
|
The move constructor creates an ImageKit by transferring the underlying object of the rvalue reference to this ImageKit.
- Parameters
-
in_kit | An rvalue reference to an ImageKit to take the underlying object from. |
◆ Empty()
bool HPS::Publish::ImageKit::Empty |
( |
| ) |
const |
|
virtual |
Indicates whether this ImageKit has any values set on it.
- Returns
- true if no values are set on this ImageKit, false otherwise.
Reimplemented from HPS::Object.
◆ Equals()
bool HPS::Publish::ImageKit::Equals |
( |
ImageKit const & |
in_kit | ) |
const |
Check if the source ImageKit is equivalent to this ImageKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ ObjectType()
HPS::Type HPS::Publish::ImageKit::ObjectType |
( |
| ) |
const |
|
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::ImageKit::operator!= |
( |
ImageKit const & |
in_kit | ) |
const |
Check if the source ImageKit is not equivalent to this ImageKit.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
◆ operator=() [2/2]
The move assignment operator transfers the underlying object of the rvalue reference to this ImageKit.
- Parameters
-
in_kit | An rvalue reference to an ImageKit to take the underlying object from. |
- Returns
- A reference to this ImageKit.
◆ operator==()
bool HPS::Publish::ImageKit::operator== |
( |
ImageKit const & |
in_kit | ) |
const |
Check if the source ImageKit is equivalent to this ImageKit.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
void HPS::Publish::ImageKit::Set |
( |
ImageKit const & |
in_kit | ) |
|
◆ SetFile()
ImageKit& HPS::Publish::ImageKit::SetFile |
( |
char const * |
in_filename | ) |
|
Sets the file for the image. This corresponds to the value that will be passed to A3DPDFImageData::m_pcFileName.
- Parameters
-
in_filename | UTF8-encoded filename for the image. |
- Returns
- A reference to this ImageKit.
◆ SetFormat()
Sets the format of the image. This corresponds to the value that will be passed to A3DPDFImageData::m_eFormat.
- Parameters
-
in_format | The format of the image. |
- Returns
- A reference to this ImageKit.
◆ SetSize()
ImageKit& HPS::Publish::ImageKit::SetSize |
( |
int |
in_width, |
|
|
int |
in_height |
|
) |
| |
◆ Show()
void HPS::Publish::ImageKit::Show |
( |
ImageKit & |
out_kit | ) |
const |
◆ ShowFile()
bool HPS::Publish::ImageKit::ShowFile |
( |
UTF8 & |
out_filename | ) |
const |
Shows the file setting.
- Parameters
-
out_filename | The filename for the image. |
- Returns
- true if a color was specified, false otherwise.
◆ ShowFormat()
bool HPS::Publish::ImageKit::ShowFormat |
( |
Image::Format & |
out_format | ) |
const |
Shows the format setting.
- Parameters
-
out_format | The format of the image. |
- Returns
- true if a format was specified, false otherwise.
◆ ShowSize()
bool HPS::Publish::ImageKit::ShowSize |
( |
int & |
out_width, |
|
|
int & |
out_height |
|
) |
| const |
Shows the size setting.
- Parameters
-
out_width | The width of the image in pixels. |
out_height | The height of the image in pixels. |
- Returns
- true if a width and height were specified, false otherwise.
◆ UnsetEverything()
ImageKit& HPS::Publish::ImageKit::UnsetEverything |
( |
| ) |
|
Removes all data from the image.
- Returns
- A reference to this ImageKit.
◆ UnsetFile()
ImageKit& HPS::Publish::ImageKit::UnsetFile |
( |
| ) |
|
Removes the file from the image.
- Returns
- A reference to this ImageKit.
◆ UnsetFormat()
ImageKit& HPS::Publish::ImageKit::UnsetFormat |
( |
| ) |
|
Removes the format from the image.
- Returns
- A reference to this ImageKit.
◆ UnsetSize()
ImageKit& HPS::Publish::ImageKit::UnsetSize |
( |
| ) |
|
Removes the size from the image.
- Returns
- A reference to this ImageKit.
The documentation for this class was generated from the following file: