HPS::MarkerAttributeControl Class Reference

#include <hps.h>

Inheritance diagram for HPS::MarkerAttributeControl:

Collaboration diagram for HPS::MarkerAttributeControl:

Public Member Functions
	MarkerAttributeControl (SegmentKey &in_seg)
	Initializes a control tied to the segment in_seg. More...
	MarkerAttributeControl (MarkerAttributeControl const &in_that)
	Initializes a control tied to the same object as in_that. More...
	MarkerAttributeControl (MarkerAttributeControl &&in_that)
	The move constructor creates a MarkerAttributeControl by transferring the underlying impl of the rvalue reference to this MarkerAttributeControl thereby avoiding a copy and allocation. More...
MarkerAttributeControl &	operator= (MarkerAttributeControl &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this MarkerAttributeControl thereby avoiding a copy. More...
	~MarkerAttributeControl ()
	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
MarkerAttributeControl &	operator= (MarkerAttributeControl const &in_that)
	Share the underlying smart-pointer of the MarkerAttributeControl source. More...
MarkerAttributeControl &	SetSymbol (char const *in_glyph_name)
	Sets the glyph that should be used to draw markers. More...
MarkerAttributeControl &	SetSize (float in_size, Marker::SizeUnits in_units=Marker::SizeUnits::ScaleFactor)
	Sets the size of markers. More...
MarkerAttributeControl &	SetDrawingPreference (Marker::DrawingPreference in_preference)
	Sets the drawing method for markers. More...
MarkerAttributeControl &	UnsetSymbol ()
	Removes the marker symbol setting. More...
MarkerAttributeControl &	UnsetSize ()
	Removes the marker size setting. More...
MarkerAttributeControl &	UnsetDrawingPreference ()
	Removes the drawing preference setting. More...
MarkerAttributeControl &	UnsetEverything ()
	Removes all settings from this object. More...
bool	ShowSymbol (UTF8 &out_glyph_name) const
	Shows the glyph that should be used to draw markers. More...
bool	ShowSize (float &out_size, Marker::SizeUnits &out_units) const
	Shows the size of markers. More...
bool	ShowDrawingPreference (Marker::DrawingPreference &out_preference) const
	Shows the drawing method for markers. 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::MarkerAttributeControl

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

Detailed Description

The HPS::MarkerAttributeControl class is a smart pointer that is tied to a database object. This control allows you to manipulate the marker size and symbol at the segment level.

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

Constructor & Destructor Documentation

MarkerAttributeControl() [1/4]

HPS::MarkerAttributeControl::MarkerAttributeControl ( SegmentKey &  in_seg )

explicit

Initializes a control tied to the segment in_seg.

MarkerAttributeControl() [2/4]

HPS::MarkerAttributeControl::MarkerAttributeControl

(

MarkerAttributeControl const &

in_that

)

Initializes a control tied to the same object as in_that.

MarkerAttributeControl() [3/4]

HPS::MarkerAttributeControl::MarkerAttributeControl

(

MarkerAttributeControl &&

in_that

)

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

Parameters

in_that

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

~MarkerAttributeControl()

HPS::MarkerAttributeControl::~MarkerAttributeControl

(

)

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

MarkerAttributeControl() [4/4]

HPS::MarkerAttributeControl::MarkerAttributeControl ( )

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

inlinevirtual

Reimplemented from HPS::Control.

operator=() [1/2]

MarkerAttributeControl& HPS::MarkerAttributeControl::operator=

(

MarkerAttributeControl &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this MarkerAttributeControl.

operator=() [2/2]

MarkerAttributeControl& HPS::MarkerAttributeControl::operator=

(

MarkerAttributeControl const &

in_that

)

Share the underlying smart-pointer of the MarkerAttributeControl source.

Parameters

in_that

The MarkerAttributeControl source of the assignment.

Returns

A reference to this MarkerAttributeControl.

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.

SetDrawingPreference()

MarkerAttributeControl& HPS::MarkerAttributeControl::SetDrawingPreference

(

Marker::DrawingPreference

in_preference

)

Sets the drawing method for markers.

Fastest will draw at requested size, unless that would incur performance cost. Nicest will anyway.

Parameters

in_preference

The preferred drawing style.

Returns

A reference to this object.

SetSize()

MarkerAttributeControl& HPS::MarkerAttributeControl::SetSize	(	float	in_size,
		Marker::SizeUnits	in_units = Marker::SizeUnits::ScaleFactor
	)

Sets the size of markers.

Parameters

in_size	The size for markers.
in_units	The units of the size for markers.

Returns

A reference to this object.

SetSymbol()

MarkerAttributeControl& HPS::MarkerAttributeControl::SetSymbol

(

char const *

in_glyph_name

)

Sets the glyph that should be used to draw markers.

Parameters

in_glyph_name

A UTF8 encoded name of a glyph, defined in an accessible portfolio.

Returns

A reference to this object.

ShowDrawingPreference()

bool HPS::MarkerAttributeControl::ShowDrawingPreference

(

Marker::DrawingPreference &

out_preference

)

const

Shows the drawing method for markers.

Parameters

out_preference

The preferred drawing style. return true if the setting is valid, false otherwise.

ShowSize()

bool HPS::MarkerAttributeControl::ShowSize	(	float &	out_size,
		Marker::SizeUnits &	out_units
	)		const

Shows the size of markers.

Parameters

out_size	The size for markers.
out_units	The units of the size for markers.

Returns

true if the setting is valid, false otherwise.

ShowSymbol()

bool HPS::MarkerAttributeControl::ShowSymbol

(

UTF8 &

out_glyph_name

)

const

Shows the glyph that should be used to draw markers.

Parameters

out_glyph_name

A UTF8 encoded name of a glyph, defined in an accessible portfolio.

Returns

true if the setting is valid, false otherwise.

Type()

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

UnsetDrawingPreference()

MarkerAttributeControl& HPS::MarkerAttributeControl::UnsetDrawingPreference

(

)

Removes the drawing preference setting.

Returns

A reference to this object.

UnsetEverything()

MarkerAttributeControl& HPS::MarkerAttributeControl::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 MarkerAttributeKit::GetDefault().

Returns

A reference to this object.

UnsetSize()

MarkerAttributeControl& HPS::MarkerAttributeControl::UnsetSize

(

)

Removes the marker size setting.

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

Returns

A reference to this object.

UnsetSymbol()

MarkerAttributeControl& HPS::MarkerAttributeControl::UnsetSymbol

(

)

Removes the marker symbol setting.

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

Returns

A reference to this object.

Member Data Documentation

staticType

const HPS::Type HPS::MarkerAttributeControl::staticType = HPS::Type::MarkerAttributeControl

static

---

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

• hps.h