#include <hps.h>

Inheritance diagram for HPS::CurveAttributeKit:
HPS::Kit HPS::Object

Public Member Functions

 CurveAttributeKit ()
 
 CurveAttributeKit (CurveAttributeKit const &in_kit)
 
 CurveAttributeKit (CurveAttributeKit &&in_that)
 
bool Empty () const
 
bool Equals (CurveAttributeKit const &in_kit) const
 
HPS::Type ObjectType () const
 
bool operator!= (CurveAttributeKit const &in_kit) const
 
CurveAttributeKitoperator= (CurveAttributeKit &&in_that)
 
CurveAttributeKitoperator= (CurveAttributeKit const &in_kit)
 
bool operator== (CurveAttributeKit const &in_kit) const
 
void Set (CurveAttributeKit const &in_kit)
 
CurveAttributeKitSetBudget (size_t in_budget)
 
CurveAttributeKitSetContinuedBudget (bool in_state, size_t in_budget=0)
 
CurveAttributeKitSetContinuedBudget (size_t in_budget)
 
CurveAttributeKitSetMaximumAngle (float in_degrees)
 
CurveAttributeKitSetMaximumDeviation (float in_deviation)
 
CurveAttributeKitSetMaximumLength (float in_length)
 
CurveAttributeKitSetViewDependent (bool in_state)
 
void Show (CurveAttributeKit &out_kit) const
 
bool ShowBudget (size_t &out_budget) const
 
bool ShowContinuedBudget (bool &out_state, size_t &out_budget) const
 
bool ShowMaximumAngle (float &out_degrees) const
 
bool ShowMaximumDeviation (float &out_deviation) const
 
bool ShowMaximumLength (float &out_length) const
 
bool ShowViewDependent (bool &out_state) const
 
CurveAttributeKitUnsetBudget ()
 
CurveAttributeKitUnsetContinuedBudget ()
 
CurveAttributeKitUnsetEverything ()
 
CurveAttributeKitUnsetMaximumAngle ()
 
CurveAttributeKitUnsetMaximumDeviation ()
 
CurveAttributeKitUnsetMaximumLength ()
 
CurveAttributeKitUnsetViewDependent ()
 
virtual ~CurveAttributeKit ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static CurveAttributeKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::CurveAttributeKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

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_kitThe 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_thatAn rvalue reference to a CurveAttributeKit to take the impl from.

◆ ~CurveAttributeKit()

virtual HPS::CurveAttributeKit::~CurveAttributeKit ( )
virtual

Destroy this kit.

Member Function Documentation

◆ 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_kitThe source CurveAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ 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.

◆ ObjectType()

HPS::Type HPS::CurveAttributeKit::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::Kit.

◆ operator!=()

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

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

Parameters
in_kitThe 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_thatAn 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_kitThe 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_kitThe source CurveAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

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

Copies all settings from the source CurveAttributeKit into this object.

Parameters
in_kitThe source CurveAttributeKit to copy.

◆ 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_stateWhether the continued budget will be used at all.
in_budgetThe 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_budgetThe 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_degreesThe 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_deviationThe 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_lengthThe 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_stateWhether 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_kitThe 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_budgetThe 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_stateWhether the continued budget will be used at all.
out_budgetThe 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_degreesThe 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_deviationThe 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_lengthThe 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_stateWhether curves should be rendered in a view-dependent manner.
Returns
true if the setting is valid, false otherwise.

◆ 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.

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