HPS::SolidLinePatternElement Class Reference

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

#include <hps.h>

Inheritance diagram for HPS::SolidLinePatternElement:

Collaboration diagram for HPS::SolidLinePatternElement:

Public Member Functions
	SolidLinePatternElement ()
	The default constructor creates an empty SolidLinePatternElement object. More...
	SolidLinePatternElement (LinePatternElement const &in_that)
	This constructor creates a SolidLinePatternElement object that contains the same settings as the source LinePatternElement. More...
	SolidLinePatternElement (SolidLinePatternElement const &in_that)
	The copy constructor creates a new SolidLinePatternElement object that contains the same settings as the source SolidLinePatternElement. More...
	SolidLinePatternElement (float in_size, LinePattern::SizeUnits in_units)
	This constructor creates a SolidLinePatternElement with a given size. More...
	SolidLinePatternElement (SolidLinePatternElement &&in_that)
	The move constructor creates a SolidLinePatternElement by transferring the underlying impl of the rvalue reference to this SolidLinePatternElement thereby avoiding a copy and allocation. More...
SolidLinePatternElement &	operator= (SolidLinePatternElement &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this SolidLinePatternElement thereby avoiding a copy. More...
	~SolidLinePatternElement ()
HPS::Type	ObjectType () const
void	SetColor (RGBAColor const &in_color)
	Sets the color for this SolidLinePatternElement. More...
void	SetMaterialByIndex (float in_material_index)
	Sets the color (by material index) for this SolidLinePatternElement. More...
bool	ShowColor (Material::Type &out_type, RGBAColor &out_color, float &out_index) const
	Shows the color for this SolidLinePatternElement. 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::SolidLinePatternElement

Detailed Description

The SolidLinePatternElement class is a user space object.

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

Constructor & Destructor Documentation

SolidLinePatternElement() [1/5]

HPS::SolidLinePatternElement::SolidLinePatternElement

(

)

The default constructor creates an empty SolidLinePatternElement object.

SolidLinePatternElement() [2/5]

HPS::SolidLinePatternElement::SolidLinePatternElement

(

LinePatternElement const &

in_that

)

This constructor creates a SolidLinePatternElement 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 solid line pattern element. Otherwise the copy will fail and the resulting SolidLinePatternElement will be invalid.

Parameters

in_that

The source LinePatternElement to copy.

SolidLinePatternElement() [3/5]

HPS::SolidLinePatternElement::SolidLinePatternElement

(

SolidLinePatternElement const &

in_that

)

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

Parameters

in_that

The source SolidLinePatternElement to copy.

SolidLinePatternElement() [4/5]

HPS::SolidLinePatternElement::SolidLinePatternElement	(	float	in_size,
		LinePattern::SizeUnits	in_units
	)

This constructor creates a SolidLinePatternElement with a given size.

Parameters

in_size	The length of the SolidLinePatternElement.
in_units	The units for the length of the SolidLinePatternElement.

SolidLinePatternElement() [5/5]

HPS::SolidLinePatternElement::SolidLinePatternElement

(

SolidLinePatternElement &&

in_that

)

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

Parameters

in_that

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

~SolidLinePatternElement()

HPS::SolidLinePatternElement::~SolidLinePatternElement

(

)

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::SolidLinePatternElement::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=()

SolidLinePatternElement& HPS::SolidLinePatternElement::operator=

(

SolidLinePatternElement &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this SolidLinePatternElement.

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.

SetColor()

void HPS::SolidLinePatternElement::SetColor

(

RGBAColor const &

in_color

)

Sets the color for this SolidLinePatternElement.

If this is not set, this SolidLinePatternElement will take the effective line (or edge) color in the segment where the line (or edge) pattern is used.

Parameters

in_color

The color for this SolidLinePatternElement.

SetMaterialByIndex()

void HPS::SolidLinePatternElement::SetMaterialByIndex

(

float

in_material_index

)

Sets the color (by material index) for this SolidLinePatternElement.

If this is not set, this SolidLinePatternElement will take the effective line (or edge) color in the segment where the line (or edge) pattern is used.

Parameters

in_color

The color for this SolidLinePatternElement.

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.

ShowColor()

bool HPS::SolidLinePatternElement::ShowColor	(	Material::Type &	out_type,
		RGBAColor &	out_color,
		float &	out_index
	)		const

Shows the color for this SolidLinePatternElement.

Parameters

out_type	Indicates which of the following arguments is valid.
out_color	The color of this SolidLinePatternElement. This is only valid if out_type is Material::Type::RGBAColor.
out_index	The material index for this SolidLinePatternElement. This is only valid if out_type is Material::Type::MaterialIndex.

Returns

true if a color 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.

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

static

---

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

• hps.h