Inheritance diagram for HPS.CurveAttributeKit:
HPS.Kit HPS.Object

Public Member Functions

 CurveAttributeKit ()
 
 CurveAttributeKit (HPS.CurveAttributeKit in_kit)
 
override void Dispose ()
 
override bool Empty ()
 
override bool Equals (System.Object obj)
 
bool Equals (HPS.CurveAttributeKit in_kit)
 
override int GetHashCode ()
 
override HPS.Type ObjectType ()
 
void Set (HPS.CurveAttributeKit in_kit)
 
HPS.CurveAttributeKit SetBudget (ulong in_budget)
 
HPS.CurveAttributeKit SetContinuedBudget (bool in_state, ulong in_budget)
 
HPS.CurveAttributeKit SetContinuedBudget (bool in_state)
 
HPS.CurveAttributeKit SetContinuedBudget (ulong in_budget)
 
HPS.CurveAttributeKit SetMaximumAngle (float in_degrees)
 
HPS.CurveAttributeKit SetMaximumDeviation (float in_deviation)
 
HPS.CurveAttributeKit SetMaximumLength (float in_length)
 
HPS.CurveAttributeKit SetViewDependent (bool in_state)
 
void Show (out HPS.CurveAttributeKit out_kit)
 
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)
 
HPS.CurveAttributeKit UnsetBudget ()
 
HPS.CurveAttributeKit UnsetContinuedBudget ()
 
HPS.CurveAttributeKit UnsetEverything ()
 
HPS.CurveAttributeKit UnsetMaximumAngle ()
 
HPS.CurveAttributeKit UnsetMaximumDeviation ()
 
HPS.CurveAttributeKit UnsetMaximumLength ()
 
HPS.CurveAttributeKit UnsetViewDependent ()
 
- Public Member Functions inherited from HPS.Kit
override void Dispose ()
 
 Kit (HPS.Kit in_that)
 
override HPS.Type ObjectType ()
 
override HPS.Type Type ()
 
- Public Member Functions inherited from HPS.Object
IntPtr GetClassID ()
 
IntPtr GetInstanceID ()
 
bool HasType (HPS.Type in_mask)
 
 Object (HPS.Object that)
 
virtual void Reset ()
 

Static Public Member Functions

static HPS.CurveAttributeKit GetDefault ()
 
static bool operator!= (HPS.CurveAttributeKit a, HPS.CurveAttributeKit b)
 
static bool operator== (HPS.CurveAttributeKit a, HPS.CurveAttributeKit b)
 
- Static Public Member Functions inherited from HPS.Object
static IntPtr ClassID< T > ()
 

Protected Member Functions

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

Additional Inherited Members

- Protected Attributes inherited from HPS.Object
bool cMemOwn
 
HandleRef cptr
 

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

◆ CurveAttributeKit() [1/2]

HPS.CurveAttributeKit.CurveAttributeKit ( )
inline

Initializes an empty kit.

◆ CurveAttributeKit() [2/2]

HPS.CurveAttributeKit.CurveAttributeKit ( HPS.CurveAttributeKit  in_kit)
inline

The copy constructor creates a new CurveAttributeKit object that contains the same settings as the source object.

Parameters
in_kitThe source object to copy.

Member Function Documentation

◆ Empty()

override bool HPS.CurveAttributeKit.Empty ( )
inlinevirtual

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.

◆ Equals()

bool HPS.CurveAttributeKit.Equals ( HPS.CurveAttributeKit  in_kit)
inline

Check if the source CurveAttributeKit is equivalent to this object.

Parameters
in_kitThe source CurveAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static HPS.CurveAttributeKit HPS.CurveAttributeKit.GetDefault ( )
inlinestatic

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.

◆ ObjectType()

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

◆ Set()

void HPS.CurveAttributeKit.Set ( HPS.CurveAttributeKit  in_kit)
inline

Copies all settings from the source CurveAttributeKit into this object.

Parameters
in_kitThe source CurveAttributeKit to copy.

◆ SetContinuedBudget() [1/3]

HPS.CurveAttributeKit HPS.CurveAttributeKit.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.CurveAttributeKit HPS.CurveAttributeKit.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.CurveAttributeKit HPS.CurveAttributeKit.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.CurveAttributeKit HPS.CurveAttributeKit.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.CurveAttributeKit HPS.CurveAttributeKit.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.CurveAttributeKit HPS.CurveAttributeKit.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.CurveAttributeKit HPS.CurveAttributeKit.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.

◆ Show()

void HPS.CurveAttributeKit.Show ( out HPS.CurveAttributeKit  out_kit)
inline

Copies all settings from this CurveAttributeKit into the given CurveAttributeKit.

Parameters
out_kitThe CurveAttributeKit to populate with the contents of this object.

◆ ShowBudget()

bool HPS.CurveAttributeKit.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.CurveAttributeKit.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.CurveAttributeKit.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.CurveAttributeKit.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.CurveAttributeKit.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.CurveAttributeKit.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.

◆ UnsetBudget()

HPS.CurveAttributeKit HPS.CurveAttributeKit.UnsetBudget ( )
inline

Removes the budget setting.

Returns
A reference to this object.

◆ UnsetContinuedBudget()

HPS.CurveAttributeKit HPS.CurveAttributeKit.UnsetContinuedBudget ( )
inline

Removes the continued budget setting.

Returns
A reference to this object.

◆ UnsetEverything()

HPS.CurveAttributeKit HPS.CurveAttributeKit.UnsetEverything ( )
inline

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetMaximumAngle()

HPS.CurveAttributeKit HPS.CurveAttributeKit.UnsetMaximumAngle ( )
inline

Removes the maximum angle setting.

Returns
A reference to this object.

◆ UnsetMaximumDeviation()

HPS.CurveAttributeKit HPS.CurveAttributeKit.UnsetMaximumDeviation ( )
inline

Removes the maximum deviation setting.

Returns
A reference to this object.

◆ UnsetMaximumLength()

HPS.CurveAttributeKit HPS.CurveAttributeKit.UnsetMaximumLength ( )
inline

Removes the maximum length setting.

Returns
A reference to this object.

◆ UnsetViewDependent()

HPS.CurveAttributeKit HPS.CurveAttributeKit.UnsetViewDependent ( )
inline

Removes the view-dependent setting.

Returns
A reference to this object.

The documentation for this class was generated from the following file:
  • internals/hps_core/source/cs/HPS.CurveAttributeKit.cs