#include <hps.h>

Inheritance diagram for HPS::NURBSSurfaceAttributeKit:
HPS::Kit HPS::Object

Public Member Functions

bool Empty () const
 
bool Equals (NURBSSurfaceAttributeKit const &in_kit) const
 
 NURBSSurfaceAttributeKit ()
 
 NURBSSurfaceAttributeKit (NURBSSurfaceAttributeKit const &in_kit)
 
 NURBSSurfaceAttributeKit (NURBSSurfaceAttributeKit &&in_that)
 
HPS::Type ObjectType () const
 
bool operator!= (NURBSSurfaceAttributeKit const &in_kit) const
 
NURBSSurfaceAttributeKitoperator= (NURBSSurfaceAttributeKit &&in_that)
 
NURBSSurfaceAttributeKitoperator= (NURBSSurfaceAttributeKit const &in_kit)
 
bool operator== (NURBSSurfaceAttributeKit const &in_kit) const
 
void Set (NURBSSurfaceAttributeKit const &in_kit)
 
NURBSSurfaceAttributeKitSetBudget (size_t in_budget)
 
NURBSSurfaceAttributeKitSetMaximumAngle (float in_degrees)
 
NURBSSurfaceAttributeKitSetMaximumDeviation (float in_deviation)
 
NURBSSurfaceAttributeKitSetMaximumTrimDeviation (float in_deviation)
 
NURBSSurfaceAttributeKitSetMaximumWidth (float in_width)
 
NURBSSurfaceAttributeKitSetTrimBudget (size_t in_budget)
 
void Show (NURBSSurfaceAttributeKit &out_kit) const
 
bool ShowBudget (size_t &out_budget) const
 
bool ShowMaximumAngle (float &out_degrees) const
 
bool ShowMaximumDeviation (float &out_deviation) const
 
bool ShowMaximumTrimDeviation (float &out_deviation) const
 
bool ShowMaximumWidth (float &out_width) const
 
bool ShowTrimBudget (size_t &out_budget) const
 
NURBSSurfaceAttributeKitUnsetBudget ()
 
NURBSSurfaceAttributeKitUnsetEverything ()
 
NURBSSurfaceAttributeKitUnsetMaximumAngle ()
 
NURBSSurfaceAttributeKitUnsetMaximumDeviation ()
 
NURBSSurfaceAttributeKitUnsetMaximumTrimDeviation ()
 
NURBSSurfaceAttributeKitUnsetMaximumWidth ()
 
NURBSSurfaceAttributeKitUnsetTrimBudget ()
 
virtual ~NURBSSurfaceAttributeKit ()
 
- Public Member Functions inherited from HPS::Kit
virtual HPS::Type Type () const
 
- Public Member Functions inherited from HPS::Object
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (HPS::Type in_mask) const
 
Object (Object const &that)
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 

Static Public Member Functions

static NURBSSurfaceAttributeKit GetDefault ()
 
- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::NURBSSurfaceAttributeKit
 
- Static Public Attributes inherited from HPS::Kit
static const HPS::Type staticType = HPS::Type::Kit
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Protected Member Functions inherited from HPS::Kit
 Kit (Kit &&in_that)
 
Kitoperator= (Kit &&in_that)
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ NURBSSurfaceAttributeKit() [1/3]

HPS::NURBSSurfaceAttributeKit::NURBSSurfaceAttributeKit ( )

Initializes an empty kit.

◆ NURBSSurfaceAttributeKit() [2/3]

HPS::NURBSSurfaceAttributeKit::NURBSSurfaceAttributeKit ( NURBSSurfaceAttributeKit const &  in_kit)

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

Parameters
in_kitThe source object to copy.

◆ NURBSSurfaceAttributeKit() [3/3]

HPS::NURBSSurfaceAttributeKit::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_thatAn rvalue reference to a NURBSSurfaceAttributeKit to take the impl from.

◆ ~NURBSSurfaceAttributeKit()

virtual HPS::NURBSSurfaceAttributeKit::~NURBSSurfaceAttributeKit ( )
virtual

Destroy this kit.

Member Function Documentation

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

bool HPS::NURBSSurfaceAttributeKit::Equals ( NURBSSurfaceAttributeKit const &  in_kit) const

Check if the source NURBSSurfaceAttributeKit is equivalent to this object.

Parameters
in_kitThe source NURBSSurfaceAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ GetDefault()

static NURBSSurfaceAttributeKit HPS::NURBSSurfaceAttributeKit::GetDefault ( )
static

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!=()

bool HPS::NURBSSurfaceAttributeKit::operator!= ( NURBSSurfaceAttributeKit const &  in_kit) const

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

Parameters
in_kitThe source NURBSSurfaceAttributeKit to compare to this object.
Returns
true if the objects are not equivalent, false otherwise.

◆ operator=() [1/2]

NURBSSurfaceAttributeKit& HPS::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_thatAn rvalue reference to a NURBSSurfaceAttributeKit to take the impl from.
Returns
A reference to this NURBSSurfaceAttributeKit.

◆ operator=() [2/2]

NURBSSurfaceAttributeKit& HPS::NURBSSurfaceAttributeKit::operator= ( NURBSSurfaceAttributeKit const &  in_kit)

Copies the source NURBSSurfaceAttributeKit into this object.

Parameters
in_kitThe source NURBSSurfaceAttributeKit to copy.
Returns
A reference to this object.

◆ operator==()

bool HPS::NURBSSurfaceAttributeKit::operator== ( NURBSSurfaceAttributeKit const &  in_kit) const

Check if the source NURBSSurfaceAttributeKit is equivalent to this object.

Parameters
in_kitThe source NURBSSurfaceAttributeKit to compare to this object.
Returns
true if the objects are equivalent, false otherwise.

◆ Set()

void HPS::NURBSSurfaceAttributeKit::Set ( NURBSSurfaceAttributeKit const &  in_kit)

Copies the source NURBSSurfaceAttributeKit into this object.

Parameters
in_kitThe source object to copy.

◆ SetBudget()

NURBSSurfaceAttributeKit& HPS::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_budgetThe maximum number of vertices to be used in NURBS surface tessellation.
Returns
A reference to this object.

◆ SetMaximumAngle()

NURBSSurfaceAttributeKit& HPS::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_degreesThe maximum angle allowed between the surface tangents, in degrees.
Returns
A reference to this object.

◆ SetMaximumDeviation()

NURBSSurfaceAttributeKit& HPS::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_deviationThe maximum distance, in object space, of the tessellation to the parametric definition of the surface.
Returns
A reference to this object.

◆ SetMaximumTrimDeviation()

NURBSSurfaceAttributeKit& HPS::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_deviationThe maximum distance, in object space, of the tessellation to the parametric definition of the trimming curve.
Returns
A reference to this object.

◆ SetMaximumWidth()

NURBSSurfaceAttributeKit& HPS::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_widthThe largest allowable length of any facet's edge. Valid range is [0, sqrt(2)].
Returns
A reference to this object.

◆ SetTrimBudget()

NURBSSurfaceAttributeKit& HPS::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_budgetThe maximum number of vertices to be used in trim curve tessellation.
Returns
A reference to this object.

◆ Show()

void HPS::NURBSSurfaceAttributeKit::Show ( NURBSSurfaceAttributeKit out_kit) const

Copies this object into the given NURBSSurfaceAttributeKit.

Parameters
out_kitThe NURBSSurfaceAttributeKit to populate with the contents of this object.

◆ ShowBudget()

bool HPS::NURBSSurfaceAttributeKit::ShowBudget ( size_t &  out_budget) const

Shows the NURBS surface tessellation budget.

Parameters
out_budgetThe 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_degreesThe 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_deviationThe 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_deviationThe 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_widthThe 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_budgetThe maximum number of vertices to be used in trim curve tessellation.
Returns
true if the budget is valid, false otherwise.

◆ UnsetBudget()

NURBSSurfaceAttributeKit& HPS::NURBSSurfaceAttributeKit::UnsetBudget ( )

Removes the NURBS surface tessellation budget.

Returns
A reference to this object.

◆ UnsetEverything()

NURBSSurfaceAttributeKit& HPS::NURBSSurfaceAttributeKit::UnsetEverything ( )

Removes all settings from this object.

Returns
A reference to this object.

◆ UnsetMaximumAngle()

NURBSSurfaceAttributeKit& HPS::NURBSSurfaceAttributeKit::UnsetMaximumAngle ( )

Removes the largest angle allowed between the surface tangents.

Returns
A reference to this object.

◆ UnsetMaximumDeviation()

NURBSSurfaceAttributeKit& HPS::NURBSSurfaceAttributeKit::UnsetMaximumDeviation ( )

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

Returns
A reference to this object.

◆ UnsetMaximumTrimDeviation()

NURBSSurfaceAttributeKit& HPS::NURBSSurfaceAttributeKit::UnsetMaximumTrimDeviation ( )

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

Returns
A reference to this object.

◆ UnsetMaximumWidth()

NURBSSurfaceAttributeKit& HPS::NURBSSurfaceAttributeKit::UnsetMaximumWidth ( )

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

Returns
A reference to this object.

◆ UnsetTrimBudget()

NURBSSurfaceAttributeKit& HPS::NURBSSurfaceAttributeKit::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: