Gui::ViewProvider Class Reference

General interface for all visual stuff in FreeCAD This class is used to generate and handle all around visualizing and presenting objects from the FreeCAD App layer to the user. More...

#include <ViewProvider.h>

Inheritance diagram for Gui::ViewProvider:

List of all members.

Public Member Functions
virtual bool	doubleClicked (void)
	is called by the tree if the user double click on the object
SoSeparator *	getAnnotation (void)
virtual SoSeparator *	getBackRoot (void) const
virtual SoSeparator *	getFrontRoot (void) const
PyObject *	getPyObject ()
	This method returns the Python wrapper for a C++ object.
virtual SoSeparator *	getRoot (void)
virtual Base::Type	getTypeId (void) const
bool	isUpdatesEnabled () const
virtual bool	keyPressed (bool pressed, int key)
	is called when the provider is in edit and a key event occurs. Only ESC ends edit.
virtual bool	mouseButtonPressed (int Button, bool pressed, const SbVec3f &pos, const SbVec3f &norm, const SoPickedPoint *pp)
	is called when the Provider is in edit and the mouse is clicked
virtual bool	mouseMove (const SbVec3f &pos, const SbVec3f &norm, const SoPickedPoint *pp)
	is called when the provider is in edit and the mouse is moved
virtual void	setupContextMenu (QMenu , QObject , const char *)
	set up the context-menu with the supported edit modes
void	setUpdatesEnabled (bool enable)
std::string	toString () const
void	update (const App::Property *)
	update the content of the ViewProvider this method have to implement the recalcualtion of the ViewProvider.
virtual void	updateData (const App::Property *)=0
	ViewProvider ()
	constructor.
virtual	~ViewProvider ()
	destructor.
Methods used by the Tree
If you want to take control over the appearance of your object in the tree you can reimplemnt this methods.
virtual std::vector < App::DocumentObject * >	claimChildren (void) const
	deliver the children belonging to this object this method is used to deliver the objects to the tree framework which should be grouped under its label.
virtual QIcon	getIcon (void) const
	deliver the icon shown in the tree view
direct handling methods
This group of methods is to direct influence the appearance of the viewed content. It's only for fast interactions! If you want to set the visual parameters you have to do it on the object viewed by this provider!
SbMatrix	convert (const Base::Matrix4D &rcMatrix) const
virtual void	setTransformation (const SbMatrix &rcMatrix)
virtual void	setTransformation (const Base::Matrix4D &rcMatrix)
	set the viewing transformation of the provider
Display mode methods

std::string	getActiveDisplayMode (void) const
virtual const char *	getDefaultDisplayMode () const =0
	get the default display mode
virtual std::vector< std::string >	getDisplayModes (void) const =0
	returns a list of all possible display modes
virtual void	hide (void)
	Hides the view provider.
virtual bool	isShow (void) const
	checks whether the view provider is visible or not
bool	isVisible () const
virtual void	setDisplayMode (const char *ModeName)
	set the display mode
void	setVisible (bool)
virtual void	show (void)
	Shows the view provider.
Selection handling
This group of methodes do the selection handling. Here you can define how the selection for your ViewProfider works.
virtual std::string	getElement (const SoPickedPoint *) const
	return a hit element to the selection path or 0
virtual std::vector < Base::Vector3d >	getSelectionShape (const char *Element) const
	return the higlight lines for a given element or the whole shape
virtual bool	isSelectable (void) const
	indicates if the ViewProvider can be selected
virtual bool	onDelete (const std::vector< std::string > &)
	get called if the object is about to get deleted. Here you can delete other objects to or switch visibility of others.
virtual bool	useNewSelectionModel (void) const
	indicates if the ViewProvider use the new Selection model
Task panel
With this interface the ViewProvider can steer the appearance of widgets in the task view
virtual void	getTaskViewContent (std::vector< Gui::TaskView::TaskContent * > &) const
	get a list of TaskBoxes associated with this object
Static Public Member Functions
static void *	create (void)
static void	eventCallback (void ud, SoEventCallback node)
static Base::Type	getClassTypeId (void)
static void	init (void)
Public Attributes
Signals of the view provider

boost::signal< void()>	signalChangeIcon
	signal on icon change
boost::signal< void(const QString &)>	signalChangeStatusTip
	signal on status tip change
boost::signal< void(const QString &)>	signalChangeToolTip
	signal on tooltip change
Protected Member Functions
SoPickedPoint *	getPointOnRay (const SbVec3f &pos, const SbVec3f &dir, const View3DInventorViewer &viewer) const
	Helper method to get picked entities while editing.
virtual const App::PropertyData &	getPropertyData (void) const
void	onChanged (const App::Property *prop)
	Reimplemented from subclass.
Display mask modes
Mainly controls an SoSwitch node which selects the display mask modes. The number of display mask modes doesn't necessarily match with the number of display modes. E.g. various display modes like Gaussian curvature, mean curvature or gray values are displayed by one display mask mode that handles color values.
void	addDisplayMaskMode (SoNode node, const char type)
	Adds a new display mask mode.
std::vector< std::string >	getDisplayMaskModes () const
	Returns a list of added display mask modes.
void	setDefaultMode (int)
void	setDisplayMaskMode (const char *type)
	Activates the display mask mode type.
Static Protected Member Functions
static const App::PropertyData *	getPropertyDataPtr (void)
Protected Attributes
SoSeparator *	pcAnnotation
	The root separator for annotations.
SoSwitch *	pcModeSwitch
	this is the mode switch, all the different viewing modes are collected here
SoSeparator *	pcRoot
	The root Separator of the ViewProvider.
SoTransform *	pcTransform
	this is transformation for the provider
ViewProviderPy *	pyViewObject
const char *	sPixmap
Friends
class	ViewProviderPythonFeaturePy
Edit methods
if the Viewprovider goes in edit mode you can handle most of the events in the viewer by yourself
enum	EditMode { Default = 0, Transform, Cutting, Color }
void	finishEditing ()
bool	isEditing () const
virtual void	setEditViewer (View3DInventorViewer *, int ModNum)
	adjust viewer settings when editing a view provider
bool	startEditing (int ModNum=0)
virtual void	unsetEditViewer (View3DInventorViewer *)
	restores viewer settings when leaving editing mode
int	getEditingMode () const
	return the edit mode or -1 if nothing is being edited
virtual bool	setEdit (int ModNum)
	is called by the document when the provider goes in edit mode
virtual void	unsetEdit (int ModNum)
	is called when you loose the edit mode

Detailed Description

General interface for all visual stuff in FreeCAD This class is used to generate and handle all around visualizing and presenting objects from the FreeCAD App layer to the user.

This class and its descendents have to be implemented for any object type in order to show them in the 3DView and TreeView.

Definition at line 74 of file Gui/ViewProvider.h.

Member Enumeration Documentation

enum Gui::ViewProvider::EditMode

Enumerator:

Default
Transform
Cutting
Color

Definition at line 184 of file Gui/ViewProvider.h.

Constructor & Destructor Documentation

ViewProvider::ViewProvider ( )

constructor.

Reimplemented in PartDesignGui::ViewProvider.

Definition at line 63 of file Gui/ViewProvider.cpp.

ViewProvider::~ViewProvider ( ) [virtual]

destructor.

Reimplemented in PartDesignGui::ViewProvider.

Definition at line 78 of file Gui/ViewProvider.cpp.

References Base::PyObjectBase::DecRef(), pcAnnotation, pcModeSwitch, pcRoot, pcTransform, pyViewObject, and Base::PyObjectBase::setInvalid().

Member Function Documentation

void ViewProvider::addDisplayMaskMode	(	SoNode *	node,
		const char *	type
	)			`[protected]`

Adds a new display mask mode.

Definition at line 267 of file Gui/ViewProvider.cpp.

References pcModeSwitch.

virtual std::vector<App::DocumentObject*> Gui::ViewProvider::claimChildren ( void ) const [inline, virtual]

deliver the children belonging to this object this method is used to deliver the objects to the tree framework which should be grouped under its label.

Obvious is the usage in the group but it can be used for any kind of grouping needed for a special purpose.

Reimplemented in Gui::ViewProviderDocumentObjectGroup, PartGui::ViewProviderBoolean, PartGui::ViewProviderMultiFuse, PartGui::ViewProviderMultiCommon, PartGui::ViewProviderExtrusion, PartGui::ViewProviderFillet, PartDesignGui::ViewProviderHole, PartDesignGui::ViewProviderMainPart, PartDesignGui::ViewProviderPad, PartDesignGui::ViewProviderPocket, PartDesignGui::ViewProviderRevolution, RobotGui::ViewProviderTrajectoryCompound, and RobotGui::ViewProviderTrajectoryDressUp.

Definition at line 131 of file Gui/ViewProvider.h.

Referenced by Gui::DocumentItem::slotChangeObject().

SbMatrix ViewProvider::convert ( const Base::Matrix4D & rcMatrix ) const

Definition at line 257 of file Gui/ViewProvider.cpp.

References Base::Matrix4D::getGLMatrix().

void * Gui::ViewProvider::create ( void ) [static]

Reimplemented from App::PropertyContainer.

Definition at line 61 of file Gui/ViewProvider.cpp.

virtual bool Gui::ViewProvider::doubleClicked ( void ) [inline, virtual]

is called by the tree if the user double click on the object

Reimplemented in Gui::ViewProviderAnnotationLabel, Gui::ViewProviderGeometryObject, DrawingGui::ViewProviderDrawingPage, MeshGui::ViewProviderMesh, PartDesignGui::ViewProvider, RobotGui::ViewProviderEdge2TracObject, and SketcherGui::ViewProviderSketch.

Definition at line 219 of file Gui/ViewProvider.h.

void ViewProvider::eventCallback	(	void *	ud,
		SoEventCallback *	node
	)			`[static]`

Definition at line 142 of file Gui/ViewProvider.cpp.

References Gui::Application::activeDocument(), Base::Console(), Gui::View3DInventorViewer::getPointOnScreen(), Gui::View3DInventorViewer::getViewDirection(), Gui::Application::Instance, Gui::Document::resetEdit(), and Base::Exception::what().

Referenced by Gui::View3DInventorViewer::resetEditingViewProvider(), and Gui::View3DInventorViewer::setEditingViewProvider().

void ViewProvider::finishEditing ( )

Definition at line 109 of file Gui/ViewProvider.cpp.

References unsetEdit().

Referenced by MeshGui::ViewProviderMesh::clipMeshCallback(), PointsGui::ViewProviderPoints::clipPointsCallback(), Gui::ViewProviderPy::finishEditing(), MeshGui::ViewProviderMesh::partMeshCallback(), Gui::View3DInventorViewer::resetEditingViewProvider(), MeshGui::ViewProviderMesh::segmMeshCallback(), and MeshGui::ViewProviderMesh::selectGLCallback().

std::string ViewProvider::getActiveDisplayMode ( void ) const

Definition at line 302 of file Gui/ViewProvider.cpp.

Referenced by MeshGui::ViewProviderMeshCurvature::curvatureInfo(), SketcherGui::ViewProviderCustom::updateData(), and PartGui::ViewProviderCustom::updateData().

SoSeparator * ViewProvider::getAnnotation ( void )

Definition at line 215 of file Gui/ViewProvider.cpp.

References pcAnnotation, and pcRoot.

Referenced by Gui::ViewProviderPy::getAnnotation().

virtual SoSeparator* Gui::ViewProvider::getBackRoot ( void ) const [inline, virtual]

Definition at line 92 of file Gui/ViewProvider.h.

Referenced by Gui::View3DInventorViewer::addViewProvider(), and Gui::View3DInventorViewer::removeViewProvider().

Base::Type Gui::ViewProvider::getClassTypeId ( void ) [static]

Reimplemented from App::PropertyContainer.

Definition at line 61 of file Gui/ViewProvider.cpp.

Referenced by MeshGui::DlgEvaluateMeshImp::addViewProvider(), and Gui::TreeView::mouseDoubleClickEvent().

virtual const char* Gui::ViewProvider::getDefaultDisplayMode ( ) const [pure virtual]

get the default display mode

Implemented in Gui::ViewProviderDocumentObject, Gui::ViewProviderExtern, MeshGui::ViewProviderFace, MeshGui::ViewProviderExport, MeshGui::ViewProviderMeshCurvature, MeshGui::ViewProviderMeshTransform, MeshGui::ViewProviderMeshTransformDemolding, PartGui::ViewProviderCrossSections, and PartGui::ViewProvider2DObject.

std::vector< std::string > ViewProvider::getDisplayMaskModes ( ) const [protected]

Returns a list of added display mask modes.

Definition at line 283 of file Gui/ViewProvider.cpp.

virtual std::vector<std::string> Gui::ViewProvider::getDisplayModes ( void ) const [pure virtual]

returns a list of all possible display modes

Implemented in Gui::ViewProviderAnnotation, Gui::ViewProviderAnnotationLabel, Gui::ViewProviderDocumentObject, Gui::ViewProviderDocumentObjectGroup, Gui::ViewProviderExtern, Gui::ViewProviderInventorObject, Gui::ViewProviderMeasureDistance, Gui::ViewProviderVRMLObject, DrawingGui::ViewProviderDrawingPage, DrawingGui::ViewProviderDrawingView, FemGui::ViewProviderFemMesh, ImageGui::ViewProviderImagePlane, InspectionGui::ViewProviderInspection, MeshGui::ViewProviderFace, MeshGui::ViewProviderExport, MeshGui::ViewProviderMesh, MeshGui::ViewProviderMeshCurvature, MeshGui::ViewProviderMeshNode, MeshGui::ViewProviderMeshTransform, MeshGui::ViewProviderMeshTransformDemolding, PartGui::ViewProviderCrossSections, PartGui::ViewProviderPartBase, PartGui::ViewProvider2DObject, PartGui::ViewProviderBox, PartGui::ViewProviderCurveNet, PartGui::ViewProviderPartExt, PartGui::ViewProviderPartReference, PointsGui::ViewProviderPoints, RobotGui::ViewProviderRobotObject, and RobotGui::ViewProviderTrajectory.

Referenced by Gui::ViewProviderPy::listDisplayModes().

int ViewProvider::getEditingMode ( ) const [protected]

return the edit mode or -1 if nothing is being edited

Definition at line 99 of file Gui/ViewProvider.cpp.

Referenced by MeshGui::ViewProviderMesh::clipMeshCallback(), PointsGui::ViewProviderPoints::clipPointsCallback(), isEditing(), MeshGui::ViewProviderMesh::partMeshCallback(), MeshGui::ViewProviderMesh::segmMeshCallback(), MeshGui::ViewProviderMesh::selectGLCallback(), and Gui::ViewProviderGeometryObject::unsetEditViewer().

virtual std::string Gui::ViewProvider::getElement ( const SoPickedPoint * ) const [inline, virtual]

return a hit element to the selection path or 0

Reimplemented in PartGui::ViewProviderPartExt.

Definition at line 106 of file Gui/ViewProvider.h.

Referenced by Gui::View3DInventorPy::getObjectInfo(), Gui::View3DInventorPy::getObjectsInfo(), and Gui::SoFCUnifiedSelection::handleEvent().

virtual SoSeparator* Gui::ViewProvider::getFrontRoot ( void ) const [inline, virtual]

Reimplemented in InspectionGui::ViewProviderInspection, and MeshGui::ViewProviderMeshCurvature.

Definition at line 90 of file Gui/ViewProvider.h.

Referenced by Gui::View3DInventorViewer::addViewProvider(), Gui::ViewProviderDocumentObject::findFrontRootOfType(), and Gui::View3DInventorViewer::removeViewProvider().

QIcon ViewProvider::getIcon ( void ) const [virtual]

deliver the icon shown in the tree view

Reimplemented in Gui::ViewProviderDocumentObjectGroup, InspectionGui::ViewProviderInspection, InspectionGui::ViewProviderInspectionGroup, MeshGui::ViewProviderExport, MeshGui::ViewProviderMesh, MeshGui::ViewProviderMeshCurvature, MeshGui::ViewProviderMeshNode, PartGui::ViewProviderBoolean, PartGui::ViewProviderMultiFuse, PartGui::ViewProviderMultiCommon, and PointsGui::ViewProviderPoints.

Definition at line 236 of file Gui/ViewProvider.cpp.

References Gui::BitmapFactory(), Gui::BitmapFactoryInst::pixmap(), and sPixmap.

Referenced by Gui::ViewProviderIndex::data(), PartGui::DlgExtrusion::findShapes(), InspectionGui::ViewProviderInspection::getIcon(), Gui::DocumentItem::slotNewObject(), Gui::DocumentObjectItem::testStatus(), and InspectionGui::VisualInspection::VisualInspection().

SoPickedPoint * ViewProvider::getPointOnRay	(	const SbVec3f &	pos,
		const SbVec3f &	dir,
		const View3DInventorViewer &	viewer
	)			const `[protected]`

Helper method to get picked entities while editing.

Definition at line 355 of file Gui/ViewProvider.cpp.

References pcRoot.

const App::PropertyData & Gui::ViewProvider::getPropertyData ( void ) const [protected, virtual]

Reimplemented from App::PropertyContainer.

Definition at line 61 of file Gui/ViewProvider.cpp.

const App::PropertyData * Gui::ViewProvider::getPropertyDataPtr ( void ) [static, protected]

Reimplemented from App::PropertyContainer.

Definition at line 61 of file Gui/ViewProvider.cpp.

PyObject * ViewProvider::getPyObject ( void ) [virtual]

This method returns the Python wrapper for a C++ object.

It's in the responsibility of the programmer to do the correct reference counting. Basically there are two ways how to implement that: Either always return a new Python object then reference counting is not a matter or return always the same Python object then the reference counter must be incremented by one. However, it's absolutely forbidden to return always the same Python object without incrementing the reference counter.

The default implementation returns 'None'.

Reimplemented from Base::BaseClass.

Reimplemented in Gui::ViewProviderDocumentObject.

Definition at line 347 of file Gui/ViewProvider.cpp.

References Base::PyObjectBase::IncRef(), and pyViewObject.

Referenced by Gui::DocumentPy::activeObject(), Gui::DocumentPy::getActiveObject(), Gui::DocumentPy::getCustomAttributes(), and Gui::DocumentPy::getObject().

virtual SoSeparator* Gui::ViewProvider::getRoot ( void ) [inline, virtual]

Reimplemented in MeshGui::ViewProviderExport.

Definition at line 86 of file Gui/ViewProvider.h.

Referenced by Gui::View3DInventorViewer::addViewProvider(), Gui::SoFCUnifiedSelection::doAction(), Gui::ViewProviderPy::getRootNode(), Gui::SoFCUnifiedSelection::handleEvent(), Gui::View3DInventorViewer::removeViewProvider(), SketcherGui::ViewProviderCustom::updateData(), and PartGui::ViewProviderCustom::updateData().

virtual std::vector<Base::Vector3d> Gui::ViewProvider::getSelectionShape ( const char * Element ) const [inline, virtual]

return the higlight lines for a given element or the whole shape

Reimplemented in PartGui::ViewProviderPartExt.

Definition at line 108 of file Gui/ViewProvider.h.

virtual void Gui::ViewProvider::getTaskViewContent ( std::vector< Gui::TaskView::TaskContent * > & ) const [inline, virtual]

get a list of TaskBoxes associated with this object

Reimplemented in Gui::ViewProviderDocumentObject.

Definition at line 213 of file Gui/ViewProvider.h.

Base::Type Gui::ViewProvider::getTypeId ( void ) const [virtual]

Reimplemented from App::PropertyContainer.

Definition at line 61 of file Gui/ViewProvider.cpp.

Referenced by MeshGui::ViewProviderMeshCurvature::curvatureInfoCallback(), Gui::Document::exportObjects(), MeshGui::ViewProviderMesh::faceInfoCallback(), MeshGui::ViewProviderMesh::fillHoleCallback(), Gui::ViewProviderDocumentObjectGroup::getViewProviders(), Gui::Document::importObjects(), InspectionGui::ViewProviderInspection::inspectCallback(), MeshGui::ViewProviderMesh::markPartCallback(), Gui::Document::setHide(), Gui::Document::setShow(), PartGui::ViewProviderPartBase::shapeInfoCallback(), Gui::Document::slotDeletedObject(), SketcherGui::ViewProviderCustom::updateData(), and PartGui::ViewProviderCustom::updateData().

void ViewProvider::hide ( void ) [virtual]

Hides the view provider.

Reimplemented in Gui::ViewProviderDocumentObject, Gui::ViewProviderDocumentObjectGroup, InspectionGui::ViewProviderInspection, and MeshGui::ViewProviderMeshCurvature.

Definition at line 307 of file Gui/ViewProvider.cpp.

References pcModeSwitch.

Referenced by Gui::ViewProviderPy::hide(), Gui::ViewProviderDocumentObjectGroup::hide(), Gui::Application::hideViewProvider(), Gui::MergeDocuments::importObject(), Gui::ViewProviderDocumentObject::setActiveMode(), PartGui::DlgFilletEdges::setupFillet(), setVisible(), and update().

void Gui::ViewProvider::init ( void ) [static]

Reimplemented from App::PropertyContainer.

Definition at line 61 of file Gui/ViewProvider.cpp.

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

bool ViewProvider::isEditing ( ) const

Definition at line 104 of file Gui/ViewProvider.cpp.

References getEditingMode().

Referenced by Gui::TreeWidget::contextMenuEvent(), Gui::ViewProviderPy::isEditing(), and SketcherGui::ViewProviderSketch::isSelectable().

virtual bool Gui::ViewProvider::isSelectable ( void ) const [inline, virtual]

indicates if the ViewProvider can be selected

Reimplemented in Gui::ViewProviderGeometryObject, and SketcherGui::ViewProviderSketch.

Definition at line 104 of file Gui/ViewProvider.h.

Referenced by Gui::SoFCUnifiedSelection::doAction(), and Gui::SoFCUnifiedSelection::handleEvent().

bool ViewProvider::isShow ( void ) const [virtual]

checks whether the view provider is visible or not

Reimplemented in Gui::ViewProviderDocumentObjectGroup.

Definition at line 317 of file Gui/ViewProvider.cpp.

References pcModeSwitch.

Referenced by Gui::Document::isShow(), isVisible(), Gui::DocumentObjectItem::testStatus(), update(), and Gui::ViewProviderDocumentObject::updateView().

bool ViewProvider::isUpdatesEnabled ( ) const

Definition at line 132 of file Gui/ViewProvider.cpp.

Referenced by update().

bool ViewProvider::isVisible ( ) const

Definition at line 327 of file Gui/ViewProvider.cpp.

References isShow().

Referenced by CmdMeshPolyCut::activated(), and CmdMeshPolySegm::activated().

virtual bool Gui::ViewProvider::keyPressed	(	bool	pressed,
		int	key
	)			`[inline, virtual]`

is called when the provider is in edit and a key event occurs. Only ESC ends edit.

Reimplemented in SketcherGui::ViewProviderSketch.

Definition at line 217 of file Gui/ViewProvider.h.

virtual bool Gui::ViewProvider::mouseButtonPressed	(	int	Button,
		bool	pressed,
		const SbVec3f &	pos,
		const SbVec3f &	norm,
		const SoPickedPoint *	pp
	)			`[inline, virtual]`

is called when the Provider is in edit and the mouse is clicked

Reimplemented in SketcherGui::ViewProviderSketch.

Definition at line 224 of file Gui/ViewProvider.h.

virtual bool Gui::ViewProvider::mouseMove	(	const SbVec3f &	pos,
		const SbVec3f &	norm,
		const SoPickedPoint *	pp
	)			`[inline, virtual]`

is called when the provider is in edit and the mouse is moved

Reimplemented in SketcherGui::ViewProviderSketch.

Definition at line 221 of file Gui/ViewProvider.h.

void ViewProvider::onChanged ( const App::Property * prop ) [protected, virtual]

Reimplemented from subclass.

Reimplemented from App::PropertyContainer.

Reimplemented in Gui::ViewProviderAnnotation, Gui::ViewProviderAnnotationLabel, Gui::ViewProviderDocumentObject, Gui::ViewProviderDocumentObjectGroup, Gui::ViewProviderGeometryObject, Gui::ViewProviderMeasureDistance, FemGui::ViewProviderFemMesh, InspectionGui::ViewProviderInspection, MeshGui::ViewProviderMesh, MeshGui::ViewProviderMeshCurvature, MeshGui::ViewProviderMeshDefects, MeshGui::ViewProviderMeshNode, PartGui::ViewProviderPartBase, PartGui::ViewProvider2DObject, PartGui::ViewProviderPartExt, PartGui::ViewProviderCustom, PartGui::ViewProviderPartReference, PointsGui::ViewProviderPoints, RobotGui::ViewProviderRobotObject, SketcherGui::ViewProviderCustom, and SketcherGui::ViewProviderSketch.

Definition at line 337 of file Gui/ViewProvider.cpp.

References Gui::Application::Instance, and Gui::Application::signalChangedObject.

virtual bool Gui::ViewProvider::onDelete ( const std::vector< std::string > & ) [inline, virtual]

get called if the object is about to get deleted. Here you can delete other objects to or switch visibility of others.

Reimplemented in Gui::ViewProviderDocumentObjectGroup, PartDesignGui::ViewProviderFillet, PartDesignGui::ViewProviderPad, PartDesignGui::ViewProviderPocket, PartDesignGui::ViewProviderRevolution, and SketcherGui::ViewProviderSketch.

Definition at line 111 of file Gui/ViewProvider.h.

Referenced by StdCmdDelete::activated().

void ViewProvider::setDefaultMode ( int val ) [protected]

Definition at line 332 of file Gui/ViewProvider.cpp.

void ViewProvider::setDisplayMaskMode ( const char * type ) [protected]

Activates the display mask mode type.

Definition at line 273 of file Gui/ViewProvider.cpp.

References pcModeSwitch.

void ViewProvider::setDisplayMode ( const char * ModeName ) [virtual]

set the display mode

If you add new viewing modes in getDisplayModes() then you need to reimplement also seDisplaytMode() to handle these new modes by setting the appropriate display mode.

Reimplemented in Gui::ViewProviderAnnotation, Gui::ViewProviderAnnotationLabel, Gui::ViewProviderInventorObject, Gui::ViewProviderMeasureDistance, Gui::ViewProviderVRMLObject, DrawingGui::ViewProviderDrawingPage, DrawingGui::ViewProviderDrawingView, FemGui::ViewProviderFemMesh, ImageGui::ViewProviderImagePlane, InspectionGui::ViewProviderInspection, MeshGui::ViewProviderFace, MeshGui::ViewProviderMesh, MeshGui::ViewProviderMeshCurvature, MeshGui::ViewProviderMeshNode, MeshGui::ViewProviderMeshTransform, MeshGui::ViewProviderMeshTransformDemolding, PartGui::ViewProviderPartBase, PartGui::ViewProviderCurveNet, PartGui::ViewProviderPartExt, PartGui::ViewProviderPartReference, PointsGui::ViewProviderPoints, RobotGui::ViewProviderRobotObject, and RobotGui::ViewProviderTrajectory.