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. More...

Public Member Functions | |
CurveAttributeKit () | |
Initializes an empty kit. More... | |
CurveAttributeKit (HPS.CurveAttributeKit in_kit) | |
The copy constructor creates a new CurveAttributeKit object that contains the same settings as the source object. More... | |
override void | Dispose () |
override bool | Empty () |
Indicates whether this object has any values set on it. More... | |
override bool | Equals (System.Object obj) |
bool | Equals (HPS.CurveAttributeKit in_kit) |
Check if the source CurveAttributeKit is equivalent to this object. More... | |
override int | GetHashCode () |
override HPS.Type | ObjectType () |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object. More... | |
void | Set (HPS.CurveAttributeKit in_kit) |
Copies all settings from the source CurveAttributeKit into this object. More... | |
HPS.CurveAttributeKit | SetBudget (ulong in_budget) |
HPS.CurveAttributeKit | 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. More... | |
HPS.CurveAttributeKit | 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. More... | |
HPS.CurveAttributeKit | 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. More... | |
HPS.CurveAttributeKit | 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. More... | |
HPS.CurveAttributeKit | SetMaximumDeviation (float in_deviation) |
Sets the distance in object space from the parametric definition of the curve to its tessellated counterpart. More... | |
HPS.CurveAttributeKit | 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. More... | |
HPS.CurveAttributeKit | 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. More... | |
void | Show (out HPS.CurveAttributeKit out_kit) |
Copies all settings from this CurveAttributeKit into the given CurveAttributeKit. 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. Applies to view-independent curves only. More... | |
bool | 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. 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. Applies to view-independent curves only. More... | |
bool | ShowViewDependent (out bool out_state) |
Shows whether curves should be rendered in a view-dependent or view-independent manner. More... | |
HPS.CurveAttributeKit | UnsetBudget () |
Removes the budget setting. More... | |
HPS.CurveAttributeKit | UnsetContinuedBudget () |
Removes the continued budget setting. More... | |
HPS.CurveAttributeKit | UnsetEverything () |
Removes all settings from this object. More... | |
HPS.CurveAttributeKit | UnsetMaximumAngle () |
Removes the maximum angle setting. More... | |
HPS.CurveAttributeKit | UnsetMaximumDeviation () |
Removes the maximum deviation setting. More... | |
HPS.CurveAttributeKit | UnsetMaximumLength () |
Removes the maximum length setting. More... | |
HPS.CurveAttributeKit | UnsetViewDependent () |
Removes the view-dependent setting. More... | |
![]() | |
IntPtr | GetClassID () |
IntPtr | GetInstanceID () |
Returns an identifier that can be used to identify which instance of a class an object is. Different keys and controls will return the same value if they are backed by the same database resource. More... | |
bool | HasType (HPS.Type in_mask) |
This function indicates whether this Object has the given Type mask. More... | |
Object (HPS.Object that) | |
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. This function is useful for finding the type of smart pointer objects that have been cast to more generic types. More... | |
Static Public Member Functions | |
static HPS.CurveAttributeKit | GetDefault () |
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. More... | |
static bool | operator!= (HPS.CurveAttributeKit a, HPS.CurveAttributeKit b) |
static bool | operator== (HPS.CurveAttributeKit a, HPS.CurveAttributeKit b) |
![]() | |
static IntPtr | ClassID< T > () |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
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
|
inline |
Initializes an empty kit.
|
inline |
The copy constructor creates a new CurveAttributeKit object that contains the same settings as the source object.
- Parameters
-
in_kit The source object to copy.
Member Function Documentation
|
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.
|
inline |
Check if the source CurveAttributeKit is equivalent to this object.
- Parameters
-
in_kit The source CurveAttributeKit to compare to this object.
- Returns
- true if the objects are equivalent, false otherwise.
|
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.
|
inlinevirtual |
This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.
- Returns
- The declared type of the object in question, which may differ from the true, underlying type.
Reimplemented from HPS.Object.
|
inline |
Copies all settings from the source CurveAttributeKit into this object.
- Parameters
-
in_kit The source CurveAttributeKit to copy.
|
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_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.
|
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_state Whether the continued budget will be used at all.
- Returns
- A reference to this object.
|
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_budget The number of additional vertices that will be allocated to the overall curve.
- Returns
- A reference to this object.
|
inline |
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.
|
inline |
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.
|
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_length The largest allowable length of any line segment.
- Returns
- A reference to this object.
|
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_state Whether curves should be rendered in a view-dependent manner.
- Returns
- A reference to this object.
|
inline |
Copies all settings from this CurveAttributeKit into the given CurveAttributeKit.
- Parameters
-
out_kit The CurveAttributeKit to populate with the contents of this object.
|
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_budget The number of vertices that will be allowed in the tessellation of curves.
- Returns
- true if the setting is valid, false otherwise.
|
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_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.
|
inline |
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.
|
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_deviation The distance in object space from the parametric definition.
- Returns
- true if the setting is valid, false otherwise.
|
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_length The largest allowable length of any line segment.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
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.
|
inline |
Removes the budget setting.
- Returns
- A reference to this object.
|
inline |
Removes the continued budget setting.
- Returns
- A reference to this object.
|
inline |
Removes all settings from this object.
- Returns
- A reference to this object.
|
inline |
Removes the maximum angle setting.
- Returns
- A reference to this object.
|
inline |
Removes the maximum deviation setting.
- Returns
- A reference to this object.
|
inline |
Removes the maximum length setting.
- Returns
- A reference to this object.
|
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