REFERENCE MANUAL
The CurveAttributeControl class is a smart pointer that is tied to a database object. More...
Public Member Functions | |
CurveAttributeControl (HPS.SegmentKey in_seg) | |
Initializes a control tied to the segment in_seg. More... | |
CurveAttributeControl (HPS.CurveAttributeControl in_that) | |
Initializes a control tied to the same object as in_that. More... | |
override void | Dispose () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. More... | |
HPS.CurveAttributeControl | SetBudget (ulong in_budget) |
Sets the upper boundary of the number of vertices that will be allowed in the tessellation of curves, regardless of view settings. More... | |
HPS.CurveAttributeControl | SetContinuedBudget (bool in_state, ulong 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... | |
HPS.CurveAttributeControl | SetContinuedBudget (bool in_state) |
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... | |
HPS.CurveAttributeControl | SetContinuedBudget (ulong 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... | |
HPS.CurveAttributeControl | SetMaximumAngle (float in_degrees) |
Sets the largest angle allowed, in degrees, between adjacent line segments in the tessellated representation. More... | |
HPS.CurveAttributeControl | SetMaximumDeviation (float in_deviation) |
Sets the distance in object space from the parametric definition of the curve to its tessellated counterpart. More... | |
HPS.CurveAttributeControl | SetMaximumLength (float in_length) |
Sets the largest allowable length, in the curve's normalized [0,1] parametric space, of any line segment. More... | |
HPS.CurveAttributeControl | SetViewDependent (bool in_state) |
Sets whether curves should be rendered in a view-dependent or view-independent manner. More... | |
bool | ShowBudget (out ulong out_budget) |
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 (out bool out_state, out ulong out_budget) |
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 | ShowMaximumAngle (out float out_degrees) |
Shows the largest angle allowed, in degrees, between adjacent line segments in the tessellated representation. More... | |
bool | ShowMaximumDeviation (out float out_deviation) |
Shows the distance in object space from the parametric definition of the curve to its tessellated counterpart. More... | |
bool | ShowMaximumLength (out float out_length) |
Shows the largest allowable length, in the curve's normalized [0,1] parametric space, of any line segment. More... | |
bool | ShowViewDependent (out bool out_state) |
Shows whether curves should be rendered in a view-dependent or view-independent manner. More... | |
HPS.CurveAttributeControl | UnsetBudget () |
Removes the budget setting. More... | |
HPS.CurveAttributeControl | UnsetContinuedBudget () |
Removes the continued budget setting. More... | |
HPS.CurveAttributeControl | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.CurveAttributeControl | UnsetMaximumAngle () |
Removes the maximum angle setting. More... | |
HPS.CurveAttributeControl | UnsetMaximumDeviation () |
Removes the maximum deviation setting. More... | |
HPS.CurveAttributeControl | UnsetMaximumLength () |
Removes the maximum length setting. More... | |
HPS.CurveAttributeControl | UnsetViewDependent () |
Removes the view-dependent setting. More... | |
![]() | |
Control (HPS.Control in_that) | |
![]() | |
virtual bool | Empty () |
Indicates whether this object has any values set on it. More... | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object in_that) | |
The move constructor creates an Object by transferring the underlying impl of the rvalue reference to this Object thereby avoiding a copy and allocation. More... | |
virtual void | Reset () |
Resets this object to its initial, uninitialized state. More... | |
HPS.Type | Type () |
This function returns the true type of the underlying object. More... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
HandleRef | scptr |
The 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 CurveAttributeControl.
HPS.CurveAttributeControl.CurveAttributeControl | ( | HPS.SegmentKey | in_seg | ) |
Initializes a control tied to the segment in_seg.
HPS.CurveAttributeControl.CurveAttributeControl | ( | HPS.CurveAttributeControl | in_that | ) |
Initializes a control tied to the same object as in_that.
|
virtual |
This function returns the type the object, as declared.
This does not necessarily give the true type of the underlying object.
Reimplemented from HPS.Object.
HPS.CurveAttributeControl HPS.CurveAttributeControl.SetBudget | ( | ulong | 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. |
HPS.CurveAttributeControl HPS.CurveAttributeControl.SetContinuedBudget | ( | bool | in_state, |
ulong | 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.
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. |
HPS.CurveAttributeControl HPS.CurveAttributeControl.SetContinuedBudget | ( | bool | in_state | ) |
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. |
HPS.CurveAttributeControl HPS.CurveAttributeControl.SetContinuedBudget | ( | ulong | 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. |
HPS.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. |
HPS.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. |
HPS.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. |
HPS.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 | ( | out ulong | out_budget | ) |
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 | ( | out bool | out_state, |
out ulong | out_budget | ||
) |
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 | ( | out float | out_degrees | ) |
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 | ( | out float | out_deviation | ) |
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 | ( | out float | out_length | ) |
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 | ( | out bool | out_state | ) |
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. |
HPS.CurveAttributeControl HPS.CurveAttributeControl.UnsetBudget | ( | ) |
Removes the budget setting.
HPS.CurveAttributeControl HPS.CurveAttributeControl.UnsetContinuedBudget | ( | ) |
Removes the continued budget setting.
HPS.CurveAttributeControl HPS.CurveAttributeControl.UnsetEverything | ( | ) |
Removes all settings from this object.
HPS.CurveAttributeControl HPS.CurveAttributeControl.UnsetMaximumAngle | ( | ) |
Removes the maximum angle setting.
HPS.CurveAttributeControl HPS.CurveAttributeControl.UnsetMaximumDeviation | ( | ) |
Removes the maximum deviation setting.
HPS.CurveAttributeControl HPS.CurveAttributeControl.UnsetMaximumLength | ( | ) |
Removes the maximum length setting.
HPS.CurveAttributeControl HPS.CurveAttributeControl.UnsetViewDependent | ( | ) |
Removes the view-dependent setting.