#include <hps.h>

Static Public Member Functions | |
static CurveAttributeKit | GetDefault () |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
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
HPS::CurveAttributeKit::CurveAttributeKit | ( | ) |
Initializes an empty kit.
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.
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.
|
virtual |
Destroy this kit.
Member Function Documentation
|
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.
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.
|
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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS::Object.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
CurveAttributeKit& HPS::CurveAttributeKit::UnsetBudget | ( | ) |
Removes the budget setting.
- Returns
- A reference to this object.
CurveAttributeKit& HPS::CurveAttributeKit::UnsetContinuedBudget | ( | ) |
Removes the continued budget setting.
- Returns
- A reference to this object.
CurveAttributeKit& HPS::CurveAttributeKit::UnsetEverything | ( | ) |
Removes all settings from this object.
- Returns
- A reference to this object.
CurveAttributeKit& HPS::CurveAttributeKit::UnsetMaximumAngle | ( | ) |
Removes the maximum angle setting.
- Returns
- A reference to this object.
CurveAttributeKit& HPS::CurveAttributeKit::UnsetMaximumDeviation | ( | ) |
Removes the maximum deviation setting.
- Returns
- A reference to this object.
CurveAttributeKit& HPS::CurveAttributeKit::UnsetMaximumLength | ( | ) |
Removes the maximum length setting.
- Returns
- A reference to this object.
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:
- include/hps.h