Gui::SelectionSingleton Class Reference

The Selection class The selection singleton keeps track of the selection state of the whole application. More...

#include <Selection.h>

Inheritance diagram for Gui::SelectionSingleton:

Classes
struct	_SelObj
struct	SelObj
Public Member Functions
bool	addSelection (const char pDocName, const char pObjectName=0, const char *pSubName=0, float x=0, float y=0, float z=0)
	Add to selection.
void	addSelectionGate (Gui::SelectionGate *gate)
	add a SelectionGate to control what is selectable
void	clearCompleteSelection ()
	Clear the selection of all documents.
void	clearSelection (const char *pDocName=0)
	Clear the selection of document pDocName. If the document name is not given the selection of the active document is cleared.
unsigned int	countObjectsOfType (const char typeName, const char pDocName=0) const
	Does basically the same as the method above unless that it accepts a string literal as first argument.
unsigned int	countObjectsOfType (const Base::Type &typeId, const char *pDocName=0) const
	Returns the number of selected objects with a special object type It's the convenient way to check if the right objects are selected to perform an operation (GuiCommand).
std::vector< SelObj >	getCompleteSelection () const
	Returns a vector of all selection objects of all documents.
template<typename T >
std::vector< T * >	getObjectsOfType (const char *pDocName=0) const
	A convenience template-based method that returns an array with the correct types already.
std::vector < App::DocumentObject * >	getObjectsOfType (const char typeName, const char pDocName=0) const
	Does basically the same as the method above unless that it accepts a string literal as first argument.
std::vector < App::DocumentObject * >	getObjectsOfType (const Base::Type &typeId, const char *pDocName=0) const
	Returns a vector of objects of type TypeName selected for the given document name pDocName.
const SelectionChanges &	getPreselection (void) const
	returns the present preselection
std::vector< SelObj >	getSelection (const char *pDocName=0) const
	Returns a vector of selection objects If no document name is given the objects of the active are returned.
std::vector< Gui::SelectionObject >	getSelectionEx (const char *pDocName=0, Base::Type typeId=App::DocumentObject::getClassTypeId()) const
	Returns a vector of selection objects If no document name is given the objects of the active are returned.
bool	hasSelection (const char *doc) const
bool	hasSelection () const
bool	isSelected (App::DocumentObject , const char pSubName=0) const
	Check if selected.
bool	isSelected (const char pDocName, const char pObjectName=0, const char *pSubName=0) const
	Check if selected.
void	rmvPreselect ()
	remove the present preselection
void	rmvSelection (const char pDocName, const char pObjectName=0, const char *pSubName=0)
	Remove from selection (for internal use).
void	rmvSelectionGate (void)
	remove the active SelectionGate
bool	setPreselect (const char pDocName, const char pObjectName, const char *pSubName, float x=0, float y=0, float z=0)
	set the preselected object (mostly by the 3D view)
void	setPreselectCoord (float x, float y, float z)
	sets different coords for the preselection
void	setSelection (const char pDocName, const std::vector< App::DocumentObject > &)
	Set the selection for a document.
unsigned int	size (void) const
	Size of selcted entities for all documents.
Static Public Member Functions
static void	destruct (void)
static SelectionSingleton &	instance (void)
Public Attributes
boost::signal< void(const SelectionChanges &msg)>	signalSelectionChanged
	signal on new object
Static Public Attributes
static PyMethodDef	Methods []
Protected Member Functions
App::Document *	getDocument (const char *pDocName=0) const
	helper to retrieve document by name
	SelectionSingleton ()
	Construction.
void	slotDeletedObject (const App::DocumentObject &)
void	slotRenamedObject (const App::DocumentObject &)
	Observer message from the App doc.
virtual	~SelectionSingleton ()
	Destruction.
Static Protected Member Functions
static PyObject *	sAddSelection (PyObject self, PyObject args, PyObject *kwd)
static PyObject *	saddSelectionGate (PyObject self, PyObject args, PyObject *kwd)
static PyObject *	sAddSelObserver (PyObject self, PyObject args, PyObject *kwd)
static PyObject *	sClearSelection (PyObject self, PyObject args, PyObject *kwd)
static PyObject *	sGetSelection (PyObject self, PyObject args, PyObject *kwd)
static PyObject *	sGetSelectionEx (PyObject self, PyObject args, PyObject *kwd)
static PyObject *	sIsSelected (PyObject self, PyObject args, PyObject *kwd)
static PyObject *	sRemoveSelection (PyObject self, PyObject args, PyObject *kwd)
static PyObject *	sremoveSelectionGate (PyObject self, PyObject args, PyObject *kwd)
static PyObject *	sRemSelObserver (PyObject self, PyObject args, PyObject *kwd)
Protected Attributes
std::list< _SelObj >	_SelList
Gui::SelectionGate *	ActiveGate
SelectionChanges	CurrentPreselection
std::string	DocName
std::string	FeatName
float	hx
float	hy
float	hz
std::string	SubName
Static Protected Attributes
static SelectionSingleton *	_pcSingleton = NULL
Friends
class	SelectionFilter

Detailed Description

The Selection class The selection singleton keeps track of the selection state of the whole application.

It gets messages from all entities which can alter the selection (e.g. tree view and 3D-view) and sends messages to entities which need to keep track on the selection state.

The selection consists mainly out of following information per selected object:

document (pointer)
Object (pointer)
list of subelements (list of strings)
3D coordinates where the user clicks to select (Vector3d)

Also the preselection is managed. That means you can add a filter to prevent selection of unwanted objects or subelements.

Definition at line 198 of file Selection.h.

Constructor & Destructor Documentation

SelectionSingleton::SelectionSingleton ( ) [protected]

Construction.

A constructor.

A more elaborate description of the constructor.

Definition at line 897 of file Selection.cpp.

References ActiveGate, draftlibs::fcgeo::bind(), CurrentPreselection, App::GetApplication(), Gui::SelectionChanges::pDocName, Gui::SelectionChanges::pObjectName, Gui::SelectionChanges::pSubName, App::Application::signalDeletedObject, App::Application::signalRenamedObject, slotDeletedObject(), and slotRenamedObject().

SelectionSingleton::~SelectionSingleton ( ) [protected, virtual]

Destruction.

A destructor.

A more elaborate description of the destructor.

Definition at line 912 of file Selection.cpp.

Member Function Documentation

bool SelectionSingleton::addSelection	(	const char *	pDocName,
		const char *	pObjectName = `0`,
		const char *	pSubName = `0`,
		float	x = `0`,
		float	y = `0`,
		float	z = `0`
	)

Add to selection.

Definition at line 627 of file Selection.cpp.

Referenced by Gui::SoFCUnifiedSelection::handleEvent(), Gui::SoFCSelection::handleEvent(), and sAddSelection().

void SelectionSingleton::addSelectionGate ( Gui::SelectionGate * gate )

add a SelectionGate to control what is selectable

Definition at line 601 of file Selection.cpp.

References ActiveGate, and rmvSelectionGate().

Referenced by saddSelectionGate().

void SelectionSingleton::clearCompleteSelection ( )

Clear the selection of all documents.

Definition at line 825 of file Selection.cpp.

References _SelList, Gui::SelectionChanges::ClrSelection, Base::Console(), Base::Subject< const SelectionChanges & >::Notify(), Gui::SelectionChanges::pDocName, Gui::SelectionChanges::pObjectName, Gui::SelectionChanges::pSubName, signalSelectionChanged, and Gui::SelectionChanges::Type.

Referenced by clearSelection(), and sClearSelection().

void SelectionSingleton::clearSelection ( const char * pDocName = 0 )

Clear the selection of document pDocName. If the document name is not given the selection of the active document is cleared.

Definition at line 789 of file Selection.cpp.

References _SelList, clearCompleteSelection(), Gui::SelectionChanges::ClrSelection, Base::Console(), getDocument(), App::Document::getName(), Base::Subject< const SelectionChanges & >::Notify(), Gui::SelectionChanges::pDocName, Gui::SelectionChanges::pObjectName, Gui::SelectionChanges::pSubName, signalSelectionChanged, and Gui::SelectionChanges::Type.

unsigned int SelectionSingleton::countObjectsOfType	(	const char *	typeName,
		const char *	pDocName = `0`
	)			const

Does basically the same as the method above unless that it accepts a string literal as first argument.

typeName must be a registered type, otherwise 0 is returned.

Definition at line 448 of file Selection.cpp.

References Base::Type::badType(), countObjectsOfType(), and Base::Type::fromName().

unsigned int SelectionSingleton::countObjectsOfType	(	const Base::Type &	typeId,
		const char *	pDocName = `0`
	)			const

Returns the number of selected objects with a special object type It's the convenient way to check if the right objects are selected to perform an operation (GuiCommand).

The check also detects base types. E.g. "Part" also fits on "PartImport" or PartTransform types. If no document name is given the active document is assumed.

Definition at line 429 of file Selection.cpp.

References _SelList, getDocument(), App::PropertyContainer::getTypeId(), and Base::Type::isDerivedFrom().

Referenced by CmdRobotInsertWaypoint::activated(), StdCmdMeasurementSimple::activated(), CmdRobotExportKukaFull::activated(), CmdRobotExportKukaCompact::activated(), CmdRaytracingExportProject::activated(), CmdPartDesignRevolution::activated(), CmdPartDesignPocket::activated(), CmdPartDesignPad::activated(), CmdPartSection::activated(), CmdPartFuse::activated(), CmdPartCommon::activated(), CmdPartCut::activated(), CmdMeshDemolding::activated(), CmdMeshTransform::activated(), CmdDrawingExportPage::activated(), countObjectsOfType(), StdCmdExport::isActive(), CmdPointsPolyCut::isActive(), CmdPointsTransform::isActive(), CmdPointsExport::isActive(), CmdPartSection::isActive(), CmdPartFuse::isActive(), CmdPartCommon::isActive(), CmdPartCut::isActive(), CmdMeshFillupHoles::isActive(), CmdMeshBoundingBox::isActive(), CmdMeshFlipNormals::isActive(), CmdMeshHarmonizeNormals::isActive(), CmdMeshSmoothing::isActive(), CmdMeshEvaluateSolid::isActive(), CmdMeshToolMesh::isActive(), CmdMeshVertexCurvature::isActive(), CmdMeshFromGeometry::isActive(), CmdMeshExport::isActive(), CmdMeshIntersection::isActive(), CmdMeshDifference::isActive(), CmdMeshUnion::isActive(), CmdMeshDemolding::isActive(), and CmdMeshTransform::isActive().

void SelectionSingleton::destruct ( void ) [static]

Definition at line 926 of file Selection.cpp.

References _pcSingleton.

Referenced by Gui::Application::~Application().

std::vector< SelectionSingleton::SelObj > SelectionSingleton::getCompleteSelection ( ) const

Returns a vector of all selection objects of all documents.

Definition at line 278 of file Selection.cpp.

References _SelList, Gui::SelectionSingleton::SelObj::DocName, Gui::SelectionSingleton::SelObj::FeatName, Gui::SelectionSingleton::SelObj::pDoc, Gui::SelectionSingleton::SelObj::pObject, Gui::SelectionSingleton::SelObj::SubName, and Gui::SelectionSingleton::SelObj::TypeName.

Referenced by StdCmdRandomColor::activated(), StdCmdDDuplicateSelection::activated(), Gui::MainWindow::createMimeDataFromSelection(), StdCmdDelete::isActive(), and sGetSelection().

App::Document * SelectionSingleton::getDocument ( const char * pDocName = 0 ) const [protected]

helper to retrieve document by name

Definition at line 619 of file Selection.cpp.

References App::Application::getActiveDocument(), App::GetApplication(), and App::Application::getDocument().

Referenced by addSelection(), clearSelection(), countObjectsOfType(), getObjectsOfType(), getSelection(), getSelectionEx(), hasSelection(), setPreselect(), and setSelection().

template<typename T >

std::vector< T * > Gui::SelectionSingleton::getObjectsOfType ( const char * pDocName = 0 ) const [inline]

A convenience template-based method that returns an array with the correct types already.

Definition at line 356 of file Selection.h.

References getObjectsOfType(), and Py::type().

std::vector< App::DocumentObject * > SelectionSingleton::getObjectsOfType	(	const char *	typeName,
		const char *	pDocName = `0`
	)			const

Does basically the same as the method above unless that it accepts a string literal as first argument.

typeName must be a registered type otherwise an empty array is returned.

Definition at line 421 of file Selection.cpp.

References Base::Type::badType(), Base::Type::fromName(), and getObjectsOfType().

vector< App::DocumentObject * > SelectionSingleton::getObjectsOfType	(	const Base::Type &	typeId,
		const char *	pDocName = `0`
	)			const

Returns a vector of objects of type TypeName selected for the given document name pDocName.

If no document name is specified the objects from the active document are regarded. If no objects of this document are selected an empty vector is returned.

Note:: The vector reflects the sequence of selection.

Definition at line 402 of file Selection.cpp.

References _SelList, getDocument(), App::PropertyContainer::getTypeId(), and Base::Type::isDerivedFrom().

const SelectionChanges & SelectionSingleton::getPreselection ( void ) const

returns the present preselection

Definition at line 595 of file Selection.cpp.

References CurrentPreselection.

Referenced by CmdRobotInsertWaypointPreselect::activated().

std::vector< SelectionSingleton::SelObj > SelectionSingleton::getSelection ( const char * pDocName = 0 ) const

Returns a vector of selection objects If no document name is given the objects of the active are returned.

If nothing for this Document is selected an empty vector is returned. The vector reflects the sequence of selection.

Definition at line 296 of file Selection.cpp.

References _SelList, Gui::SelectionSingleton::SelObj::DocName, Gui::SelectionSingleton::SelObj::FeatName, getDocument(), Gui::SelectionSingleton::SelObj::pDoc, Gui::SelectionSingleton::SelObj::pObject, Gui::SelectionSingleton::SelObj::SubName, Gui::SelectionSingleton::SelObj::TypeName, Gui::SelectionSingleton::SelObj::x, Gui::SelectionSingleton::SelObj::y, and Gui::SelectionSingleton::SelObj::z.

Referenced by CmdRobotInsertWaypointPreselect::activated(), CmdRobotInsertWaypoint::activated(), StdCmdMeasurementSimple::activated(), CmdRobotExportKukaFull::activated(), CmdRobotExportKukaCompact::activated(), CmdRaytracingExportProject::activated(), CmdPartSection::activated(), CmdPartFuse::activated(), CmdPartCommon::activated(), CmdPartCut::activated(), CmdMeshDemolding::activated(), CmdMeshTransform::activated(), CmdDrawingExportPage::activated(), CmdDrawingNewView::activated(), Gui::DocumentItem::selectItems(), and sGetSelection().

std::vector< SelectionObject > SelectionSingleton::getSelectionEx	(	const char *	pDocName = `0`,
		Base::Type	typeId = `App::DocumentObject::getClassTypeId()`
	)			const