The HPS.NURBSSurfaceAttributeControl class is a smart pointer that is tied to a database object. This object allows you to manipulate various settings related to NURBS surfaces, such as budget, angle, deviation, and width. This table lists default values for the various segment attributes accessible from HPS.NURBSSurfaceAttributeControl. More...

Public Member Functions | |
override void | Dispose () |
NURBSSurfaceAttributeControl (HPS.SegmentKey in_seg) | |
Initializes a control tied to the segment in_seg. More... | |
NURBSSurfaceAttributeControl (HPS.NURBSSurfaceAttributeControl in_that) | |
Initializes a control tied to the same object as in_that. More... | |
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... | |
HPS.NURBSSurfaceAttributeControl | SetBudget (ulong in_budget) |
Sets an upper bound on the number of vertices that will be allowed in the tessellation of NURBS surfaces. More... | |
HPS.NURBSSurfaceAttributeControl | SetMaximumAngle (float in_degrees) |
Sets the largest angle allowed between the surface tangents evaluated at any two corners of a given facet. Expressed in degrees. More... | |
HPS.NURBSSurfaceAttributeControl | SetMaximumDeviation (float in_deviation) |
Sets an upper bound for the distance, in object space, of the tessellation to the parametric definition of the surface. Note that since this setting is in object space, it should be set differently depending on the scale of the NURBS control points. More... | |
HPS.NURBSSurfaceAttributeControl | SetMaximumTrimDeviation (float in_deviation) |
Sets an upper bound for the distance, in the NURBS surface's normalized [0..1] parametric space, of trim curve vertices from the parametric definition of the trimming curve. More... | |
HPS.NURBSSurfaceAttributeControl | SetMaximumWidth (float in_width) |
The largest allowable length, in the NURBS surface's normalized [0..1] parametric space, of any facet's edge. More... | |
HPS.NURBSSurfaceAttributeControl | SetTrimBudget (ulong in_budget) |
Sets an upper bound on the number of vertices that will be allowed in the tessellation of a trim curve. More... | |
bool | ShowBudget (out ulong out_budget) |
Shows the NURBS surface tessellation budget. More... | |
bool | ShowMaximumAngle (out float out_degrees) |
Shows the largest angle allowed between the surface tangents. More... | |
bool | ShowMaximumDeviation (out float out_deviation) |
Shows the upper bound of the difference between the NURBS surface and its parametric definition. More... | |
bool | ShowMaximumTrimDeviation (out float out_deviation) |
Shows the upper bound of trim curve vertices from the parametric definition of the trimming curve. More... | |
bool | ShowMaximumWidth (out float out_width) |
Shows the setting for the largest allowable length of any facet's edge. More... | |
bool | ShowTrimBudget (out ulong out_budget) |
Shows the upper bound of vertices to be used in trim curve tessellation. More... | |
override 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... | |
HPS.NURBSSurfaceAttributeControl | UnsetBudget () |
Unsets the NURBS surface tessellation budget. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CurveAttributeKit.GetDefault(). More... | |
HPS.NURBSSurfaceAttributeControl | UnsetEverything () |
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(). More... | |
HPS.NURBSSurfaceAttributeControl | UnsetMaximumAngle () |
Removes the largest angle allowed between the surface tangents. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CurveAttributeKit.GetDefault(). More... | |
HPS.NURBSSurfaceAttributeControl | UnsetMaximumDeviation () |
Removes the upper bound of the difference between the NURBS surface and its parametric definition. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CurveAttributeKit.GetDefault(). More... | |
HPS.NURBSSurfaceAttributeControl | UnsetMaximumTrimDeviation () |
Removes the upper bound of trim curve vertices from the parametric definition of the trimming curve. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CurveAttributeKit.GetDefault(). More... | |
HPS.NURBSSurfaceAttributeControl | UnsetMaximumWidth () |
Removes the setting for the largest allowable length of any facet's edge. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CurveAttributeKit.GetDefault(). More... | |
HPS.NURBSSurfaceAttributeControl | UnsetTrimBudget () |
Removes the upper bound of vertices to be used in trim curve tessellation. If the control is attached to a WindowKey this function restores the default value of this setting as specified by CurveAttributeKit.GetDefault(). 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. 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... | |
Protected Member Functions | |
override void | deleteCptr () |
![]() | |
virtual IntPtr | GetNonDirectorClassID () |
Additional Inherited Members | |
![]() | |
static IntPtr | ClassID< T > () |
![]() | |
bool | cMemOwn |
HandleRef | cptr |
Detailed Description
The HPS.NURBSSurfaceAttributeControl class is a smart pointer that is tied to a database object. This object allows you to manipulate various settings related to NURBS surfaces, such as budget, angle, deviation, and width. This table lists default values for the various segment attributes accessible from HPS.NURBSSurfaceAttributeControl.
Constructor & Destructor Documentation
|
inline |
Initializes a control tied to the segment in_seg.
|
inline |
Initializes a control tied to the same object as in_that.
Member Function Documentation
|
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.Control.
|
inline |
Sets an upper bound on the number of vertices that will be allowed in the tessellation of NURBS surfaces.
- Parameters
-
in_budget The maximum number of vertices to be used in NURBS surface tessellation.
- Returns
- A reference to this object.
|
inline |
Sets the largest angle allowed between the surface tangents evaluated at any two corners of a given facet. Expressed in degrees.
- Parameters
-
in_degrees The maximum angle allowed between the surface tangents, in degrees.
- Returns
- A reference to this object.
|
inline |
Sets an upper bound for the distance, in object space, of the tessellation to the parametric definition of the surface. Note that since this setting is in object space, it should be set differently depending on the scale of the NURBS control points.
- Parameters
-
in_deviation The maximum distance, in object space, of the tessellation to the parametric definition of the surface.
- Returns
- A reference to this object.
|
inline |
Sets an upper bound for the distance, in the NURBS surface's normalized [0..1] parametric space, of trim curve vertices from the parametric definition of the trimming curve.
- Parameters
-
in_deviation The maximum distance, in object space, of the tessellation to the parametric definition of the trimming curve.
- Returns
- A reference to this object.
|
inline |
The largest allowable length, in the NURBS surface's normalized [0..1] parametric space, of any facet's edge.
- Parameters
-
in_width The largest allowable length of any facet's edge. Valid range is [0, sqrt(2)].
- Returns
- A reference to this object.
|
inline |
Sets an upper bound on the number of vertices that will be allowed in the tessellation of a trim curve.
- Parameters
-
in_budget The maximum number of vertices to be used in trim curve tessellation.
- Returns
- A reference to this object.
|
inline |
Shows the NURBS surface tessellation budget.
- Parameters
-
out_budget The maximum number of vertices to be used in NURBS surface tessellation.
- Returns
- true if the budget is valid, false otherwise.
|
inline |
Shows the largest angle allowed between the surface tangents.
- Parameters
-
out_degrees The maximum angle allowed between the surface tangents, in degrees.
- Returns
- true if the maximum angle is valid, false otherwise.
|
inline |
Shows the upper bound of the difference between the NURBS surface and its parametric definition.
- Parameters
-
out_deviation The maximum distance, in object space, of the tessellation to the parametric definition of the surface.
- Returns
- true if the maximum deviation is valid, false otherwise.
|
inline |
Shows the upper bound of trim curve vertices from the parametric definition of the trimming curve.
- Parameters
-
out_deviation The maximum distance, in object space, of the tessellation to the parametric definition of the trimming curve.
- Returns
- true if the setting is valid, false otherwise.
|
inline |
Shows the setting for the largest allowable length of any facet's edge.
- Parameters
-
out_width The largest allowable length of any facet's edge..
- Returns
- true if the maximum width is valid, false otherwise.
|
inline |
Shows the upper bound of vertices to be used in trim curve tessellation.
- Parameters
-
out_budget The maximum number of vertices to be used in trim curve tessellation.
- Returns
- true if the budget is valid, false otherwise.
|
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.
- Returns
- The true type of the object in question.
Reimplemented from HPS.Control.
|
inline |
Unsets the NURBS surface tessellation budget. 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.
|
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.
|
inline |
Removes the largest angle allowed between the surface tangents. 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.
|
inline |
Removes the upper bound of the difference between the NURBS surface and its parametric definition. 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.
|
inline |
Removes the upper bound of trim curve vertices from the parametric definition of the trimming curve. 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.
|
inline |
Removes the setting for the largest allowable length of any facet's edge. 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.
|
inline |
Removes the upper bound of vertices to be used in trim curve tessellation. 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.NURBSSurfaceAttributeControl.cs