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

NURBSSurfaceAttributeControl(NURBSSurfaceAttributeControl &&in_that)

The move constructor creates a NURBSSurfaceAttributeControl by transferring the underlying impl of the rvalue reference to this NURBSSurfaceAttributeControl thereby avoiding a copy and allocation.

Parameters: in_that – An rvalue reference to a NURBSSurfaceAttributeControl to take the impl from.

NURBSSurfaceAttributeControl(NURBSSurfaceAttributeControl const &in_that): Initializes a control tied to the same object as in_that.

explicit NURBSSurfaceAttributeControl(SegmentKey &in_seg): Initializes a control tied to the segment in_seg.

inline virtual HPS::Type ObjectType() const

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.

NURBSSurfaceAttributeControl &operator=(NURBSSurfaceAttributeControl &&in_that)

The move assignment operator transfers the underlying impl of the rvalue reference to this NURBSSurfaceAttributeControl thereby avoiding a copy.

Parameters: in_that – An rvalue reference to a NURBSSurfaceAttributeControl to take the impl from.
Returns: A reference to this NURBSSurfaceAttributeControl.

NURBSSurfaceAttributeControl &operator=(NURBSSurfaceAttributeControl const &in_that)

Share the underlying smart-pointer of the NURBSSurfaceAttributeControl source.

Parameters: in_that – The NURBSSurfaceAttributeControl source of the assignment.
Returns: A reference to this NURBSSurfaceAttributeControl.

NURBSSurfaceAttributeControl &SetBudget(size_t in_budget)

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.

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.

Parameters: in_degrees – The maximum angle allowed between the surface tangents, in degrees.
Returns: A reference to this object.

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.

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.

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.

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.

NURBSSurfaceAttributeControl &SetMaximumWidth(float in_width)

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.

NURBSSurfaceAttributeControl &SetTrimBudget(size_t in_budget)

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.

bool ShowBudget(size_t &out_budget) const

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.

bool ShowMaximumAngle(float &out_degrees) const

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.

bool ShowMaximumDeviation(float &out_deviation) const

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.

bool ShowMaximumTrimDeviation(float &out_deviation) const

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.

bool ShowMaximumWidth(float &out_width) const

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.

bool ShowTrimBudget(size_t &out_budget) const

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.

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

Returns: A reference to this object.

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

Returns: A reference to this object.

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

Returns: A reference to this object.

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

Returns: A reference to this object.

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

Returns: A reference to this object.

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

Returns: A reference to this object.

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

Returns: A reference to this object.

~NURBSSurfaceAttributeControl(): Releases a reference to the database object this control is tied to.

Public Static Attributes

static const HPS::Type staticType = HPS::Type::NURBSSurfaceAttributeControl