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

#include <hps.h>

Inheritance diagram for HPS::CurveAttributeKit:

Collaboration diagram for HPS::CurveAttributeKit:

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

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

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

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

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

HPS::Type	ObjectType () const

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

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

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

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

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

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

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

CurveAttributeKit &	SetBudget (size_t in_budget)

CurveAttributeKit &	SetContinuedBudget (bool in_state, size_t in_budget=0)
	Sets the number of additional vertices will be allocated to the overall curve for each control point beyond the degree of the curve plus one. More...

CurveAttributeKit &	SetContinuedBudget (size_t in_budget)
	Sets the number of additional vertices will be allocated to the overall curve for each control point beyond the degree of the curve plus one. More...

CurveAttributeKit &	SetViewDependent (bool in_state)
	Sets whether curves should be rendered in a view-dependent or view-independent manner. More...

CurveAttributeKit &	SetMaximumDeviation (float in_deviation)
	Sets the distance in object space from the parametric definition of the curve to its tessellated counterpart. More...

CurveAttributeKit &	SetMaximumAngle (float in_degrees)
	Sets the largest angle allowed, in degrees, between adjacent line segments in the tessellated representation. More...

CurveAttributeKit &	SetMaximumLength (float in_length)
	Sets the largest allowable length, in the curve's normalized [0,1] parametric space, of any line segment. More...

CurveAttributeKit &	UnsetBudget ()
	Removes the budget setting. More...

CurveAttributeKit &	UnsetContinuedBudget ()
	Removes the continued budget setting. More...

CurveAttributeKit &	UnsetViewDependent ()
	Removes the view-dependent setting. More...

CurveAttributeKit &	UnsetMaximumDeviation ()
	Removes the maximum deviation setting. More...

CurveAttributeKit &	UnsetMaximumAngle ()
	Removes the maximum angle setting. More...

CurveAttributeKit &	UnsetMaximumLength ()
	Removes the maximum length setting. More...

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

bool	ShowBudget (size_t &out_budget) const
	Shows the upper boundary of the number of vertices that will be allowed in the tessellation of curves, regardless of view settings. More...

bool	ShowContinuedBudget (bool &out_state, size_t &out_budget) const
	Shows the number of additional vertices will be allocated to the overall curve for each control point beyond the degree of the curve plus one. More...

bool	ShowViewDependent (bool &out_state) const
	Shows whether curves should be rendered in a view-dependent or view-independent manner. More...

bool	ShowMaximumDeviation (float &out_deviation) const
	Shows the distance in object space from the parametric definition of the curve to its tessellated counterpart. More...

bool	ShowMaximumAngle (float &out_degrees) const
	Shows the largest angle allowed, in degrees, between adjacent line segments in the tessellated representation. More...

bool	ShowMaximumLength (float &out_length) const
	Shows the largest allowable length, in the curve's normalized [0,1] parametric space, of any line segment. 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 CurveAttributeKit	GetDefault ()
	Creates a CurveAttributeKit 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::CurveAttributeKit

Detailed Description

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

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

Constructor & Destructor Documentation

◆ CurveAttributeKit() [1/3]

HPS::CurveAttributeKit::CurveAttributeKit ( )

Initializes an empty kit.

◆ CurveAttributeKit() [2/3]

HPS::CurveAttributeKit::CurveAttributeKit ( CurveAttributeKit const & in_kit )

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

Parameters

in_kit The source object to copy.

◆ CurveAttributeKit() [3/3]

HPS::CurveAttributeKit::CurveAttributeKit ( CurveAttributeKit && in_that )

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

Parameters

in_that An rvalue reference to a CurveAttributeKit to take the impl from.

◆ ~CurveAttributeKit()

virtual HPS::CurveAttributeKit::~CurveAttributeKit ( )

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

Check if the source CurveAttributeKit is equivalent to this object.

Parameters

in_kit The source CurveAttributeKit 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 CurveAttributeKit HPS::CurveAttributeKit::GetDefault ( )

static

Creates a CurveAttributeKit 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 CurveAttributeKit 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::CurveAttributeKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

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

Parameters

in_kit The source CurveAttributeKit to compare to this object.

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

◆ operator=() [1/2]

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

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

Parameters

in_that An rvalue reference to a CurveAttributeKit to take the impl from.

Returns: A reference to this CurveAttributeKit.

◆ operator=() [2/2]

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

Copies the source CurveAttributeKit into this object.

Parameters

in_kit The source CurveAttributeKit to copy.

Returns: A reference to this object.

◆ operator==()

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

Check if the source CurveAttributeKit is equivalent to this object.

Parameters

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

Copies all settings from the source CurveAttributeKit into this object.

Parameters

in_kit The source CurveAttributeKit to copy.

◆ SetBudget()

CurveAttributeKit& HPS::CurveAttributeKit::SetBudget ( size_t in_budget )

◆ SetContinuedBudget() [1/2]

CurveAttributeKit& HPS::CurveAttributeKit::SetContinuedBudget	(	bool	in_state,
		size_t	in_budget = `0`
	)

Sets the number of additional vertices will be allocated to the overall curve for each control point beyond the degree of the curve plus one.

A curve with a number of control points equal to the degree plus one will have a number of vertices equal to the budget. Curves with more control points than that number will have additional vertices equal to the continued budget for each extra control point.

Parameters

in_state	Whether the continued budget will be used at all.
in_budget	The number of additional vertices that will be allocated to the overall curve.

Returns: A reference to this object.

◆ SetContinuedBudget() [2/2]

CurveAttributeKit& HPS::CurveAttributeKit::SetContinuedBudget ( size_t in_budget )

Sets the number of additional vertices will be allocated to the overall curve for each control point beyond the degree of the curve plus one.

A curve with a number of control points equal to the degree plus one will have a number of vertices equal to the budget. Curves with more control points than that number will have additional vertices equal to the continued budget for each extra control point. The state is implicitly on.

Parameters

in_budget The number of additional vertices that will be allocated to the overall curve.

Returns: A reference to this object.

◆ SetMaximumAngle()

CurveAttributeKit& HPS::CurveAttributeKit::SetMaximumAngle ( float in_degrees )

Sets the largest angle allowed, in degrees, between adjacent line segments in the tessellated representation.

Applies to view-independent curves only.

Parameters

in_degrees The largest angle allowed between adjacent line segments.

Returns: A reference to this object.

◆ SetMaximumDeviation()

CurveAttributeKit& HPS::CurveAttributeKit::SetMaximumDeviation ( float in_deviation )

Sets the distance in object space from the parametric definition of the curve to its tessellated counterpart.

Parameters

in_deviation The distance in object space from the parametric definition.

Returns: A reference to this object.

◆ SetMaximumLength()

CurveAttributeKit& HPS::CurveAttributeKit::SetMaximumLength ( float in_length )

Sets the largest allowable length, in the curve's normalized [0,1] parametric space, of any line segment.

Applies to view-independent curves only.

Parameters

in_length The largest allowable length of any line segment.

Returns: A reference to this object.

◆ SetViewDependent()

CurveAttributeKit& HPS::CurveAttributeKit::SetViewDependent ( bool in_state )

Sets whether curves should be rendered in a view-dependent or view-independent manner.

The tessellation of view-dependent curves is adjusted to maintain a smooth curve with the current camera setting. View-independent curves are statically tessellated based on the curve attribute settings. View-independent is less computationally intensive but can result in curves that do not look smooth with certain camera settings.

Parameters

in_state Whether curves should be rendered in a view-dependent manner.

Returns: A reference to this object.

◆ Show()

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

Copies all settings from this CurveAttributeKit into the given CurveAttributeKit.

Parameters

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

◆ ShowBudget()

bool HPS::CurveAttributeKit::ShowBudget ( size_t & out_budget ) const

Shows the upper boundary of the number of vertices that will be allowed in the tessellation of curves, regardless of view settings.

Parameters

out_budget The number of vertices that will be allowed in the tessellation of curves.

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

◆ ShowContinuedBudget()

bool HPS::CurveAttributeKit::ShowContinuedBudget	(	bool &	out_state,
		size_t &	out_budget
	)		const

Shows the number of additional vertices will be allocated to the overall curve for each control point beyond the degree of the curve plus one.

Parameters

out_state	Whether the continued budget will be used at all.
out_budget	The number of additional vertices that will be allocated to the overall curve.

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

◆ ShowMaximumAngle()

bool HPS::CurveAttributeKit::ShowMaximumAngle ( float & out_degrees ) const

Shows the largest angle allowed, in degrees, between adjacent line segments in the tessellated representation.

Applies to view-independent curves only.

Parameters

out_degrees The largest angle allowed between adjacent line segments.

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

◆ ShowMaximumDeviation()

bool HPS::CurveAttributeKit::ShowMaximumDeviation ( float & out_deviation ) const

Shows the distance in object space from the parametric definition of the curve to its tessellated counterpart.

Applies to view-independent curves only.

Parameters

out_deviation The distance in object space from the parametric definition.

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

◆ ShowMaximumLength()

bool HPS::CurveAttributeKit::ShowMaximumLength ( float & out_length ) const

Shows the largest allowable length, in the curve's normalized [0,1] parametric space, of any line segment.

Applies to view-independent curves only.

Parameters

out_length The largest allowable length of any line segment.

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

◆ ShowViewDependent()

bool HPS::CurveAttributeKit::ShowViewDependent ( bool & out_state ) const

Shows whether curves should be rendered in a view-dependent or view-independent manner.

Parameters

out_state Whether curves should be rendered in a view-dependent manner.

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.

◆ UnsetBudget()

CurveAttributeKit& HPS::CurveAttributeKit::UnsetBudget ( )

Removes the budget setting.

Returns: A reference to this object.

◆ UnsetContinuedBudget()

CurveAttributeKit& HPS::CurveAttributeKit::UnsetContinuedBudget ( )

Removes the continued budget setting.

Returns: A reference to this object.

◆ UnsetEverything()

CurveAttributeKit& HPS::CurveAttributeKit::UnsetEverything ( )

Removes all settings from this object.

Returns: A reference to this object.

◆ UnsetMaximumAngle()

CurveAttributeKit& HPS::CurveAttributeKit::UnsetMaximumAngle ( )

Removes the maximum angle setting.

Returns: A reference to this object.

◆ UnsetMaximumDeviation()

CurveAttributeKit& HPS::CurveAttributeKit::UnsetMaximumDeviation ( )

Removes the maximum deviation setting.

Returns: A reference to this object.

◆ UnsetMaximumLength()

CurveAttributeKit& HPS::CurveAttributeKit::UnsetMaximumLength ( )

Removes the maximum length setting.

Returns: A reference to this object.

◆ UnsetViewDependent()

CurveAttributeKit& HPS::CurveAttributeKit::UnsetViewDependent ( )

Removes the view-dependent setting.

Returns: A reference to this object.

Member Data Documentation

◆ staticType

const HPS::Type HPS::CurveAttributeKit::staticType = HPS::Type::CurveAttributeKit

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

◆ CurveAttributeKit() [1/3]

◆ CurveAttributeKit() [2/3]

◆ CurveAttributeKit() [3/3]

◆ ~CurveAttributeKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetBudget()

◆ SetContinuedBudget() [1/2]

◆ SetContinuedBudget() [2/2]

◆ SetMaximumAngle()

◆ SetMaximumDeviation()

◆ SetMaximumLength()

◆ SetViewDependent()

◆ Show()

◆ ShowBudget()

◆ ShowContinuedBudget()

◆ ShowMaximumAngle()

◆ ShowMaximumDeviation()

◆ ShowMaximumLength()

◆ ShowViewDependent()

◆ Type()

◆ UnsetBudget()

◆ UnsetContinuedBudget()

◆ UnsetEverything()

◆ UnsetMaximumAngle()

◆ UnsetMaximumDeviation()

◆ UnsetMaximumLength()

◆ UnsetViewDependent()

Member Data Documentation

◆ staticType