HPS::CurveAttributeControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::CurveAttributeControl:

Collaboration diagram for HPS::CurveAttributeControl:

Public Member Functions
	CurveAttributeControl (SegmentKey &in_seg)
	Initializes a control tied to the segment in_seg. More...
	CurveAttributeControl (CurveAttributeControl const &in_that)
	Initializes a control tied to the same object as in_that. More...
	CurveAttributeControl (CurveAttributeControl &&in_that)
	The move constructor creates a CurveAttributeControl by transferring the underlying impl of the rvalue reference to this CurveAttributeControl thereby avoiding a copy and allocation. More...
CurveAttributeControl &	operator= (CurveAttributeControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this CurveAttributeControl thereby avoiding a copy. More...
	~CurveAttributeControl ()
	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
CurveAttributeControl &	operator= (CurveAttributeControl const &in_that)
	Share the underlying smart-pointer of the CurveAttributeControl source. More...
CurveAttributeControl &	SetBudget (size_t in_budget)
	Sets the upper boundary of the number of vertices that will be allowed in the tessellation of curves, regardless of view settings. More...
CurveAttributeControl &	SetContinuedBudget (bool in_state, size_t in_budget=0)
	Sets the number of additional vertices will be allocated to the overall curve for each control point beyond the degree of the curve plus one. More...
CurveAttributeControl &	SetContinuedBudget (size_t in_budget)
	Sets the number of additional vertices will be allocated to the overall curve for each control point beyond the degree of the curve plus one. More...
CurveAttributeControl &	SetViewDependent (bool in_state)
	Sets whether curves should be rendered in a view-dependent or view-independent manner. More...
CurveAttributeControl &	SetMaximumDeviation (float in_deviation)
	Sets the distance in object space from the parametric definition of the curve to its tessellated counterpart. More...
CurveAttributeControl &	SetMaximumAngle (float in_degrees)
	Sets the largest angle allowed, in degrees, between adjacent line segments in the tessellated representation. More...
CurveAttributeControl &	SetMaximumLength (float in_length)
	Sets the largest allowable length, in the curve's normalized [0,1] parametric space, of any line segment. More...
CurveAttributeControl &	UnsetBudget ()
	Removes the budget setting. More...
CurveAttributeControl &	UnsetContinuedBudget ()
	Removes the continued budget setting. More...
CurveAttributeControl &	UnsetViewDependent ()
	Removes the view-dependent setting. More...
CurveAttributeControl &	UnsetMaximumDeviation ()
	Removes the maximum deviation setting. More...
CurveAttributeControl &	UnsetMaximumAngle ()
	Removes the maximum angle setting. More...
CurveAttributeControl &	UnsetMaximumLength ()
	Removes the maximum length setting. More...
CurveAttributeControl &	UnsetEverything ()
	Removes all settings from this object. More...
bool	ShowBudget (size_t &out_budget) const
	Shows the upper boundary of the number of vertices that will be allowed in the tessellation of curves, regardless of view settings. More...
bool	ShowContinuedBudget (bool &out_state, size_t &out_budget) const
	Shows the number of additional vertices will be allocated to the overall curve for each control point beyond the degree of the curve plus one. More...
bool	ShowViewDependent (bool &out_state) const
	Shows whether curves should be rendered in a view-dependent or view-independent manner. More...
bool	ShowMaximumDeviation (float &out_deviation) const
	Shows the distance in object space from the parametric definition of the curve to its tessellated counterpart. More...
bool	ShowMaximumAngle (float &out_degrees) const
	Shows the largest angle allowed, in degrees, between adjacent line segments in the tessellated representation. More...
bool	ShowMaximumLength (float &out_length) const
	Shows the largest allowable length, in the curve's normalized [0,1] parametric space, of any line segment. 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::CurveAttributeControl

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

Detailed Description

The HPS::CurveAttributeControl class is a smart pointer that is tied to a database object. This object is used to manipulate the various attributes related to curved lines, such as budget, angle, deviation, and length. This table lists default values for the various segment attributes accessible from HPS::CurveAttributeControl.

Constructor & Destructor Documentation

CurveAttributeControl() [1/4]

HPS::CurveAttributeControl::CurveAttributeControl ( SegmentKey &  in_seg )

explicit

Initializes a control tied to the segment in_seg.

CurveAttributeControl() [2/4]

HPS::CurveAttributeControl::CurveAttributeControl

(

CurveAttributeControl const &

in_that

)

Initializes a control tied to the same object as in_that.

CurveAttributeControl() [3/4]

HPS::CurveAttributeControl::CurveAttributeControl

(

CurveAttributeControl &&

in_that

)

The move constructor creates a CurveAttributeControl by transferring the underlying impl of the rvalue reference to this CurveAttributeControl thereby avoiding a copy and allocation.

Parameters

in_that

An rvalue reference to a CurveAttributeControl to take the impl from.

~CurveAttributeControl()

HPS::CurveAttributeControl::~CurveAttributeControl

(

)

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

CurveAttributeControl() [4/4]

HPS::CurveAttributeControl::CurveAttributeControl ( )

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

inlinevirtual

Reimplemented from HPS::Control.

operator=() [1/2]

CurveAttributeControl& HPS::CurveAttributeControl::operator=

(

CurveAttributeControl &&

in_that

)

The move assignment operator transfers the underlying impl of the rvalue reference to this CurveAttributeControl thereby avoiding a copy.

Parameters

in_that

An rvalue reference to a CurveAttributeControl to take the impl from.

Returns

A reference to this CurveAttributeControl.

operator=() [2/2]

CurveAttributeControl& HPS::CurveAttributeControl::operator=

(

CurveAttributeControl const &

in_that

)

Share the underlying smart-pointer of the CurveAttributeControl source.

Parameters

in_that

The CurveAttributeControl source of the assignment.

Returns

A reference to this CurveAttributeControl.

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

CurveAttributeControl& HPS::CurveAttributeControl::SetBudget

(

size_t

in_budget

)

Sets the upper boundary of the number of vertices that will be allowed in the tessellation of curves, regardless of view settings.

Parameters

in_budget

The number of vertices that will be allowed in the tessellation of curves.

Returns

A reference to this object.

SetContinuedBudget() [1/2]

CurveAttributeControl& HPS::CurveAttributeControl::SetContinuedBudget	(	bool	in_state,
		size_t	in_budget = 0
	)

Sets the number of additional vertices will be allocated to the overall curve for each control point beyond the degree of the curve plus one.

A curve with a number of control points equal to the degree plus one will have a number of vertices equal to the budget. Curves with more control points than that number will have additional vertices equal to the continued budget for each extra control point.

Parameters

in_state	Whether the continued budget will be used at all.
in_budget	The number of additional vertices that will be allocated to the overall curve.

Returns

A reference to this object.

SetContinuedBudget() [2/2]

CurveAttributeControl& HPS::CurveAttributeControl::SetContinuedBudget

(

size_t

in_budget

)

Sets the number of additional vertices will be allocated to the overall curve for each control point beyond the degree of the curve plus one.

A curve with a number of control points equal to the degree plus one will have a number of vertices equal to the budget. Curves with more control points than that number will have additional vertices equal to the continued budget for each extra control point. The state is implicitly on.

Parameters

in_budget

The number of additional vertices that will be allocated to the overall curve.

Returns

A reference to this object.

SetMaximumAngle()

CurveAttributeControl& HPS::CurveAttributeControl::SetMaximumAngle

(

float

in_degrees

)

Sets the largest angle allowed, in degrees, between adjacent line segments in the tessellated representation.

Applies to view-independent curves only.

Parameters

in_degrees

The largest angle allowed between adjacent line segments.

Returns

A reference to this object.

SetMaximumDeviation()

CurveAttributeControl& HPS::CurveAttributeControl::SetMaximumDeviation

(

float

in_deviation

)

Sets the distance in object space from the parametric definition of the curve to its tessellated counterpart.

Parameters

in_deviation

The distance in object space from the parametric definition.

Returns

A reference to this object.

SetMaximumLength()

CurveAttributeControl& HPS::CurveAttributeControl::SetMaximumLength

(

float

in_length

)

Sets the largest allowable length, in the curve's normalized [0,1] parametric space, of any line segment.

Applies to view-independent curves only.

Parameters

in_length

The largest allowable length of any line segment.

Returns

A reference to this object.

SetViewDependent()

CurveAttributeControl& HPS::CurveAttributeControl::SetViewDependent

(

bool

in_state

)

Sets whether curves should be rendered in a view-dependent or view-independent manner.

The tessellation of view-dependent curves is adjusted to maintain a smooth curve with the current camera setting. View-independent curves are statically tessellated based on the curve attribute settings. View-independent is less computationally intensive but can result in curves that do not look smooth with certain camera settings.

Parameters

in_state

Whether curves should be rendered in a view-dependent manner.

Returns

A reference to this object.

ShowBudget()

bool HPS::CurveAttributeControl::ShowBudget

(

size_t &

out_budget

)

const

Shows the upper boundary of the number of vertices that will be allowed in the tessellation of curves, regardless of view settings.

Parameters

out_budget

The number of vertices that will be allowed in the tessellation of curves.

Returns

true if the setting is valid, false otherwise.

ShowContinuedBudget()

bool HPS::CurveAttributeControl::ShowContinuedBudget	(	bool &	out_state,
		size_t &	out_budget
	)		const

Shows the number of additional vertices will be allocated to the overall curve for each control point beyond the degree of the curve plus one.

Parameters

out_state	Whether the continued budget will be used at all.
out_budget	The number of additional vertices that will be allocated to the overall curve.

Returns

true if the setting is valid, false otherwise.

ShowMaximumAngle()

bool HPS::CurveAttributeControl::ShowMaximumAngle

(

float &

out_degrees

)

const

Shows the largest angle allowed, in degrees, between adjacent line segments in the tessellated representation.

Applies to view-independent curves only.

Parameters

out_degrees

The largest angle allowed between adjacent line segments.

Returns

true if the setting is valid, false otherwise.

ShowMaximumDeviation()

bool HPS::CurveAttributeControl::ShowMaximumDeviation

(

float &

out_deviation

)

const

Shows the distance in object space from the parametric definition of the curve to its tessellated counterpart.

Applies to view-independent curves only.

Parameters

out_deviation

The distance in object space from the parametric definition.

Returns

true if the setting is valid, false otherwise.

ShowMaximumLength()

bool HPS::CurveAttributeControl::ShowMaximumLength

(

float &

out_length

)

const

Shows the largest allowable length, in the curve's normalized [0,1] parametric space, of any line segment.

Applies to view-independent curves only.

Parameters

out_length

The largest allowable length of any line segment.

Returns

true if the setting is valid, false otherwise.

ShowViewDependent()

bool HPS::CurveAttributeControl::ShowViewDependent

(

bool &

out_state

)

const

Shows whether curves should be rendered in a view-dependent or view-independent manner.

Parameters

out_state

Whether curves should be rendered in a view-dependent manner.

Returns

true if the setting is valid, false otherwise.

Type()

virtual HPS::Type HPS::CurveAttributeControl::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()

CurveAttributeControl& HPS::CurveAttributeControl::UnsetBudget

(

)

Removes the budget setting.

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.

UnsetContinuedBudget()

CurveAttributeControl& HPS::CurveAttributeControl::UnsetContinuedBudget

(

)

Removes the continued budget setting.

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

CurveAttributeControl& HPS::CurveAttributeControl::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()

CurveAttributeControl& HPS::CurveAttributeControl::UnsetMaximumAngle

(

)

Removes the maximum angle setting.

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

CurveAttributeControl& HPS::CurveAttributeControl::UnsetMaximumDeviation

(

)

Removes the maximum deviation setting.

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.

UnsetMaximumLength()

CurveAttributeControl& HPS::CurveAttributeControl::UnsetMaximumLength

(

)

Removes the maximum length setting.

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.

UnsetViewDependent()

CurveAttributeControl& HPS::CurveAttributeControl::UnsetViewDependent

(

)

Removes the view-dependent setting.

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::CurveAttributeControl::staticType = HPS::Type::CurveAttributeControl

static

---

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

• hps.h