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

#include <hps.h>

Inheritance diagram for HPS::Image::ImportOptionsKit:

[legend]

Collaboration diagram for HPS::Image::ImportOptionsKit:

[legend]

Public Member Functions
	ImportOptionsKit ()
	The default constructor creates an empty ImportOptionsKit object. More...

	ImportOptionsKit (ImportOptionsKit const &in_kit)
	The copy constructor creates a new ImportOptionsKit object that contains the same settings as the source ImportOptionsKit. More...

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

ImportOptionsKit &	operator= (ImportOptionsKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this ImportOptionsKit thereby avoiding a copy. More...

virtual	~ImportOptionsKit ()

HPS::Type	ObjectType () const

void	Set (ImportOptionsKit const &in_kit)
	Copies the source ImportOptionsKit into this ImportOptionsKit. More...

void	Show (ImportOptionsKit &out_kit) const
	Copies this ImportOptionsKit into the given ImportOptionsKit. More...

ImportOptionsKit &	operator= (ImportOptionsKit const &in_kit)
	Copies the source ImportOptionsKit into this ImportOptionsKit. More...

bool	Empty () const
	Indicates whether this ImportOptionsKit has any values set on it. More...

bool	Equals (ImportOptionsKit const &in_kit) const
	Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit. More...

bool	operator== (ImportOptionsKit const &in_kit) const
	Check if the source ImportOptionsKit is equivalent to this ImportOptionsKit. More...

bool	operator!= (ImportOptionsKit const &in_kit) const
	Check if the source ImportOptionsKit is not equivalent to this ImportOptionsKit. More...

ImportOptionsKit &	SetSize (unsigned int in_width, unsigned int in_height)
	Sets the width and height (in pixels) of the image. More...

ImportOptionsKit &	SetFormat (Image::Format in_format)
	Sets the format of the image. More...

ImportOptionsKit &	SetDownSampling (bool in_state)
	Sets whether to down-sample the image. More...

ImportOptionsKit &	SetCompressionQuality (float in_quality)
	Sets the compression quality for the image. More...

ImportOptionsKit &	UnsetSize ()
	Removes the width and height of the image. More...

ImportOptionsKit &	UnsetFormat ()
	Removes the format of the image. More...

ImportOptionsKit &	UnsetDownSampling ()
	Removes whether to down-sample the image. More...

ImportOptionsKit &	UnsetCompressionQuality ()
	Removes the compression quality for the image. More...

ImportOptionsKit &	UnsetEverything ()
	Removes all settings from this ImportOptionsKit. More...

bool	ShowSize (unsigned int &out_width, unsigned int &out_height) const
	Shows the width and height (in pixels) of the image. More...

bool	ShowFormat (Image::Format &out_format) const
	Shows the format of the image. More...

bool	ShowDownSampling (bool &out_state) const
	Shows whether to down-sample the image. More...

bool	ShowCompressionQuality (float &out_quality) const
	Shows the compression quality for the image. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::ImageImportOptionsKit

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_kit The 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_that An rvalue reference to an ImportOptionsKit to take the impl from.

◆ ~ImportOptionsKit()

virtual HPS::Image::ImportOptionsKit::~ImportOptionsKit ( )

virtual

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ 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_kit The source ImportOptionsKit to compare to this ImportOptionsKit.

Returns: true if the objects are equivalent, false otherwise.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::Image::ImportOptionsKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The 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_that An 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_kit The 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_kit The source ImportOptionsKit to compare to this ImportOptionsKit.

Returns: true if the objects are equivalent, false otherwise.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

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

Copies the source ImportOptionsKit into this ImportOptionsKit.

Parameters

in_kit The 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_quality The 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_state Whether 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_format The 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_width	The width (in pixels) of the image.
in_height	The 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_kit The 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_quality The 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_state whether 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_format The 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_width	The width (in pixels) of the image.
out_height	The height (in pixels) of the image.

Returns: true if the width and height are valid, false otherwise.

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

This function returns the true type of the underlying object.

This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Returns: The true type of the object in question.

Reimplemented from HPS::Object.

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

Member Data Documentation

◆ staticType

const HPS::Type HPS::Image::ImportOptionsKit::staticType = HPS::Type::ImageImportOptionsKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ImportOptionsKit() [1/3]

◆ ImportOptionsKit() [2/3]

◆ ImportOptionsKit() [3/3]

◆ ~ImportOptionsKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetCompressionQuality()

◆ SetDownSampling()

◆ SetFormat()

◆ SetSize()

◆ Show()

◆ ShowCompressionQuality()

◆ ShowDownSampling()

◆ ShowFormat()

◆ ShowSize()

◆ Type()

◆ UnsetCompressionQuality()

◆ UnsetDownSampling()

◆ UnsetEverything()

◆ UnsetFormat()

◆ UnsetSize()

Member Data Documentation

◆ staticType