The ImageKit class is a user space object. More...

#include <hps.h>

Inheritance diagram for HPS::ImageKit:

Collaboration diagram for HPS::ImageKit:

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

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

	ImageKit (ImageKit const &in_kit, HPS::Image::Format in_format)
	This constructor creates a new ImageKit object that contains the same settings as the source ImageKit but converts it to the specified format. More...

	ImageKit (ImageKit &&in_that)
	The move constructor creates an ImageKit by transferring the underlying impl of the rvalue reference to this ImageKit thereby avoiding a copy and allocation. More...

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

virtual	~ImageKit ()

HPS::Type	ObjectType () const

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

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

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

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

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

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

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

void	Convert (ImageKit const &in_kit, HPS::Image::Format in_format)
	Copies the source ImageKit into this ImageKit but converts it to the specified format. More...

void	Convert (HPS::Image::Format in_format)
	Converts this ImageKit to the specified format. More...

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

ImageKit &	SetData (ByteArray const &in_image_data)
	Sets the data for the image. More...

ImageKit &	SetData (size_t in_byte_count, byte const in_image_data [])
	Sets the data for the image. More...

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

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

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

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

ImageKit &	UnsetData ()
	Removes the data for the image. More...

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

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

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

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

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

bool	ShowData (ByteArray &out_image_data) const
	Shows the data for 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::ImageKit

Detailed Description

The ImageKit class is a user space object.

It is used for specifying all data associated with images.

Constructor & Destructor Documentation

◆ ImageKit() [1/4]

HPS::ImageKit::ImageKit ( )

The default constructor creates an empty ImageKit object.

◆ ImageKit() [2/4]

HPS::ImageKit::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.

◆ ImageKit() [3/4]

HPS::ImageKit::ImageKit	(	ImageKit const &	in_kit,
		HPS::Image::Format	in_format
	)

This constructor creates a new ImageKit object that contains the same settings as the source ImageKit but converts it to the specified format.

Parameters

in_kit	The source ImageKit to copy and convert.
in_format	The format to convert the source ImageKit to.

◆ ImageKit() [4/4]

HPS::ImageKit::ImageKit ( ImageKit && in_that )

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

Parameters

in_that An rvalue reference to an ImageKit to take the impl from.

◆ ~ImageKit()

virtual HPS::ImageKit::~ImageKit ( )

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.

◆ Convert() [1/2]

void HPS::ImageKit::Convert	(	ImageKit const &	in_kit,
		HPS::Image::Format	in_format
	)

Copies the source ImageKit into this ImageKit but converts it to the specified format.

Parameters

in_kit	The source ImageKit to copy and convert.
in_format	The format to convert the source ImageKit to.

◆ Convert() [2/2]

void HPS::ImageKit::Convert ( HPS::Image::Format in_format )

Converts this ImageKit to the specified format.

Parameters

in_format The format to convert the ImageKit to.

◆ Empty()

bool HPS::ImageKit::Empty ( ) const

virtual

Indicates whether this ImageKit has any values set on it.

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

Reimplemented from HPS::Object.

◆ Equals()

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

◆ 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::ImageKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

◆ operator=() [1/2]

ImageKit& HPS::ImageKit::operator= ( ImageKit && in_that )

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

Parameters

in_that An rvalue reference to an ImageKit to take the impl from.

Returns: A reference to this ImageKit.

◆ operator=() [2/2]

ImageKit& HPS::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.

◆ operator==()

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

◆ 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::ImageKit::Set ( ImageKit const & in_kit )

Copies the source ImageKit into this ImageKit.

Parameters

in_kit The source ImageKit to copy.

◆ SetCompressionQuality()

ImageKit& HPS::ImageKit::SetCompressionQuality ( float in_quality )

Sets the compression quality for the image.

Values range from highest compression and poorest quality (0) to no compression and full quality (1).

Parameters

in_quality The compression quality for the image, a floating point value between 0 and 1.

Returns: A reference to this ImageKit.

◆ SetData() [1/2]

ImageKit& HPS::ImageKit::SetData ( ByteArray const & in_image_data )

Sets the data for the image.

Parameters

in_image_data The array of data for the image.

Returns: A reference to this ImageKit.

◆ SetData() [2/2]

ImageKit& HPS::ImageKit::SetData	(	size_t	in_byte_count,
		byte const	in_image_data[]
	)

Sets the data for the image.

Parameters

in_byte_count	The size of the following array.
in_image_data	The array of data for the image.

Returns: A reference to this ImageKit.

◆ SetDownSampling()

ImageKit& HPS::ImageKit::SetDownSampling ( bool in_state )

Sets the whether to down-sample the image.

Parameters

in_state Whether to down-sample the image.

Returns: A reference to this ImageKit.

◆ SetFormat()

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

Sets the format of the image.

Parameters

in_format The format of the image.

Returns: A reference to this ImageKit.

◆ SetSize()

ImageKit& HPS::ImageKit::SetSize	(	unsigned int	in_width,
		unsigned int	in_height
	)

Sets the width and height (in pixels) of the image.

Parameters

in_width	The width (in pixels) of the image.
in_height	The height (in pixels) of the image.

Returns: A reference to this ImageKit.

◆ Show()

void HPS::ImageKit::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.

◆ ShowCompressionQuality()

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

◆ ShowData()

bool HPS::ImageKit::ShowData ( ByteArray & out_image_data ) const

Shows the data for the image.

Parameters

out_image_data The array of data for the image.

Returns: true if the data array is valid, false otherwise.

◆ ShowDownSampling()

bool HPS::ImageKit::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::ImageKit::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::ImageKit::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()

ImageKit& HPS::ImageKit::UnsetCompressionQuality ( )

Removes the compression quality for the image.

Returns: A reference to this ImageKit.

◆ UnsetData()

ImageKit& HPS::ImageKit::UnsetData ( )

Removes the data for the image.

Returns: A reference to this ImageKit.

◆ UnsetDownSampling()

ImageKit& HPS::ImageKit::UnsetDownSampling ( )

Removes whether to down-sample the image.

Returns: A reference to this ImageKit.

◆ UnsetEverything()

ImageKit& HPS::ImageKit::UnsetEverything ( )

Removes all settings from this ImageKit.

Returns: A reference to this ImageKit.

◆ UnsetFormat()

ImageKit& HPS::ImageKit::UnsetFormat ( )

Removes the format of the image.

Returns: A reference to this ImageKit.

◆ UnsetSize()

ImageKit& HPS::ImageKit::UnsetSize ( )

Removes the width and height of the image.

Returns: A reference to this ImageKit.

Member Data Documentation

◆ staticType

const HPS::Type HPS::ImageKit::staticType = HPS::Type::ImageKit

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

◆ ImageKit() [1/4]

◆ ImageKit() [2/4]

◆ ImageKit() [3/4]

◆ ImageKit() [4/4]

◆ ~ImageKit()

Member Function Documentation

◆ ClassID()

◆ Convert() [1/2]

◆ Convert() [2/2]

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetCompressionQuality()

◆ SetData() [1/2]

◆ SetData() [2/2]

◆ SetDownSampling()

◆ SetFormat()

◆ SetSize()

◆ Show()

◆ ShowCompressionQuality()

◆ ShowData()

◆ ShowDownSampling()

◆ ShowFormat()

◆ ShowSize()

◆ Type()

◆ UnsetCompressionQuality()

◆ UnsetData()

◆ UnsetDownSampling()

◆ UnsetEverything()

◆ UnsetFormat()

◆ UnsetSize()

Member Data Documentation

◆ staticType