HPS::NURBSSurfaceAttributeControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::NURBSSurfaceAttributeControl:
HPS::Control HPS::Object

Public Member Functions

 NURBSSurfaceAttributeControl (SegmentKey &in_seg)
 
 NURBSSurfaceAttributeControl (NURBSSurfaceAttributeControl const &in_that)
 
 NURBSSurfaceAttributeControl (NURBSSurfaceAttributeControl &&in_that)
 
HPS::Type ObjectType () const
 
NURBSSurfaceAttributeControloperator= (NURBSSurfaceAttributeControl &&in_that)
 
NURBSSurfaceAttributeControloperator= (NURBSSurfaceAttributeControl const &in_that)
 
NURBSSurfaceAttributeControlSetBudget (size_t in_budget)
 
NURBSSurfaceAttributeControlSetMaximumAngle (float in_degrees)
 
NURBSSurfaceAttributeControlSetMaximumDeviation (float in_deviation)
 
NURBSSurfaceAttributeControlSetMaximumTrimDeviation (float in_deviation)
 
NURBSSurfaceAttributeControlSetMaximumWidth (float in_width)
 
NURBSSurfaceAttributeControlSetTrimBudget (size_t in_budget)
 
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
 
virtual HPS::Type Type () const
 
NURBSSurfaceAttributeControlUnsetBudget ()
 
NURBSSurfaceAttributeControlUnsetEverything ()
 
NURBSSurfaceAttributeControlUnsetMaximumAngle ()
 
NURBSSurfaceAttributeControlUnsetMaximumDeviation ()
 
NURBSSurfaceAttributeControlUnsetMaximumTrimDeviation ()
 
NURBSSurfaceAttributeControlUnsetMaximumWidth ()
 
NURBSSurfaceAttributeControlUnsetTrimBudget ()
 
 ~NURBSSurfaceAttributeControl ()
 
- Public Member Functions inherited from HPS::Object
virtual bool Empty () const
 
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 Attributes

static const HPS::Type staticType = HPS::Type::NURBSSurfaceAttributeControl
 
- Static Public Attributes inherited from HPS::Control
static const HPS::Type staticType = HPS::Type::Control
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
template<typename T >
static intptr_t ClassID ()
 
- Protected Member Functions inherited from HPS::Control
 Control (Control &&in_that)
 
Controloperator= (Control &&in_that)
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ NURBSSurfaceAttributeControl() [1/3]

HPS::NURBSSurfaceAttributeControl::NURBSSurfaceAttributeControl ( SegmentKey in_seg)
explicit

Initializes a control tied to the segment in_seg.

◆ NURBSSurfaceAttributeControl() [2/3]

HPS::NURBSSurfaceAttributeControl::NURBSSurfaceAttributeControl ( NURBSSurfaceAttributeControl const &  in_that)

Initializes a control tied to the same object as in_that.

◆ NURBSSurfaceAttributeControl() [3/3]

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

◆ ~NURBSSurfaceAttributeControl()

HPS::NURBSSurfaceAttributeControl::~NURBSSurfaceAttributeControl ( )

Releases a reference to the database object this control is tied to.

Member Function Documentation

◆ ObjectType()

HPS::Type HPS::NURBSSurfaceAttributeControl::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::Control.

◆ operator=() [1/2]

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

◆ operator=() [2/2]

NURBSSurfaceAttributeControl& HPS::NURBSSurfaceAttributeControl::operator= ( NURBSSurfaceAttributeControl const &  in_that)

Share the underlying smart-pointer of the NURBSSurfaceAttributeControl source.

Parameters
in_thatThe NURBSSurfaceAttributeControl source of the assignment.
Returns
A reference to this NURBSSurfaceAttributeControl.

◆ SetBudget()

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

◆ SetMaximumAngle()

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

Parameters
in_degreesThe maximum angle allowed between the surface tangents, in degrees.
Returns
A reference to this object.

◆ SetMaximumDeviation()

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

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

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

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

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

Parameters
in_widthThe largest allowable length of any facet's edge. Valid range is [0, sqrt(2)].
Returns
A reference to this object.

◆ SetTrimBudget()

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

◆ ShowBudget()

bool HPS::NURBSSurfaceAttributeControl::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::NURBSSurfaceAttributeControl::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::NURBSSurfaceAttributeControl::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::NURBSSurfaceAttributeControl::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::NURBSSurfaceAttributeControl::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::NURBSSurfaceAttributeControl::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.

◆ Type()

virtual HPS::Type HPS::NURBSSurfaceAttributeControl::Type ( ) const
inlinevirtual

This function returns the true type of the underlying object. This function is useful for finding the type of smart pointer objects that have been cast to more generic types.

Warning
This function must synchronize the database (by waiting for all pending database operations to complete) in order to know the type status of this object with certainty. Therefore this function can negatively impact performance. You should vigorously avoid using this function in high-traffic or peformance-critical areas of your code.
Returns
The true type of the object in question.

Reimplemented from HPS::Control.

◆ UnsetBudget()

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

Returns
A reference to this object.

◆ UnsetEverything()

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

Returns
A reference to this object.

◆ UnsetMaximumAngle()

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

Returns
A reference to this object.

◆ UnsetMaximumDeviation()

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

Returns
A reference to this object.

◆ UnsetMaximumTrimDeviation()

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

Returns
A reference to this object.

◆ UnsetMaximumWidth()

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

Returns
A reference to this object.

◆ UnsetTrimBudget()

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

Returns
A reference to this object.

The documentation for this class was generated from the following file: