The HPS::NURBSSurfaceAttributeKit class is a user space object that contains settings related to NURBS surfaces. More...

#include <hps.h>

Inheritance diagram for HPS::NURBSSurfaceAttributeKit:

[legend]

Collaboration diagram for HPS::NURBSSurfaceAttributeKit:

[legend]

Public Member Functions
	NURBSSurfaceAttributeKit ()
	Initializes an empty kit. More...

	NURBSSurfaceAttributeKit (NURBSSurfaceAttributeKit const &in_kit)
	The copy constructor creates a new NURBSSurfaceAttributeKit object that contains the same settings as the source object. More...

	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. More...

NURBSSurfaceAttributeKit &	operator= (NURBSSurfaceAttributeKit &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this NURBSSurfaceAttributeKit thereby avoiding a copy. More...

virtual	~NURBSSurfaceAttributeKit ()
	Destroy this kit. More...

HPS::Type	ObjectType () const

void	Set (NURBSSurfaceAttributeKit const &in_kit)
	Copies the source NURBSSurfaceAttributeKit into this object. More...

void	Show (NURBSSurfaceAttributeKit &out_kit) const
	Copies this object into the given NURBSSurfaceAttributeKit. More...

NURBSSurfaceAttributeKit &	operator= (NURBSSurfaceAttributeKit const &in_kit)
	Copies the source NURBSSurfaceAttributeKit into this object. More...

bool	Empty () const
	Indicates whether this object has any values set on it. More...

bool	Equals (NURBSSurfaceAttributeKit const &in_kit) const
	Check if the source NURBSSurfaceAttributeKit is equivalent to this object. More...

bool	operator== (NURBSSurfaceAttributeKit const &in_kit) const
	Check if the source NURBSSurfaceAttributeKit is equivalent to this object. More...

bool	operator!= (NURBSSurfaceAttributeKit const &in_kit) const
	Check if the source NURBSSurfaceAttributeKit is not equivalent to this object. More...

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. More...

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. More...

NURBSSurfaceAttributeKit &	SetMaximumAngle (float in_degrees)
	Sets the largest angle allowed between the surface tangents evaluated at any two corners of a given facet. More...

NURBSSurfaceAttributeKit &	SetMaximumWidth (float in_width)
	The largest allowable length, in the NURBS surface's normalized [0..1] parametric space, of any facet's edge. More...

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. More...

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. More...

NURBSSurfaceAttributeKit &	UnsetBudget ()
	Removes the NURBS surface tessellation budget. More...

NURBSSurfaceAttributeKit &	UnsetMaximumDeviation ()
	Removes the upper bound of the difference between the NURBS surface and its parametric definition. More...

NURBSSurfaceAttributeKit &	UnsetMaximumAngle ()
	Removes the largest angle allowed between the surface tangents. More...

NURBSSurfaceAttributeKit &	UnsetMaximumWidth ()
	Removes the setting for the largest allowable length of any facet's edge. More...

NURBSSurfaceAttributeKit &	UnsetTrimBudget ()
	Removes the upper bound of vertices to be used in trim curve tessellation. More...

NURBSSurfaceAttributeKit &	UnsetMaximumTrimDeviation ()
	Removes the upper bound of trim curve vertices from the parametric definition of the trimming curve. More...

NURBSSurfaceAttributeKit &	UnsetEverything ()
	Removes all settings from this object. More...

bool	ShowBudget (size_t &out_budget) const
	Shows the NURBS surface tessellation budget. More...

bool	ShowMaximumDeviation (float &out_deviation) const
	Shows the upper bound of the difference between the NURBS surface and its parametric definition. More...

bool	ShowMaximumAngle (float &out_degrees) const
	Shows the largest angle allowed between the surface tangents. More...

bool	ShowMaximumWidth (float &out_width) const
	Shows the setting for the largest allowable length of any facet's edge. More...

bool	ShowTrimBudget (size_t &out_budget) const
	Shows the upper bound of vertices to be used in trim curve tessellation. More...

bool	ShowMaximumTrimDeviation (float &out_deviation) const
	Shows the upper bound of trim curve vertices from the parametric definition of the trimming curve. More...

virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...

virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...

bool	HasType (HPS::Type in_mask) const
	This function indicates whether this Object has the given Type mask. More...

intptr_t	GetClassID () const
	Returns a unique identifier that is shared by all objects of the same class. More...

intptr_t	GetInstanceID () const
	Returns an identifier that can be used to identify which instance of a class an object is. More...

Static Public Member Functions
static NURBSSurfaceAttributeKit	GetDefault ()
	Creates a NURBSSurfaceAttributeKit which contains the default settings. More...

template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

Static Public Attributes
static const HPS::Type	staticType = HPS::Type::NURBSSurfaceAttributeKit

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_kit The 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_that An rvalue reference to a NURBSSurfaceAttributeKit to take the impl from.

◆ ~NURBSSurfaceAttributeKit()

virtual HPS::NURBSSurfaceAttributeKit::~NURBSSurfaceAttributeKit ( )

virtual

Destroy this kit.

Member Function Documentation

◆ ClassID()

template<typename T >

static intptr_t HPS::Object::ClassID ( )

inlinestaticinherited

Unique identifier for this class.

Note: this method uses construction of static objects. If used in a constructor, it should be used in the body not the initializer list.

◆ 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_kit The source NURBSSurfaceAttributeKit to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

◆ GetClassID()

intptr_t HPS::Object::GetClassID ( ) const

inherited

Returns a unique identifier that is shared by all objects of the same class.

Returns: A unique value shared by all objects of the same class.

◆ 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.

◆ GetInstanceID()

intptr_t HPS::Object::GetInstanceID ( ) const

inherited

Returns an identifier that can be used to identify which instance of a class an object is.

Different keys and controls will return the same value if they are backed by the same database resource.

Returns: A value unique to an instance of an object and all objects that are backed by the same database resource.

◆ HasType()

bool HPS::Object::HasType ( HPS::Type in_mask ) const

inherited

This function indicates whether this Object has the given Type mask.

Parameters

in_mask The Type mask to check against this Object.

Returns: true if this Object has the given Type mask, false otherwise.

◆ ObjectType()

HPS::Type HPS::NURBSSurfaceAttributeKit::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Kit.

Here is the call graph for this function:

◆ operator!=()

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

◆ 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_that An 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_kit The 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_kit The source NURBSSurfaceAttributeKit to compare to this object.

Returns: true if the objects are equivalent, false otherwise.

◆ Reset()

virtual void HPS::Object::Reset ( )

virtualinherited

Resets this object to its initial, uninitialized state.

Reimplemented in HPS::EventHandler, HPS::EventDispatcher, HPS::World, HPS::HighlightSearchResults, HPS::HighlightSearchResultsIterator, HPS::SelectionResults, HPS::SelectionResultsIterator, HPS::FontSearchResults, HPS::FontSearchResultsIterator, HPS::SearchResults, and HPS::SearchResultsIterator.

◆ Set()

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

Copies the source NURBSSurfaceAttributeKit into this object.

Parameters

in_kit The 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_budget The 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_degrees The 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_deviation The 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_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()

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_width The 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_budget The 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_kit The 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_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.

◆ Type()

virtual HPS::Type HPS::Kit::Type ( ) const

inlinevirtualinherited

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.

Returns: The true type of the object in question.

Reimplemented from HPS::Object.

◆ 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.

Member Data Documentation

◆ staticType

const HPS::Type HPS::NURBSSurfaceAttributeKit::staticType = HPS::Type::NURBSSurfaceAttributeKit

static

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

hps.h

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

◆ NURBSSurfaceAttributeKit() [1/3]

◆ NURBSSurfaceAttributeKit() [2/3]

◆ NURBSSurfaceAttributeKit() [3/3]

◆ ~NURBSSurfaceAttributeKit()

Member Function Documentation

◆ ClassID()

◆ Empty()

◆ Equals()

◆ GetClassID()

◆ GetDefault()

◆ GetInstanceID()

◆ HasType()

◆ ObjectType()

◆ operator!=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==()

◆ Reset()

◆ Set()

◆ SetBudget()

◆ SetMaximumAngle()

◆ SetMaximumDeviation()

◆ SetMaximumTrimDeviation()

◆ SetMaximumWidth()

◆ SetTrimBudget()

◆ Show()

◆ ShowBudget()

◆ ShowMaximumAngle()

◆ ShowMaximumDeviation()

◆ ShowMaximumTrimDeviation()

◆ ShowMaximumWidth()

◆ ShowTrimBudget()

◆ Type()

◆ UnsetBudget()

◆ UnsetEverything()

◆ UnsetMaximumAngle()

◆ UnsetMaximumDeviation()

◆ UnsetMaximumTrimDeviation()

◆ UnsetMaximumWidth()

◆ UnsetTrimBudget()

Member Data Documentation

◆ staticType