#include <hps.h>
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
![]() | |
Control (Control &&in_that) | |
Control & | operator= (Control &&in_that) |
The HPS::CurveAttributeControl class is a smart pointer that is tied to a database object. This object is used to manipulate the various attributes related to curved lines, such as budget, angle, deviation, and length. This table lists default values for the various segment attributes accessible from HPS::CurveAttributeControl.
|
explicit |
Initializes a control tied to the segment in_seg.
HPS::CurveAttributeControl::CurveAttributeControl | ( | CurveAttributeControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
HPS::CurveAttributeControl::CurveAttributeControl | ( | CurveAttributeControl && | in_that | ) |
The move constructor creates a CurveAttributeControl by transferring the underlying impl of the rvalue reference to this CurveAttributeControl thereby avoiding a copy and allocation.
in_that | An rvalue reference to a CurveAttributeControl to take the impl from. |
HPS::CurveAttributeControl::~CurveAttributeControl | ( | ) |
Releases a reference to the database object this control is tied to.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
Reimplemented from HPS::Control.
CurveAttributeControl& HPS::CurveAttributeControl::operator= | ( | CurveAttributeControl && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this CurveAttributeControl thereby avoiding a copy.
in_that | An rvalue reference to a CurveAttributeControl to take the impl from. |
CurveAttributeControl& HPS::CurveAttributeControl::operator= | ( | CurveAttributeControl const & | in_that | ) |
Share the underlying smart-pointer of the CurveAttributeControl source.
in_that | The CurveAttributeControl source of the assignment. |
CurveAttributeControl& HPS::CurveAttributeControl::SetBudget | ( | size_t | in_budget | ) |
Sets the upper boundary of the number of vertices that will be allowed in the tessellation of curves, regardless of view settings.
in_budget | The number of vertices that will be allowed in the tessellation of curves. |
CurveAttributeControl& HPS::CurveAttributeControl::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.
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. |
CurveAttributeControl& HPS::CurveAttributeControl::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.
in_budget | The number of additional vertices that will be allocated to the overall curve. |
CurveAttributeControl& HPS::CurveAttributeControl::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.
in_degrees | The largest angle allowed between adjacent line segments. |
CurveAttributeControl& HPS::CurveAttributeControl::SetMaximumDeviation | ( | float | in_deviation | ) |
Sets the distance in object space from the parametric definition of the curve to its tessellated counterpart.
in_deviation | The distance in object space from the parametric definition. |
CurveAttributeControl& HPS::CurveAttributeControl::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.
in_length | The largest allowable length of any line segment. |
CurveAttributeControl& HPS::CurveAttributeControl::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.
in_state | Whether curves should be rendered in a view-dependent manner. |
bool HPS::CurveAttributeControl::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.
out_budget | The number of vertices that will be allowed in the tessellation of curves. |
bool HPS::CurveAttributeControl::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.
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. |
bool HPS::CurveAttributeControl::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.
out_degrees | The largest angle allowed between adjacent line segments. |
bool HPS::CurveAttributeControl::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.
out_deviation | The distance in object space from the parametric definition. |
bool HPS::CurveAttributeControl::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.
out_length | The largest allowable length of any line segment. |
bool HPS::CurveAttributeControl::ShowViewDependent | ( | bool & | out_state | ) | const |
Shows whether curves should be rendered in a view-dependent or view-independent manner.
out_state | Whether curves should be rendered in a view-dependent manner. |
CurveAttributeControl& HPS::CurveAttributeControl::UnsetBudget | ( | ) |
Removes the budget setting.
CurveAttributeControl& HPS::CurveAttributeControl::UnsetContinuedBudget | ( | ) |
Removes the continued budget setting.
CurveAttributeControl& HPS::CurveAttributeControl::UnsetEverything | ( | ) |
Removes all settings from this object.
CurveAttributeControl& HPS::CurveAttributeControl::UnsetMaximumAngle | ( | ) |
Removes the maximum angle setting.
CurveAttributeControl& HPS::CurveAttributeControl::UnsetMaximumDeviation | ( | ) |
Removes the maximum deviation setting.
CurveAttributeControl& HPS::CurveAttributeControl::UnsetMaximumLength | ( | ) |
Removes the maximum length setting.
CurveAttributeControl& HPS::CurveAttributeControl::UnsetViewDependent | ( | ) |
Removes the view-dependent setting.