HPS::Publish::ImageKit Class Reference

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

#include <sprk_publish.h>

Inheritance diagram for HPS::Publish::ImageKit:

Collaboration diagram for HPS::Publish::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 &&in_kit)
	The move constructor creates an ImageKit by transferring the underlying object of the rvalue reference to this ImageKit. 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...
ImageKit &	operator= (ImageKit &&in_kit)
	The move assignment operator transfers the underlying object of the rvalue reference to 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...
ImageKit &	SetFile (char const *in_filename)
	Sets the file for the image. More...
ImageKit &	SetSize (int in_width, int in_height)
	Sets the size of the image in pixels. More...
ImageKit &	SetFormat (Image::Format in_format)
	Sets the format of the image. More...
ImageKit &	UnsetFile ()
	Removes the file from the image. More...
ImageKit &	UnsetSize ()
	Removes the size from the image. More...
ImageKit &	UnsetFormat ()
	Removes the format from the image. More...
ImageKit &	UnsetEverything ()
	Removes all data from the image. More...
bool	ShowFile (UTF8 &out_filename) const
	Shows the file setting. More...
bool	ShowSize (int &out_width, int &out_height) const
	Shows the size setting. More...
bool	ShowFormat (Image::Format &out_format) const
	Shows the format setting. 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::PublishImageKit

Detailed Description

The ImageKit class is a user space object.

It acts as the container for all data that can be used to specify an image for a Publish PDF.

Constructor & Destructor Documentation

ImageKit() [1/3]

HPS::Publish::ImageKit::ImageKit

(

)

The default constructor creates an empty ImageKit object.

ImageKit() [2/3]

HPS::Publish::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/3]

HPS::Publish::ImageKit::ImageKit

(

ImageKit &&

in_kit

)

The move constructor creates an ImageKit by transferring the underlying object of the rvalue reference to this ImageKit.

Parameters

in_kit

An rvalue reference to an ImageKit to take the underlying object from.

~ImageKit()

virtual HPS::Publish::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.

Empty()

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

inlinevirtual

Reimplemented from HPS::SprocketKit.

Here is the call graph for this function:

operator!=()

bool HPS::Publish::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::Publish::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=() [2/2]

ImageKit& HPS::Publish::ImageKit::operator=

(

ImageKit &&

in_kit

)

The move assignment operator transfers the underlying object of the rvalue reference to this ImageKit.

Parameters

in_kit

An rvalue reference to an ImageKit to take the underlying object from.

Returns

A reference to this ImageKit.

operator==()

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

(

ImageKit const &

in_kit

)

Copies the source ImageKit into this ImageKit.

Parameters

in_kit

The source ImageKit to copy.

SetFile()

ImageKit& HPS::Publish::ImageKit::SetFile

(

char const *

in_filename

)

Sets the file for the image.

This corresponds to the value that will be passed to A3DPDFImageData::m_pcFileName.

Parameters

in_filename

UTF8-encoded filename for the image.

Returns

A reference to this ImageKit.

SetFormat()

ImageKit& HPS::Publish::ImageKit::SetFormat

(

Image::Format

in_format

)

Sets the format of the image.

This corresponds to the value that will be passed to A3DPDFImageData::m_eFormat.

Parameters

in_format

The format of the image.

Returns

A reference to this ImageKit.

SetSize()

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

Sets the size of the image in pixels.

This corresponds to the value that will be passed to A3DPDFImageData::m_iWidth and A3DPDFImageData::m_iHeight.

Parameters

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

Returns

A reference to this ImageKit.

Show()

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

ShowFile()

bool HPS::Publish::ImageKit::ShowFile

(

UTF8 &

out_filename

)

const

Shows the file setting.

Parameters

out_filename

The filename for the image.

Returns

true if a color was specified, false otherwise.

ShowFormat()

bool HPS::Publish::ImageKit::ShowFormat

(

Image::Format &

out_format

)

const

Shows the format setting.

Parameters

out_format

The format of the image.

Returns

true if a format was specified, false otherwise.

ShowSize()

bool HPS::Publish::ImageKit::ShowSize	(	int &	out_width,
		int &	out_height
	)		const

Shows the size setting.

Parameters

out_width	The width of the image in pixels.
out_height	The height of the image in pixels.

Returns

true if a width and height were specified, false otherwise.

Type()

virtual HPS::Type HPS::Object::Type ( ) const

virtualinherited

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 in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.

UnsetEverything()

ImageKit& HPS::Publish::ImageKit::UnsetEverything

(

)

Removes all data from the image.

Returns

A reference to this ImageKit.

UnsetFile()

ImageKit& HPS::Publish::ImageKit::UnsetFile

(

)

Removes the file from the image.

Returns

A reference to this ImageKit.

UnsetFormat()

ImageKit& HPS::Publish::ImageKit::UnsetFormat

(

)

Removes the format from the image.

Returns

A reference to this ImageKit.

UnsetSize()

ImageKit& HPS::Publish::ImageKit::UnsetSize

(

)

Removes the size from the image.

Returns

A reference to this ImageKit.

Member Data Documentation

staticType

const HPS::Type HPS::Publish::ImageKit::staticType = HPS::Type::PublishImageKit

static

---

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

• sprk_publish.h