#include <ViewProviderPythonFeature.h>

Public Member Functions
std::vector< App::DocumentObject * > claimChildren () const override

QIcon getIcon () const override

ViewProviderPythonFeatureT ()
	constructor. More...

virtual ~ViewProviderPythonFeatureT ()
	destructor. More...

Nodes
virtual SoSeparator * getRoot () const override

virtual SoSeparator * getFrontRoot () const override

virtual SoSeparator * getBackRoot () const override

Selection handling
virtual bool useNewSelectionModel () const override

virtual bool getElementPicked (const SoPickedPoint *pp, std::string &subname) const override

virtual std::string getElement (const SoDetail *det) const override

virtual SoDetail * getDetail (const char *name) const override

virtual bool getDetailPath (const char name, SoFullPath path, bool append, SoDetail *&det) const override

virtual std::vector< Base::Vector3d > getSelectionShape (const char *Element) const override

Update data methods
virtual void attach (App::DocumentObject *obj) override

virtual void updateData (const App::Property *prop) override

virtual void getTaskViewContent (std::vector< Gui::TaskView::TaskContent * > &c) const override

virtual bool onDelete (const std::vector< std::string > &sub) override

virtual bool canDelete (App::DocumentObject *obj) const override

Restoring view provider from document load
virtual void startRestoring () override

virtual void finishRestoring () override

Drag and drop
virtual bool canDragObjects () const override
	Returns true if the view provider generally supports dragging objects. More...

virtual bool canDragObject (App::DocumentObject *obj) const override
	Check whether the object can be removed from the view provider by drag and drop. More...

virtual void dragObject (App::DocumentObject *obj) override
	Starts to drag the object. More...

virtual bool canDropObjects () const override
	Returns true if the view provider generally accepts dropping of objects. More...

virtual bool canDropObject (App::DocumentObject *obj) const override
	Check whether the object can be dropped to the view provider by drag and drop. More...

virtual void dropObject (App::DocumentObject *obj) override
	If the dropped object type is accepted the object will be added as child. More...

virtual bool canDragAndDropObject (App::DocumentObject *obj) const override
	Return false to force drop only operation for a give object. More...

virtual bool canDropObjectEx (App::DocumentObject obj, App::DocumentObject owner, const char *subname, const std::vector< std::string > &elements) const override

virtual std::string dropObjectEx (App::DocumentObject obj, App::DocumentObject owner, const char *subname, const std::vector< std::string > &elements) override
	Add an object with full quanlified name to the view provider by drag and drop. More...

Public Member Functions inherited from Gui::ViewProviderT
std::string getAppDocumentPython () const

Document * getDocument () const

std::string getDocumentName () const

std::string getGuiDocumentPython () const

template<typename T >
T * getObjectAs () const

std::string getObjectName () const

std::string getObjectPython () const

ViewProviderDocumentObject * getViewProvider () const

void operator= (const ViewProviderDocumentObject *)

void operator= (const ViewProviderT &)

ViewProviderT ()

ViewProviderT (ViewProviderDocumentObject *)

~ViewProviderT ()

Display methods
virtual bool isShow () const override
	Returns true if the icon must always appear enabled in the tree view. More...

virtual const char * getDefaultDisplayMode () const override
	get the default display mode More...

virtual std::vector< std::string > getDisplayModes (void) const override
	returns a list of all possible modes More...

virtual void setDisplayMode (const char *ModeName) override
	set the display mode More...

virtual bool canRemoveChildrenFromRoot () const override

PyObject * getPyObject () override

virtual bool canAddToSceneGraph () const override

virtual void setupContextMenu (QMenu menu, QObject recipient, const char *member) override

virtual void onChanged (const App::Property *prop) override

virtual bool setEdit (int ModNum) override
	is called by the document when the provider goes in edit mode More...

virtual void unsetEdit (int ModNum) override
	is called when you lose the edit mode More...

virtual void setEditViewer (View3DInventorViewer *viewer, int ModNum) override

virtual void unsetEditViewer (View3DInventorViewer *viewer) override

virtual std::string getDropPrefix () const override

virtual int replaceObject (App::DocumentObject oldObj, App::DocumentObject newObj) override

virtual ViewProviderDocumentObject * getLinkedViewProvider (std::string *subname=0, bool recursive=false) const override

virtual bool doubleClicked (void) override

virtual void setOverrideMode (const std::string &mode) override

Constructor & Destructor Documentation

◆ ViewProviderPythonFeatureT()

template<class ViewProviderT >

Gui::ViewProviderPythonFeatureT< ViewProviderT >::ViewProviderPythonFeatureT ( )

constructor.

◆ ~ViewProviderPythonFeatureT()

template<class ViewProviderT >

virtual Gui::ViewProviderPythonFeatureT< ViewProviderT >::~ViewProviderPythonFeatureT ( )

virtual

destructor.

Member Function Documentation

◆ attach()

template<class ViewProviderT >

virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::attach ( App::DocumentObject * obj )

overridevirtual

◆ canAddToSceneGraph()

template<class ViewProviderT >

virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::canAddToSceneGraph ( ) const

overridevirtual

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::canAddToSceneGraph(), and Gui::ViewProviderPythonFeatureImp::Rejected.

◆ canDelete()

template<class ViewProviderT >

virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::canDelete ( App::DocumentObject * obj ) const

overridevirtual

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::canDelete(), and Gui::ViewProviderPythonFeatureImp::Rejected.

◆ canDragAndDropObject()

template<class ViewProviderT >

virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::canDragAndDropObject ( App::DocumentObject * obj ) const

overridevirtual

Return false to force drop only operation for a give object.

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::canDragAndDropObject(), and Gui::ViewProviderPythonFeatureImp::Rejected.

◆ canDragObject()

template<class ViewProviderT >

virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::canDragObject ( App::DocumentObject * obj ) const

overridevirtual

Check whether the object can be removed from the view provider by drag and drop.

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::canDragObject(), and Gui::ViewProviderPythonFeatureImp::Rejected.

◆ canDragObjects()

template<class ViewProviderT >

virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::canDragObjects ( ) const

overridevirtual

Returns true if the view provider generally supports dragging objects.

◆ canDropObject()

template<class ViewProviderT >

virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::canDropObject ( App::DocumentObject * obj ) const

overridevirtual

Check whether the object can be dropped to the view provider by drag and drop.

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::canDropObject(), and Gui::ViewProviderPythonFeatureImp::Rejected.

◆ canDropObjectEx()

template<class ViewProviderT >

virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::canDropObjectEx	(	App::DocumentObject *	obj,
		App::DocumentObject *	owner,
		const char *	subname,
		const std::vector< std::string > &	elements
	)		const

overridevirtual

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::canDropObjectEx(), and Gui::ViewProviderPythonFeatureImp::Rejected.

◆ canDropObjects()

template<class ViewProviderT >

virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::canDropObjects ( ) const

overridevirtual

Returns true if the view provider generally accepts dropping of objects.

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::canDropObjects(), and Gui::ViewProviderPythonFeatureImp::Rejected.

◆ canRemoveChildrenFromRoot()

template<class ViewProviderT >

virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::canRemoveChildrenFromRoot ( ) const

overridevirtual

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::canRemoveChildrenFromRoot(), and Gui::ViewProviderPythonFeatureImp::NotImplemented.

◆ claimChildren()

template<class ViewProviderT >

std::vector<App::DocumentObject*> Gui::ViewProviderPythonFeatureT< ViewProviderT >::claimChildren ( ) const

override

References Gui::ViewProviderPythonFeatureImp::claimChildren().

Referenced by femviewprovider.view_result_mechanical.VPResultMechanical::onDelete(), BOPTools.SplitFeatures.ViewProviderBooleanFragments::onDelete(), BOPTools.JoinFeatures.ViewProviderConnect::onDelete(), femviewprovider.view_mesh_gmsh.VPMeshGmsh::onDelete(), BOPTools.SplitFeatures.ViewProviderSlice::onDelete(), and BOPTools.SplitFeatures.ViewProviderXOR::onDelete().

◆ doubleClicked()

template<class ViewProviderT >

virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::doubleClicked ( void )

overrideprotectedvirtual

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::doubleClicked(), and Gui::ViewProviderPythonFeatureImp::Rejected.

◆ dragObject()

template<class ViewProviderT >

virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::dragObject ( App::DocumentObject * obj )

overridevirtual

Starts to drag the object.

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::dragObject(), and Gui::ViewProviderPythonFeatureImp::Rejected.

◆ dropObject()

template<class ViewProviderT >

virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::dropObject ( App::DocumentObject * obj )

overridevirtual

If the dropped object type is accepted the object will be added as child.

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::dropObject(), and Gui::ViewProviderPythonFeatureImp::Rejected.

◆ dropObjectEx()

template<class ViewProviderT >

virtual std::string Gui::ViewProviderPythonFeatureT< ViewProviderT >::dropObjectEx	(	App::DocumentObject *	obj,
		App::DocumentObject *	owner,
		const char *	subname,
		const std::vector< std::string > &	elements
	)

overridevirtual

Add an object with full quanlified name to the view provider by drag and drop.

References Gui::ViewProviderPythonFeatureImp::dropObjectEx().

◆ finishRestoring()

template<class ViewProviderT >

virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::finishRestoring ( )

overridevirtual

References Gui::ViewProviderPythonFeatureImp::finishRestoring().

◆ getBackRoot()

template<class ViewProviderT >

virtual SoSeparator* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getBackRoot ( ) const

overridevirtual

◆ getDefaultDisplayMode()

template<class ViewProviderT >

virtual const char* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getDefaultDisplayMode ( ) const

overridevirtual

get the default display mode

References Gui::ViewProviderPythonFeatureImp::getDefaultDisplayMode().

◆ getDetail()

template<class ViewProviderT >

virtual SoDetail* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getDetail ( const char * name ) const

overridevirtual

References Gui::ViewProviderPythonFeatureImp::getDetail().

◆ getDetailPath()

template<class ViewProviderT >

virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::getDetailPath	(	const char *	name,
		SoFullPath *	path,
		bool	append,
		SoDetail *&	det
	)		const

overridevirtual

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::getDetailPath(), and Gui::ViewProviderPythonFeatureImp::NotImplemented.

◆ getDisplayModes()

template<class ViewProviderT >

virtual std::vector<std::string> Gui::ViewProviderPythonFeatureT< ViewProviderT >::getDisplayModes ( void ) const

overridevirtual

returns a list of all possible modes

References Gui::ViewProviderPythonFeatureImp::getDisplayModes().

◆ getDropPrefix()

template<class ViewProviderT >

virtual std::string Gui::ViewProviderPythonFeatureT< ViewProviderT >::getDropPrefix ( ) const

overrideprotectedvirtual

References Gui::ViewProviderPythonFeatureImp::getDropPrefix().

◆ getElement()

template<class ViewProviderT >

virtual std::string Gui::ViewProviderPythonFeatureT< ViewProviderT >::getElement ( const SoDetail * det ) const

overridevirtual

References Gui::ViewProviderPythonFeatureImp::getElement().

◆ getElementPicked()

template<class ViewProviderT >

virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::getElementPicked	(	const SoPickedPoint *	pp,
		std::string &	subname
	)		const

overridevirtual

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::getElementPicked(), and Gui::ViewProviderPythonFeatureImp::NotImplemented.

◆ getFrontRoot()

template<class ViewProviderT >

virtual SoSeparator* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getFrontRoot ( ) const

overridevirtual

◆ getIcon()

template<class ViewProviderT >

QIcon Gui::ViewProviderPythonFeatureT< ViewProviderT >::getIcon ( ) const

override

References Gui::ViewProviderPythonFeatureImp::getIcon().

Referenced by ArchAxis.AxisSystemTaskPanel::update(), ArchSectionPlane.SectionPlaneTaskPanel::update(), and ArchComponent.ComponentTaskPanel::update().

◆ getLinkedViewProvider()

template<class ViewProviderT >

virtual ViewProviderDocumentObject* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getLinkedViewProvider	(	std::string *	subname = `0`,
		bool	recursive = `false`
	)		const

overrideprotectedvirtual

References Gui::ViewProviderPythonFeatureImp::getLinkedViewProvider().

◆ getPyObject()

template<class ViewProviderT >

PyObject* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getPyObject ( )

override

◆ getRoot()

template<class ViewProviderT >

virtual SoSeparator* Gui::ViewProviderPythonFeatureT< ViewProviderT >::getRoot ( ) const

overridevirtual

◆ getSelectionShape()

template<class ViewProviderT >

virtual std::vector<Base::Vector3d> Gui::ViewProviderPythonFeatureT< ViewProviderT >::getSelectionShape ( const char * Element ) const

overridevirtual

◆ getTaskViewContent()

template<class ViewProviderT >

virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::getTaskViewContent ( std::vector< Gui::TaskView::TaskContent * > & c ) const

overridevirtual

◆ isShow()

template<class ViewProviderT >

virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::isShow ( ) const

overridevirtual

Returns true if the icon must always appear enabled in the tree view.

◆ onChanged()

template<class ViewProviderT >

virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::onChanged ( const App::Property * prop )

overrideprotectedvirtual

References Gui::ViewProviderPythonFeatureImp::attach(), Gui::ViewProviderPythonFeatureImp::canAddToSceneGraph(), Gui::ViewProviderT::getDocument(), App::PropertyPythonObject::getValue(), Gui::ViewProviderPythonFeatureImp::init(), Gui::isRestoring, Gui::ViewProviderPythonFeatureImp::onChanged(), and Gui::Document::toggleInSceneGraph().

Referenced by draftviewproviders.view_base.ViewProviderDraft::attach(), ArchSite.Compass::buildCoordinates(), draftobjects.wire.Wire::execute(), ArchAxis.CommandArchGrid::IsActive(), draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy::updateData(), draftviewproviders.view_label.ViewProviderLabel::updateData(), DraftLayer.ViewProviderLayer::updateData(), ArchBuildingPart.ViewProviderBuildingPart::updateData(), ArchPanel.ViewProviderPanelCut::updateData(), and ArchPanel.ViewProviderPanelSheet::updateData().

◆ onDelete()

template<class ViewProviderT >

virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::onDelete ( const std::vector< std::string > & sub )

overridevirtual

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::onDelete(), and Gui::ViewProviderPythonFeatureImp::Rejected.

◆ replaceObject()

template<class ViewProviderT >

virtual int Gui::ViewProviderPythonFeatureT< ViewProviderT >::replaceObject	(	App::DocumentObject *	oldObj,
		App::DocumentObject *	newObj
	)

overrideprotectedvirtual

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::Rejected, and Gui::ViewProviderPythonFeatureImp::replaceObject().

◆ setDisplayMode()

template<class ViewProviderT >

virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::setDisplayMode ( const char * ModeName )

overridevirtual

set the display mode

References Gui::ViewProviderPythonFeatureImp::setDisplayMode().

◆ setEdit()

template<class ViewProviderT >

virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::setEdit ( int ModNum )

overrideprotectedvirtual

is called by the document when the provider goes in edit mode

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::Rejected, and Gui::ViewProviderPythonFeatureImp::setEdit().

Referenced by PathScripts.PathSetupSheetGui.ViewProvider::doubleClicked(), PathScripts.PathToolBitGui.ViewProvider::doubleClicked(), ArchReference.ViewProviderArchReference::doubleClicked(), Spreadsheet_legacy.ViewProviderSpreadsheet::doubleClicked(), ArchAxis.ViewProviderArchGrid::doubleClicked(), ArchSchedule.CommandArchSchedule::IsActive(), ArchAxis.CommandArchGrid::IsActive(), PathScripts.PathIconViewProvider.ViewProvider::setupContextMenu(), PathScripts.PathToolControllerGui.ViewProvider::setupContextMenu(), PathScripts.PathOpGui.ViewProvider::setupContextMenu(), and PathScripts.PathJobGui.ViewProvider::setupContextMenu().

◆ setEditViewer()

template<class ViewProviderT >

virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::setEditViewer	(	View3DInventorViewer *	viewer,
		int	ModNum
	)

overrideprotectedvirtual

References Gui::ViewProviderPythonFeatureImp::setEditViewer(), and OfflineRenderingUtils::viewer().

◆ setOverrideMode()

template<class ViewProviderT >

virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::setOverrideMode ( const std::string & mode )

overrideprotectedvirtual

◆ setupContextMenu()

template<class ViewProviderT >

virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::setupContextMenu	(	QMenu *	menu,
		QObject *	recipient,
		const char *	member
	)

overridevirtual

References Gui::ViewProviderPythonFeatureImp::setupContextMenu().

◆ startRestoring()

template<class ViewProviderT >

virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::startRestoring ( )

overridevirtual

References Gui::ViewProviderPythonFeatureImp::startRestoring().

◆ unsetEdit()

template<class ViewProviderT >

virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::unsetEdit ( int ModNum )

overrideprotectedvirtual

is called when you lose the edit mode

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::Rejected, and Gui::ViewProviderPythonFeatureImp::unsetEdit().

Referenced by PathScripts.PathJobGui.ViewProvider::uneditObject().

◆ unsetEditViewer()

template<class ViewProviderT >

virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::unsetEditViewer ( View3DInventorViewer * viewer )

overrideprotectedvirtual

References Gui::ViewProviderPythonFeatureImp::unsetEditViewer(), and OfflineRenderingUtils::viewer().

◆ updateData()

template<class ViewProviderT >

virtual void Gui::ViewProviderPythonFeatureT< ViewProviderT >::updateData ( const App::Property * prop )

overridevirtual

References Gui::ViewProviderPythonFeatureImp::updateData().

Referenced by PathScripts.PathJobDlg.JobCreate::exec_(), draftviewproviders.view_wire.ViewProviderWire::onChanged(), draftviewproviders.view_dimension.ViewProviderLinearDimension::onChanged(), draftviewproviders.view_dimension.ViewProviderAngularDimension::onChanged(), PathScripts.PathOpGui.TaskPanelPage::pageUpdateData(), and PathScripts.PathSetupSheetGui.OpTaskPanel::setupUi().

◆ useNewSelectionModel()

template<class ViewProviderT >

virtual bool Gui::ViewProviderPythonFeatureT< ViewProviderT >::useNewSelectionModel ( ) const

overridevirtual

References Gui::ViewProviderPythonFeatureImp::Accepted, Gui::ViewProviderPythonFeatureImp::Rejected, and Gui::ViewProviderPythonFeatureImp::useNewSelectionModel().

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

src/Gui/ViewProviderPythonFeature.h

Public Member Functions

Display methods

Constructor & Destructor Documentation

◆ ViewProviderPythonFeatureT()

◆ ~ViewProviderPythonFeatureT()

Member Function Documentation

◆ attach()

◆ canAddToSceneGraph()

◆ canDelete()

◆ canDragAndDropObject()

◆ canDragObject()

◆ canDragObjects()

◆ canDropObject()

◆ canDropObjectEx()

◆ canDropObjects()

◆ canRemoveChildrenFromRoot()

◆ claimChildren()

◆ doubleClicked()

◆ dragObject()

◆ dropObject()

◆ dropObjectEx()

◆ finishRestoring()

◆ getBackRoot()

◆ getDefaultDisplayMode()

◆ getDetail()

◆ getDetailPath()

◆ getDisplayModes()

◆ getDropPrefix()

◆ getElement()

◆ getElementPicked()

◆ getFrontRoot()

◆ getIcon()

◆ getLinkedViewProvider()

◆ getPyObject()

◆ getRoot()

◆ getSelectionShape()

◆ getTaskViewContent()

◆ isShow()

◆ onChanged()

◆ onDelete()

◆ replaceObject()

◆ setDisplayMode()

◆ setEdit()

◆ setEditViewer()

◆ setOverrideMode()

◆ setupContextMenu()

◆ startRestoring()

◆ unsetEdit()

◆ unsetEditViewer()

◆ updateData()

◆ useNewSelectionModel()