#include <hps.h>

Inheritance diagram for HPS::Image::ExportOptionsKit:
HPS::Kit HPS::Object

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
 
ExportOptionsKitoperator= (ExportOptionsKit &&in_that)
 
ExportOptionsKitoperator= (ExportOptionsKit const &in_kit)
 
bool operator== (ExportOptionsKit const &in_kit) const
 
void Set (ExportOptionsKit const &in_kit)
 
ExportOptionsKitSetFormat (Image::Format in_format)
 
ExportOptionsKitSetSize (unsigned int in_width, unsigned int in_height)
 
ExportOptionsKitSetTransparentBackground (bool in_state)
 
void Show (ExportOptionsKit &out_kit) const
 
bool ShowFormat (Image::Format &out_format) const
 
bool ShowSize (unsigned int &out_width, unsigned int &out_height) const
 
bool ShowTransparentBackground (bool &out_state) const
 
ExportOptionsKitUnsetEverything ()
 
ExportOptionsKitUnsetFormat ()
 
ExportOptionsKitUnsetSize ()
 
ExportOptionsKitUnsetTransparentBackground ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
 Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static ExportOptionsKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::ImageExportOptionsKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (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

◆ ExportOptionsKit() [1/3]

HPS::Image::ExportOptionsKit::ExportOptionsKit ( )

The default constructor creates an empty ExportOptionsKit object.

◆ ExportOptionsKit() [2/3]

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_kitThe source ExportOptionsKit to copy.

◆ ExportOptionsKit() [3/3]

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_thatAn rvalue reference to an ExportOptionsKit to take the impl from.

Member Function Documentation

◆ Empty()

bool HPS::Image::ExportOptionsKit::Empty ( ) const
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::Image::ExportOptionsKit::Equals ( ExportOptionsKit const &  in_kit) const

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Parameters
in_kitThe source ExportOptionsKit to compare to this ExportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static ExportOptionsKit HPS::Image::ExportOptionsKit::GetDefault ( )
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.

◆ ObjectType()

HPS::Type HPS::Image::ExportOptionsKit::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::Kit.

◆ operator!=()

bool HPS::Image::ExportOptionsKit::operator!= ( ExportOptionsKit const &  in_kit) const

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

Parameters
in_kitThe source ExportOptionsKit to compare to this ExportOptionsKit.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

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_thatAn rvalue reference to an ExportOptionsKit to take the impl from.
Returns
A reference to this ExportOptionsKit.

◆ operator=() [2/2]

ExportOptionsKit& HPS::Image::ExportOptionsKit::operator= ( ExportOptionsKit const &  in_kit)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters
in_kitThe source ExportOptionsKit to copy.
Returns
A reference to this ExportOptionsKit.

◆ operator==()

bool HPS::Image::ExportOptionsKit::operator== ( ExportOptionsKit const &  in_kit) const

Check if the source ExportOptionsKit is equivalent to this ExportOptionsKit.

Parameters
in_kitThe source ExportOptionsKit to compare to this ExportOptionsKit.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::Image::ExportOptionsKit::Set ( ExportOptionsKit const &  in_kit)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters
in_kitThe source ExportOptionsKit to copy.

◆ SetFormat()

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_formatThe format of the image.
Returns
A reference to this ExportOptionsKit.
See also
Export format default value

◆ SetSize()

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_widthThe width (in pixels) of the image.
in_heightThe height (in pixels) of the image.
Returns
A reference to this ExportOptionsKit.

◆ SetTransparentBackground()

ExportOptionsKit& HPS::Image::ExportOptionsKit::SetTransparentBackground ( bool  in_state)

Sets whether the image background will be transparent. This setting is only valid when exporting a PNG image.

Parameters
in_stateWhether the image background will be transparent.
Returns
A reference to this ExportOptionsKit.

◆ Show()

void HPS::Image::ExportOptionsKit::Show ( ExportOptionsKit out_kit) const

Copies this ExportOptionsKit into the given ExportOptionsKit.

Parameters
out_kitThe ExportOptionsKit to populate with the contents of this ExportOptionsKit.

◆ ShowFormat()

bool HPS::Image::ExportOptionsKit::ShowFormat ( Image::Format out_format) const

Shows the format of the image.

Parameters
out_formatThe format of the image.
Returns
true if the format is valid, false otherwise.

◆ ShowSize()

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_widthThe width (in pixels) of the image.
out_heightThe height (in pixels) of the image.
Returns
true if the width and height are valid, false otherwise.

◆ ShowTransparentBackground()

bool HPS::Image::ExportOptionsKit::ShowTransparentBackground ( bool &  out_state) const

Shows transparent background setting for this image

Parameters
out_stateThe transparent background setting for this image.
Returns
true if a background preference was specified, false otherwise.

◆ UnsetEverything()

ExportOptionsKit& HPS::Image::ExportOptionsKit::UnsetEverything ( )

Removes all settings from this ExportOptionsKit.

Returns
A reference to this ExportOptionsKit.

◆ UnsetFormat()

ExportOptionsKit& HPS::Image::ExportOptionsKit::UnsetFormat ( )

Removes the format of the image.

Returns
A reference to this ExportOptionsKit.

◆ UnsetSize()

ExportOptionsKit& HPS::Image::ExportOptionsKit::UnsetSize ( )

Removes the width and height of the image.

Returns
A reference to this ExportOptionsKit.

◆ UnsetTransparentBackground()

ExportOptionsKit& HPS::Image::ExportOptionsKit::UnsetTransparentBackground ( )

Removes the transparent background setting of the image.

Returns
A reference to this ExportOptionsKit.

The documentation for this class was generated from the following file: