HPS::HighlightState Class Reference

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

#include <hps.h>

Inheritance diagram for HPS::HighlightState:

Collaboration diagram for HPS::HighlightState:

Public Member Functions
	HighlightState ()
	The default constructor creates an empty HighlightState object. More...
	HighlightState (HighlightState const &in_that)
	The copy constructor creates a new HighlightState object that contains the same settings as the source HighlightState. More...
	HighlightState (HighlightState &&in_that)
	The move constructor creates a HighlightState by transferring the underlying impl of the rvalue reference to this HighlightState thereby avoiding a copy and allocation. More...
HighlightState &	operator= (HighlightState &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this HighlightState thereby avoiding a copy. More...
	~HighlightState ()
HPS::Type	ObjectType () const
void	Assign (HighlightState const &in_that)
	Copies the source HighlightState into this HighlightState. More...
HighlightState &	operator= (HighlightState const &in_that)
	Copies the source HighlightState into this HighlightState. More...
bool	Equals (HighlightState const &in_that) const
	Check if the source HighlightState is equivalent to this HighlightState. More...
bool	operator== (HighlightState const &in_that) const
	Check if the source HighlightState is equivalent to this HighlightState. More...
bool	operator!= (HighlightState const &in_that) const
	Check if the source HighlightState is not equivalent to this HighlightState. More...
void	Set (bool in_directly_highlighted, bool in_subentity_highlighted, bool in_inherits_highlight, bool in_on_highlight_path)
	Sets the flags for this HighlightState. More...
bool	GetDirectlyHighlighted () const
	Indicates if a highlight exists on the queried key or key path. More...
bool	GetSubentityHighlighted () const
	Indicates if a sub-entity highlight exists on the queried key or key path. More...
bool	GetInheritsHighlight () const
	Indicates if a highlight exists above the queried key or key path. More...
bool	GetOnHighlightPath () const
	Indicates if a highlight exists below the queried key or key path. 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::HighlightState

Detailed Description

The HighlightState class is a user space object.

It is used to return highlight information from HighlightControl::ShowHighlightState or HighlightControl::ShowHighlightStates.

Constructor & Destructor Documentation

HighlightState() [1/3]

HPS::HighlightState::HighlightState

(

)

The default constructor creates an empty HighlightState object.

HighlightState() [2/3]

HPS::HighlightState::HighlightState

(

HighlightState const &

in_that

)

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

Parameters

in_that

The source HighlightState to copy.

HighlightState() [3/3]

HPS::HighlightState::HighlightState

(

HighlightState &&

in_that

)

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

Parameters

in_that

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

~HighlightState()

HPS::HighlightState::~HighlightState

(

)

Member Function Documentation

Assign()

void HPS::HighlightState::Assign

(

HighlightState const &

in_that

)

Copies the source HighlightState into this HighlightState.

Parameters

in_that

The source HighlightState to copy.

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::HighlightState::Equals

(

HighlightState const &

in_that

)

const

Check if the source HighlightState is equivalent to this HighlightState.

Parameters

in_kit

The source HighlightState to compare to this HighlightState.

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.

GetDirectlyHighlighted()

bool HPS::HighlightState::GetDirectlyHighlighted

(

)

const

Indicates if a highlight exists on the queried key or key path.

Returns

Whether a highlight exists on the queried key or key path.

GetInheritsHighlight()

bool HPS::HighlightState::GetInheritsHighlight

(

)

const

Indicates if a highlight exists above the queried key or key path.

Returns

Whether a highlight exists above the queried key or key path.

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.

GetOnHighlightPath()

bool HPS::HighlightState::GetOnHighlightPath

(

)

const

Indicates if a highlight exists below the queried key or key path.

Returns

Whether a highlight exists below the queried key or key path.

GetSubentityHighlighted()

bool HPS::HighlightState::GetSubentityHighlighted

(

)

const

Indicates if a sub-entity highlight exists on the queried key or key path.

This value is only meaningful if the queried key or leaf of the key path is a shell or mesh since these are the only geometries for which it is possible to have subentity highlights.

Returns

Whether a subentity highlight exists on the queried key or key path.

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

inlinevirtual

Reimplemented from HPS::Object.

Here is the call graph for this function:

operator!=()

bool HPS::HighlightState::operator!=

(

HighlightState const &

in_that

)

const

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

Parameters

in_kit

The source HighlightState to compare to this HighlightState.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

HighlightState& HPS::HighlightState::operator=

(

HighlightState &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this HighlightState.

operator=() [2/2]

HighlightState& HPS::HighlightState::operator=

(

HighlightState const &

in_that

)

Copies the source HighlightState into this HighlightState.

Parameters

in_that

The source HighlightState to copy.

Returns

A reference to this HighlightState.

operator==()

bool HPS::HighlightState::operator==

(

HighlightState const &

in_that

)

const

Check if the source HighlightState is equivalent to this HighlightState.

Parameters

in_kit

The source HighlightState to compare to this HighlightState.

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::HighlightState::Set	(	bool	in_directly_highlighted,
		bool	in_subentity_highlighted,
		bool	in_inherits_highlight,
		bool	in_on_highlight_path
	)

Sets the flags for this HighlightState.

This facilitates the return of highlight state data to the user, and is not meant to be used outside of that use case.

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

static

---

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

• hps.h