#include <hps.h>
Static Public Attributes | |
| static const HPS::Type | staticType = HPS::Type::CurveAttributeControl |
 Static Public Attributes inherited from HPS::Control | |
| static const HPS::Type | staticType = HPS::Type::Control |
| Static Public Attributes inherited from HPS::Object | |
| static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
| Static Public Member Functions inherited from HPS::Object | |
| template<typename T > | |
| static intptr_t | ClassID () |
| Protected Member Functions inherited from HPS::Control | |
| Control (Control &&in_that) | |
| Control & | operator= (Control &&in_that) |
Detailed Description
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.
Constructor & Destructor Documentation
◆ CurveAttributeControl() [1/3]
|
explicit |
Initializes a control tied to the segment in_seg.
◆ CurveAttributeControl() [2/3]
| HPS::CurveAttributeControl::CurveAttributeControl | ( | CurveAttributeControl const & | in_that | ) |
Initializes a control tied to the same object as in_that.
◆ CurveAttributeControl() [3/3]
| 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.
- Parameters
-
in_that An rvalue reference to a CurveAttributeControl to take the impl from.
◆ ~CurveAttributeControl()
| HPS::CurveAttributeControl::~CurveAttributeControl | ( | ) |
Releases a reference to the database object this control is tied to.
Member Function Documentation
◆ ObjectType()
|
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::Control.
◆ operator=() [1/2]
| 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.
- Parameters
-
in_that An rvalue reference to a CurveAttributeControl to take the impl from.
- Returns
- A reference to this CurveAttributeControl.
◆ operator=() [2/2]
| CurveAttributeControl& HPS::CurveAttributeControl::operator= | ( | CurveAttributeControl const & | in_that | ) |
Share the underlying smart-pointer of the CurveAttributeControl source.
- Parameters
-
in_that The CurveAttributeControl source of the assignment.
- Returns
- A reference to this CurveAttributeControl.
◆ SetBudget()
| 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.
- Parameters
-
in_budget The number of vertices that will be allowed in the tessellation of curves.
- Returns
- A reference to this object.
◆ SetContinuedBudget() [1/2]
| 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.
- 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]
| 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.
- Parameters
-
in_budget The number of additional vertices that will be allocated to the overall curve.
- Returns
- A reference to this object.
◆ SetMaximumAngle()
| 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.
- Parameters
-
in_degrees The largest angle allowed between adjacent line segments.
- Returns
- A reference to this object.
◆ SetMaximumDeviation()
| CurveAttributeControl& HPS::CurveAttributeControl::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()
| 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.
- Parameters
-
in_length The largest allowable length of any line segment.
- Returns
- A reference to this object.
◆ SetViewDependent()
| 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.
- Parameters
-
in_state Whether curves should be rendered in a view-dependent manner.
- Returns
- A reference to this object.
◆ ShowBudget()
| 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.
- 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::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.
- 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::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.
- Parameters
-
out_degrees The largest angle allowed between adjacent line segments.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowMaximumDeviation()
| 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.
- Parameters
-
out_deviation The distance in object space from the parametric definition.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowMaximumLength()
| 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.
- Parameters
-
out_length The largest allowable length of any line segment.
- Returns
- true if the setting is valid, false otherwise.
◆ ShowViewDependent()
| bool HPS::CurveAttributeControl::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()
|
inlinevirtual |
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.
- Warning
- This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
- Returns
- The true type of the object in question.
Reimplemented from HPS::Control.
◆ UnsetBudget()
| CurveAttributeControl& HPS::CurveAttributeControl::UnsetBudget | ( | ) |
Removes the budget setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CurveAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetContinuedBudget()
| CurveAttributeControl& HPS::CurveAttributeControl::UnsetContinuedBudget | ( | ) |
Removes the continued budget setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CurveAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetEverything()
| CurveAttributeControl& HPS::CurveAttributeControl::UnsetEverything | ( | ) |
Removes all settings from this object. If the control is attached to a WindowKey this function restores the default settings of this control as specified by CurveAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetMaximumAngle()
| CurveAttributeControl& HPS::CurveAttributeControl::UnsetMaximumAngle | ( | ) |
Removes the maximum angle setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CurveAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetMaximumDeviation()
| CurveAttributeControl& HPS::CurveAttributeControl::UnsetMaximumDeviation | ( | ) |
Removes the maximum deviation setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CurveAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetMaximumLength()
| CurveAttributeControl& HPS::CurveAttributeControl::UnsetMaximumLength | ( | ) |
Removes the maximum length setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CurveAttributeKit::GetDefault().
- Returns
- A reference to this object.
◆ UnsetViewDependent()
| CurveAttributeControl& HPS::CurveAttributeControl::UnsetViewDependent | ( | ) |
Removes the view-dependent setting. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CurveAttributeKit::GetDefault().
- Returns
- A reference to this object.
The documentation for this class was generated from the following file:
- include/hps.h