HPS::GlyphLinePatternElement Class Reference

The GlyphLinePatternElement class is a user space object. More...

#include <hps.h>

Inheritance diagram for HPS::GlyphLinePatternElement:

Collaboration diagram for HPS::GlyphLinePatternElement:

Public Member Functions
	GlyphLinePatternElement ()
	The default constructor creates an empty GlyphLinePatternElement object. More...
	GlyphLinePatternElement (LinePatternElement const &in_that)
	This constructor creates a GlyphLinePatternElement object that contains the same settings as the source LinePatternElement. More...
	GlyphLinePatternElement (GlyphLinePatternElement const &in_that)
	The copy constructor creates a new GlyphLinePatternElement object that contains the same settings as the source GlyphLinePatternElement. More...
GlyphLinePatternElement &	operator= (GlyphLinePatternElement const &in_that)
	Copies the source GlyphLinePatternElement into this GlyphLinePatternElement. More...
	GlyphLinePatternElement (GlyphLinePatternElement &&in_that)
	The move constructor creates a GlyphLinePatternElement by transferring the underlying impl of the rvalue reference to this GlyphLinePatternElement thereby avoiding a copy and allocation. More...
GlyphLinePatternElement &	operator= (GlyphLinePatternElement &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this GlyphLinePatternElement thereby avoiding a copy. More...
	~GlyphLinePatternElement ()
HPS::Type	ObjectType () const
void	SetSource (char const *in_source)
	Sets the name of the source for this GlyphLinePatternElement. More...
void	SetWeight (float in_weight, LinePattern::SizeUnits in_units)
	Sets the weight for this GlyphLinePatternElement. More...
void	SetInsetBehavior (LinePattern::InsetBehavior in_behavior)
	Sets the inset behavior for this GlyphLinePatternElement. More...
void	SetMirror (bool in_state)
	Sets whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation. More...
void	SetFixed (bool in_state)
	Sets whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector. More...
void	SetRotation (float in_degrees)
	Sets the angle in degrees the GlyphLinePatternElement is rotated relative to the line vector. More...
bool	ShowSource (UTF8 &out_source) const
	Shows the name of the source for this GlyphLinePatternElement. More...
bool	ShowWeight (float &out_weight, LinePattern::SizeUnits &out_units) const
	Shows the weight for this GlyphLinePatternElement. More...
bool	ShowInsetBehavior (LinePattern::InsetBehavior &out_behavior) const
	Shows the inset behavior for this GlyphLinePatternElement. More...
bool	ShowMirror (bool &out_state) const
	Shows whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation. More...
bool	ShowFixed (bool &out_state) const
	Shows whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector. More...
bool	ShowRotation (float &out_degrees) const
	Shows the angle in degrees the GlyphLinePatternElement is rotated relative to the line vector. More...
void	Set (LinePatternElement const &in_that)
	Copies the source LinePatternElement into this LinePatternElement. More...
bool	Equals (LinePatternElement const &in_that) const
	Check if the source LinePatternElement is equivalent to this LinePatternElement. More...
bool	operator== (LinePatternElement const &in_that) const
	Check if the source LinePatternElement is equivalent to this LinePatternElement. More...
bool	operator!= (LinePatternElement const &in_that) const
	Check if the source LinePatternElement is not equivalent to this LinePatternElement. More...
void	SetSize (float in_size, LinePattern::SizeUnits in_units)
	Sets the size of this LinePatternElement. More...
bool	ShowSize (float &out_size, LinePattern::SizeUnits &out_units) const
	Shows the size of this LinePatternElement. More...
virtual HPS::Type	Type () const
	This function returns the true type of the underlying object. 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::GlyphLinePatternElement

Detailed Description

The GlyphLinePatternElement class is a user space object.

It is used for specifying glyphs elements within a line pattern.

Constructor & Destructor Documentation

GlyphLinePatternElement() [1/4]

HPS::GlyphLinePatternElement::GlyphLinePatternElement

(

)

The default constructor creates an empty GlyphLinePatternElement object.

GlyphLinePatternElement() [2/4]

HPS::GlyphLinePatternElement::GlyphLinePatternElement

(

LinePatternElement const &

in_that

)

This constructor creates a GlyphLinePatternElement object that contains the same settings as the source LinePatternElement.

The copy will only be successful if the source line pattern element is really an upcast of a glyph line pattern element. Otherwise the copy will fail and the resulting GlyphLinePatternElement will be invalid.

Parameters

in_that

The source LinePatternElement to copy.

GlyphLinePatternElement() [3/4]

HPS::GlyphLinePatternElement::GlyphLinePatternElement

(

GlyphLinePatternElement const &

in_that

)

The copy constructor creates a new GlyphLinePatternElement object that contains the same settings as the source GlyphLinePatternElement.

Parameters

in_that

The source GlyphLinePatternElement to copy.

GlyphLinePatternElement() [4/4]

HPS::GlyphLinePatternElement::GlyphLinePatternElement

(

GlyphLinePatternElement &&

in_that

)

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

Parameters

in_that

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

~GlyphLinePatternElement()

HPS::GlyphLinePatternElement::~GlyphLinePatternElement

(

)

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.

Equals()

bool HPS::LinePatternElement::Equals ( LinePatternElement const &  in_that ) const

inherited

Check if the source LinePatternElement is equivalent to this LinePatternElement.

Parameters

in_that

The source LinePatternElement to compare to this LinePatternElement.

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.

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

inlinevirtual

Reimplemented from HPS::LinePatternElement.

operator!=()

bool HPS::LinePatternElement::operator!= ( LinePatternElement const &  in_that ) const

inherited

Check if the source LinePatternElement is not equivalent to this LinePatternElement.

Parameters

in_that

The source LinePatternElement to compare to this LinePatternElement.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

GlyphLinePatternElement& HPS::GlyphLinePatternElement::operator=

(

GlyphLinePatternElement const &

in_that

)

Copies the source GlyphLinePatternElement into this GlyphLinePatternElement.

Parameters

in_that

The source GlyphLinePatternElement to copy.

Returns

A reference to this GlyphLinePatternElement.

operator=() [2/2]

GlyphLinePatternElement& HPS::GlyphLinePatternElement::operator=

(

GlyphLinePatternElement &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this GlyphLinePatternElement.

operator==()

bool HPS::LinePatternElement::operator== ( LinePatternElement const &  in_that ) const

inherited

Check if the source LinePatternElement is equivalent to this LinePatternElement.

Parameters

in_that

The source LinePatternElement to compare to this LinePatternElement.

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::LinePatternElement::Set ( LinePatternElement const &  in_that )

inherited

Copies the source LinePatternElement into this LinePatternElement.

Parameters

in_that

The source LinePatternElement to copy.

SetFixed()

void HPS::GlyphLinePatternElement::SetFixed

(

bool

in_state

)

Sets whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.

Parameters

in_state

Whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.

SetInsetBehavior()

void HPS::GlyphLinePatternElement::SetInsetBehavior

(

LinePattern::InsetBehavior

in_behavior

)

Sets the inset behavior for this GlyphLinePatternElement.

Parameters

in_behavior

The inset behavior for this GlyphLinePatternElement.

SetMirror()

void HPS::GlyphLinePatternElement::SetMirror

(

bool

in_state

)

Sets whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.

Parameters

in_state

Whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.

SetRotation()

void HPS::GlyphLinePatternElement::SetRotation

(

float

in_degrees

)

Sets the angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.

Parameters

in_degrees

The angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.

SetSize()

void HPS::LinePatternElement::SetSize ( float  in_size, LinePattern::SizeUnits  in_units  )

inherited

Sets the size of this LinePatternElement.

Parameters

in_size	The size of this LinePatternElement.
in_units	The units for the size of this LinePatternElement.

SetSource()

void HPS::GlyphLinePatternElement::SetSource

(

char const *

in_source

)

Sets the name of the source for this GlyphLinePatternElement.

Parameters

in_source

UTF8-encoded name of the source for this GlyphLinePatternElement.

SetWeight()

void HPS::GlyphLinePatternElement::SetWeight	(	float	in_weight,
		LinePattern::SizeUnits	in_units
	)

Sets the weight for this GlyphLinePatternElement.

Parameters

in_weight	The weight for this GlyphLinePatternElement.
in_units	The units of the weight for this GlyphLinePatternElement.

ShowFixed()

bool HPS::GlyphLinePatternElement::ShowFixed

(

bool &

out_state

)

const

Shows whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.

Parameters

out_state

Whether the angle of the GlyphLinePatternElement should be fixed relative to the line vector.

Returns

true if a fixed flag was set, false otherwise.

ShowInsetBehavior()

bool HPS::GlyphLinePatternElement::ShowInsetBehavior

(

LinePattern::InsetBehavior &

out_behavior

)

const

Shows the inset behavior for this GlyphLinePatternElement.

Parameters

out_behavior

The inset behavior for this GlyphLinePatternElement.

Returns

true if an inset behavior was set, false otherwise.

ShowMirror()

bool HPS::GlyphLinePatternElement::ShowMirror

(

bool &

out_state

)

const

Shows whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.

Parameters

out_state

Whether to flip this GlyphLinePatternElement about the x-axis prior to applying any rotation.

Returns

true if a mirror flag was set, false otherwise.

ShowRotation()

bool HPS::GlyphLinePatternElement::ShowRotation

(

float &

out_degrees

)

const

Shows the angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.

Parameters

out_degrees

The angle in degrees the GlyphLinePatternElement is rotated relative to the line vector.

Returns

true if an angle was set, false otherwise.

ShowSize()

bool HPS::LinePatternElement::ShowSize ( float &  out_size, LinePattern::SizeUnits &  out_units  ) const

inherited

Shows the size of this LinePatternElement.

Parameters

out_size	The size of this LinePatternElement.
out_units	The units for the size of this LinePatternElement.

Returns

true if a size was set, false otherwise.

ShowSource()

bool HPS::GlyphLinePatternElement::ShowSource

(

UTF8 &

out_source

)

const

Shows the name of the source for this GlyphLinePatternElement.

Parameters

out_source

UTF8-encoded name of the source for this GlyphLinePatternElement.

Returns

true if a source was set, false otherwise.

ShowWeight()

bool HPS::GlyphLinePatternElement::ShowWeight	(	float &	out_weight,
		LinePattern::SizeUnits &	out_units
	)		const

Shows the weight for this GlyphLinePatternElement.

Parameters

out_weight	The weight for this GlyphLinePatternElement.
out_units	The units for the weight for this GlyphLinePatternElement.

Returns

true if a weight was set, false otherwise.

Type()

virtual HPS::Type HPS::Object::Type ( ) const

virtualinherited

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 in HPS::UpdateOptionsControl, HPS::HighlightControl, HPS::SelectionOptionsControl, HPS::OffScreenWindowOptionsControl, HPS::ApplicationWindowOptionsControl, HPS::StandAloneWindowOptionsControl, HPS::AttributeLockControl, HPS::WindowInfoControl, HPS::DebuggingControl, HPS::SubwindowControl, HPS::ContourLineControl, HPS::VisualEffectsControl, HPS::TransformMaskControl, HPS::PostProcessEffectsControl, HPS::DrawingAttributeControl, HPS::HiddenLineAttributeControl, HPS::PerformanceControl, HPS::NURBSSurfaceAttributeControl, HPS::ConditionControl, HPS::StyleControl, HPS::PortfolioControl, HPS::MaterialMappingControl, HPS::TextureMatrixControl, HPS::ModellingMatrixControl, HPS::CurveAttributeControl, HPS::EdgeAttributeControl, HPS::LineAttributeControl, HPS::TextAttributeControl, HPS::CuttingSectionAttributeControl, HPS::CylinderAttributeControl, HPS::LightingAttributeControl, HPS::SphereAttributeControl, HPS::MarkerAttributeControl, HPS::CullingControl, HPS::ColorInterpolationControl, HPS::TransparencyControl, HPS::SelectabilityControl, HPS::CameraControl, HPS::VisibilityControl, HPS::BoundingControl, HPS::Kit, and HPS::Control.

Member Data Documentation

staticType

const HPS::Type HPS::GlyphLinePatternElement::staticType = HPS::Type::GlyphLinePatternElement

static

---

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

• hps.h