HPS.CurveAttributeControl Class Reference
Inheritance diagram for HPS.CurveAttributeControl:
HPS.Control HPS.Object

Public Member Functions

 CurveAttributeControl (HPS.SegmentKey in_seg)
 
 CurveAttributeControl (HPS.CurveAttributeControl in_that)
 
override void Dispose ()
 
override HPS.Type ObjectType ()
 
HPS.CurveAttributeControl SetBudget (ulong in_budget)
 
HPS.CurveAttributeControl SetContinuedBudget (bool in_state, ulong in_budget)
 
HPS.CurveAttributeControl SetContinuedBudget (bool in_state)
 
HPS.CurveAttributeControl SetContinuedBudget (ulong in_budget)
 
HPS.CurveAttributeControl SetMaximumAngle (float in_degrees)
 
HPS.CurveAttributeControl SetMaximumDeviation (float in_deviation)
 
HPS.CurveAttributeControl SetMaximumLength (float in_length)
 
HPS.CurveAttributeControl SetViewDependent (bool in_state)
 
bool ShowBudget (out ulong out_budget)
 
bool ShowContinuedBudget (out bool out_state, out ulong out_budget)
 
bool ShowMaximumAngle (out float out_degrees)
 
bool ShowMaximumDeviation (out float out_deviation)
 
bool ShowMaximumLength (out float out_length)
 
bool ShowViewDependent (out bool out_state)
 
override HPS.Type Type ()
 
HPS.CurveAttributeControl UnsetBudget ()
 
HPS.CurveAttributeControl UnsetContinuedBudget ()
 
HPS.CurveAttributeControl UnsetEverything ()
 
HPS.CurveAttributeControl UnsetMaximumAngle ()
 
HPS.CurveAttributeControl UnsetMaximumDeviation ()
 
HPS.CurveAttributeControl UnsetMaximumLength ()
 
HPS.CurveAttributeControl UnsetViewDependent ()
 
- Public Member Functions inherited from HPS.Control
 Control (HPS.Control in_that)
 
- Public Member Functions inherited from HPS.Object
virtual bool Empty ()
 
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Protected Member Functions

override void deleteCptr ()
 
- Protected Member Functions inherited from HPS.Object
virtual IntPtr GetNonDirectorClassID ()
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 
- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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/2]

HPS.CurveAttributeControl.CurveAttributeControl ( HPS.SegmentKey  in_seg)
inline

Initializes a control tied to the segment in_seg.

◆ CurveAttributeControl() [2/2]

HPS.CurveAttributeControl.CurveAttributeControl ( HPS.CurveAttributeControl  in_that)
inline

Initializes a control tied to the same object as in_that.

Member Function Documentation

◆ ObjectType()

override HPS.Type HPS.CurveAttributeControl.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.

◆ SetBudget()

HPS.CurveAttributeControl HPS.CurveAttributeControl.SetBudget ( ulong  in_budget)
inline

Sets the upper boundary of the number of vertices that will be allowed in the tessellation of curves, regardless of view settings.

Parameters
in_budgetThe number of vertices that will be allowed in the tessellation of curves.
Returns
A reference to this object.

◆ SetContinuedBudget() [1/3]

HPS.CurveAttributeControl HPS.CurveAttributeControl.SetContinuedBudget ( bool  in_state,
ulong  in_budget 
)
inline

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/3]

HPS.CurveAttributeControl HPS.CurveAttributeControl.SetContinuedBudget ( bool  in_state)
inline

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.
Returns
A reference to this object.

◆ SetContinuedBudget() [3/3]

HPS.CurveAttributeControl HPS.CurveAttributeControl.SetContinuedBudget ( ulong  in_budget)
inline

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()

HPS.CurveAttributeControl HPS.CurveAttributeControl.SetMaximumAngle ( float  in_degrees)
inline

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()

HPS.CurveAttributeControl HPS.CurveAttributeControl.SetMaximumDeviation ( float  in_deviation)
inline

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()

HPS.CurveAttributeControl HPS.CurveAttributeControl.SetMaximumLength ( float  in_length)
inline

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()

HPS.CurveAttributeControl HPS.CurveAttributeControl.SetViewDependent ( bool  in_state)
inline

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.

◆ ShowBudget()

bool HPS.CurveAttributeControl.ShowBudget ( out ulong  out_budget)
inline

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.CurveAttributeControl.ShowContinuedBudget ( out bool  out_state,
out ulong  out_budget 
)
inline

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.CurveAttributeControl.ShowMaximumAngle ( out float  out_degrees)
inline

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.CurveAttributeControl.ShowMaximumDeviation ( out float  out_deviation)
inline

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.CurveAttributeControl.ShowMaximumLength ( out float  out_length)
inline

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.CurveAttributeControl.ShowViewDependent ( out bool  out_state)
inline

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.

◆ Type()

override HPS.Type HPS.CurveAttributeControl.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()

HPS.CurveAttributeControl HPS.CurveAttributeControl.UnsetBudget ( )
inline

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()

HPS.CurveAttributeControl HPS.CurveAttributeControl.UnsetContinuedBudget ( )
inline

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()

HPS.CurveAttributeControl HPS.CurveAttributeControl.UnsetEverything ( )
inline

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()

HPS.CurveAttributeControl HPS.CurveAttributeControl.UnsetMaximumAngle ( )
inline

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()

HPS.CurveAttributeControl HPS.CurveAttributeControl.UnsetMaximumDeviation ( )
inline

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()

HPS.CurveAttributeControl HPS.CurveAttributeControl.UnsetMaximumLength ( )
inline

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()

HPS.CurveAttributeControl HPS.CurveAttributeControl.UnsetViewDependent ( )
inline

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:
  • internals/hps_core/source/cs/HPS.CurveAttributeControl.cs