HPS::NURBSSurfaceAttributeControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::NURBSSurfaceAttributeControl:

Collaboration diagram for HPS::NURBSSurfaceAttributeControl:

Public Member Functions
	NURBSSurfaceAttributeControl (SegmentKey &in_seg)
	Initializes a control tied to the segment in_seg. More...
	NURBSSurfaceAttributeControl (NURBSSurfaceAttributeControl const &in_that)
	Initializes a control tied to the same object as in_that. More...
	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. More...
NURBSSurfaceAttributeControl &	operator= (NURBSSurfaceAttributeControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this NURBSSurfaceAttributeControl thereby avoiding a copy. More...
	~NURBSSurfaceAttributeControl ()
	Releases a reference to the database object this control is tied to. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. More...
HPS::Type	ObjectType () const
NURBSSurfaceAttributeControl &	operator= (NURBSSurfaceAttributeControl const &in_that)
	Share the underlying smart-pointer of the NURBSSurfaceAttributeControl source. More...
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. More...
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. More...
NURBSSurfaceAttributeControl &	SetMaximumAngle (float in_degrees)
	Sets the largest angle allowed between the surface tangents evaluated at any two corners of a given facet. More...
NURBSSurfaceAttributeControl &	SetMaximumWidth (float in_width)
	The largest allowable length, in the NURBS surface's normalized [0..1] parametric space, of any facet's edge. More...
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. More...
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. More...
NURBSSurfaceAttributeControl &	UnsetBudget ()
	Unsets the NURBS surface tessellation budget. More...
NURBSSurfaceAttributeControl &	UnsetMaximumDeviation ()
	Removes the upper bound of the difference between the NURBS surface and its parametric definition. More...
NURBSSurfaceAttributeControl &	UnsetMaximumAngle ()
	Removes the largest angle allowed between the surface tangents. More...
NURBSSurfaceAttributeControl &	UnsetMaximumWidth ()
	Removes the setting for the largest allowable length of any facet's edge. More...
NURBSSurfaceAttributeControl &	UnsetTrimBudget ()
	Removes the upper bound of vertices to be used in trim curve tessellation. More...
NURBSSurfaceAttributeControl &	UnsetMaximumTrimDeviation ()
	Removes the upper bound of trim curve vertices from the parametric definition of the trimming curve. More...
NURBSSurfaceAttributeControl &	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 bool	Empty () const
	Indicates whether this object has any values set on it. 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
template<typename T >
static intptr_t	ClassID ()
	Unique identifier for this class. More...

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

Private Member Functions
	NURBSSurfaceAttributeControl ()
	Private default constructor to prevent instantiation without a segment. More...

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/4]

HPS::NURBSSurfaceAttributeControl::NURBSSurfaceAttributeControl ( SegmentKey &  in_seg )

explicit

Initializes a control tied to the segment in_seg.

NURBSSurfaceAttributeControl() [2/4]

HPS::NURBSSurfaceAttributeControl::NURBSSurfaceAttributeControl

(

NURBSSurfaceAttributeControl const &

in_that

)

Initializes a control tied to the same object as in_that.

NURBSSurfaceAttributeControl() [3/4]

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_that

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

NURBSSurfaceAttributeControl() [4/4]

HPS::NURBSSurfaceAttributeControl::NURBSSurfaceAttributeControl ( )

private

Private default constructor to prevent instantiation without a segment.

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

virtual bool HPS::Object::Empty ( ) const

inlinevirtualinherited

Indicates whether this object has any values set on it.

Returns

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

Reimplemented in HPS::STL::ImportResultsKit, HPS::STL::ImportOptionsKit, HPS::OBJ::ImportResultsKit, HPS::OBJ::ImportOptionsKit, HPS::Hardcopy::File::ExportOptionsKit, HPS::Stream::ExportOptionsKit, HPS::Stream::ImportResultsKit, HPS::Stream::ImportOptionsKit, HPS::PointCloud::ImportOptionsKit, HPS::PointCloud::ImportResultsKit, HPS::UpdateOptionsKit, HPS::HighlightSearchOptionsKit, HPS::HighlightOptionsKit, HPS::SelectionOptionsKit, HPS::SearchOptionsKit, HPS::CutGeometryGatheringOptionsKit, HPS::ShapeKit, HPS::ShaderKit, HPS::Shader::ImportOptionsKit, HPS::ImageKit, HPS::Image::ImportOptionsKit, HPS::Image::ExportOptionsKit, HPS::TextureOptionsKit, HPS::LinePatternKit, HPS::LinePatternParallelKit, HPS::LinePatternOptionsKit, HPS::GlyphKit, HPS::ApplicationWindowOptionsKit, HPS::OffScreenWindowOptionsKit, HPS::StandAloneWindowOptionsKit, HPS::GridKit, HPS::PolygonKit, HPS::MeshKit, HPS::ShellKit, HPS::ShellRelationResultsKit, HPS::ShellRelationOptionsKit, HPS::ShellOptimizationOptionsKit, HPS::TextKit, HPS::EllipticalArcKit, HPS::EllipseKit, HPS::TrimKit, HPS::NURBSSurfaceKit, HPS::NURBSCurveKit, HPS::SpotlightKit, HPS::InfiniteLineKit, HPS::CuttingSectionKit, HPS::CircularWedgeKit, HPS::CircularArcKit, HPS::CircleKit, HPS::SphereKit, HPS::CylinderKit, HPS::DistantLightKit, HPS::MarkerKit, HPS::LineKit, HPS::AttributeLockKit, HPS::FontInfoState, HPS::WindowInfoKit, HPS::DebuggingKit, HPS::SubwindowKit, HPS::ContourLineKit, HPS::VisualEffectsKit, HPS::TransformMaskKit, HPS::PostProcessEffectsKit, HPS::DrawingAttributeKit, HPS::HiddenLineAttributeKit, HPS::PerformanceKit, HPS::NURBSSurfaceAttributeKit, HPS::MaterialKit, HPS::MaterialMappingKit, HPS::MatrixKit, HPS::CurveAttributeKit, HPS::EdgeAttributeKit, HPS::LineAttributeKit, HPS::TextAttributeKit, HPS::CuttingSectionAttributeKit, HPS::CylinderAttributeKit, HPS::LightingAttributeKit, HPS::SphereAttributeKit, HPS::MarkerAttributeKit, HPS::CullingKit, HPS::ColorInterpolationKit, HPS::TransparencyKit, HPS::SelectabilityKit, HPS::CameraKit, HPS::VisibilityKit, HPS::BoundingKit, HPS::SegmentOptimizationOptionsKit, HPS::Publish::ExportOptionsKit, HPS::Publish::TextFieldKit, HPS::Publish::SignatureFieldKit, HPS::Publish::DropDownListKit, HPS::Exchange::TessellationOptionsKit, HPS::Publish::ListBoxKit, HPS::Exchange::ExportSTEPOptionsKit, HPS::Exchange::ExportParasolidOptionsKit, HPS::Publish::RadioButtonKit, HPS::Exchange::ExportIGESOptionsKit, HPS::Exchange::ExportXMLOptionsKit, HPS::Publish::CheckBoxKit, HPS::Exchange::ExportU3DOptionsKit, HPS::Exchange::ExportSTLOptionsKit, HPS::Publish::ButtonKit, HPS::Exchange::ExportPRCOptionsKit, HPS::Publish::LinkKit, HPS::Exchange::ExportJTOptionsKit, HPS::Publish::SlideTableKit, HPS::Exchange::ExportACISOptionsKit, HPS::Publish::TableKit, HPS::Exchange::Export3MFOptionsKit, HPS::Publish::ImageKit, HPS::Publish::TextKit, HPS::Exchange::ModelFileImportOptionsKit, HPS::Publish::ViewKit, HPS::Exchange::TranslationOptionsKit, HPS::Publish::ArtworkKit, HPS::Publish::AnnotationKit, HPS::ComponentPath, HPS::Exchange::ImportOptionsKit, HPS::Parasolid::ExportOptionsKit, HPS::Exchange::NURBSConversionOptionsKit, HPS::Parasolid::LineTessellationKit, HPS::Exchange::Configuration, HPS::Publish::PageKit, HPS::Parasolid::FacetTessellationKit, HPS::Publish::DocumentKit, HPS::Parasolid::ImportOptionsKit, HPS::DWG::ImportOptionsKit, HPS::OOC::ImportOptionsKit, HPS::Sketchup::ImportOptionsKit, and HPS::Sketchup::ImportResultsKit.

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.

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::NURBSSurfaceAttributeControl::ObjectType ( ) const

inlinevirtual

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_that

An 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_that

The NURBSSurfaceAttributeControl source of the assignment.

Returns

A reference to this NURBSSurfaceAttributeControl.

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.

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_budget

The 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_degrees

The 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_deviation

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

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_width

The 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_budget

The 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_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::NURBSSurfaceAttributeControl::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::NURBSSurfaceAttributeControl::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::NURBSSurfaceAttributeControl::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::NURBSSurfaceAttributeControl::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::NURBSSurfaceAttributeControl::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::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.

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.

Member Data Documentation

staticType

const HPS::Type HPS::NURBSSurfaceAttributeControl::staticType = HPS::Type::NURBSSurfaceAttributeControl

static

---

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

• hps.h