FreeCAD C++
Public Member Functions | List of all members
Gui::SelectionObject Class Reference

#include <Gui/SelectionObject.h>

Detailed Description

The Selection object class

Public Member Functions

 SelectionObject ()
 
 SelectionObject (const SelectionChanges &msg)
 
PyObject * getPyObject ()
 
const std::vector< std::string > & getSubNames (void) const
 get the SubElement name of this SelectionObject
 
bool hasSubNames (void) const
 are there any SubNames selected
 
const char * getDocName (void) const
 get the name of the Document of this SelctionObject
 
const char * getFeatName (void) const
 get the name of the Document Object of this SelectionObject
 
const char * getTypeName (void) const
 get the Type of the selected Object
 
const std::vector< Base::Vector3dgetPickedPoints (void) const
 get the selection points
 
const App::DocumentObjectgetObject (void) const
 returns the selected DocumentObject or NULL if the object is already deleted
 
App::DocumentObjectgetObject (void)
 returns the selected DocumentObject or NULL if the object is already deleted
 
bool isObjectTypeOf (const Base::Type &typeId) const
 check the selected object is a special type or derived of
 
std::string getAsPropertyLinkSubString (void) const
 returns python expreasion sutably for assigning to a LinkSub property
 
- Public Member Functions inherited from Base::BaseClass
 BaseClass ()
 Construction.
 
virtual ~BaseClass ()
 Destruction.
 

Constructor & Destructor Documentation

◆ SelectionObject() [1/2]

Gui::SelectionObject::SelectionObject ( )

Constructs a SelectionObject object.

◆ SelectionObject() [2/2]

Gui::SelectionObject::SelectionObject ( const SelectionChanges msg)

Constructs a SelectionObject from the SelectionChanges structure.

Member Function Documentation

◆ getPyObject()

PyObject* Gui::SelectionObject::getPyObject ( )
virtual

The default implementation returns an instance of SelectionObjectPy.

Reimplemented from Base::BaseClass.