HPS::EllipseGlyphElement Class Reference

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

#include <hps.h>

Inheritance diagram for HPS::EllipseGlyphElement:

Collaboration diagram for HPS::EllipseGlyphElement:

Public Member Functions
	EllipseGlyphElement ()
	The default constructor creates an empty EllipseGlyphElement object. More...
	EllipseGlyphElement (GlyphElement const &in_that)
	This constructor creates a EllipseGlyphElement object that contains the same settings as the source GlyphElement. More...
	EllipseGlyphElement (EllipseGlyphElement const &in_that)
	The copy constructor creates a new EllipseGlyphElement object that contains the same settings as the source EllipseGlyphElement. More...
	EllipseGlyphElement (GlyphPoint const &in_lower_left, GlyphPoint const &in_upper_right)
	This constructor creates a EllipseGlyphElement with the lower left and upper right points for the bounding box which circumscribes the ellipse. More...
	EllipseGlyphElement (EllipseGlyphElement &&in_that)
	The move constructor creates an EllipseGlyphElement by transferring the underlying impl of the rvalue reference to this EllipseGlyphElement thereby avoiding a copy and allocation. More...
EllipseGlyphElement &	operator= (EllipseGlyphElement &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this EllipseGlyphElement thereby avoiding a copy. More...
	~EllipseGlyphElement ()
HPS::Type	ObjectType () const
void	SetLowerLeft (GlyphPoint const &in_point)
	Sets the lower left point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement. More...
void	SetUpperRight (GlyphPoint const &in_point)
	Sets the upper right point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement. More...
void	SetPoints (GlyphPoint const &in_lower_left, GlyphPoint const &in_upper_right)
	Sets the lower left and upper right points for the bounding box which circumscribes the ellipse for this EllipseGlyphElement. More...
bool	ShowLowerLeft (GlyphPoint &out_point) const
	Shows the lower left point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement. More...
bool	ShowUpperRight (GlyphPoint &out_point) const
	Shows the upper right point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement. More...
void	Set (GlyphElement const &in_that)
	Copies the source GlyphElement into this GlyphElement. More...
bool	Equals (GlyphElement const &in_that) const
	Check if the source GlyphElement is equivalent to this GlyphElement. More...
bool	operator== (GlyphElement const &in_that) const
	Check if the source GlyphElement is equivalent to this GlyphElement. More...
bool	operator!= (GlyphElement const &in_that) const
	Check if the source GlyphElement is not equivalent to this GlyphElement. More...
void	SetFill (Glyph::Fill in_fill)
	Sets the fill mode for this GlyphElement. More...
void	SetIndexedColor (byte in_index)
	Sets the color index for this GlyphElement. More...
void	SetNormalColor ()
	Sets that this GlyphElement should inherit the color of the owning geometry which uses the glyph. More...
void	SetExplicitColor (RGBAColor const &in_color)
	Sets the RGBA color for this GlyphElement. More...
bool	ShowFill (Glyph::Fill &out_fill) const
	Shows the fill mode for this GlyphElement. More...
bool	ShowColor (Glyph::ColorSource &out_source, byte &out_index, RGBAColor &out_color) const
	Shows the color for this GlyphElement. 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::EllipseGlyphElement

Detailed Description

The EllipseGlyphElement class is a user space object.

It is used to add ellipse elements to glyphs.

Constructor & Destructor Documentation

EllipseGlyphElement() [1/5]

HPS::EllipseGlyphElement::EllipseGlyphElement

(

)

The default constructor creates an empty EllipseGlyphElement object.

EllipseGlyphElement() [2/5]

HPS::EllipseGlyphElement::EllipseGlyphElement

(

GlyphElement const &

in_that

)

This constructor creates a EllipseGlyphElement object that contains the same settings as the source GlyphElement.

The copy will only be successful if the source glyph element is really an upcast of an ellipse glyph element. Otherwise the copy will fail and the resulting EllipseGlyphElement will be invalid.

Parameters

in_that

The source GlyphElement to copy.

EllipseGlyphElement() [3/5]

HPS::EllipseGlyphElement::EllipseGlyphElement

(

EllipseGlyphElement const &

in_that

)

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

Parameters

in_that

The source EllipseGlyphElement to copy.

EllipseGlyphElement() [4/5]

HPS::EllipseGlyphElement::EllipseGlyphElement	(	GlyphPoint const &	in_lower_left,
		GlyphPoint const &	in_upper_right
	)

This constructor creates a EllipseGlyphElement with the lower left and upper right points for the bounding box which circumscribes the ellipse.

Parameters

in_lower_left	The lower left point for the bounding box which circumscribes the ellipse.
in_upper_right	The upper right point for the bounding box which circumscribes the ellipse.

EllipseGlyphElement() [5/5]

HPS::EllipseGlyphElement::EllipseGlyphElement

(

EllipseGlyphElement &&

in_that

)

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

Parameters

in_that

An rvalue reference to an EllipseGlyphElement to take the impl from.

~EllipseGlyphElement()

HPS::EllipseGlyphElement::~EllipseGlyphElement

(

)

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::GlyphElement::Equals ( GlyphElement const &  in_that ) const

inherited

Check if the source GlyphElement is equivalent to this GlyphElement.

Parameters

in_that

The source GlyphElement to compare to this GlyphElement.

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

inlinevirtual

Reimplemented from HPS::GlyphElement.

operator!=()

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

inherited

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

Parameters

in_that

The source GlyphElement to compare to this GlyphElement.

Returns

true if the objects are not equivalent, false otherwise.

operator=()

EllipseGlyphElement& HPS::EllipseGlyphElement::operator=

(

EllipseGlyphElement &&

in_that

)

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

Parameters

in_that

An rvalue reference to an EllipseGlyphElement to take the impl from.

Returns

A reference to this EllipseGlyphElement.

operator==()

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

inherited

Check if the source GlyphElement is equivalent to this GlyphElement.

Parameters

in_that

The source GlyphElement to compare to this GlyphElement.

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

inherited

Copies the source GlyphElement into this GlyphElement.

Parameters

in_that

The source GlyphElement to copy.

SetExplicitColor()

void HPS::GlyphElement::SetExplicitColor ( RGBAColor const &  in_color )

inherited

Sets the RGBA color for this GlyphElement.

Parameters

in_color

The color for this GlyphElement.

SetFill()

void HPS::GlyphElement::SetFill ( Glyph::Fill  in_fill )

inherited

Sets the fill mode for this GlyphElement.

Parameters

in_fill

The fill mode for this GlyphElement.

SetIndexedColor()

void HPS::GlyphElement::SetIndexedColor ( byte  in_index )

inherited

Sets the color index for this GlyphElement.

Parameters

in_index

The color index for this GlyphElement.

SetLowerLeft()

void HPS::EllipseGlyphElement::SetLowerLeft

(

GlyphPoint const &

in_point

)

Sets the lower left point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters

in_point

The lower left point for the bounding box which circumscribes the ellipse.

SetNormalColor()

void HPS::GlyphElement::SetNormalColor ( )

inherited

Sets that this GlyphElement should inherit the color of the owning geometry which uses the glyph.

SetPoints()

void HPS::EllipseGlyphElement::SetPoints	(	GlyphPoint const &	in_lower_left,
		GlyphPoint const &	in_upper_right
	)

Sets the lower left and upper right points for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters

in_lower_left	The lower left point for the bounding box which circumscribes the ellipse.
in_upper_right	The upper right point for the bounding box which circumscribes the ellipse.

SetUpperRight()

void HPS::EllipseGlyphElement::SetUpperRight

(

GlyphPoint const &

in_point

)

Sets the upper right point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters

in_point

The upper right point for the bounding box which circumscribes the ellipse.

ShowColor()

bool HPS::GlyphElement::ShowColor ( Glyph::ColorSource &  out_source, byte &  out_index, RGBAColor &  out_color  ) const

inherited

Shows the color for this GlyphElement.

Parameters

out_source	The color source for this GlyphElement.
out_index	The color index for this GlyphElement. This is only valid if out_source is Glyph::ColorSource::Indexed.
out_color	The color for this GlyphElement. This is only valid if out_source is Glyph::ColorSource::Explicit.

Returns

true if a color was set, false otherwise.

ShowFill()

bool HPS::GlyphElement::ShowFill ( Glyph::Fill &  out_fill ) const

inherited

Shows the fill mode for this GlyphElement.

Parameters

out_fill

The fill mode for this GlyphElement.

Returns

true if a fill mode was set, false otherwise.

ShowLowerLeft()

bool HPS::EllipseGlyphElement::ShowLowerLeft

(

GlyphPoint &

out_point

)

const

Shows the lower left point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters

out_point

The lower left point for the bounding box which circumscribes the ellipse.

Returns

true if a lower left point was set, false otherwise.

ShowUpperRight()

bool HPS::EllipseGlyphElement::ShowUpperRight

(

GlyphPoint &

out_point

)

const

Shows the upper right point for the bounding box which circumscribes the ellipse for this EllipseGlyphElement.

Parameters

out_point

The upper right point for the bounding box which circumscribes the ellipse.

Returns

true if an upper right point 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::EllipseGlyphElement::staticType = HPS::Type::EllipseGlyphElement

static

---

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

• hps.h