NURBSSurfaceAttributeControl

class HPS.NURBSSurfaceAttributeControl : public HPS.Control

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.

Public Functions

override void Dispose ()
NURBSSurfaceAttributeControl (HPS.NURBSSurfaceAttributeControl in_that)

Initializes a control tied to the same object as in_that.

NURBSSurfaceAttributeControl (HPS.SegmentKey in_seg)

Initializes a control tied to the segment in_seg.

override HPS.Type ObjectType ()

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

Return

The declared type of the object in question, which may differ from the true, underlying type.

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.

Param in_budget

The maximum number of vertices to be used in NURBS surface tessellation.

Return

A reference to this object.

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.

Param in_degrees

The maximum angle allowed between the surface tangents, in degrees.

Return

A reference to this object.

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.

Param in_deviation

The maximum distance, in object space, of the tessellation to the parametric definition of the surface.

Return

A reference to this object.

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.

Param in_deviation

The maximum distance, in object space, of the tessellation to the parametric definition of the trimming curve.

Return

A reference to this object.

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.

Param in_width

The largest allowable length of any facet’s edge. Valid range is [0, sqrt(2)].

Return

A reference to this object.

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.

Param in_budget

The maximum number of vertices to be used in trim curve tessellation.

Return

A reference to this object.

bool ShowBudget (out ulong out_budget)

Shows the NURBS surface tessellation budget.

Param out_budget

The maximum number of vertices to be used in NURBS surface tessellation.

Return

true if the budget is valid, false otherwise.

bool ShowMaximumAngle (out float out_degrees)

Shows the largest angle allowed between the surface tangents.

Param out_degrees

The maximum angle allowed between the surface tangents, in degrees.

Return

true if the maximum angle is valid, false otherwise.

bool ShowMaximumDeviation (out float out_deviation)

Shows the upper bound of the difference between the NURBS surface and its parametric definition.

Param out_deviation

The maximum distance, in object space, of the tessellation to the parametric definition of the surface.

Return

true if the maximum deviation is valid, false otherwise.

bool ShowMaximumTrimDeviation (out float out_deviation)

Shows the upper bound of trim curve vertices from the parametric definition of the trimming curve.

Param out_deviation

The maximum distance, in object space, of the tessellation to the parametric definition of the trimming curve.

Return

true if the setting is valid, false otherwise.

bool ShowMaximumWidth (out float out_width)

Shows the setting for the largest allowable length of any facet’s edge.

Param out_width

The largest allowable length of any facet’s edge..

Return

true if the maximum width is valid, false otherwise.

bool ShowTrimBudget (out ulong out_budget)

Shows the upper bound of vertices to be used in trim curve tessellation.

Param out_budget

The maximum number of vertices to be used in trim curve tessellation.

Return

true if the budget is valid, false otherwise.

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

Return

A reference to this object.

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

Return

A reference to this object.

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

Return

A reference to this object.

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

Return

A reference to this object.

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

Return

A reference to this object.

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

Return

A reference to this object.

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

Return

A reference to this object.