Public Member Functions | Static Public Member Functions | List of all members
HPS::Image::ExportOptionsKit Class Reference

#include <hps.h>

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

Public Member Functions

 ExportOptionsKit ()
 
 ExportOptionsKit (ExportOptionsKit const &in_kit)
 
 ExportOptionsKit (ExportOptionsKit &&in_that)
 
ExportOptionsKitoperator= (ExportOptionsKit &&in_that)
 
HPS::Type ObjectType () const
 
void Set (ExportOptionsKit const &in_kit)
 
void Show (ExportOptionsKit &out_kit) const
 
ExportOptionsKitoperator= (ExportOptionsKit const &in_kit)
 
bool Empty () const
 
bool Equals (ExportOptionsKit const &in_kit) const
 
bool operator== (ExportOptionsKit const &in_kit) const
 
bool operator!= (ExportOptionsKit const &in_kit) const
 
ExportOptionsKitSetSize (unsigned int in_width, unsigned int in_height)
 
ExportOptionsKitSetFormat (Image::Format in_format)
 
ExportOptionsKitUnsetSize ()
 
ExportOptionsKitUnsetFormat ()
 
ExportOptionsKitUnsetEverything ()
 
bool ShowSize (unsigned int &out_width, unsigned int &out_height) const
 
bool ShowFormat (Image::Format &out_format) const
 
- Public Member Functions inherited from HPS::Object
 Object (Object const &that)
 
Objectoperator= (Object const &other_object)
 
 Object (Object &&in_that)
 
Objectoperator= (Object &&in_that)
 
HPS::Type Type () const
 
virtual void Reset ()
 
bool HasType (HPS::Type in_mask) const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 

Static Public Member Functions

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

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

Member Function Documentation

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.

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

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.
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.
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.
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.
void HPS::Image::ExportOptionsKit::Set ( ExportOptionsKit const &  in_kit)

Copies the source ExportOptionsKit into this ExportOptionsKit.

Parameters
in_kitThe 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_formatThe 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_widthThe width (in pixels) of the image.
in_heightThe 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_kitThe 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_formatThe 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_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.
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: