NURBSSurfaceAttributeKit

class HPS::NURBSSurfaceAttributeKit : public HPS::Kit 

The HPS::NURBSSurfaceAttributeKit class is a user space object that contains settings related to NURBS surfaces. Calling HPS::NURBSSurfaceAttributeKit::GetDefault() will return a kit with values found in this table.

Public Functions

virtual bool Empty() const

Indicates whether this object has any values set on it.

Returns: true if no values are set on this object, false otherwise.

bool Equals(NURBSSurfaceAttributeKit const &in_kit) const

Check if the source NURBSSurfaceAttributeKit is equivalent to this object.

Parameters: in_kit – The source NURBSSurfaceAttributeKit to compare to this object.
Returns: true if the objects are equivalent, false otherwise.

NURBSSurfaceAttributeKit(): Initializes an empty kit.

NURBSSurfaceAttributeKit(NURBSSurfaceAttributeKit &&in_that)

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

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

NURBSSurfaceAttributeKit(NURBSSurfaceAttributeKit const &in_kit)

The copy constructor creates a new NURBSSurfaceAttributeKit object that contains the same settings as the source object.

Parameters: in_kit – The source object to copy.

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.

bool operator!=(NURBSSurfaceAttributeKit const &in_kit) const

Check if the source NURBSSurfaceAttributeKit is not equivalent to this object.

Parameters: in_kit – The source NURBSSurfaceAttributeKit to compare to this object.
Returns: true if the objects are not equivalent, false otherwise.

NURBSSurfaceAttributeKit &operator=(NURBSSurfaceAttributeKit &&in_that)

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

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

NURBSSurfaceAttributeKit &operator=(NURBSSurfaceAttributeKit const &in_kit)

Copies the source NURBSSurfaceAttributeKit into this object.

Parameters: in_kit – The source NURBSSurfaceAttributeKit to copy.
Returns: A reference to this object.

bool operator==(NURBSSurfaceAttributeKit const &in_kit) const

Check if the source NURBSSurfaceAttributeKit is equivalent to this object.

Parameters: in_kit – The source NURBSSurfaceAttributeKit to compare to this object.
Returns: true if the objects are equivalent, false otherwise.

void Set(NURBSSurfaceAttributeKit const &in_kit)

Copies the source NURBSSurfaceAttributeKit into this object.

Parameters: in_kit – The source object to copy.

NURBSSurfaceAttributeKit &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.

NURBSSurfaceAttributeKit &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.

NURBSSurfaceAttributeKit &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.

NURBSSurfaceAttributeKit &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.

NURBSSurfaceAttributeKit &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.

NURBSSurfaceAttributeKit &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.

void Show(NURBSSurfaceAttributeKit &out_kit) const

Copies this object into the given NURBSSurfaceAttributeKit.

Parameters: out_kit – The NURBSSurfaceAttributeKit to populate with the contents of 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.

NURBSSurfaceAttributeKit &UnsetBudget()

Removes the NURBS surface tessellation budget.

Returns: A reference to this object.

NURBSSurfaceAttributeKit &UnsetEverything()

Removes all settings from this object.

Returns: A reference to this object.

NURBSSurfaceAttributeKit &UnsetMaximumAngle()

Removes the largest angle allowed between the surface tangents.

Returns: A reference to this object.

NURBSSurfaceAttributeKit &UnsetMaximumDeviation()

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

Returns: A reference to this object.

NURBSSurfaceAttributeKit &UnsetMaximumTrimDeviation()

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

Returns: A reference to this object.

NURBSSurfaceAttributeKit &UnsetMaximumWidth()

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

Returns: A reference to this object.

NURBSSurfaceAttributeKit &UnsetTrimBudget()

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

Returns: A reference to this object.

virtual ~NURBSSurfaceAttributeKit(): Destroy this kit.

Public Static Functions

static NURBSSurfaceAttributeKit GetDefault()

Creates a NURBSSurfaceAttributeKit 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 NURBSSurfaceAttributeKit with the default settings.

Public Static Attributes

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