HPS::Publish::ImageKit

class HPS::Publish::ImageKit : public HPS::SprocketKit

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.

Public Functions

virtual bool Empty() const

Indicates whether this ImageKit has any values set on it.

Returns: true if no values are set on this ImageKit, false otherwise.

bool Equals(ImageKit const &in_kit) const

Check if the source ImageKit is equivalent to this ImageKit.

Parameters: in_kit – The source ImageKit to compare to this ImageKit.
Returns: true if the objects are equivalent, false otherwise.

ImageKit(): The default constructor creates an empty ImageKit object.

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.

ImageKit(ImageKit const &in_kit)

The copy constructor creates a new ImageKit object that contains the same settings as the source ImageKit.

Parameters: in_kit – The source ImageKit to copy.

inline virtual HPS::Type ObjectType() const

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.

bool operator!=(ImageKit const &in_kit) const

Check if the source ImageKit is not equivalent to this ImageKit.

Parameters: in_kit – The source ImageKit to compare to this ImageKit.
Returns: true if the objects are not equivalent, false otherwise.

ImageKit &operator=(ImageKit &&in_kit)

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.

ImageKit &operator=(ImageKit const &in_kit)

Copies the source ImageKit into this ImageKit.

Parameters: in_kit – The source ImageKit to copy.
Returns: A reference to this ImageKit.

bool operator==(ImageKit const &in_kit) const

Check if the source ImageKit is equivalent to this ImageKit.

Parameters: in_kit – The source ImageKit to compare to this ImageKit.
Returns: true if the objects are equivalent, false otherwise.

void Set(ImageKit const &in_kit)

Copies the source ImageKit into this ImageKit.

Parameters: in_kit – The source ImageKit to copy.

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.

ImageKit &SetFormat(Image::Format in_format)

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.

ImageKit &SetSize(int in_width, int in_height)

Sets the size of the image in pixels. This corresponds to the value that will be passed to A3DPDFImageData::m_iWidth and A3DPDFImageData::m_iHeight.

Parameters

in_width – The width of the image in pixels.
in_height – The height of the image in pixels.

Returns

A reference to this ImageKit.

void Show(ImageKit &out_kit) const

Copies this ImageKit into the given ImageKit.

Parameters: out_kit – The ImageKit to populate with the contents of this ImageKit.

bool 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.

bool 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.

bool 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.

ImageKit &UnsetEverything()

Removes all data from the image.

Returns: A reference to this ImageKit.

ImageKit &UnsetFile()

Removes the file from the image.

Returns: A reference to this ImageKit.

ImageKit &UnsetFormat()

Removes the format from the image.

Returns: A reference to this ImageKit.

ImageKit &UnsetSize()

Removes the size from the image.

Returns: A reference to this ImageKit.

virtual ~ImageKit()

Public Static Attributes

static const HPS::Type staticType = HPS::Type::PublishImageKit