HPS::LineAttributeControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::LineAttributeControl:

Collaboration diagram for HPS::LineAttributeControl:

Public Member Functions
	LineAttributeControl (SegmentKey &in_seg)
	Initializes a control tied to the segment in_seg. More...
	LineAttributeControl (LineAttributeControl const &in_that)
	Initializes a control tied to the same object as in_that. More...
	LineAttributeControl (LineAttributeControl &&in_that)
	The move constructor creates a LineAttributeControl by transferring the underlying impl of the rvalue reference to this LineAttributeControl thereby avoiding a copy and allocation. More...
LineAttributeControl &	operator= (LineAttributeControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this LineAttributeControl thereby avoiding a copy. More...
	~LineAttributeControl ()
	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
LineAttributeControl &	operator= (LineAttributeControl const &in_that)
	Share the underlying smart-pointer of the LineAttributeControl source. More...
LineAttributeControl &	SetPattern (char const *in_pattern)
	Specifies the pattern of lines. More...
LineAttributeControl &	SetPattern (char const *in_pattern, LinePatternOptionsKit const &in_options)
	Specifies the pattern of lines. More...
LineAttributeControl &	SetWeight (float in_weight, Line::SizeUnits in_units=Line::SizeUnits::ScaleFactor)
	Sets the weight of lines. More...
LineAttributeControl &	UnsetPattern ()
	Removes the line pattern setting for lines. More...
LineAttributeControl &	UnsetWeight ()
	Removes the weight setting for lines. More...
LineAttributeControl &	UnsetEverything ()
	Removes all settings from this object. More...
bool	ShowPattern (UTF8 &out_pattern, LinePatternOptionsKit &out_options) const
	Shows the pattern used to draw lines. More...
bool	ShowWeight (float &out_weight, Line::SizeUnits &out_units) const
	Shows the weight of lines. 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::LineAttributeControl

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

Detailed Description

The HPS::LineAttributeControl class is a smart pointer that is tied to a database object. This control allows you to manipulate the weight and pattern of lines and polylines.

This table lists default values for the various segment attributes accessible from HPS::LineAttributeControl.

Constructor & Destructor Documentation

LineAttributeControl() [1/4]

HPS::LineAttributeControl::LineAttributeControl ( SegmentKey &  in_seg )

explicit

Initializes a control tied to the segment in_seg.

LineAttributeControl() [2/4]

HPS::LineAttributeControl::LineAttributeControl

(

LineAttributeControl const &

in_that

)

Initializes a control tied to the same object as in_that.

LineAttributeControl() [3/4]

HPS::LineAttributeControl::LineAttributeControl

(

LineAttributeControl &&

in_that

)

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

Parameters

in_that

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

~LineAttributeControl()

HPS::LineAttributeControl::~LineAttributeControl

(

)

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

LineAttributeControl() [4/4]

HPS::LineAttributeControl::LineAttributeControl ( )

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

inlinevirtual

Reimplemented from HPS::Control.

operator=() [1/2]

LineAttributeControl& HPS::LineAttributeControl::operator=

(

LineAttributeControl &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this LineAttributeControl.

operator=() [2/2]

LineAttributeControl& HPS::LineAttributeControl::operator=

(

LineAttributeControl const &

in_that

)

Share the underlying smart-pointer of the LineAttributeControl source.

Parameters

in_that

The LineAttributeControl source of the assignment.

Returns

A reference to this LineAttributeControl.

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.

SetPattern() [1/2]

LineAttributeControl& HPS::LineAttributeControl::SetPattern

(

char const *

in_pattern

)

Specifies the pattern of lines.

Parameters

in_pattern

The name of a line pattern, defined in a portfolio that is accessible.

Returns

A reference to this object.

See also

Programming Guide: Line Patterns

SetPattern() [2/2]

LineAttributeControl& HPS::LineAttributeControl::SetPattern	(	char const *	in_pattern,
		LinePatternOptionsKit const &	in_options
	)

Specifies the pattern of lines.

Parameters

in_pattern	The name of a line pattern, defined in a portfolio that is accessible.
in_options	A set of options that modify how the named line pattern is applied.

Returns

A reference to this object.

See also

Programming Guide: Line Patterns

SetWeight()

LineAttributeControl& HPS::LineAttributeControl::SetWeight	(	float	in_weight,
		Line::SizeUnits	in_units = Line::SizeUnits::ScaleFactor
	)

Sets the weight of lines.

Parameters

in_weight	The weight value for lines.
in_units	The units applied to in_weight.

Returns

A reference to this object.

ShowPattern()

bool HPS::LineAttributeControl::ShowPattern	(	UTF8 &	out_pattern,
		LinePatternOptionsKit &	out_options
	)		const

Shows the pattern used to draw lines.

Parameters

out_pattern	The name of a line pattern, defined in a portfolio that is accessible.
out_options	A set of options that modify how the named line pattern is applied.

Returns

true if the setting is valid, false otherwise.

ShowWeight()

bool HPS::LineAttributeControl::ShowWeight	(	float &	out_weight,
		Line::SizeUnits &	out_units
	)		const

Shows the weight of lines.

Parameters

out_weight	The weight value for lines.
out_units	The units applied to in_weight.

Returns

true if the setting is valid, false otherwise.

Type()

virtual HPS::Type HPS::LineAttributeControl::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.

UnsetEverything()

LineAttributeControl& HPS::LineAttributeControl::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 LineAttributeKit::GetDefault().

Returns

A reference to this object.

UnsetPattern()

LineAttributeControl& HPS::LineAttributeControl::UnsetPattern

(

)

Removes the line pattern setting for lines.

If the control is attached to a WindowKey this function restores the default value of this setting as specified by LineAttributeKit::GetDefault().

Returns

A reference to this object.

UnsetWeight()

LineAttributeControl& HPS::LineAttributeControl::UnsetWeight

(

)

Removes the weight setting for lines.

If the control is attached to a WindowKey this function restores the default value of this setting as specified by LineAttributeKit::GetDefault().

Returns

A reference to this object.

Member Data Documentation

staticType

const HPS::Type HPS::LineAttributeControl::staticType = HPS::Type::LineAttributeControl

static

---

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

• hps.h