HPS::Image::ImportOptionsKit Class Reference

#include <hps.h>

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

Public Member Functions

bool Empty () const
 
bool Equals (ImportOptionsKit const &in_kit) const
 
 ImportOptionsKit ()
 
 ImportOptionsKit (ImportOptionsKit const &in_kit)
 
 ImportOptionsKit (ImportOptionsKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (ImportOptionsKit const &in_kit) const
 
ImportOptionsKitoperator= (ImportOptionsKit &&in_that)
 
ImportOptionsKitoperator= (ImportOptionsKit const &in_kit)
 
bool operator== (ImportOptionsKit const &in_kit) const
 
void Set (ImportOptionsKit const &in_kit)
 
ImportOptionsKitSetCompressionQuality (float in_quality)
 
ImportOptionsKitSetDownSampling (bool in_state)
 
ImportOptionsKitSetFormat (Image::Format in_format)
 
ImportOptionsKitSetSize (unsigned int in_width, unsigned int in_height)
 
void Show (ImportOptionsKit &out_kit) const
 
bool ShowCompressionQuality (float &out_quality) const
 
bool ShowDownSampling (bool &out_state) const
 
bool ShowFormat (Image::Format &out_format) const
 
bool ShowSize (unsigned int &out_width, unsigned int &out_height) const
 
ImportOptionsKitUnsetCompressionQuality ()
 
ImportOptionsKitUnsetDownSampling ()
 
ImportOptionsKitUnsetEverything ()
 
ImportOptionsKitUnsetFormat ()
 
ImportOptionsKitUnsetSize ()
 
- 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 Attributes

static const HPS::Type staticType = HPS::Type::ImageImportOptionsKit
 
- 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

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

The ImportOptionsKit class contains options that will be used to import image files and will be set on the ImageKit returned by File::Import.

Constructor & Destructor Documentation

◆ ImportOptionsKit() [1/3]

HPS::Image::ImportOptionsKit::ImportOptionsKit ( )

The default constructor creates an empty ImportOptionsKit object.

◆ ImportOptionsKit() [2/3]

HPS::Image::ImportOptionsKit::ImportOptionsKit ( ImportOptionsKit const &  in_kit)

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

Parameters
in_kitThe source ImportOptionsKit to copy.

◆ ImportOptionsKit() [3/3]

HPS::Image::ImportOptionsKit::ImportOptionsKit ( ImportOptionsKit &&  in_that)

The move constructor creates an ImportOptionsKit by transferring the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy and allocation.

Parameters
in_thatAn rvalue reference to an ImportOptionsKit to take the impl from.

Member Function Documentation

◆ Empty()

bool HPS::Image::ImportOptionsKit::Empty ( ) const
virtual

Indicates whether this ImportOptionsKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

bool HPS::Image::ImportOptionsKit::Equals ( ImportOptionsKit const &  in_kit) const

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

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

◆ ObjectType()

HPS::Type HPS::Image::ImportOptionsKit::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::ImportOptionsKit::operator!= ( ImportOptionsKit const &  in_kit) const

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

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

◆ operator=() [1/2]

ImportOptionsKit& HPS::Image::ImportOptionsKit::operator= ( ImportOptionsKit &&  in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy.

Parameters
in_thatAn rvalue reference to an ImportOptionsKit to take the impl from.
Returns
A reference to this ImportOptionsKit.

◆ operator=() [2/2]

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

Copies the source ImportOptionsKit into this ImportOptionsKit.

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

◆ operator==()

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

Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit.

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

◆ Set()

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

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters
in_kitThe source ImportOptionsKit to copy.

◆ SetCompressionQuality()

ImportOptionsKit& HPS::Image::ImportOptionsKit::SetCompressionQuality ( float  in_quality)

Sets the compression quality for the image. This setting will be copied over to the ImageKit returned from File::Import. It doesn't need to be set for the import to succeed.

Parameters
in_qualityThe compression quality for the image.
Returns
A reference to this ImportOptionsKit.

◆ SetDownSampling()

ImportOptionsKit& HPS::Image::ImportOptionsKit::SetDownSampling ( bool  in_state)

Sets whether to down-sample the image. This setting will be copied over to the ImageKit returned from File::Import. It doesn't need to be set for the import to succeed.

Parameters
in_stateWhether to down-sample the image.
Returns
A reference to this ImportOptionsKit.

◆ SetFormat()

ImportOptionsKit& HPS::Image::ImportOptionsKit::SetFormat ( Image::Format  in_format)

Sets the format of the image. This must be specified when importing any image.

Parameters
in_formatThe format of the image.
Returns
A reference to this ImportOptionsKit.

◆ SetSize()

ImportOptionsKit& HPS::Image::ImportOptionsKit::SetSize ( unsigned int  in_width,
unsigned int  in_height 
)

Sets the width and height (in pixels) of the image. This does not need to be set when importing image files which contain this information (i.e., Image::Jpeg, Image::Png or Image::Targa). If this is not specified for images files which do not contain this information, an exception will be thrown on import.

Parameters
in_widthThe width (in pixels) of the image.
in_heightThe height (in pixels) of the image.
Returns
A reference to this ImportOptionsKit.

◆ Show()

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

Copies this ImportOptionsKit into the given ImportOptionsKit.

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

◆ ShowCompressionQuality()

bool HPS::Image::ImportOptionsKit::ShowCompressionQuality ( float &  out_quality) const

Shows the compression quality for the image.

Parameters
out_qualityThe compression quality for the image.
Returns
true if the compression quality is valid, false otherwise.

◆ ShowDownSampling()

bool HPS::Image::ImportOptionsKit::ShowDownSampling ( bool &  out_state) const

Shows whether to down-sample the image.

Parameters
out_statewhether to down-sample the image.
Returns
true if the flag is valid, false otherwise.

◆ ShowFormat()

bool HPS::Image::ImportOptionsKit::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::ImportOptionsKit::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.

◆ UnsetCompressionQuality()

ImportOptionsKit& HPS::Image::ImportOptionsKit::UnsetCompressionQuality ( )

Removes the compression quality for the image.

Returns
A reference to this ImportOptionsKit.

◆ UnsetDownSampling()

ImportOptionsKit& HPS::Image::ImportOptionsKit::UnsetDownSampling ( )

Removes whether to down-sample the image.

Returns
A reference to this ImportOptionsKit.

◆ UnsetEverything()

ImportOptionsKit& HPS::Image::ImportOptionsKit::UnsetEverything ( )

Removes all settings from this ImportOptionsKit.

Returns
A reference to this ImportOptionsKit.

◆ UnsetFormat()

ImportOptionsKit& HPS::Image::ImportOptionsKit::UnsetFormat ( )

Removes the format of the image.

Returns
A reference to this ImportOptionsKit.

◆ UnsetSize()

ImportOptionsKit& HPS::Image::ImportOptionsKit::UnsetSize ( )

Removes the width and height of the image.

Returns
A reference to this ImportOptionsKit.

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