REFERENCE MANUAL
The CurveAttributeKit class is a user space object, useful for carrying a group attribute settings. 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. 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. 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. 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. More... | |
HPS.CurveAttributeKit | SetMaximumAngle (float in_degrees) |
Sets the largest angle allowed, in degrees, between adjacent line segments in the tessellated representation. 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. More... | |
HPS.CurveAttributeKit | SetViewDependent (bool in_state) |
Sets whether curves should be rendered in a view-dependent or view-independent manner. 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. 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.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. 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... | |
Static Public Member Functions | |
static HPS.CurveAttributeKit | GetDefault () |
Creates a CurveAttributeKit which contains the default settings. 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 |
HandleRef | scptr |
The CurveAttributeKit class is a user space object, useful for carrying a group attribute settings.
Calling CurveAttributeKit::GetDefault() will return a kit with values found in this table.
HPS.CurveAttributeKit.CurveAttributeKit | ( | ) |
Initializes an empty kit.
HPS.CurveAttributeKit.CurveAttributeKit | ( | HPS.CurveAttributeKit | in_kit | ) |
The copy constructor creates a new CurveAttributeKit object that contains the same settings as the source object.
in_kit | The source object to copy. |
|
virtual |
Indicates whether this object has any values set on it.
Reimplemented from HPS.Object.
bool HPS.CurveAttributeKit.Equals | ( | HPS.CurveAttributeKit | in_kit | ) |
Check if the source CurveAttributeKit is equivalent to this object.
in_kit | The source <ref refid="class_h_p_s_1_1_curve_attribute_kit" kindref="compound">CurveAttributeKit</ref> to compare to this object. |
|
static |
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.
|
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.
void HPS.CurveAttributeKit.Set | ( | HPS.CurveAttributeKit | in_kit | ) |
Copies all settings from the source CurveAttributeKit into this object.
in_kit | The source <ref refid="class_h_p_s_1_1_curve_attribute_kit" kindref="compound">CurveAttributeKit</ref> to copy. |
HPS.CurveAttributeKit 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.
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.CurveAttributeKit 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.
in_state | Whether the continued budget will be used at all. |
HPS.CurveAttributeKit 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.
in_budget | The number of additional vertices that will be allocated to the overall curve. |
HPS.CurveAttributeKit 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.
in_degrees | The largest angle allowed between adjacent line segments. |
HPS.CurveAttributeKit HPS.CurveAttributeKit.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.CurveAttributeKit 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.
in_length | The largest allowable length of any line segment. |
HPS.CurveAttributeKit 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.
in_state | Whether curves should be rendered in a view-dependent manner. |
void HPS.CurveAttributeKit.Show | ( | out HPS.CurveAttributeKit | out_kit | ) |
Copies all settings from this CurveAttributeKit into the given CurveAttributeKit.
out_kit | The <ref refid="class_h_p_s_1_1_curve_attribute_kit" kindref="compound">CurveAttributeKit</ref> to populate with the contents of this object. |
bool HPS.CurveAttributeKit.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.CurveAttributeKit.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.CurveAttributeKit.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.CurveAttributeKit.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.CurveAttributeKit.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.CurveAttributeKit.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.CurveAttributeKit HPS.CurveAttributeKit.UnsetBudget | ( | ) |
Removes the budget setting.
HPS.CurveAttributeKit HPS.CurveAttributeKit.UnsetContinuedBudget | ( | ) |
Removes the continued budget setting.
HPS.CurveAttributeKit HPS.CurveAttributeKit.UnsetEverything | ( | ) |
Removes all settings from this object.
HPS.CurveAttributeKit HPS.CurveAttributeKit.UnsetMaximumAngle | ( | ) |
Removes the maximum angle setting.
HPS.CurveAttributeKit HPS.CurveAttributeKit.UnsetMaximumDeviation | ( | ) |
Removes the maximum deviation setting.
HPS.CurveAttributeKit HPS.CurveAttributeKit.UnsetMaximumLength | ( | ) |
Removes the maximum length setting.
HPS.CurveAttributeKit HPS.CurveAttributeKit.UnsetViewDependent | ( | ) |
Removes the view-dependent setting.