#include <hps.h>
|
static const HPS::Type | staticType = HPS::Type::NURBSSurfaceAttributeKit |
|
static const HPS::Type | staticType = HPS::Type::Kit |
|
static const HPS::Type | staticType = HPS::Type::None |
|
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.
◆ NURBSSurfaceAttributeKit() [1/3]
HPS::NURBSSurfaceAttributeKit::NURBSSurfaceAttributeKit |
( |
| ) |
|
Initializes an empty kit.
◆ NURBSSurfaceAttributeKit() [2/3]
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. |
◆ NURBSSurfaceAttributeKit() [3/3]
◆ ~NURBSSurfaceAttributeKit()
virtual HPS::NURBSSurfaceAttributeKit::~NURBSSurfaceAttributeKit |
( |
| ) |
|
|
virtual |
◆ Empty()
bool HPS::NURBSSurfaceAttributeKit::Empty |
( |
| ) |
const |
|
virtual |
Indicates whether this object has any values set on it.
- Returns
- true if no values are set on this object, false otherwise.
Reimplemented from HPS::Object.
◆ Equals()
Check if the source NURBSSurfaceAttributeKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ 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.
◆ ObjectType()
HPS::Type HPS::NURBSSurfaceAttributeKit::ObjectType |
( |
| ) |
const |
|
inlinevirtual |
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.
Reimplemented from HPS::Kit.
◆ operator!=()
Check if the source NURBSSurfaceAttributeKit is not equivalent to this object.
- Parameters
-
- Returns
- true if the objects are not equivalent, false otherwise.
◆ operator=() [1/2]
◆ operator=() [2/2]
◆ operator==()
Check if the source NURBSSurfaceAttributeKit is equivalent to this object.
- Parameters
-
- Returns
- true if the objects are equivalent, false otherwise.
◆ Set()
◆ SetBudget()
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.
◆ SetMaximumAngle()
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.
◆ SetMaximumDeviation()
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.
◆ SetMaximumTrimDeviation()
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.
◆ SetMaximumWidth()
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.
◆ SetTrimBudget()
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.
◆ Show()
◆ ShowBudget()
bool HPS::NURBSSurfaceAttributeKit::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.
◆ ShowMaximumAngle()
bool HPS::NURBSSurfaceAttributeKit::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.
◆ ShowMaximumDeviation()
bool HPS::NURBSSurfaceAttributeKit::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.
◆ ShowMaximumTrimDeviation()
bool HPS::NURBSSurfaceAttributeKit::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.
◆ ShowMaximumWidth()
bool HPS::NURBSSurfaceAttributeKit::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.
◆ ShowTrimBudget()
bool HPS::NURBSSurfaceAttributeKit::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.
◆ UnsetBudget()
Removes the NURBS surface tessellation budget.
- Returns
- A reference to this object.
◆ UnsetEverything()
Removes all settings from this object.
- Returns
- A reference to this object.
◆ UnsetMaximumAngle()
Removes the largest angle allowed between the surface tangents.
- Returns
- A reference to this object.
◆ UnsetMaximumDeviation()
Removes the upper bound of the difference between the NURBS surface and its parametric definition.
- Returns
- A reference to this object.
◆ UnsetMaximumTrimDeviation()
Removes the upper bound of trim curve vertices from the parametric definition of the trimming curve.
- Returns
- A reference to this object.
◆ UnsetMaximumWidth()
Removes the setting for the largest allowable length of any facet's edge.
- Returns
- A reference to this object.
◆ UnsetTrimBudget()
Removes the upper bound of vertices to be used in trim curve tessellation.
- Returns
- A reference to this object.
The documentation for this class was generated from the following file: