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

#include <hps.h>

Inheritance diagram for HPS::EdgeAttributeKit:

Collaboration diagram for HPS::EdgeAttributeKit:

Public Member Functions
	EdgeAttributeKit ()
	Initializes an empty kit. More...

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

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

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

virtual	~EdgeAttributeKit ()
	Destroy this kit. More...

HPS::Type	ObjectType () const

void	Set (EdgeAttributeKit const &in_kit)
	Copies all settings from the source EdgeAttributeKit into this object. More...

void	Show (EdgeAttributeKit &out_kit) const
	Copies all settings from this EdgeAttributeKit into the given EdgeAttributeKit. More...

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

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

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

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

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

EdgeAttributeKit &	SetPattern (char const *in_pattern_name)
	Specifies the pattern of edges. More...

EdgeAttributeKit &	SetWeight (float in_weight, Edge::SizeUnits in_units=Edge::SizeUnits::ScaleFactor)
	Sets the weight of lines drawn in edge rendering. More...

EdgeAttributeKit &	SetHardAngle (float in_angle)
	Sets the angle between adjacent faces necessary for the edge between them to be considered a hard edge. More...

EdgeAttributeKit &	UnsetPattern ()
	Removes the line pattern setting for edges. More...

EdgeAttributeKit &	UnsetWeight ()
	Removes the weight setting for edges. More...

EdgeAttributeKit &	UnsetHardAngle ()
	Removes the hard edge angle setting. More...

EdgeAttributeKit &	UnsetEverything ()
	Removes all settings from this object. More...

bool	ShowPattern (UTF8 &out_pattern_name) const
	Shows the line pattern of the edges. More...

bool	ShowWeight (float &out_weight, Edge::SizeUnits &out_units) const
	Shows the weight of lines drawn in edge rendering. More...

bool	ShowHardAngle (float &out_angle) const
	Shows the weight of lines drawn in edge rendering. 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
static EdgeAttributeKit	GetDefault ()
	Creates a EdgeAttributeKit which contains the default settings. More...

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

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

Detailed Description

The HPS::EdgeAttributeKit class is a user space object, useful for carrying a group attribute settings.

Calling HPS::EdgeAttributeKit::GetDefault() will return a kit with values found in this table.

Constructor & Destructor Documentation

◆ EdgeAttributeKit() [1/3]

HPS::EdgeAttributeKit::EdgeAttributeKit ( )

Initializes an empty kit.

◆ EdgeAttributeKit() [2/3]

HPS::EdgeAttributeKit::EdgeAttributeKit ( EdgeAttributeKit const & in_kit )

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

Parameters

in_kit The source object to copy.

◆ EdgeAttributeKit() [3/3]

HPS::EdgeAttributeKit::EdgeAttributeKit ( EdgeAttributeKit && in_that )

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

Parameters

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

◆ ~EdgeAttributeKit()

virtual HPS::EdgeAttributeKit::~EdgeAttributeKit ( )

virtual

Destroy this kit.

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::EdgeAttributeKit::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::EdgeAttributeKit::Equals ( EdgeAttributeKit const & in_kit ) const

Check if the source EdgeAttributeKit is equivalent to this object.

Parameters

in_kit The source EdgeAttributeKit 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.

◆ GetDefault()

static EdgeAttributeKit HPS::EdgeAttributeKit::GetDefault ( )

static

Creates a EdgeAttributeKit which contains the default settings.

The returned object will not necessarily have values set for every option, but it will have settings for those options where it is reasonable to have a default.

Returns: A EdgeAttributeKit with the default settings.

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

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

bool HPS::EdgeAttributeKit::operator!= ( EdgeAttributeKit const & in_kit ) const

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

Parameters

in_kit The source EdgeAttributeKit to compare to this object.

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

◆ operator=() [1/2]

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

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

Parameters

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

Returns: A reference to this EdgeAttributeKit.

◆ operator=() [2/2]

EdgeAttributeKit& HPS::EdgeAttributeKit::operator= ( EdgeAttributeKit const & in_kit )

Copies the source EdgeAttributeKit into this object.

Parameters

in_kit The source EdgeAttributeKit to copy.

Returns: A reference to this object.

◆ operator==()

bool HPS::EdgeAttributeKit::operator== ( EdgeAttributeKit const & in_kit ) const

Check if the source EdgeAttributeKit is equivalent to this object.

Parameters

in_kit The source EdgeAttributeKit 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::EdgeAttributeKit::Set ( EdgeAttributeKit const & in_kit )

Copies all settings from the source EdgeAttributeKit into this object.

Parameters

in_kit The source EdgeAttributeKit to copy.

◆ SetHardAngle()

EdgeAttributeKit& HPS::EdgeAttributeKit::SetHardAngle ( float in_angle )

Sets the angle between adjacent faces necessary for the edge between them to be considered a hard edge.

Parameters

in_angle The angle, in degrees, between the adjacent faces necessary for a hard edge.

Returns: A reference to this object.

◆ SetPattern()

EdgeAttributeKit& HPS::EdgeAttributeKit::SetPattern ( char const * in_pattern_name )

Specifies the pattern of edges.

Parameters

in_pattern The name of a line pattern, defined in a portfolio that is accessible.

Returns: A reference to this object.

See also: Programming Guide: Line Patterns

◆ SetWeight()

EdgeAttributeKit& HPS::EdgeAttributeKit::SetWeight	(	float	in_weight,
		Edge::SizeUnits	in_units = `Edge::SizeUnits::ScaleFactor`
	)

Sets the weight of lines drawn in edge rendering.

Parameters

in_weight	The weight value for edges.
in_units	The units applied to in_weight.

Returns: A reference to this object.

◆ Show()

void HPS::EdgeAttributeKit::Show ( EdgeAttributeKit & out_kit ) const

Copies all settings from this EdgeAttributeKit into the given EdgeAttributeKit.

Parameters

out_kit The EdgeAttributeKit to populate with the contents of this object.

◆ ShowHardAngle()

bool HPS::EdgeAttributeKit::ShowHardAngle ( float & out_angle ) const

Shows the weight of lines drawn in edge rendering.

Parameters

out_angle The angle, in degrees, between the adjacent faces necessary for a hard edge.

Returns: true if the setting is valid, false otherwise.

◆ ShowPattern()

bool HPS::EdgeAttributeKit::ShowPattern ( UTF8 & out_pattern_name ) const

Shows the line pattern of the edges.

Parameters

out_pattern The name of a line pattern, defined in a portfolio that is accessible.

Returns: true if the setting is valid, false otherwise.

◆ ShowWeight()

bool HPS::EdgeAttributeKit::ShowWeight	(	float &	out_weight,
		Edge::SizeUnits &	out_units
	)		const

Shows the weight of lines drawn in edge rendering.

Parameters

out_weight	The weight value for edges.
out_units	The units applied to in_weight.

Returns: true if the setting is 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.

◆ UnsetEverything()

EdgeAttributeKit& HPS::EdgeAttributeKit::UnsetEverything ( )

Removes all settings from this object.

Returns: A reference to this object.

◆ UnsetHardAngle()

EdgeAttributeKit& HPS::EdgeAttributeKit::UnsetHardAngle ( )

Removes the hard edge angle setting.

Returns: A reference to this object.

◆ UnsetPattern()

EdgeAttributeKit& HPS::EdgeAttributeKit::UnsetPattern ( )

Removes the line pattern setting for edges.

Returns: A reference to this object.

◆ UnsetWeight()

EdgeAttributeKit& HPS::EdgeAttributeKit::UnsetWeight ( )

Removes the weight setting for edges.

Returns: A reference to this object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::EdgeAttributeKit::staticType = HPS::Type::EdgeAttributeKit

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

◆ EdgeAttributeKit() [1/3]

◆ EdgeAttributeKit() [2/3]

◆ EdgeAttributeKit() [3/3]

◆ ~EdgeAttributeKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetHardAngle()

◆ SetPattern()

◆ SetWeight()

◆ Show()

◆ ShowHardAngle()

◆ ShowPattern()

◆ ShowWeight()

◆ Type()

◆ UnsetEverything()

◆ UnsetHardAngle()

◆ UnsetPattern()

◆ UnsetWeight()

Member Data Documentation

◆ staticType