HPS::LeaderLineClippingElement Class Reference

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

#include <hps.h>

Inheritance diagram for HPS::LeaderLineClippingElement:

Collaboration diagram for HPS::LeaderLineClippingElement:

Public Member Functions
	LeaderLineClippingElement ()
	The default constructor creates an empty LeaderLineClippingElement object. More...
	LeaderLineClippingElement (ShapeElement const &in_that)
	This constructor creates a LeaderLineClippingElement object that contains the same settings as the source ShapeElement. More...
	LeaderLineClippingElement (LeaderLineClippingElement const &in_that)
	The copy constructor creates a new LeaderLineClippingElement object that contains the same settings as the source LeaderLineClippingElement. More...
	LeaderLineClippingElement (LeaderLineClippingElement &&in_that)
	The move constructor creates a LeaderLineClippingElement by transferring the underlying impl of the rvalue reference to this LeaderLineClippingElement thereby avoiding a copy and allocation. More...
LeaderLineClippingElement &	operator= (LeaderLineClippingElement &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this LeaderLineClippingElement thereby avoiding a copy. More...
	~LeaderLineClippingElement ()
HPS::Type	ObjectType () const
bool	ShowClipShapeType (HPS::Type &out_type)
bool	ShowShape (PolygonShapeElement &out_shape) const
	Shows the explicit Polygon clip shape for this LeaderLineClippingElement. More...
bool	ShowShape (EllipseShapeElement &out_shape) const
	Shows the explicit Ellipse clip shape for this LeaderLineClippingElement. More...
bool	ShowShape (EllipticalArcShapeElement &out_shape) const
	Shows the explicit EllipticalArc clip shape for this LeaderLineClippingElement. More...
bool	ShowShape (CircleShapeElement &out_shape) const
	Shows the explicit Circle clip shape for this LeaderLineClippingElement. More...
bool	ShowShape (CircularArcShapeElement &out_shape) const
	Shows the explicit Ciruclar Arc clip shape for this LeaderLineClippingElement. More...
LeaderLineClippingElement &	SetShape (const PolygonShapeElement &in_shape)
	Sets the explicit Polygon clip shape for this LeaderLineClippingElement. More...
LeaderLineClippingElement &	SetShape (const EllipseShapeElement &in_shape)
	Sets the explicit Ellipse clip shape for this LeaderLineClippingElement. More...
LeaderLineClippingElement &	SetShape (const EllipticalArcShapeElement &in_shape)
	Sets the explicit Elliptical Arcclip shape for this LeaderLineClippingElement. More...
LeaderLineClippingElement &	SetShape (const CircleShapeElement &in_shape)
	Sets the explicit Circle clip shape for this LeaderLineClippingElement. More...
LeaderLineClippingElement &	SetShape (const CircularArcShapeElement &in_shape)
	Sets the explicit Circular Arc clip shape for this LeaderLineClippingElement. More...
LeaderLineClippingElement &	UnSetShape ()
	Unsets the explicit clip shape and returns to the default functionality of clipping around the background shape. More...
void	Set (ShapeElement const &in_that)
	Copies the source ShapeElement into this ShapeElement. More...
bool	Equals (ShapeElement const &in_that) const
	Check if the source ShapeElement is equivalent to this ShapeElement. More...
bool	operator== (ShapeElement const &in_that) const
	Check if the source ShapeElement is equivalent to this ShapeElement. More...
bool	operator!= (ShapeElement const &in_that) const
	Check if the source ShapeElement is not equivalent to this ShapeElement. More...
ShapeElement &	SetDisjointed (bool in_state)
	Sets the disjointed state for this ShapeElement. More...
bool	ShowDisjointed (bool &out_state) const
	Shows the disjointed state for this ShapeElement. More...
ShapeElement &	SetFill (bool in_state)
	Sets the fill mode for this ShapeElement. More...
bool	ShowFill (bool &out_state) const
	Shows the fill mode for this ShapeElement. 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::LeaderLineClippingElement

Detailed Description

The LeaderLineClippingElement class is a user space object.

It is used to define clipping of leader lines around a text background If LeaderLineClippingElement does not have another ShapeElement set for the clip region, it will use the background shape. If LeaderLineClippingElement has another ShapeElement set for the clip region, it will use that instead

Constructor & Destructor Documentation

LeaderLineClippingElement() [1/4]

HPS::LeaderLineClippingElement::LeaderLineClippingElement

(

)

The default constructor creates an empty LeaderLineClippingElement object.

LeaderLineClippingElement() [2/4]

HPS::LeaderLineClippingElement::LeaderLineClippingElement

(

ShapeElement const &

in_that

)

This constructor creates a LeaderLineClippingElement object that contains the same settings as the source ShapeElement.

The copy will only be successful if the source shape element is really an upcast of a line clipping shape element. Otherwise the copy will fail and the resulting LeaderLineClippingElement will be invalid.

Parameters

in_that

The source ShapeElement to copy.

LeaderLineClippingElement() [3/4]

HPS::LeaderLineClippingElement::LeaderLineClippingElement

(

LeaderLineClippingElement const &

in_that

)

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

Parameters

in_that

The source LeaderLineClippingElement to copy.

LeaderLineClippingElement() [4/4]

HPS::LeaderLineClippingElement::LeaderLineClippingElement

(

LeaderLineClippingElement &&

in_that

)

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

Parameters

in_that

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

~LeaderLineClippingElement()

HPS::LeaderLineClippingElement::~LeaderLineClippingElement

(

)

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

inherited

Check if the source ShapeElement is equivalent to this ShapeElement.

Parameters

in_that

The source ShapeElement to compare to this ShapeElement.

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

inlinevirtual

Reimplemented from HPS::ShapeElement.

operator!=()

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

inherited

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

Parameters

in_that

The source ShapeElement to compare to this ShapeElement.

Returns

true if the objects are not equivalent, false otherwise.

operator=()

LeaderLineClippingElement& HPS::LeaderLineClippingElement::operator=

(

LeaderLineClippingElement &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this LeaderLineClippingElement.

operator==()

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

inherited

Check if the source ShapeElement is equivalent to this ShapeElement.

Parameters

in_that

The source ShapeElement to compare to this ShapeElement.

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

inherited

Copies the source ShapeElement into this ShapeElement.

Parameters

in_that

The source ShapeElement to copy.

SetDisjointed()

ShapeElement& HPS::ShapeElement::SetDisjointed ( bool  in_state )

inherited

Sets the disjointed state for this ShapeElement.

Two shape elements of the same type are automatically joined together if they appear consecutively in the shape element array. LineShapeElement objects are always disjointed.

Parameters

in_state

The disjointed state for this ShapeElement.

SetFill()

ShapeElement& HPS::ShapeElement::SetFill ( bool  in_state )

inherited

Sets the fill mode for this ShapeElement.

All shape elements default to being filled, except for Lines which cannot be filled.

Parameters

in_state

The fill mode for this ShapeElement.

SetShape() [1/5]

LeaderLineClippingElement& HPS::LeaderLineClippingElement::SetShape

(

const PolygonShapeElement &

in_shape

)

Sets the explicit Polygon clip shape for this LeaderLineClippingElement.

if no explicit shape is set, the background shape will be used

Parameters

in_shape

The shape to clip leader lines with.

SetShape() [2/5]

LeaderLineClippingElement& HPS::LeaderLineClippingElement::SetShape

(

const EllipseShapeElement &

in_shape

)

Sets the explicit Ellipse clip shape for this LeaderLineClippingElement.

if no explicit shape is set, the background shape will be used

Parameters

in_shape

The shape to clip leader lines with.

SetShape() [3/5]

LeaderLineClippingElement& HPS::LeaderLineClippingElement::SetShape

(

const EllipticalArcShapeElement &

in_shape

)

Sets the explicit Elliptical Arcclip shape for this LeaderLineClippingElement.

if no explicit shape is set, the background shape will be used

Parameters

in_shape

The shape to clip leader lines with.

SetShape() [4/5]

LeaderLineClippingElement& HPS::LeaderLineClippingElement::SetShape

(

const CircleShapeElement &

in_shape

)

Sets the explicit Circle clip shape for this LeaderLineClippingElement.

if no explicit shape is set, the background shape will be used

Parameters

in_shape

The shape to clip leader lines with.

SetShape() [5/5]

LeaderLineClippingElement& HPS::LeaderLineClippingElement::SetShape

(

const CircularArcShapeElement &

in_shape

)

Sets the explicit Circular Arc clip shape for this LeaderLineClippingElement.

if no explicit shape is set, the background shape will be used

Parameters

in_shape

The shape to clip leader lines with.

ShowClipShapeType()

bool HPS::LeaderLineClippingElement::ShowClipShapeType

(

HPS::Type &

out_type

)

ShowDisjointed()

bool HPS::ShapeElement::ShowDisjointed ( bool &  out_state ) const

inherited

Shows the disjointed state for this ShapeElement.

Two shape elements of the same type are automatically joined together if they appear consecutively in the shape element array. LineShapeElement objects are always disjointed.

Parameters

out_state

Whether this shape element will be disjointed from the previous one.

Returns

true if a disjointed state was set, false otherwise.

ShowFill()

bool HPS::ShapeElement::ShowFill ( bool &  out_state ) const

inherited

Shows the fill mode for this ShapeElement.

All shape elements default to being filled, except for Lines which cannot be filled.

Parameters

out_state

Whether faces are drawn for this shape element.

Returns

true if a fill mode was set, false otherwise.

ShowShape() [1/5]

bool HPS::LeaderLineClippingElement::ShowShape

(

PolygonShapeElement &

out_shape

)

const

Shows the explicit Polygon clip shape for this LeaderLineClippingElement.

If the wrong type is provided, will return false

Parameters

out_shape

The explicit clip shape.

Returns

true if out_shape was set, false otherwise.

ShowShape() [2/5]

bool HPS::LeaderLineClippingElement::ShowShape

(

EllipseShapeElement &

out_shape

)

const

Shows the explicit Ellipse clip shape for this LeaderLineClippingElement.

If the wrong type is provided, will return false

Parameters

out_shape

The explicit clip shape.

Returns

true if out_shape was set, false otherwise.

ShowShape() [3/5]

bool HPS::LeaderLineClippingElement::ShowShape

(

EllipticalArcShapeElement &

out_shape

)

const

Shows the explicit EllipticalArc clip shape for this LeaderLineClippingElement.

If the wrong type is provided, will return false

Parameters

out_shape

The explicit clip shape.

Returns

true if out_shape was set, false otherwise.

ShowShape() [4/5]

bool HPS::LeaderLineClippingElement::ShowShape

(

CircleShapeElement &

out_shape

)

const

Shows the explicit Circle clip shape for this LeaderLineClippingElement.

If the wrong type is provided, will return false

Parameters

out_shape

The explicit clip shape.

Returns

true if out_shape was set, false otherwise.

ShowShape() [5/5]

bool HPS::LeaderLineClippingElement::ShowShape

(

CircularArcShapeElement &

out_shape

)

const

Shows the explicit Ciruclar Arc clip shape for this LeaderLineClippingElement.

If the wrong type is provided, will return false

Parameters

out_shape

The explicit clip shape.

Returns

true if out_shape 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.

UnSetShape()

LeaderLineClippingElement& HPS::LeaderLineClippingElement::UnSetShape

(

)

Unsets the explicit clip shape and returns to the default functionality of clipping around the background shape.

Member Data Documentation

staticType

const HPS::Type HPS::LeaderLineClippingElement::staticType = HPS::Type::LeaderLineClippingElement

static

---

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

• hps.h