HPS::SelectionResults Class Reference

The SelectionResults class is a smart pointer to a database object. More...

#include <hps.h>

Inheritance diagram for HPS::SelectionResults:

Collaboration diagram for HPS::SelectionResults:

Public Member Functions
	SelectionResults ()
	The default constructor creates an empty SelectionResults object which is not associated with any selection action. More...
	SelectionResults (SelectionResults const &in_that)
	The copy constructor creates a SelectionResults object that shares the underlying smart-pointer of the source SelectionResults. More...
	SelectionResults (SelectionResults &&in_that)
	The move constructor creates a SelectionResults by transferring the underlying impl of the rvalue reference to this SelectionResults thereby avoiding a copy and allocation. More...
SelectionResults &	operator= (SelectionResults &&in_that)
	The move assignment operator transfers the underlying impl of the rvalue reference to this SelectionResults thereby avoiding a copy. More...
	~SelectionResults ()
HPS::Type	ObjectType () const
void	Assign (SelectionResults const &in_that)
	Share the underlying smart-pointer of the SelectionResults source. More...
SelectionResults &	operator= (SelectionResults const &in_that)
	Share the underlying smart-pointer of the SelectionResults source. More...
bool	Equals (SelectionResults const &in_that) const
	Check if the source SelectionResults is equivalent to this SelectionResults. More...
bool	operator== (SelectionResults const &in_that) const
	Check if the source SelectionResults is equivalent to this SelectionResults. More...
bool	operator!= (SelectionResults const &in_that) const
	Check if the source SelectionResults is not equivalent to this SelectionResults. More...
virtual void	Reset ()
	Resets this object to its initial, uninitialized state. More...
Selection::Level	GetSelectionLevel () const
	Gets the selection level used when the associated selection action occurred. More...
size_t	GetCount () const
	Gets the number of items selected when the associated selection action occurred. More...
SelectionResultsIterator	GetIterator () const
	Get an iterator that can be used to iterate through the selection results. More...
bool	Union (SelectionResults const &in_that)
	Perform a set union of elements in this SelectionResults object with the elements of the supplied SelectionResults. More...
bool	Intersect (SelectionResults const &in_that)
	Perform a set intersection of elements in this SelectionResults object with the elements of the supplied SelectionResults. More...
bool	SymmetricDifference (SelectionResults const &in_that)
	Perform a symmetric difference (similar to XOR) of elements in this SelectionResults object with the elements of the supplied SelectionResults. More...
bool	Difference (SelectionResults const &in_that)
	Removes elements from this SelectionResults that also occur in the supplied SelectionResults. More...
void	Copy (SelectionResults const &in_that)
	Copy the selection results from another SelectionResults object. 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...
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::SelectionResults

Detailed Description

The SelectionResults class is a smart pointer to a database object.

It is a handle to the results of a selection action and allows iteration over them. When there are no remaining handles to a given selection result, the memory associated with it is freed.

Constructor & Destructor Documentation

SelectionResults() [1/3]

HPS::SelectionResults::SelectionResults

(

)

The default constructor creates an empty SelectionResults object which is not associated with any selection action.

SelectionResults() [2/3]

HPS::SelectionResults::SelectionResults

(

SelectionResults const &

in_that

)

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

Parameters

in_that

The source SelectionResults to copy.

SelectionResults() [3/3]

HPS::SelectionResults::SelectionResults

(

SelectionResults &&

in_that

)

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

Parameters

in_that

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

~SelectionResults()

HPS::SelectionResults::~SelectionResults

(

)

Member Function Documentation

Assign()

void HPS::SelectionResults::Assign

(

SelectionResults const &

in_that

)

Share the underlying smart-pointer of the SelectionResults source.

Parameters

in_that

The SelectionResults source of the assignment.

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.

Copy()

void HPS::SelectionResults::Copy

(

SelectionResults const &

in_that

)

Copy the selection results from another SelectionResults object.

Parameters

in_that

The SelectionResults source of the copy.

Difference()

bool HPS::SelectionResults::Difference

(

SelectionResults const &

in_that

)

Removes elements from this SelectionResults that also occur in the supplied SelectionResults.

This will fail if the SelectionResults selections were performed at different levels (e.g. Entity vs Segment).

Parameters

in_that

The SelectionResults to subtract from this object.

Returns

true if the operation succeeded, false otherwise.

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

(

SelectionResults const &

in_that

)

const

Check if the source SelectionResults is equivalent to this SelectionResults.

Parameters

in_that

The source SelectionResults to compare to this SelectionResults.

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.

GetCount()

size_t HPS::SelectionResults::GetCount

(

)

const

Gets the number of items selected when the associated selection action occurred.

Returns

Number of items selected when the associated selection action occurred.

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.

GetIterator()

SelectionResultsIterator HPS::SelectionResults::GetIterator

(

)

const

Get an iterator that can be used to iterate through the selection results.

Returns

An iterator that can be used to iterate through the selection results.

GetSelectionLevel()

Selection::Level HPS::SelectionResults::GetSelectionLevel

(

)

const

Gets the selection level used when the associated selection action occurred.

Returns

The selection level used when the associated selection action occurred.

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.

Intersect()

bool HPS::SelectionResults::Intersect

(

SelectionResults const &

in_that

)

Perform a set intersection of elements in this SelectionResults object with the elements of the supplied SelectionResults.

This will fail if the SelectionResults selections were performed at different levels (e.g. Entity vs Segment).

Parameters

in_that

The SelectionResults to intersect with this object.

Returns

true if the operation succeeded, false otherwise.

ObjectType()

HPS::Type HPS::SelectionResults::ObjectType ( ) const

inlinevirtual

Reimplemented from HPS::Object.

Here is the call graph for this function:

operator!=()

bool HPS::SelectionResults::operator!=

(

SelectionResults const &

in_that

)

const

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

Parameters

in_that

The source SelectionResults to compare to this SelectionResults.

Returns

true if the objects are not equivalent, false otherwise.

operator=() [1/2]

SelectionResults& HPS::SelectionResults::operator=

(

SelectionResults &&

in_that

)

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

Parameters

in_that

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

Returns

A reference to this SelectionResults.

operator=() [2/2]

SelectionResults& HPS::SelectionResults::operator=

(

SelectionResults const &

in_that

)

Share the underlying smart-pointer of the SelectionResults source.

Parameters

in_that

The SelectionResults source of the assignment.

Returns

A reference to this SelectionResults.

operator==()

bool HPS::SelectionResults::operator==

(

SelectionResults const &

in_that

)

const

Check if the source SelectionResults is equivalent to this SelectionResults.

Parameters

in_that

The source SelectionResults to compare to this SelectionResults.

Returns

true if the objects are equivalent, false otherwise.

Reset()

virtual void HPS::SelectionResults::Reset ( )

virtual

Resets this object to its initial, uninitialized state.

Reimplemented from HPS::Object.

SymmetricDifference()

bool HPS::SelectionResults::SymmetricDifference

(

SelectionResults const &

in_that

)

Perform a symmetric difference (similar to XOR) of elements in this SelectionResults object with the elements of the supplied SelectionResults.

This will fail if the SelectionResults selections were performed at different levels (e.g. Entity vs Segment). The resulting SelectionResults will be unsorted, even if the sources were sorted.

Parameters

in_that

The SelectionResults to take the symmetric difference of with this object.

Returns

true if the operation succeeded, 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.

Union()

bool HPS::SelectionResults::Union

(

SelectionResults const &

in_that

)

Perform a set union of elements in this SelectionResults object with the elements of the supplied SelectionResults.

This will fail if the SelectionResults selections were performed at different levels (e.g. Entity vs Segment). The resulting SelectionResults will be unsorted, even if the sources were sorted.

Parameters

in_that

The SelectionResults to union with this object.

Returns

true if the operation succeeded, false otherwise.

Member Data Documentation

staticType

const HPS::Type HPS::SelectionResults::staticType = HPS::Type::SelectionResults

static

---

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

• hps.h