HPS::SelectionItem Class Reference

The SelectionItem class is a smart-pointer to a database object. More...

#include <hps.h>

Inheritance diagram for HPS::SelectionItem:

Collaboration diagram for HPS::SelectionItem:

Public Member Functions
	SelectionItem ()
	The default constructor creates an uninitialized SelectionItem object. More...
	SelectionItem (SelectionItem const &in_that)
	The copy constructor creates a SelectionItem object that shares the underlying smart-pointer of the source SelectionItem. More...
	SelectionItem (SelectionItem &&in_that)
	The move constructor creates a SelectionItem by transferring the underlying impl of the rvalue reference to this SelectionItem thereby avoiding a copy and allocation. More...
SelectionItem &	operator= (SelectionItem &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this SelectionItem thereby avoiding a copy. More...
virtual	~SelectionItem ()
HPS::Type	ObjectType () const
void	Set (SelectionItem const &in_that)
	Associate this SelectionItem with the same underlying impl as the source SelectionItem. More...
SelectionItem &	operator= (SelectionItem const &in_that)
	Associate this SelectionItem with the same underlying impl as the source SelectionItem. More...
bool	Equals (SelectionItem const &in_that) const
	Check if the source SelectionItem is equivalent to this SelectionItem. More...
bool	operator== (SelectionItem const &in_that) const
	Check if the source SelectionItem is equivalent to this SelectionItem. More...
bool	operator!= (SelectionItem const &in_that) const
	Check if the source SelectionItem is not equivalent to this SelectionItem. More...
bool	ShowSelectionLevel (Selection::Level &out_level) const
	Shows the selection level used when this item was selected. More...
bool	ShowSelectedItem (Key &out_selection) const
	Shows the key for the item that was selected. More...
bool	ShowPath (KeyPath &out_path) const
	Shows the key path for the item that was selected. More...
bool	ShowFaces (SizeTArray &out_faces) const
	Shows the indices to the faces within a shell or mesh for the item that was selected if using subentity selection. More...
bool	ShowVertices (SizeTArray &out_vertices) const
	Shows the indices to the vertices within a shell, mesh, line, polygon, or NURBS curve for the item that was selected if using subentity selection. More...
bool	ShowEdges (SizeTArray &out_vertices1, SizeTArray &out_vertices2) const
	Shows the indices to the edges (i.e., indices to the vertices at each end of an edge) within a shell, mesh, or polygon for the item that was selected if using subentity selection. More...
bool	ShowCharacters (SizeTArray &out_characters) const
	Shows the indices to the characters within a text string for the item that was selected if using subentity selection. More...
bool	ShowSelectionPosition (WindowPoint &out_location) const
	Shows the selection position in window space for the item that was selected. More...
bool	ShowSelectionPosition (WorldPoint &out_location) const
	Shows the selection position in world space for the item that was selected. More...
bool	ShowNormalizedSelectionPosition (WindowPoint &out_location) const
	Shows the Z-normalized selection position in window space for the item that was selected. 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::SelectionItem

Detailed Description

The SelectionItem class is a smart-pointer to a database object.

It represents an item in a SelectionResults object.

Constructor & Destructor Documentation

SelectionItem() [1/3]

HPS::SelectionItem::SelectionItem

(

)

The default constructor creates an uninitialized SelectionItem object.

The Type() function will return Type::None.

SelectionItem() [2/3]

HPS::SelectionItem::SelectionItem

(

SelectionItem const &

in_that

)

The copy constructor creates a SelectionItem object that shares the underlying smart-pointer of the source SelectionItem.

Parameters

in_that

The source SelectionItem to copy.

SelectionItem() [3/3]

HPS::SelectionItem::SelectionItem

(

SelectionItem &&

in_that

)

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

Parameters

in_that

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

~SelectionItem()

virtual HPS::SelectionItem::~SelectionItem ( )

virtual

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

(

SelectionItem const &

in_that

)

const

Check if the source SelectionItem is equivalent to this SelectionItem.

Parameters

in_kit

The source SelectionItem to compare to this SelectionItem.

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

inlinevirtual

Reimplemented from HPS::Object.

Here is the call graph for this function:

operator!=()

bool HPS::SelectionItem::operator!=

(

SelectionItem const &

in_that

)

const

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

Parameters

in_kit

The source SelectionItem to compare to this SelectionItem.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

SelectionItem& HPS::SelectionItem::operator=

(

SelectionItem &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this SelectionItem.

operator=() [2/2]

SelectionItem& HPS::SelectionItem::operator=

(

SelectionItem const &

in_that

)

Associate this SelectionItem with the same underlying impl as the source SelectionItem.

Parameters

in_that

The source SelectionItem for the assignment.

Returns

A reference to this SelectionItem.

operator==()

bool HPS::SelectionItem::operator==

(

SelectionItem const &

in_that

)

const

Check if the source SelectionItem is equivalent to this SelectionItem.

Parameters

in_kit

The source SelectionItem to compare to this SelectionItem.

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::SelectionItem::Set

(

SelectionItem const &

in_that

)

Associate this SelectionItem with the same underlying impl as the source SelectionItem.

Parameters

in_that

The source SelectionItem for the assignment.

ShowCharacters()

bool HPS::SelectionItem::ShowCharacters

(

SizeTArray &

out_characters

)

const

Shows the indices to the characters within a text string for the item that was selected if using subentity selection.

Parameters

out_characters

The indices to the characters within a text string for the item that was selected.

Returns

true if the indices array is valid, false otherwise.

ShowEdges()

bool HPS::SelectionItem::ShowEdges	(	SizeTArray &	out_vertices1,
		SizeTArray &	out_vertices2
	)		const

Shows the indices to the edges (i.e., indices to the vertices at each end of an edge) within a shell, mesh, or polygon for the item that was selected if using subentity selection.

Parameters

out_faces

The indices to the edges within a shell, mesh, or polygon for the item that was selected.

Returns

true if the indices array is valid, false otherwise.

ShowFaces()

bool HPS::SelectionItem::ShowFaces

(

SizeTArray &

out_faces

)

const

Shows the indices to the faces within a shell or mesh for the item that was selected if using subentity selection.

Parameters

out_faces

The indices to the faces within a shell or mesh for the item that was selected.

Returns

true if the indices array is valid, false otherwise.

ShowNormalizedSelectionPosition()

bool HPS::SelectionItem::ShowNormalizedSelectionPosition

(

WindowPoint &

out_location

)

const

Shows the Z-normalized selection position in window space for the item that was selected.

Parameters

out_location

The selection position in window space with a normalized Z-coordinate for the item that was selected.

Returns

true if the window space position is valid, false otherwise.

ShowPath()

bool HPS::SelectionItem::ShowPath

(

KeyPath &

out_path

)

const

Shows the key path for the item that was selected.

Parameters

out_path

The key path for the item that was selected.

Returns

true if the key path is valid, false otherwise.

ShowSelectedItem()

bool HPS::SelectionItem::ShowSelectedItem

(

Key &

out_selection

)

const

Shows the key for the item that was selected.

Parameters

out_selection

The key for the item that was selected.

Returns

true if the key is valid, false otherwise.

ShowSelectionLevel()

bool HPS::SelectionItem::ShowSelectionLevel

(

Selection::Level &

out_level

)

const

Shows the selection level used when this item was selected.

Parameters

out_level

The selection level used when this item was selected.

Returns

true if the selection level is valid, false otherwise.

ShowSelectionPosition() [1/2]

bool HPS::SelectionItem::ShowSelectionPosition

(

WindowPoint &

out_location

)

const

Shows the selection position in window space for the item that was selected.

Parameters

out_location

The selection position in window space for the item that was selected.

Returns

true if the window space position is valid, false otherwise.

ShowSelectionPosition() [2/2]

bool HPS::SelectionItem::ShowSelectionPosition

(

WorldPoint &

out_location

)

const

Shows the selection position in world space for the item that was selected.

Parameters

out_location

The selection position in world space for the item that was selected.

Returns

true if the world space position is valid, false otherwise.

ShowVertices()

bool HPS::SelectionItem::ShowVertices

(

SizeTArray &

out_vertices

)

const

Shows the indices to the vertices within a shell, mesh, line, polygon, or NURBS curve for the item that was selected if using subentity selection.

Parameters

out_faces

The indices to the vertices within a shell, mesh, line, polygon, or NURBS curve for the item that was selected.

Returns

true if the indices array is valid, 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::SelectionItem::staticType = HPS::Type::SelectionItem

static

---

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

• hps.h