HPS::FontInfoState Class Reference

The FontInfoState class is a user space object, useful for carrying a group attribute settings. More...

#include <hps.h>

Inheritance diagram for HPS::FontInfoState:

Collaboration diagram for HPS::FontInfoState:

Public Member Functions
	FontInfoState ()
	Initializes an empty State. More...
	FontInfoState (FontInfoState const &in_kit)
	Copies the kit in_kit into this kit. More...
	FontInfoState (FontInfoState &&in_that)
	The move constructor creates a FontInfoState by transferring the underlying impl of the rvalue reference to this FontInfoState thereby avoiding a copy and allocation. More...
FontInfoState &	operator= (FontInfoState &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this FontInfoState thereby avoiding a copy. More...
virtual	~FontInfoState ()
	Destroy this kit. More...
HPS::Type	ObjectType () const
void	Assign (FontInfoState const &in_that)
	Copies the source FontInfoState into this FontInfoState. More...
void	Set (FontInfoState const &in_kit)
	Copies the source FontInfoState into this object. More...
void	Show (FontInfoState &out_kit) const
	Copies this object into the given FontInfoState. More...
FontInfoState &	operator= (FontInfoState const &in_kit)
	Copies the source FontInfoState into this object. More...
bool	Empty () const
	Indicates whether this object has any values set on it. More...
bool	Equals (FontInfoState const &in_kit) const
	Check if the source FontInfoState is equivalent to this object. More...
bool	operator== (FontInfoState const &in_kit) const
	Check if the source FontInfoState is equivalent to this object. More...
bool	operator!= (FontInfoState const &in_kit) const
	Check if the source FontInfoState is not equivalent to this object. More...
UTF8	GetName () const
	Gets the name of this font. More...
bool	ShowSystemName (HPS::UTF8 &out_name) const
	Shows the system name for this font. More...
bool	GetShellConvertibility () const
	Gets the shell convertibility of this font. 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::FontInfoState

Detailed Description

The FontInfoState class is a user space object, useful for carrying a group attribute settings.

Constructor & Destructor Documentation

FontInfoState() [1/3]

HPS::FontInfoState::FontInfoState

(

)

Initializes an empty State.

FontInfoState() [2/3]

HPS::FontInfoState::FontInfoState

(

FontInfoState const &

in_kit

)

Copies the kit in_kit into this kit.

FontInfoState() [3/3]

HPS::FontInfoState::FontInfoState

(

FontInfoState &&

in_that

)

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

Parameters

in_that

An rvalue reference to a FontInfoState to take the impl from.

~FontInfoState()

virtual HPS::FontInfoState::~FontInfoState ( )

virtual

Destroy this kit.

Member Function Documentation

Assign()

void HPS::FontInfoState::Assign

(

FontInfoState const &

in_that

)

Copies the source FontInfoState into this FontInfoState.

Parameters

in_that

The source LocatorState to copy.

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::FontInfoState::Empty ( ) const

virtual

Indicates whether this object has any values set on it.

Returns

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

Reimplemented from HPS::Object.

Equals()

bool HPS::FontInfoState::Equals

(

FontInfoState const &

in_kit

)

const

Check if the source FontInfoState is equivalent to this object.

Parameters

in_kit

The source FontInfoState to compare to this object.

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.

GetName()

UTF8 HPS::FontInfoState::GetName

(

)

const

Gets the name of this font.

Returns

The name of the font in UTF8 format.

GetShellConvertibility()

bool HPS::FontInfoState::GetShellConvertibility

(

)

const

Gets the shell convertibility of this font.

This determines whether or not the font can be converted into a Visualize shell.

Returns

A reference to this object.

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

inlinevirtual

Reimplemented from HPS::Object.

Here is the call graph for this function:

operator!=()

bool HPS::FontInfoState::operator!=

(

FontInfoState const &

in_kit

)

const

Check if the source FontInfoState is not equivalent to this object.

Parameters

in_kit

The source FontInfoState to compare to this object.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

FontInfoState& HPS::FontInfoState::operator=

(

FontInfoState &&

in_that

)

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

Parameters

in_that

An rvalue reference to a FontInfoState to take the impl from.

Returns

A reference to this FontInfoState.

operator=() [2/2]

FontInfoState& HPS::FontInfoState::operator=

(

FontInfoState const &

in_kit

)

Copies the source FontInfoState into this object.

Parameters

in_kit

The source FontInfoState to copy.

Returns

A reference to this object.

operator==()

bool HPS::FontInfoState::operator==

(

FontInfoState const &

in_kit

)

const

Check if the source FontInfoState is equivalent to this object.

Parameters

in_kit

The source FontInfoState to compare to this object.

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::FontInfoState::Set

(

FontInfoState const &

in_kit

)

Copies the source FontInfoState into this object.

Parameters

in_kit

The source object to copy.

Show()

void HPS::FontInfoState::Show

(

FontInfoState &

out_kit

)

const

Copies this object into the given FontInfoState.

Parameters

out_kit

The FontInfoState to populate with the contents of this object.

ShowSystemName()

bool HPS::FontInfoState::ShowSystemName

(

HPS::UTF8 &

out_name

)

const

Shows the system name for this font.

Returns

true if the system name is available, 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.

Member Data Documentation

staticType

const HPS::Type HPS::FontInfoState::staticType = HPS::Type::FontInfoState

static

---

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

• hps.h