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>

Public Member Functions
virtual bool	canAddToSceneGraph () const
	Indicate whether to be added to scene graph or not. More...
virtual std::vector< App::DocumentObject * >	claimChildren3D (void) const
	deliver the children belonging to this object this method is used to deliver the objects to the 3DView which should be grouped under its scene graph. More...
SoSeparator *	getAnnotation (void)
virtual SoSeparator *	getBackRoot (void) const
virtual SoGroup *	getChildRoot (void) const
virtual SoSeparator *	getFrontRoot (void) const
SoSwitch *	getModeSwitch (void) const
virtual SoSeparator *	getRoot (void) const
SoTransform *	getTransformNode () const
	ViewProvider ()
	constructor. More...
virtual	~ViewProvider ()
	destructor. More...
Selection handling
This group of methods do the selection handling. Here you can define how the selection for your ViewProfider works.
virtual bool	useNewSelectionModel (void) const
	indicates if the ViewProvider use the new Selection model More...
virtual bool	isSelectable (void) const
virtual bool	getElementPicked (const SoPickedPoint *, std::string &subname) const
	return a hit element given the picked point which contains the full node path More...
virtual std::string	getElement (const SoDetail *) const
	return a hit element to the selection path or 0 More...
virtual SoDetail *	getDetail (const char *) const
	return the coin node detail of the subelement More...
virtual bool	getDetailPath (const char *subname, SoFullPath *pPath, bool append, SoDetail *&det) const
	return the coin node detail and path to the node of the subelement More...
int	partialRender (const std::vector< std::string > &subelements, bool clear)
	partial rendering setup More...
virtual std::vector< Base::Vector3d >	getModelPoints (const SoPickedPoint *) const
virtual std::vector< Base::Vector3d >	getSelectionShape (const char *Element) const
	return the highlight lines for a given element or the whole shape More...
Base::BoundBox3d	getBoundingBox (const char *subname=nullptr, bool transform=true, MDIView *view=nullptr) const
	Return the bound box of this view object. More...
virtual bool	onDelete (const std::vector< std::string > &subNames)
	Get called if the object is about to get deleted. More...
virtual void	beforeDelete ()
	Called before deletion. More...
virtual bool	canDelete (App::DocumentObject *obj) const
	Asks the view provider if the given object that is part of its outlist can be removed from there without breaking it. More...
Drag and drop
To enable drag and drop you have to re-implement canDragObjects() and canDropObjects() to return true. For finer control you can also re-implement canDragObject() or canDropObject() to filter certain object types, by default these methods don't filter any types. To take action of drag and drop the method dragObject() and dropObject() must be re-implemented, too.
virtual bool	canDragObjects () const
	Check whether children can be removed from the view provider by drag and drop. More...
virtual bool	canDragObject (App::DocumentObject *) const
	Check whether the object can be removed from the view provider by drag and drop. More...
virtual void	dragObject (App::DocumentObject *)
	Remove a child from the view provider by drag and drop. More...
virtual bool	canDropObjects () const
	Check whether objects can be added to the view provider by drag and drop or drop only. More...
virtual bool	canDropObject (App::DocumentObject *) const
	Check whether the object can be dropped to the view provider by drag and drop or drop only. More...
virtual bool	canDragAndDropObject (App::DocumentObject *) const
	Return false to force drop only operation for a given object. More...
virtual void	dropObject (App::DocumentObject *)
	Add an object to the view provider by drag and drop. More...
virtual bool	canDropObjectEx (App::DocumentObject *obj, App::DocumentObject *owner, const char *subname, const std::vector< std::string > &elements) const
	Query object dropping with full qualified name. More...
virtual std::string	getDropPrefix () const
	return a subname referencing the sub-object holding the dropped objects More...
virtual std::string	dropObjectEx (App::DocumentObject *obj, App::DocumentObject *owner, const char *subname, const std::vector< std::string > &elements)
	Add an object with full qualified name to the view provider by drag and drop. More...
virtual int	replaceObject (App::DocumentObject *oldObj, App::DocumentObject *newObj)
	Replace an object to the view provider by drag and drop. More...
virtual bool	showInTree () const
	Tell the tree view if this object should appear there. More...
virtual bool	canRemoveChildrenFromRoot () const
	Tell the tree view to remove children items from the tree root. More...
Display mode methods
std::string	getActiveDisplayMode (void) const
virtual void	setDisplayMode (const char *ModeName)
	set the display mode More...
virtual const char *	getDefaultDisplayMode () const
	get the default display mode More...
virtual std::vector< std::string >	getDisplayModes (void) const
	returns a list of all possible display modes More...
virtual void	hide (void)
	Hides the view provider. More...
virtual void	show (void)
	Shows the view provider. More...
virtual bool	isShow (void) const
	checks whether the view provider is visible or not More...
void	setVisible (bool)
bool	isVisible () const
void	setLinkVisible (bool)
bool	isLinkVisible () const
virtual void	setOverrideMode (const std::string &mode)
	Overrides the display mode with mode. More...
const std::string	getOverrideMode ()
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 More...
virtual bool	keyPressed (bool pressed, int key)
	is called when the provider is in edit and a key event occurs. Only ESC ends edit. More...
virtual const char *	getTransactionText () const
	Is called by the tree if the user double clicks on the object. More...
virtual bool	doubleClicked (void)
	is called by the tree if the user double clicks on the object More...
virtual bool	mouseMove (const SbVec2s &cursorPos, View3DInventorViewer *viewer)
	is called when the provider is in edit and the mouse is moved More...
virtual bool	mouseButtonPressed (int button, bool pressed, const SbVec2s &cursorPos, const View3DInventorViewer *viewer)
	is called when the Provider is in edit and the mouse is clicked More...
virtual bool	mouseWheelEvent (int delta, const SbVec2s &cursorPos, const View3DInventorViewer *viewer)
virtual void	setupContextMenu (QMenu *, QObject *, const char *)
	set up the context-menu with the supported edit modes More...
Public Member Functions inherited from App::TransactionalObject
virtual const char *	detachFromDocument ()
virtual bool	isAttachedToDocument () const
	TransactionalObject (void)
	Constructor. More...
virtual	~TransactionalObject ()
Public Member Functions inherited from App::ExtensionContainer
ExtensionIterator	extensionBegin ()
	ExtensionContainer ()
ExtensionIterator	extensionEnd ()
App::Extension *	getExtension (Base::Type, bool derived=true, bool no_except=false) const
App::Extension *	getExtension (const std::string &name) const
template<typename ExtensionT >
ExtensionT *	getExtensionByType (bool no_except=false, bool derived=true) const
std::vector< Extension * >	getExtensionsDerivedFrom (Base::Type type) const
template<typename ExtensionT >
std::vector< ExtensionT * >	getExtensionsDerivedFromType () const
bool	hasExtension (Base::Type, bool derived=true) const
bool	hasExtension (const std::string &name) const
bool	hasExtensions () const
void	registerExtension (Base::Type extension, App::Extension *ext)
virtual	~ExtensionContainer ()
virtual Property *	getPropertyByName (const char *name) const override
	find a property by its name More...
virtual const char *	getPropertyName (const Property *prop) const override
	get the name of a property More...
virtual void	getPropertyMap (std::map< std::string, Property * > &Map) const override
	get all properties of the class (including properties of the parent) More...
virtual void	getPropertyList (std::vector< Property * > &List) const override
	get all properties of the class (including properties of the parent) More...
virtual short	getPropertyType (const Property *prop) const override
	get the Type of a Property More...
virtual short	getPropertyType (const char *name) const override
	get the Type of a named Property More...
virtual const char *	getPropertyGroup (const Property *prop) const override
	get the Group of a Property More...
virtual const char *	getPropertyGroup (const char *name) const override
	get the Group of a named Property More...
virtual const char *	getPropertyDocumentation (const Property *prop) const override
	get the Group of a Property More...
virtual const char *	getPropertyDocumentation (const char *name) const override
	get the Group of a named Property More...
virtual void	Save (Base::Writer &writer) const override
	This method is used to save properties to an XML document. More...
void	saveExtensions (Base::Writer &writer) const
void	restoreExtensions (Base::XMLReader &reader)
Public Member Functions inherited from App::PropertyContainer
virtual App::Property *	addDynamicProperty (const char *type, const char *name=nullptr, const char *group=nullptr, const char *doc=nullptr, short attr=0, bool ro=false, bool hidden=false)
bool	changeDynamicProperty (const Property *prop, const char *group, const char *doc)
virtual void	editProperty (const char *)
virtual App::Property *	getDynamicPropertyByName (const char *name) const
DynamicProperty::PropData	getDynamicPropertyData (const Property *prop) const
virtual std::vector< std::string >	getDynamicPropertyNames () const
virtual std::string	getFullName () const
virtual unsigned int	getMemSize (void) const
	This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? More...
virtual Property *	getPropertyByName (const char *name) const
	find a property by its name More...
virtual const char *	getPropertyDocumentation (const char *name) const
	get the Group of a named Property More...
virtual const char *	getPropertyDocumentation (const Property *prop) const
	get the Group of a Property More...
virtual const char *	getPropertyGroup (const char *name) const
	get the Group of a named Property More...
virtual const char *	getPropertyGroup (const Property *prop) const
	get the Group of a Property More...
virtual void	getPropertyList (std::vector< Property * > &List) const
	get all properties of the class (including properties of the parent) More...
virtual void	getPropertyMap (std::map< std::string, Property * > &Map) const
	get all properties of the class (including properties of the parent) More...
virtual const char *	getPropertyName (const Property *prop) const
	get the name of a property More...
virtual void	getPropertyNamedList (std::vector< std::pair< const char *, Property * > > &List) const
	get all properties with their names, may contain duplicates and aliases More...
const char *	getPropertyPrefix () const
virtual short	getPropertyType (const char *name) const
	get the Type of a named Property More...
virtual short	getPropertyType (const Property *prop) const
	get the Type of a Property More...
bool	isHidden (const char *name) const
	check if the named property is hidden More...
bool	isHidden (const Property *prop) const
	check if the property is hidden More...
bool	isReadOnly (const char *name) const
	check if the named property is read-only More...
bool	isReadOnly (const Property *prop) const
	check if the property is read-only More...
virtual void	onPropertyStatusChanged (const Property &prop, unsigned long oldStatus)
	PropertyContainer ()
	A constructor. More...
virtual bool	removeDynamicProperty (const char *name)
virtual void	Restore (Base::XMLReader &reader)
	This method is used to restore properties from an XML document. More...
virtual void	Save (Base::Writer &writer) const
	This method is used to save properties to an XML document. More...
void	setPropertyPrefix (const char *prefix)
void	setPropertyStatus (unsigned char bit, bool value)
	set the Status bit of all properties at once More...
virtual	~PropertyContainer ()
	A destructor. More...
Public Member Functions inherited from Base::Persistence
void	dumpToStream (std::ostream &stream, int compression)
virtual unsigned int	getMemSize () const =0
	This method is used to get the size of objects It is not meant to have the exact size, it is more or less an estimation which runs fast! Is it two bytes or a GB? More...
virtual Base::Type	getTypeId (void) const
virtual void	Restore (XMLReader &)=0
	This method is used to restore properties from an XML document. More...
virtual void	RestoreDocFile (Reader &)
	This method is used to restore large amounts of data from a file In this method you simply stream in your SaveDocFile() saved data. More...
void	restoreFromStream (std::istream &stream)
virtual void	Save (Writer &) const =0
	This method is used to save properties to an XML document. More...
virtual void	SaveDocFile (Writer &) const
	This method is used to save large amounts of data to a binary file. More...
Public Member Functions inherited from Base::BaseClass
	BaseClass ()
	Construction. More...
	BaseClass (const BaseClass &)=default
virtual PyObject *	getPyObject ()
	This method returns the Python wrapper for a C++ object. More...
virtual Type	getTypeId () const
bool	isDerivedFrom (const Type type) const
BaseClass &	operator= (const BaseClass &)=default
virtual void	setPyObject (PyObject *)
virtual	~BaseClass ()
	Destruction. More...

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 }
virtual ViewProvider *	startEditing (int ModNum=0)
bool	isEditing () const
void	finishEditing ()
virtual void	setEditViewer (View3DInventorViewer *, int ModNum)
	adjust viewer settings when editing a view provider More...
virtual void	unsetEditViewer (View3DInventorViewer *)
	restores viewer settings when leaving editing mode More...
virtual bool	setEdit (int ModNum)
	is called by the document when the provider goes in edit mode More...
virtual void	unsetEdit (int ModNum)
	is called when you lose the edit mode More...
int	getEditingMode () const
	return the edit mode or -1 if nothing is being edited More...

Signals of the view provider
boost::signals2::signal< void()>	signalChangeIcon
	signal on icon change More...
boost::signals2::signal< void(const QString &)>	signalChangeToolTip
	signal on tooltip change More...
boost::signals2::signal< void(const QString &)>	signalChangeStatusTip
	signal on status tip change More...
virtual void	update (const App::Property *)
	update the content of the ViewProvider this method have to implement the recalculation of the ViewProvider. More...
virtual void	updateData (const App::Property *)
bool	isUpdatesEnabled () const
void	setUpdatesEnabled (bool enable)
unsigned long	getStatus () const
	return the status bits More...
bool	testStatus (ViewStatus pos) const
void	setStatus (ViewStatus pos, bool on)
std::string	toString () const
PyObject *	getPyObject ()
	This method returns the Python wrapper for a C++ object. More...

Methods used by the Tree
If you want to take control over the viewprovider specific overlay icons, that will be grayed out together with the base icon, you can reimplement this method.
SoSeparator *	pcRoot
	The root Separator of the ViewProvider. More...
SoTransform *	pcTransform
	this is transformation for the provider More...
const char *	sPixmap
SoSwitch *	pcModeSwitch
	this is the mode switch, all the different viewing modes are collected here More...
SoSeparator *	pcAnnotation
	The root separator for annotations. More...
ViewProviderPy *	pyViewObject
std::string	overrideMode
std::bitset< 32 >	StatusBits
virtual QIcon	getIcon (void) const
	deliver the icon shown in the tree view More...
virtual QIcon	mergeColorfulOverlayIcons (const QIcon &orig) const
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. More...
virtual QIcon	mergeGreyableOverlayIcons (const QIcon &orig) const
virtual void	setModeSwitch ()
	Turn on mode switch. More...

Color management methods
virtual std::map< std::string, App::Color >	getElementColors (const char *element=nullptr) const
virtual void	setElementColors (const std::map< std::string, App::Color > &colors)
static const std::string &	hiddenMarker ()
static const char *	hasHiddenMarker (const char *subname)

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!
virtual void	setTransformation (const Base::Matrix4D &rcMatrix)
	set the viewing transformation of the provider More...
virtual void	setTransformation (const SbMatrix &rcMatrix)
virtual MDIView *	getMDIView () const
virtual void	Restore (Base::XMLReader &reader)
	This method is used to restore properties from an XML document. More...
bool	isRestoring ()
static SbMatrix	convert (const Base::Matrix4D &rcMatrix)
static Base::Matrix4D	convert (const SbMatrix &sbMat)
static void	eventCallback (void *ud, SoEventCallback *node)

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. More...
void	setDisplayMaskMode (const char *type)
	Activates the display mask mode type. More...
SoNode *	getDisplayMaskMode (const char *type) const
	Get the node to the display mask mode type. More...
std::vector< std::string >	getDisplayMaskModes () const
	Returns a list of added display mask modes. More...
void	setDefaultMode (int)
int	getDefaultMode () const
virtual void	setRenderCacheMode (int)
bool	checkRecursion (SoNode *)
	Helper method to check that the node is valid, i.e. More...
SoPickedPoint *	getPointOnRay (const SbVec2s &pos, const View3DInventorViewer *viewer) const
	Helper method to get picked entities while editing. More...
SoPickedPoint *	getPointOnRay (const SbVec3f &pos, const SbVec3f &dir, const View3DInventorViewer *viewer) const
	Helper method to get picked entities while editing. More...
void	onBeforeChange (const App::Property *prop)
	Reimplemented from subclass. More...
void	onChanged (const App::Property *prop)
	Reimplemented from subclass. More...

Additional Inherited Members
Public Types inherited from App::ExtensionContainer
typedef std::map< Base::Type, App::Extension * >::iterator	ExtensionIterator
Static Public Member Functions inherited from Base::Persistence
static void *	create (void)
static std::string	encodeAttribute (const std::string &)
	Encodes an attribute upon saving. More...
static Base::Type	getClassTypeId (void)
static void	init (void)
Static Public Member Functions inherited from Base::BaseClass
static void *	create ()
static Type	getClassTypeId ()
static void	init ()
Protected Member Functions inherited from App::TransactionalObject
void	onBeforeChangeProperty (Document *doc, const Property *prop)
Protected Member Functions inherited from App::PropertyContainer
virtual const PropertyData &	getPropertyData (void) const
virtual void	handleChangedPropertyName (Base::XMLReader &reader, const char *TypeName, const char *PropName)
	PropertyContainer::handleChangedPropertyName is called during restore to possibly fix reading of older versions of this property container. More...
virtual void	handleChangedPropertyType (Base::XMLReader &reader, const char *TypeName, Property *prop)
	PropertyContainer::handleChangedPropertyType is called during restore to possibly fix reading of older versions of the property container. More...
virtual void	onBeforeChange (const Property *)
	get called before the value is changed More...
virtual void	onChanged (const Property *)
	get called by the container when a property has changed More...
Static Protected Member Functions inherited from App::PropertyContainer
static const PropertyData *	getPropertyDataPtr (void)
Static Protected Member Functions inherited from Base::BaseClass
static void	initSubclass (Base::Type &toInit, const char *ClassName, const char *ParentName, Type::instantiationMethod method=nullptr)
Protected Attributes inherited from App::PropertyContainer
DynamicProperty	dynamicProps

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.

Member Enumeration Documentation

EditMode

enum Gui::ViewProvider::EditMode

Enumerator
Default
Transform
Cutting
Color

Constructor & Destructor Documentation

ViewProvider()

ViewProvider::ViewProvider

(

)

constructor.

References Gui::UpdateData.

~ViewProvider()

ViewProvider::~ViewProvider ( )

virtual

destructor.

Reimplemented in PartDesignGui::ViewProvider.

References pcAnnotation, pcModeSwitch, pcRoot, pcTransform, and pyViewObject.

Member Function Documentation

addDisplayMaskMode()

void ViewProvider::addDisplayMaskMode	(	SoNode *	node,
		const char *	type
	)

Adds a new display mask mode.

References pcModeSwitch.

Referenced by Gui::ViewProviderAnnotation::attach(), Gui::ViewProviderAnnotationLabel::attach(), Gui::ViewProviderMeasureDistance::attach(), Gui::ViewProviderOriginFeature::attach(), FemGui::ViewProviderFemConstraint::attach(), MeshGui::ViewProviderMesh::attach(), MeshGui::ViewProviderMeshTransform::attach(), MeshGui::ViewProviderMeshTransformDemolding::attach(), PartGui::ViewProviderCurveNet::attach(), PartGui::ViewProviderPartReference::attach(), PartDesignGui::ViewProviderAddSub::attach(), PointsGui::ViewProviderScattered::attach(), PointsGui::ViewProviderStructured::attach(), Gui::ViewProviderPlacement::attach(), PartGui::ViewProviderPartExt::attach(), PartDesignGui::ViewProviderDatum::attach(), MeshGui::ViewProviderFace::attach(), InspectionGui::ViewProviderInspection::attach(), MeshGui::ViewProviderMeshNode::attach(), MeshGui::ViewProviderMeshCurvature::attach(), MeshGui::ViewProviderMeshOrientation::attach(), MeshGui::ViewProviderMeshNonManifolds::attach(), MeshGui::ViewProviderMeshNonManifoldPoints::attach(), MeshGui::ViewProviderMeshDuplicatedFaces::attach(), MeshGui::ViewProviderMeshDegenerations::attach(), MeshGui::ViewProviderMeshDuplicatedPoints::attach(), MeshGui::ViewProviderMeshIndices::attach(), MeshGui::ViewProviderMeshSelfIntersections::attach(), MeshGui::ViewProviderMeshFolds::attach(), Gui::ViewProviderLink::attach(), Gui::ViewProviderInventorObject::attach(), Gui::ViewProviderOrigin::attach(), Gui::ViewProviderVRMLObject::attach(), FemGui::ViewProviderFemMesh::attach(), FemGui::ViewProviderFemPostFunction::attach(), FemGui::ViewProviderFemPostObject::attach(), ImageGui::ViewProviderImagePlane::attach(), PathGui::ViewProviderPath::attach(), RobotGui::ViewProviderRobotObject::attach(), RobotGui::ViewProviderTrajectory::attach(), Gui::ViewProviderGeoFeatureGroupExtension::extensionAttach(), and Gui::ViewProviderExtern::setModeBySoInput().

beforeDelete()

void ViewProvider::beforeDelete ( )

virtual

Called before deletion.

Unlike onDelete(), this function is guaranteed to be called before deletion, either by Document::remObject(), or on document deletion.

Reimplemented in SpreadsheetGui::ViewProviderSheet.

Referenced by Gui::ViewProviderLink::onBeforeChange(), and Gui::Document::slotDeletedObject().

canAddToSceneGraph()

virtual bool Gui::ViewProvider::canAddToSceneGraph ( ) const

virtual

Indicate whether to be added to scene graph or not.

Referenced by Gui::View3DInventorViewer::addViewProvider(), and Gui::Document::toggleInSceneGraph().

canDelete()

bool ViewProvider::canDelete ( App::DocumentObject *  obj ) const

virtual

Asks the view provider if the given object that is part of its outlist can be removed from there without breaking it.

Parameters

obj	is part of the outlist of the object associated to the view provider

Returns

true if the removal is approved by the view provider.

Reimplemented in FemGui::ViewProviderFemAnalysis, FemGui::ViewProviderFemPostFunctionProvider, FemGui::ViewProviderFemPostObject, FemGui::ViewProviderSolver, TechDrawGui::ViewProviderBalloon, TechDrawGui::ViewProviderDimension, TechDrawGui::ViewProviderLeader, TechDrawGui::ViewProviderProjGroup, TechDrawGui::ViewProviderProjGroupItem, TechDrawGui::ViewProviderRichAnno, TechDrawGui::ViewProviderTile, TechDrawGui::ViewProviderViewClip, TechDrawGui::ViewProviderViewPart, TechDrawGui::ViewProviderViewSection, TechDrawGui::ViewProviderWeld, Gui::ViewProviderDocumentObject, Gui::ViewProviderLink, TechDrawGui::ViewProviderGeomHatch, TechDrawGui::ViewProviderHatch, and TechDrawGui::ViewProviderPage.

Referenced by StdCmdDelete::activated().

canDragAndDropObject()

bool ViewProvider::canDragAndDropObject ( App::DocumentObject *  obj ) const

virtual

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

Reimplemented in Gui::ViewProviderLink, and PartDesignGui::ViewProviderSubShapeBinder.

Referenced by Gui::TreeWidget::dragMoveEvent(), and Gui::TreeWidget::dropEvent().

canDragObject()

bool ViewProvider::canDragObject ( App::DocumentObject *  obj ) const

virtual

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

Reimplemented in FemGui::ViewProviderFemAnalysis, PartGui::ViewProviderMultiFuse, PartGui::ViewProviderMultiCommon, PartGui::ViewProviderCompound, PartGui::ViewProviderFace, PathGui::ViewProviderArea, PathGui::ViewProviderAreaView, PathGui::ViewProviderPathShape, and Gui::ViewProviderLink.

canDragObjects()

bool ViewProvider::canDragObjects ( ) const

virtual

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

Reimplemented in Gui::ViewProviderOrigin, FemGui::ViewProviderFemAnalysis, PartGui::ViewProviderMultiFuse, PartGui::ViewProviderMultiCommon, PartGui::ViewProviderCompound, PartGui::ViewProviderFace, PathGui::ViewProviderArea, PathGui::ViewProviderAreaView, PathGui::ViewProviderPathCompound, PathGui::ViewProviderPathShape, and Gui::ViewProviderLink.

canDropObject()

bool ViewProvider::canDropObject ( App::DocumentObject *  obj ) const

virtual

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

Reimplemented in FemGui::ViewProviderFemAnalysis, PartGui::ViewProviderMultiFuse, PartGui::ViewProviderMultiCommon, PartGui::ViewProviderCompound, PartGui::ViewProviderFace, PathGui::ViewProviderArea, PathGui::ViewProviderAreaView, PathGui::ViewProviderPathShape, and PartDesignGui::ViewProviderBody.

References Base::Console(), and Base::ConsoleSingleton::Log().

Referenced by Gui::ViewProviderDocumentObject::canDropObjectEx(), and canDropObjectEx().

canDropObjectEx()

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

virtual

Query object dropping with full qualified name.

Tree view now calls this function instead of canDropObject(), and may query for objects from other document. The default implementation (actually in ViewProviderDocumentObject) inhibites cross document dropping, and calls canDropObject(obj) for the rest. Override this function to enable cross document linking.

Parameters

obj	the object being dropped
owner	the (grand)parent object of the dropping object. Maybe null. This may not be the top parent object, as tree view will try to find a parent of the dropping object relative to this object to avoid cyclic dependency
subname	subname reference to the dropping object
elements	non-object sub-elements, e.g. Faces, Edges, selected when the object is being dropped

Returns

Return whether the dropping action is allowed.

Reimplemented in Gui::ViewProviderDocumentObject, PartDesignGui::ViewProviderSubShapeBinder, and Gui::ViewProviderLink.

References canDropObject().

canDropObjects()

bool ViewProvider::canDropObjects ( ) const

virtual

Check whether objects can be added to the view provider by drag and drop or drop only.

Reimplemented in FemGui::ViewProviderFemAnalysis, PartGui::ViewProviderMultiFuse, PartGui::ViewProviderMultiCommon, PartGui::ViewProviderCompound, PartGui::ViewProviderFace, PathGui::ViewProviderArea, PathGui::ViewProviderAreaView, PathGui::ViewProviderPathCompound, PathGui::ViewProviderPathShape, Gui::ViewProviderLink, PartDesignGui::ViewProviderBody, and PartDesignGui::ViewProviderSubShapeBinder.

Referenced by Gui::TreeWidget::dragMoveEvent(), and Gui::TreeWidget::dropEvent().

canRemoveChildrenFromRoot()

virtual bool Gui::ViewProvider::canRemoveChildrenFromRoot ( ) const

virtual

Tell the tree view to remove children items from the tree root.

Referenced by Gui::DocumentObjectData::DocumentObjectData().

checkRecursion()

bool ViewProvider::checkRecursion ( SoNode *  node )

protected

Helper method to check that the node is valid, i.e.

it must not cause and infinite recursion.

References Gui::addNodes().

Referenced by Gui::ViewProviderVRMLObject::updateData().

claimChildren()

std::vector< App::DocumentObject * > ViewProvider::claimChildren ( void  ) const

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 PartGui::ViewProviderCompound, PartGui::ViewProviderMirror, PartGui::ViewProviderFillet, PartGui::ViewProviderChamfer, PartGui::ViewProviderRuledSurface, Gui::ViewProviderOrigin, FemGui::ViewProviderFemAnalysis, FemGui::ViewProviderFemConstraint, FemGui::ViewProviderFemPostFunctionProvider, FemGui::ViewProviderFemPostPipeline, PartGui::ViewProviderBoolean, PartGui::ViewProviderMultiFuse, PartGui::ViewProviderMultiCommon, PartGui::ViewProviderExtrusion, PartGui::ViewProviderRevolution, PartGui::ViewProviderLoft, PartGui::ViewProviderSweep, PartGui::ViewProviderOffset, PartGui::ViewProviderThickness, PartGui::ViewProviderFace, PartDesignGui::ViewProviderHelix, PartDesignGui::ViewProviderHole, PartDesignGui::ViewProviderLoft, PartDesignGui::ViewProviderMainPart, PartDesignGui::ViewProviderMultiTransform, PartDesignGui::ViewProviderPipe, PartDesignGui::ViewProviderSketchBased, PathGui::ViewProviderArea, PathGui::ViewProviderAreaView, PathGui::ViewProviderPathCompound, PathGui::ViewProviderPathShape, RobotGui::ViewProviderTrajectoryCompound, RobotGui::ViewProviderTrajectoryDressUp, TechDrawGui::ViewProviderLeader, TechDrawGui::ViewProviderProjGroup, TechDrawGui::ViewProviderViewClip, TechDrawGui::ViewProviderViewPart, TechDrawGui::ViewProviderViewSection, TechDrawGui::ViewProviderWeld, Gui::ViewProviderLink, PartDesignGui::ViewProviderSubShapeBinder, and TechDrawGui::ViewProviderPage.

References draftgeoutils.general::vec().

Referenced by Gui::Document::addRootObjectsToGroup(), FemGui::ViewProviderFemAnalysis::claimChildren(), Gui::ViewProviderGeoFeatureGroupExtension::extensionClaimChildren(), FemGui::ViewProviderFemPostObject::onDelete(), FemGui::ViewProviderSolver::onDelete(), femviewprovider.view_mesh_gmsh.VPMeshGmsh::onDelete(), femviewprovider.view_result_mechanical.VPResultMechanical::onDelete(), BOPTools.JoinFeatures.ViewProviderConnect::onDelete(), BOPTools.SplitFeatures.ViewProviderBooleanFragments::onDelete(), BOPTools.SplitFeatures.ViewProviderSlice::onDelete(), BOPTools.SplitFeatures.ViewProviderXOR::onDelete(), and Gui::DocumentObjectData::updateChildren().

claimChildren3D()

std::vector< App::DocumentObject * > ViewProvider::claimChildren3D ( void  ) const

virtual

deliver the children belonging to this object this method is used to deliver the objects to the 3DView which should be grouped under its scene graph.

This affects the visibility and the 3D position of the object.

Reimplemented in Gui::ViewProviderOrigin, FemGui::ViewProviderFemPostFunctionProvider, and FemGui::ViewProviderFemPostPipeline.

References draftgeoutils.general::vec().

Referenced by Gui::LinkInfo::updateChildren().

convert() [1/2]

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

static

References Base::Matrix4D::getGLMatrix().

Referenced by Gui::ViewProviderLink::updateDataPrivate(), and Gui::ViewProviderLink::updateDraggingPlacement().

convert() [2/2]

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

static

doubleClicked()

virtual bool Gui::ViewProvider::doubleClicked ( void  )

virtual

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

Reimplemented in Gui::ViewProviderTextDocument, MeshGui::ViewProviderMesh, Gui::ViewProviderLink, PartDesignGui::ViewProviderSubShapeBinder, Gui::ViewProviderAnnotationLabel, Gui::ViewProviderMaterialObject, DrawingGui::ViewProviderDrawingPage, FemGui::ViewProviderFemAnalysis, FemGui::ViewProviderFemPostFunction, FemGui::ViewProviderFemPostObject, FemGui::ViewProviderSetElements, FemGui::ViewProviderSetFaces, FemGui::ViewProviderSetGeometry, FemGui::ViewProviderSetNodes, PartGui::ViewProviderPart, PartDesignGui::ViewProviderBase, RaytracingGui::ViewProviderLux, RaytracingGui::ViewProviderPovray, RobotGui::ViewProviderEdge2TracObject, TechDrawGui::ViewProviderBalloon, TechDrawGui::ViewProviderDimension, TechDrawGui::ViewProviderLeader, TechDrawGui::ViewProviderProjGroup, TechDrawGui::ViewProviderProjGroupItem, TechDrawGui::ViewProviderRichAnno, TechDrawGui::ViewProviderViewPart, TechDrawGui::ViewProviderViewSection, TechDrawGui::ViewProviderWeld, Gui::ViewProviderDragger, Gui::ViewProviderPart, PartDesignGui::ViewProvider, PartDesignGui::ViewProviderBody, PartDesignGui::ViewProviderDatum, SketcherGui::ViewProviderSketch, SpreadsheetGui::ViewProviderSheet, TechDrawGui::ViewProviderGeomHatch, TechDrawGui::ViewProviderHatch, and TechDrawGui::ViewProviderPage.

Referenced by Gui::ViewProviderLink::doubleClicked(), and Gui::TreeWidget::mouseDoubleClickEvent().

dragObject()

void ViewProvider::dragObject ( App::DocumentObject *  obj )

virtual

Remove a child from the view provider by drag and drop.

Reimplemented in FemGui::ViewProviderFemAnalysis, PartGui::ViewProviderMultiFuse, PartGui::ViewProviderMultiCommon, PartGui::ViewProviderCompound, PartGui::ViewProviderFace, PathGui::ViewProviderArea, PathGui::ViewProviderAreaView, PathGui::ViewProviderPathCompound, PathGui::ViewProviderPathShape, and Gui::ViewProviderLink.

Referenced by Gui::TreeWidget::dropEvent().

dropObject()

void ViewProvider::dropObject ( App::DocumentObject *  obj )

virtual

Add an object to the view provider by drag and drop.

Reimplemented in FemGui::ViewProviderFemAnalysis, PartGui::ViewProviderMultiFuse, PartGui::ViewProviderMultiCommon, PartGui::ViewProviderCompound, PartGui::ViewProviderFace, PathGui::ViewProviderArea, PathGui::ViewProviderAreaView, PathGui::ViewProviderPathCompound, PathGui::ViewProviderPathShape, and PartDesignGui::ViewProviderBody.

Referenced by dropObjectEx().

dropObjectEx()

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

virtual

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

Parameters

obj	the object being dropped
owner	the (grand)parent object of the dropping object. Maybe null. This may not be the top parent object, as tree view will try to find a parent of the dropping object relative to this object to avoid cyclic dependency
subname	subname reference to the dropping object
elements	non-object sub-elements, e.g. Faces, Edges, selected when the object is being dropped

Returns

Optionally returns a subname reference locating the dropped object, which may or may not be the actual dropped object, e.g. it may be a link.

Reimplemented in PartDesignGui::ViewProviderSubShapeBinder, and Gui::ViewProviderLink.

References dropObject().

Referenced by Gui::TreeWidget::dropEvent().

eventCallback()

void ViewProvider::eventCallback ( void *  ud, SoEventCallback *  node  )

static

References Gui::Application::activeDocument(), draftgeoutils.faces::bind(), Base::Console(), Base::ConsoleSingleton::Error(), Base::Type::getName(), Base::Persistence::getTypeId(), Gui::Application::Instance, keyPressed(), mouseButtonPressed(), mouseMove(), mouseWheelEvent(), Gui::Document::resetEdit(), and OfflineRenderingUtils::viewer().

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

finishEditing()

void ViewProvider::finishEditing

(

)

References unsetEdit().

Referenced by MeshGui::ViewProviderMesh::clipMeshCallback(), PointsGui::ViewProviderPoints::clipPointsCallback(), MeshGui::ViewProviderMesh::partMeshCallback(), MeshGui::ViewProviderMesh::segmMeshCallback(), MeshGui::ViewProviderMesh::selectGLCallback(), and MeshGui::ViewProviderMesh::trimMeshCallback().

getActiveDisplayMode()

std::string ViewProvider::getActiveDisplayMode

(

void

)

const

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

getAnnotation()

SoSeparator * ViewProvider::getAnnotation

(

void

)

References pcAnnotation, and pcRoot.

getBackRoot()

SoSeparator * ViewProvider::getBackRoot ( void  ) const

virtual

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

getBoundingBox()

Base::BoundBox3d ViewProvider::getBoundingBox	(	const char *	subname = nullptr,
		bool	transform = true,
		MDIView *	view = nullptr
	)		const

Return the bound box of this view object.

This method shall work regardless whether the current view object is visible or not.

References Gui::Application::activeDocument(), Gui::Application::activeView(), Base::BaseClass::getClassTypeId(), getDefaultMode(), getDetailPath(), Gui::Application::Instance, pcModeSwitch, pcRoot, and OfflineRenderingUtils::viewer().

Referenced by Gui::ViewProviderLink::initDraggingPlacement(), Gui::ViewProviderGeometryObject::updateData(), PartGui::ViewProvider2DObjectGrid::updateData(), and FemGui::ViewProviderFemPostPipeline::updateFunctionSize().

getChildRoot()

SoGroup * ViewProvider::getChildRoot ( void  ) const

virtual

Reimplemented in Gui::ViewProviderOrigin.

Referenced by Gui::View3DInventorViewer::checkGroupOnTop(), Gui::LinkInfo::getDetail(), Gui::ViewProviderDocumentObject::getDetailPath(), Gui::ViewProviderDocumentObject::getElementPicked(), Gui::LinkInfo::getSnapshot(), and Gui::LinkInfo::updateChildren().

getDefaultDisplayMode()

const char * ViewProvider::getDefaultDisplayMode ( ) const

virtual

get the default display mode

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

Referenced by Gui::ViewProviderDocumentObject::attach().

getDefaultMode()

int ViewProvider::getDefaultMode

(

)

const

Referenced by getBoundingBox(), Gui::ViewProviderLink::getDetailPath(), PartDesignGui::ViewProviderAddSub::setPreviewDisplayMode(), Gui::LinkInfo::setVisible(), and Gui::LinkInfo::updateSwitch().

getDetail()

virtual SoDetail * Gui::ViewProvider::getDetail ( const char *  ) const

virtual

return the coin node detail of the subelement

Reimplemented in FemGui::ViewProviderFemMesh, PartGui::ViewProviderPartExt, PartDesignGui::ViewProviderDatum, PartDesignGui::ViewProviderDatumCoordinateSystem, and PathGui::ViewProviderPath.

Referenced by Gui::SoFCUnifiedSelection::doAction(), getDetailPath(), and MeshPartGui::CurveOnMeshHandler::Private::vertexCallback().

getDetailPath()

bool ViewProvider::getDetailPath ( const char *  subname, SoFullPath *  pPath, bool  append, SoDetail *&  det  ) const

virtual

return the coin node detail and path to the node of the subelement

Parameters

subname	dot separated string reference to the sub element
pPath	output coin path leading to the returned element detail
append	If true, pPath will be first appended with the root node and the mode switch node of this view provider.

Returns

the coint detail of the subelement

If this view provider links to other view provider, then the implementation of getDetailPath() shall also append all intermediate nodes starting just after the mode switch node up till the mode switch of the linked view provider.

Reimplemented in Gui::ViewProviderLink, Gui::ViewProviderPlacement, and Gui::ViewProviderDocumentObject.

References getDetail(), pcModeSwitch, and pcRoot.

Referenced by Gui::SoFCUnifiedSelection::doAction(), getBoundingBox(), Gui::ViewProviderDocumentObject::getDetailPath(), and partialRender().

getDisplayMaskMode()

SoNode * ViewProvider::getDisplayMaskMode

(

const char *

type

)

const

Get the node to the display mask mode type.

References pcModeSwitch.

Referenced by Gui::Dialog::DlgInspector::setNodeNames().

getDisplayMaskModes()

std::vector< std::string > ViewProvider::getDisplayMaskModes

(

)

const

Returns a list of added display mask modes.

Referenced by Gui::Dialog::DlgInspector::setNodeNames().

getDisplayModes()

vector< std::string > ViewProvider::getDisplayModes ( void  ) const

virtual

returns a list of all possible display modes

Reimplemented in Gui::ViewProviderInventorObject, Gui::ViewProviderOriginFeature, Gui::ViewProviderVRMLObject, FemGui::ViewProviderFemMesh, FemGui::ViewProviderFemPostFunction, FemGui::ViewProviderFemPostObject, ImageGui::ViewProviderImagePlane, MeshGui::ViewProviderFace, MeshGui::ViewProviderExport, MeshGui::ViewProviderMesh, MeshGui::ViewProviderMeshCurvature, MeshGui::ViewProviderMeshNode, MeshGui::ViewProviderMeshTransform, MeshGui::ViewProviderMeshTransformDemolding, PathGui::ViewProviderPath, PointsGui::ViewProviderPoints, RobotGui::ViewProviderRobotObject, RobotGui::ViewProviderTrajectory, SpreadsheetGui::ViewProviderSheet, Gui::ViewProviderAnnotation, Gui::ViewProviderAnnotationLabel, Gui::ViewProviderExtern, Gui::ViewProviderMeasureDistance, Gui::ViewProviderOrigin, DrawingGui::ViewProviderDrawingPage, DrawingGui::ViewProviderDrawingView, DrawingGui::ViewProviderDrawingClip, FemGui::ViewProviderFemAnalysis, FemGui::ViewProviderFemConstraint, FemGui::ViewProviderSolver, InspectionGui::ViewProviderInspection, MeshPartGui::ViewProviderCrossSections, PartGui::ViewProviderCrossSections, PartGui::ViewProvider2DObject, PartGui::ViewProviderBox, PartGui::ViewProviderCircleParametric, PartGui::ViewProviderConeParametric, PartGui::ViewProviderCurveNet, PartGui::ViewProviderCylinderParametric, PartGui::ViewProviderEllipseParametric, PartGui::ViewProviderHelixParametric, PartGui::ViewProviderSpiralParametric, PartGui::ViewProviderLineParametric, PartGui::ViewProviderPlaneParametric, PartGui::ViewProviderPointParametric, PartGui::ViewProviderPrism, PartGui::ViewProviderWedge, PartGui::ViewProviderPartReference, PartGui::ViewProviderRegularPolygon, PartGui::ViewProviderRuledSurface, PartGui::ViewProviderSphereParametric, PartGui::ViewProviderEllipsoid, PartGui::ViewProviderTorusParametric, TechDrawGui::ViewProviderAnnotation, TechDrawGui::ViewProviderBalloon, TechDrawGui::ViewProviderDimension, TechDrawGui::ViewProviderImage, TechDrawGui::ViewProviderProjGroup, TechDrawGui::ViewProviderProjGroupItem, TechDrawGui::ViewProviderSpreadsheet, TechDrawGui::ViewProviderSymbol, TechDrawGui::ViewProviderTile, TechDrawGui::ViewProviderViewClip, TechDrawGui::ViewProviderViewPart, TechDrawGui::ViewProviderViewSection, TechDrawGui::ViewProviderWeld, Gui::ViewProviderDocumentObjectGroup, Gui::ViewProviderLink, Gui::ViewProviderPlacement, PartGui::ViewProviderPartExt, PartDesignGui::ViewProviderBody, PartDesignGui::ViewProviderDatum, TechDrawGui::ViewProviderDrawingView, TechDrawGui::ViewProviderGeomHatch, TechDrawGui::ViewProviderHatch, TechDrawGui::ViewProviderPage, and TechDrawGui::ViewProviderTemplate.

Referenced by Gui::ViewProviderDocumentObject::attach(), MeshGui::ViewProviderMeshCurvature::getDisplayModes(), and Gui::ViewProviderLink::getDisplayModes().

getDropPrefix()

virtual std::string Gui::ViewProvider::getDropPrefix ( ) const

virtual

return a subname referencing the sub-object holding the dropped objects

getEditingMode()

int ViewProvider::getEditingMode ( ) const

protected

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

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

getElement()

virtual std::string Gui::ViewProvider::getElement ( const SoDetail *  ) const

virtual

return a hit element to the selection path or 0

Reimplemented in FemGui::ViewProviderFemMesh, PathGui::ViewProviderPath, PartGui::ViewProviderPartExt, PartDesignGui::ViewProviderDatum, and PartDesignGui::ViewProviderDatumCoordinateSystem.

Referenced by getElementPicked().

getElementColors()

virtual std::map< std::string, App::Color > Gui::ViewProvider::getElementColors ( const char *  element = nullptr ) const

virtual

Reimplemented in PartGui::ViewProviderPartExt, and Gui::ViewProviderLink.

Referenced by Gui::ElementColors::Private::addItem(), and Gui::ElementColors::Private::populate().

getElementPicked()

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

virtual

return a hit element given the picked point which contains the full node path

Reimplemented in Gui::ViewProviderLink, Gui::ViewProviderDocumentObject, and Gui::ViewProviderPlacement.

References getElement(), and isSelectable().

Referenced by Gui::ViewProviderDocumentObject::getElementPicked(), Gui::View3DInventorPy::getObjectInfo(), and Gui::View3DInventorPy::getObjectsInfo().

getFrontRoot()

SoSeparator * ViewProvider::getFrontRoot ( void  ) const

virtual

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

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

getIcon()

QIcon ViewProvider::getIcon ( void  ) const

virtual

deliver the icon shown in the tree view

Reimplemented in InspectionGui::ViewProviderInspection, InspectionGui::ViewProviderInspectionGroup, MeshGui::ViewProviderExport, MeshGui::ViewProviderMesh, MeshGui::ViewProviderMeshCurvature, MeshGui::ViewProviderMeshNode, PartGui::ViewProviderSpline, PathGui::ViewProviderPath, PointsGui::ViewProviderPoints, SpreadsheetGui::ViewProviderSheet, Gui::ViewProviderMaterialObject, PartGui::ViewProviderBoolean, PartGui::ViewProviderMultiFuse, PartGui::ViewProviderMultiCommon, PartDesignGui::ViewProviderHelix, PartDesignGui::ViewProviderLoft, PartDesignGui::ViewProviderPipe, PartDesignGui::ViewProviderPrimitive, PathGui::ViewProviderPathCompound, PathGui::ViewProviderPathShape, SurfaceGui::ViewProviderFilling, SurfaceGui::ViewProviderGeomFillSurface, SurfaceGui::ViewProviderSections, SurfaceGui::ViewProviderExtend, Gui::ViewProviderDocumentObjectGroup, Gui::ViewProviderLink, and Gui::ViewProviderPart.

References Gui::BitmapFactory(), mergeGreyableOverlayIcons(), and sPixmap.

Referenced by PartGui::DlgExtrusion::findShapes(), Gui::LinkInfo::getIcon(), PartGui::ViewProviderBoolean::getIcon(), TechDrawGui::TaskLinkDim::loadToTree(), Gui::DocumentObjectItem::testStatus(), ArchAxisSystem.AxisSystemTaskPanel::update(), ArchComponent.ComponentTaskPanel::update(), and ArchSectionPlane.SectionPlaneTaskPanel::update().

getMDIView()

virtual MDIView * Gui::ViewProvider::getMDIView ( ) const

virtual

Reimplemented in Gui::ViewProviderTextDocument, SpreadsheetGui::ViewProviderSheet, TechDrawGui::ViewProviderDrawingView, TechDrawGui::ViewProviderGeomHatch, TechDrawGui::ViewProviderHatch, TechDrawGui::ViewProviderPage, and TechDrawGui::ViewProviderTemplate.

Referenced by TechDrawGui::ViewProviderGeomHatch::getMDIView(), TechDrawGui::ViewProviderHatch::getMDIView(), and Gui::Document::setActiveView().

getModelPoints()

std::vector< Base::Vector3d > ViewProvider::getModelPoints ( const SoPickedPoint *  pp ) const

virtual

Reimplemented in PartGui::ViewProviderPartExt.

References draftgeoutils.general::vec().

Referenced by Gui::ManualAlignment::applyPickedProbe().

getModeSwitch()

SoSwitch * Gui::ViewProvider::getModeSwitch

(

void

)

const

Referenced by Gui::LinkInfo::getSnapshot(), and Gui::ViewProviderDocumentObject::setShowable().

getOverrideMode()

const string ViewProvider::getOverrideMode

(

)

References overrideMode.

Referenced by PartDesignGui::ViewProviderBody::onChanged().

getPointOnRay() [1/2]

SoPickedPoint * ViewProvider::getPointOnRay ( const SbVec2s &  pos, const View3DInventorViewer *  viewer  ) const

protected

Helper method to get picked entities while editing.

It's in the responsibility of the caller to delete the returned instance.

References OfflineRenderingUtils::viewer().

Referenced by SketcherGui::ViewProviderSketch::mouseButtonPressed(), and SketcherGui::ViewProviderSketch::mouseMove().

getPointOnRay() [2/2]

SoPickedPoint * ViewProvider::getPointOnRay ( const SbVec3f &  pos, const SbVec3f &  dir, const View3DInventorViewer *  viewer  ) const

protected

Helper method to get picked entities while editing.

It's in the responsibility of the caller to delete the returned instance.

References OfflineRenderingUtils::viewer().

getPyObject()

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 FemGui::ViewProviderFemMesh, MeshGui::ViewProviderMesh, Gui::ViewProviderDocumentObject, Gui::ViewProviderLink, SpreadsheetGui::ViewProviderSheet, and PartDesignGui::ViewProvider.

References pyViewObject.

getRoot()

virtual SoSeparator * Gui::ViewProvider::getRoot ( void  ) const

virtual

Reimplemented in MeshGui::ViewProviderExport.

Referenced by Gui::Document::addViewProvider(), Gui::View3DInventorViewer::addViewProvider(), Gui::View3DInventorViewer::containsViewProvider(), Gui::SoFCUnifiedSelection::doAction(), Gui::ViewProviderGeometryObject::getPickedPoint(), Gui::ViewProviderGeometryObject::getPickedPoints(), Gui::View3DInventorViewer::getPointOnRay(), PartDesignGui::ViewProviderDatum::getRelevantBoundBox(), Gui::LinkInfo::getSnapshot(), Gui::Document::getViewOfViewProvider(), PartGui::TaskCheckGeometryResults::goCheck(), PartGui::FaceColors::Private::isVisibleFace(), Gui::ViewProviderDocumentObject::onChanged(), Gui::View3DInventorViewer::removeViewProvider(), Gui::View3DInventorViewer::resetEditingRoot(), Gui::Dialog::DlgInspector::setNodeNames(), Gui::View3DInventorViewer::setupEditingRoot(), Gui::Application::sExport(), PartGui::ViewProviderSplineExtension::showControlPoints(), Gui::Document::slotNewObject(), Gui::Document::slotTransactionRemove(), Gui::Document::toggleInSceneGraph(), PartGui::ViewProviderCustom::updateData(), SketcherGui::ViewProviderCustom::updateData(), PartDesignGui::ViewProviderBody::updateOriginDatumSize(), and Gui::ViewProviderOriginGroupExtension::updateOriginSize().

getSelectionShape()

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

virtual

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

Reimplemented in FemGui::ViewProviderFemMesh, and PartGui::ViewProviderPartExt.

getStatus()

unsigned long Gui::ViewProvider::getStatus

(

)

const

return the status bits

getTaskViewContent()

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

virtual

get a list of TaskBoxes associated with this object

Reimplemented in Gui::ViewProviderDocumentObject.

getTransactionText()

virtual const char * Gui::ViewProvider::getTransactionText ( ) const

virtual

Is called by the tree if the user double clicks on the object.

It returns the string for the transaction that will be shown in the undo/redo dialog. If null is returned then no transaction will be opened.

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

getTransformNode()

SoTransform * Gui::ViewProvider::getTransformNode

(

)

const

Referenced by Gui::LinkInfo::getSnapshot(), Gui::View3DInventorViewer::resetEditingRoot(), and Gui::View3DInventorViewer::setupEditingRoot().

hasHiddenMarker()

const char * ViewProvider::hasHiddenMarker ( const char *  subname )

static

References App::DocumentObject::hasHiddenMarker().

Referenced by partialRender().

hiddenMarker()

const std::string & ViewProvider::hiddenMarker ( )

static

References App::DocumentObject::hiddenMarker().

Referenced by Gui::ViewProviderLink::applyColors(), Gui::ViewProviderLink::getElementColors(), and partialRender().

hide()

void ViewProvider::hide ( void  )

virtual

Hides the view provider.

Reimplemented in MeshGui::ViewProviderMeshCurvature, DrawingGui::ViewProviderDrawingPage, DrawingGui::ViewProviderDrawingView, DrawingGui::ViewProviderDrawingClip, FemGui::ViewProviderFemAnalysis, FemGui::ViewProviderFemPostObject, InspectionGui::ViewProviderInspection, TechDrawGui::ViewProviderViewClip, Gui::ViewProviderDocumentObject, TechDrawGui::ViewProviderDrawingView, TechDrawGui::ViewProviderPage, and TechDrawGui::ViewProviderTemplate.

References pcModeSwitch.

Referenced by ArchComponent.ArchSelectionObserver::addSelection(), DrawingGui::DrawingView::closeEvent(), TechDrawGui::MDIViewPage::closeEvent(), Gui::ViewProviderDocumentObject::hide(), Mod.Show.mTempoVis.TempoVis::hide_all_dependencies(), Mod.Show.mTempoVis.TempoVis::hide_all_dependent(), Gui::Application::hideViewProvider(), Gui::MergeDocuments::importObject(), PartDesignGui::ViewProvider::makeTemporaryVisible(), Gui::ViewProviderDocumentObject::setActiveMode(), Gui::ViewProviderDocumentObject::setShowable(), PartGui::DlgFilletEdges::setupFillet(), PathScripts.PathToolEdit.ToolEditorImage::setupUI(), setVisible(), update(), PathScripts.PathToolEdit.ToolEditorImage::updateTool(), and Gui::ViewProviderDocumentObject::updateView().

isEditing()

bool ViewProvider::isEditing

(

)

const

References getEditingMode().

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

isLinkVisible()

bool ViewProvider::isLinkVisible

(

)

const

isRestoring()

bool Gui::ViewProvider::isRestoring

(

void

)

References Gui::isRestoring.

Referenced by Gui::ViewProviderDocumentObject::attach(), Gui::ViewProviderLink::onChanged(), PartDesignGui::ViewProviderSubShapeBinder::onChanged(), PartDesignGui::ViewProviderBody::slotChangedObjectApp(), PartDesignGui::ViewProviderBody::unifyVisualProperty(), Gui::LinkInfo::update(), Gui::ViewProviderDocumentObject::update(), TechDrawGui::ViewProviderLeader::updateData(), and Gui::ViewProviderLink::updateData().

isSelectable()

virtual bool Gui::ViewProvider::isSelectable ( void  ) const

virtual

Reimplemented in Gui::ViewProviderGeometryObject, Gui::ViewProviderLink, Gui::ViewProviderPlacement, PartDesignGui::ViewProviderDatum, and SketcherGui::ViewProviderSketch.

Referenced by Gui::SoFCUnifiedSelection::doAction(), Gui::LinkInfo::getElementPicked(), getElementPicked(), Gui::ViewProviderDocumentObject::getElementPicked(), Gui::View3DInventorPy::getObjectInfo(), and Gui::View3DInventorPy::getObjectsInfo().

isShow()

bool ViewProvider::isShow ( void  ) const

virtual

checks whether the view provider is visible or not

Reimplemented in Gui::ViewProviderTextDocument, Gui::ViewProviderMaterialObject, DrawingGui::ViewProviderDrawingView, DrawingGui::ViewProviderDrawingClip, FemGui::ViewProviderFemAnalysis, FemGui::ViewProviderResult, FemGui::ViewProviderSolver, TechDrawGui::ViewProviderViewClip, Gui::ViewProviderDocumentObjectGroup, SpreadsheetGui::ViewProviderSheet, TechDrawGui::ViewProviderDrawingView, TechDrawGui::ViewProviderPage, and TechDrawGui::ViewProviderTemplate.

References pcModeSwitch.

Referenced by PartGui::ViewProviderPartExt::forceUpdate(), Gui::Document::isShow(), isVisible(), PathGui::ViewProviderPath::onChanged(), PartDesignGui::ViewProvider::onDelete(), Gui::DocumentObjectItem::testStatus(), update(), and Gui::ViewProviderDocumentObject::updateView().

isUpdatesEnabled()

bool ViewProvider::isUpdatesEnabled

(

)

const

References testStatus(), and Gui::UpdateData.

Referenced by update().

isVisible()

bool ViewProvider::isVisible

(

)

const

References isShow().

Referenced by PartDesignGui::ViewProviderDatum::getRelevantBoundBox(), MeshGui::MeshSelection::getViewProviders(), ArchVRM.Renderer::removeHidden(), and Gui::ViewProviderOrigin::setTemporaryVisibility().

keyPressed()

bool ViewProvider::keyPressed ( bool  pressed, int  key  )

virtual

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

Reimplemented in SketcherGui::ViewProviderSketch.

Referenced by eventCallback().

mergeColorfulOverlayIcons()

QIcon ViewProvider::mergeColorfulOverlayIcons ( const QIcon &  orig ) const

virtual

Reimplemented in PartDesignGui::ViewProvider, and SketcherGui::ViewProviderSketch.

Referenced by PartDesignGui::ViewProvider::mergeColorfulOverlayIcons(), SketcherGui::ViewProviderSketch::mergeColorfulOverlayIcons(), and Gui::DocumentObjectItem::testStatus().

mergeGreyableOverlayIcons()

QIcon ViewProvider::mergeGreyableOverlayIcons ( const QIcon &  orig ) const

protectedvirtual

Referenced by getIcon(), PartDesignGui::ViewProviderHelix::getIcon(), PartDesignGui::ViewProviderLoft::getIcon(), PartDesignGui::ViewProviderPipe::getIcon(), PartDesignGui::ViewProviderPrimitive::getIcon(), Gui::ViewProviderDocumentObjectGroup::getIcon(), Gui::ViewProviderPart::getIcon(), Gui::ViewProviderDragger::setupContextMenu(), PartGui::ViewProviderPartExt::setupContextMenu(), and PartDesignGui::ViewProvider::setupContextMenu().

mouseButtonPressed()

bool ViewProvider::mouseButtonPressed ( int  button, bool  pressed, const SbVec2s &  cursorPos, const View3DInventorViewer *  viewer  )

virtual

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

Reimplemented in SketcherGui::ViewProviderSketch.

References OfflineRenderingUtils::viewer().

Referenced by eventCallback().

mouseMove()

bool ViewProvider::mouseMove ( const SbVec2s &  cursorPos, View3DInventorViewer *  viewer  )

virtual

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

Reimplemented in SketcherGui::ViewProviderSketch.

References OfflineRenderingUtils::viewer().

Referenced by eventCallback().

mouseWheelEvent()

bool ViewProvider::mouseWheelEvent ( int  delta, const SbVec2s &  cursorPos, const View3DInventorViewer *  viewer  )

virtual

Reimplemented in SketcherGui::ViewProviderSketch.

References OfflineRenderingUtils::viewer().

Referenced by eventCallback().

onBeforeChange()

void ViewProvider::onBeforeChange ( const App::Property *  prop )

protectedvirtual

Reimplemented from subclass.

Reimplemented from App::PropertyContainer.

Reimplemented in Gui::ViewProviderLink, and Gui::ViewProviderDocumentObject.

References Gui::Application::Instance, App::PropertyContainer::onBeforeChange(), and Gui::Application::signalBeforeChangeObject.

Referenced by Gui::ViewProviderDocumentObject::onBeforeChange(), and PathScripts.PathGui.QuantitySpinBox::updateProperty().

onChanged()

void ViewProvider::onChanged ( const App::Property *  prop )

protectedvirtual

Reimplemented from subclass.

Reimplemented from App::ExtensionContainer.

Reimplemented in FemGui::ViewProviderFemPostPlaneFunction, PartDesignGui::ViewProviderDatumCoordinateSystem, TechDrawGui::ViewProviderBalloon, TechDrawGui::ViewProviderDimension, TechDrawGui::ViewProviderLeader, TechDrawGui::ViewProviderRichAnno, TechDrawGui::ViewProviderWeld, Gui::ViewProviderAnnotation, Gui::ViewProviderAnnotationLabel, Gui::ViewProviderGeometryObject, Gui::ViewProviderMeasureDistance, Gui::ViewProviderOrigin, Gui::ViewProviderOriginFeature, Gui::ViewProviderTextDocument, FemGui::ViewProviderFemConstraint, FemGui::ViewProviderFemMesh, FemGui::ViewProviderFemPostFunctionProvider, FemGui::ViewProviderFemPostFunction, FemGui::ViewProviderFemPostObject, InspectionGui::ViewProviderInspection, MeshGui::ViewProviderMesh, MeshGui::ViewProviderMeshCurvature, MeshGui::ViewProviderMeshDefects, MeshGui::ViewProviderMeshNode, PartGui::ViewProvider2DObjectGrid, PartGui::ViewProviderCustom, PartGui::ViewProviderPartReference, PartDesignGui::ViewProviderDatumPoint, PathGui::ViewProviderPath, PointsGui::ViewProviderPoints, RobotGui::ViewProviderRobotObject, SketcherGui::ViewProviderCustom, TechDrawGui::ViewProviderImage, TechDrawGui::ViewProviderProjGroup, TechDrawGui::ViewProviderViewPart, TechDrawGui::ViewProviderViewSection, Gui::ViewProviderDocumentObject, Gui::ViewProviderLink, Gui::ViewProviderPart, Gui::ViewProviderPlacement, PartGui::ViewProviderPartExt, PartDesignGui::ViewProvider, PartDesignGui::ViewProviderBody, PartDesignGui::ViewProviderBoolean, PartDesignGui::ViewProviderSubShapeBinder, SketcherGui::ViewProviderSketch, TechDrawGui::ViewProviderDrawingView, TechDrawGui::ViewProviderGeomHatch, TechDrawGui::ViewProviderHatch, TechDrawGui::ViewProviderPage, and TechDrawGui::ViewProviderTemplate.

References Gui::Application::Instance, App::ExtensionContainer::onChanged(), Gui::Application::signalChangedObject, and Gui::Application::updateActions().

Referenced by ArchStructure.CommandStructuralSystem::Activated(), draftviewproviders.view_base.ViewProviderDraft::attach(), ArchSite.Compass::buildCoordinates(), draftobjects.wire.Wire::execute(), Gui::ViewProviderDocumentObject::onChanged(), ArchBuildingPart.ViewProviderBuildingPart::updateData(), ArchPanel.ViewProviderPanelCut::updateData(), ArchPanel.ViewProviderPanelSheet::updateData(), draftviewproviders.view_label.ViewProviderLabel::updateData(), draftviewproviders.view_layer.ViewProviderLayer::updateData(), and draftviewproviders.view_wpproxy.ViewProviderWorkingPlaneProxy::updateData().

onDelete()

bool ViewProvider::onDelete ( const std::vector< std::string > &  subNames )

virtual

Get called if the object is about to get deleted.

Here you can delete other objects, switch their visibility or prevent the deletion of the object.

Parameters

subNames

list of selected subelements

Returns

true if the deletion is approved by the view provider.

Reimplemented in Gui::ViewProviderOrigin, Gui::ViewProviderOriginFeature, DrawingGui::ViewProviderDrawingPage, FemGui::ViewProviderFemAnalysis, FemGui::ViewProviderFemPostFunctionProvider, FemGui::ViewProviderFemPostObject, FemGui::ViewProviderSolver, PartGui::ViewProviderBoolean, PartGui::ViewProviderMultiFuse, PartGui::ViewProviderMultiCommon, PartGui::ViewProviderCompound, PartGui::ViewProviderMirror, PartGui::ViewProviderFillet, PartGui::ViewProviderChamfer, PartGui::ViewProviderRevolution, PartGui::ViewProviderLoft, PartGui::ViewProviderSweep, PartGui::ViewProviderOffset, PartGui::ViewProviderThickness, PartGui::ViewProviderRuledSurface, PartDesignGui::ViewProviderHelix, PartDesignGui::ViewProviderLoft, PartDesignGui::ViewProviderMultiTransform, PartDesignGui::ViewProviderPipe, PartDesignGui::ViewProviderSketchBased, PathGui::ViewProviderArea, PathGui::ViewProviderAreaView, PathGui::ViewProviderPathShape, TechDrawGui::ViewProviderLeader, TechDrawGui::ViewProviderProjGroup, TechDrawGui::ViewProviderProjGroupItem, TechDrawGui::ViewProviderViewPart, TechDrawGui::ViewProviderWeld, Gui::ViewProviderLink, PartDesignGui::ViewProvider, PartDesignGui::ViewProviderBody, PartDesignGui::ViewProviderBoolean, PartDesignGui::ViewProviderDatum, PartDesignGui::ViewProviderTransformed, SketcherGui::ViewProviderSketch, TechDrawGui::ViewProviderPage, TechDrawGui::ViewProviderTemplate, and PartDesignGui::ViewProviderHole.

Referenced by StdCmdDelete::activated(), SketcherGui::ConstraintView::deleteSelectedItems(), SketcherGui::ElementView::deleteSelectedItems(), SketcherGui::ViewProviderSketch::onDelete(), and Gui::Document::slotDeletedObject().

partialRender()

int ViewProvider::partialRender	(	const std::vector< std::string > &	subelements,
		bool	clear
	)

partial rendering setup

Parameters

subelements	a list of dot separated string refer to the sub element
clear	if true, remove the the subelement from partial rendering. If else, add the subelement for rendering.

Returns

Return the number of subelement found

Partial rendering only works if there is at least one SoFCSelectRoot node in this view provider

References Gui::SoSelectionElementAction::Append, getDetailPath(), hasHiddenMarker(), hiddenMarker(), Gui::SoSelectionElementAction::Hide, pcModeSwitch, Gui::SoSelectionElementAction::Remove, and Gui::SoSelectionElementAction::Show.

Referenced by Gui::ElementColors::leaveEvent().

replaceObject()

int ViewProvider::replaceObject ( App::DocumentObject *  oldObj, App::DocumentObject *  newObj  )

virtual

Replace an object to the view provider by drag and drop.

Parameters

oldObj	object to be replaced
newObj	object to replace with

Returns

Returns 0 if not found, 1 if succeeded, -1 if not supported

Reimplemented in Gui::ViewProviderDocumentObject.

Referenced by Gui::ViewProviderDocumentObject::replaceObject().

Restore()

void ViewProvider::Restore ( Base::XMLReader &  )

virtual

This method is used to restore properties from an XML document.

It uses the XMLReader class, which bases on SAX, to read the in Save() written information. Again the Vector as an example:

void PropertyVector::Restore(Base::XMLReader &reader)
{
  // read my Element
  reader.readElement("PropertyVector");
  // get the value of my Attribute
  _cVec.x = reader.getAttributeAsFloat("valueX");
  _cVec.y = reader.getAttributeAsFloat("valueY");
  _cVec.z = reader.getAttributeAsFloat("valueZ");
}

Reimplemented from App::ExtensionContainer.

Reimplemented in PartGui::ViewProvider2DObjectGrid.

Referenced by Gui::Document::importObjects(), PartGui::ViewProvider2DObjectGrid::Restore(), and Gui::Document::RestoreDocFile().

setDefaultMode()

void ViewProvider::setDefaultMode

(

int

val

)

setDisplayMaskMode()

void ViewProvider::setDisplayMaskMode

(

const char *

type

)

Activates the display mask mode type.

References setModeSwitch().

Referenced by Gui::ViewProviderLink::attach(), FemGui::ViewProviderFemPostFunction::attach(), FemGui::ViewProviderFemPostObject::attach(), Gui::ViewProviderGeoFeatureGroupExtension::extensionSetDisplayMode(), PartDesignGui::ViewProviderBody::onChanged(), Gui::ViewProviderAnnotation::setDisplayMode(), Gui::ViewProviderAnnotationLabel::setDisplayMode(), Gui::ViewProviderInventorObject::setDisplayMode(), Gui::ViewProviderMeasureDistance::setDisplayMode(), Gui::ViewProviderOrigin::setDisplayMode(), Gui::ViewProviderOriginFeature::setDisplayMode(), Gui::ViewProviderVRMLObject::setDisplayMode(), FemGui::ViewProviderFemConstraint::setDisplayMode(), FemGui::ViewProviderFemMesh::setDisplayMode(), ImageGui::ViewProviderImagePlane::setDisplayMode(), InspectionGui::ViewProviderInspection::setDisplayMode(), MeshGui::ViewProviderFace::setDisplayMode(), MeshGui::ViewProviderMesh::setDisplayMode(), MeshGui::ViewProviderMeshCurvature::setDisplayMode(), MeshGui::ViewProviderMeshNode::setDisplayMode(), MeshGui::ViewProviderMeshTransform::setDisplayMode(), MeshGui::ViewProviderMeshTransformDemolding::setDisplayMode(), MeshPartGui::ViewProviderCurveOnMesh::setDisplayMode(), PartGui::ViewProviderCurveNet::setDisplayMode(), PartGui::ViewProviderPartReference::setDisplayMode(), PathGui::ViewProviderPath::setDisplayMode(), PointsGui::ViewProviderPoints::setDisplayMode(), RobotGui::ViewProviderRobotObject::setDisplayMode(), RobotGui::ViewProviderTrajectory::setDisplayMode(), Gui::ViewProviderPlacement::setDisplayMode(), PartGui::ViewProviderPartExt::setDisplayMode(), PartDesignGui::ViewProviderDatum::setDisplayMode(), Gui::ViewProviderExtern::setModeBySoInput(), PartDesignGui::ViewProviderAddSub::setPreviewDisplayMode(), MeshGui::ViewProviderMeshOrientation::showDefects(), MeshGui::ViewProviderMeshNonManifolds::showDefects(), MeshGui::ViewProviderMeshNonManifoldPoints::showDefects(), MeshGui::ViewProviderMeshDuplicatedFaces::showDefects(), MeshGui::ViewProviderMeshDegenerations::showDefects(), MeshGui::ViewProviderMeshDuplicatedPoints::showDefects(), MeshGui::ViewProviderMeshIndices::showDefects(), MeshGui::ViewProviderMeshSelfIntersections::showDefects(), and MeshGui::ViewProviderMeshFolds::showDefects().

setDisplayMode()

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::ViewProviderOrigin, Gui::ViewProviderOriginFeature, Gui::ViewProviderVRMLObject, DrawingGui::ViewProviderDrawingPage, DrawingGui::ViewProviderDrawingView, DrawingGui::ViewProviderDrawingClip, FemGui::ViewProviderFemConstraint, FemGui::ViewProviderFemMesh, FemGui::ViewProviderFemPostObject, ImageGui::ViewProviderImagePlane, InspectionGui::ViewProviderInspection, MeshGui::ViewProviderFace, MeshGui::ViewProviderMesh, MeshGui::ViewProviderMeshCurvature, MeshGui::ViewProviderMeshNode, MeshGui::ViewProviderMeshTransform, MeshGui::ViewProviderMeshTransformDemolding, MeshPartGui::ViewProviderCurveOnMesh, PartGui::ViewProviderCurveNet, PartGui::ViewProviderPartReference, PathGui::ViewProviderPath, PointsGui::ViewProviderPoints, RobotGui::ViewProviderRobotObject, RobotGui::ViewProviderTrajectory, TechDrawGui::ViewProviderAnnotation, TechDrawGui::ViewProviderBalloon, TechDrawGui::ViewProviderDimension, TechDrawGui::ViewProviderImage, TechDrawGui::ViewProviderProjGroup, TechDrawGui::ViewProviderProjGroupItem, TechDrawGui::ViewProviderSpreadsheet, TechDrawGui::ViewProviderSymbol, TechDrawGui::ViewProviderTile, TechDrawGui::ViewProviderViewClip, TechDrawGui::ViewProviderViewPart, TechDrawGui::ViewProviderViewSection, TechDrawGui::ViewProviderWeld, Gui::ViewProviderPlacement, PartGui::ViewProviderPartExt, PartDesignGui::ViewProviderBody, PartDesignGui::ViewProviderDatum, SpreadsheetGui::ViewProviderSheet, TechDrawGui::ViewProviderDrawingView, TechDrawGui::ViewProviderGeomHatch, TechDrawGui::ViewProviderHatch, TechDrawGui::ViewProviderPage, and TechDrawGui::ViewProviderTemplate.

Referenced by Gui::ViewProviderDocumentObject::setActiveMode(), Gui::ViewProviderAnnotation::setDisplayMode(), Gui::ViewProviderAnnotationLabel::setDisplayMode(), Gui::ViewProviderInventorObject::setDisplayMode(), Gui::ViewProviderMeasureDistance::setDisplayMode(), Gui::ViewProviderOrigin::setDisplayMode(), Gui::ViewProviderOriginFeature::setDisplayMode(), Gui::ViewProviderVRMLObject::setDisplayMode(), MeshGui::ViewProviderMeshCurvature::setDisplayMode(), and Gui::ViewProviderPlacement::setDisplayMode().

setEdit()

bool ViewProvider::setEdit ( int  ModNum )

protectedvirtual

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

Reimplemented in Gui::ViewProviderAnnotationLabel, DrawingGui::ViewProviderDrawingPage, FemGui::ViewProviderFemAnalysis, FemGui::ViewProviderFemConstraint, FemGui::ViewProviderFemConstraintBearing, FemGui::ViewProviderFemConstraintContact, FemGui::ViewProviderFemConstraintDisplacement, FemGui::ViewProviderFemConstraintFixed, FemGui::ViewProviderFemConstraintFluidBoundary, FemGui::ViewProviderFemConstraintForce, FemGui::ViewProviderFemConstraintGear, FemGui::ViewProviderFemConstraintHeatflux, FemGui::ViewProviderFemConstraintInitialTemperature, FemGui::ViewProviderFemConstraintPlaneRotation, FemGui::ViewProviderFemConstraintPressure, FemGui::ViewProviderFemConstraintPulley, FemGui::ViewProviderFemConstraintSpring, FemGui::ViewProviderFemConstraintTemperature, FemGui::ViewProviderFemConstraintTransform, FemGui::ViewProviderFemMeshShapeNetgen, FemGui::ViewProviderFemPostFunction, FemGui::ViewProviderFemPostObject, FemGui::ViewProviderSetElements, FemGui::ViewProviderSetFaces, FemGui::ViewProviderSetGeometry, FemGui::ViewProviderSetNodes, MeshGui::ViewProviderMesh, PartGui::ViewProvider2DObjectGrid, PartGui::ViewProviderCurveNet, PartGui::ViewProviderImport, PartGui::ViewProviderMirror, PartGui::ViewProviderFillet, PartGui::ViewProviderChamfer, PartGui::ViewProviderOffset, PartGui::ViewProviderThickness, PartGui::ViewProviderPrimitive, PartDesignGui::ViewProviderBase, PartDesignGui::ViewProviderDressUp, PartDesignGui::ViewProviderHelix, PartDesignGui::ViewProviderHole, PartDesignGui::ViewProviderLoft, PartDesignGui::ViewProviderPipe, PartDesignGui::ViewProviderPrimitive, PathGui::ViewProviderPathCompound, PointsGui::ViewProviderPoints, RaytracingGui::ViewProviderLux, RaytracingGui::ViewProviderPovray, RobotGui::ViewProviderEdge2TracObject, RobotGui::ViewProviderTrajectoryCompound, RobotGui::ViewProviderTrajectoryDressUp, SurfaceGui::ViewProviderFilling, SurfaceGui::ViewProviderGeomFillSurface, SurfaceGui::ViewProviderSections, TechDrawGui::ViewProviderBalloon, TechDrawGui::ViewProviderDimension, TechDrawGui::ViewProviderLeader, TechDrawGui::ViewProviderProjGroup, TechDrawGui::ViewProviderProjGroupItem, TechDrawGui::ViewProviderRichAnno, TechDrawGui::ViewProviderViewPart, TechDrawGui::ViewProviderViewSection, TechDrawGui::ViewProviderWeld, Gui::ViewProviderDragger, Gui::ViewProviderLink, PartGui::ViewProviderPartExt, PartDesignGui::ViewProvider, PartDesignGui::ViewProviderBoolean, PartDesignGui::ViewProviderDatum, PartDesignGui::ViewProviderShapeBinder, PartDesignGui::ViewProviderSubShapeBinder, PartDesignGui::ViewProviderTransformed, SketcherGui::ViewProviderSketch, SpreadsheetGui::ViewProviderSheet, TechDrawGui::ViewProviderGeomHatch, TechDrawGui::ViewProviderHatch, TechDrawGui::ViewProviderPage, MeshGui::ViewProviderMeshNode, and Gui::ViewProviderOriginFeature.

Referenced by ArchGrid.ViewProviderArchGrid::doubleClicked(), ArchReference.ViewProviderArchReference::doubleClicked(), draftviewproviders.view_dimension.ViewProviderDimensionBase::doubleClicked(), draftviewproviders.view_hatch.ViewProviderDraftHatch::doubleClicked(), draftviewproviders.view_text.ViewProviderText::doubleClicked(), PathScripts.PathPropertyBagGui.ViewProvider::doubleClicked(), PathScripts.PathSetupSheetGui.ViewProvider::doubleClicked(), PathScripts.PathToolBitGui.ViewProvider::doubleClicked(), Spreadsheet_legacy.ViewProviderSpreadsheet::doubleClicked(), ArchSchedule.CommandArchSchedule::IsActive(), FemGui::ViewProviderFemAnalysis::setEdit(), TechDrawGui::ViewProviderBalloon::setEdit(), TechDrawGui::ViewProviderDimension::setEdit(), TechDrawGui::ViewProviderLeader::setEdit(), TechDrawGui::ViewProviderRichAnno::setEdit(), TechDrawGui::ViewProviderViewPart::setEdit(), TechDrawGui::ViewProviderViewSection::setEdit(), TechDrawGui::ViewProviderWeld::setEdit(), Gui::ViewProviderLink::setEdit(), TechDrawGui::ViewProviderHatch::setEdit(), TechDrawGui::ViewProviderPage::setEdit(), PathScripts.PathIconViewProvider.ViewProvider::setupContextMenu(), PathScripts.PathJobGui.ViewProvider::setupContextMenu(), PathScripts.PathOpGui.ViewProvider::setupContextMenu(), PathScripts.PathToolControllerGui.ViewProvider::setupContextMenu(), and startEditing().

setEditViewer()

void ViewProvider::setEditViewer ( View3DInventorViewer *  , int  ModNum  )

virtual

adjust viewer settings when editing a view provider

Reimplemented in SketcherGui::ViewProviderSketch, Gui::ViewProviderDragger, and Gui::ViewProviderLink.

Referenced by Gui::View3DInventorViewer::setEditingViewProvider().

setElementColors()

virtual void Gui::ViewProvider::setElementColors ( const std::map< std::string, App::Color > &  colors )

virtual

Reimplemented in Gui::ViewProviderLink.

Referenced by Gui::ElementColors::Private::apply().

setLinkVisible()

void ViewProvider::setLinkVisible

(

bool

visible

)

setModeSwitch()

void ViewProvider::setModeSwitch ( )

protectedvirtual

Turn on mode switch.

Reimplemented in Gui::ViewProviderDocumentObject.

References pcModeSwitch.

Referenced by setDisplayMaskMode(), Gui::ViewProviderDocumentObject::setModeSwitch(), setOverrideMode(), and show().

setOverrideMode()

void ViewProvider::setOverrideMode ( const std::string &  mode )

virtual

Overrides the display mode with mode.

Reimplemented in Gui::ViewProviderLink, and PartDesignGui::ViewProviderBody.

References overrideMode, pcModeSwitch, and setModeSwitch().

Referenced by Gui::View3DInventorViewer::addViewProvider(), PartDesignGui::ViewProviderBody::onChanged(), Gui::ViewProviderLink::setOverrideMode(), and PartDesignGui::ViewProviderBody::setOverrideMode().

setRenderCacheMode()

void ViewProvider::setRenderCacheMode ( int  mode )

virtual

References pcRoot.

setStatus()

void Gui::ViewProvider::setStatus	(	ViewStatus	pos,
		bool	on
	)

Referenced by Gui::Document::addViewProvider(), Gui::ViewProviderDocumentObject::detachFromDocument(), Gui::Document::importObjects(), setUpdatesEnabled(), Gui::Document::slotFinishRestoreObject(), Gui::Document::slotNewObject(), PartDesignGui::ViewProviderDatumPoint::ViewProviderDatumPoint(), DrawingGui::ViewProviderDrawingClip::ViewProviderDrawingClip(), DrawingGui::ViewProviderDrawingView::ViewProviderDrawingView(), PartDesignGui::ViewProviderShapeBinder::ViewProviderShapeBinder(), TechDrawGui::ViewProviderTemplate::ViewProviderTemplate(), and TechDrawGui::ViewProviderViewClip::ViewProviderViewClip().

setTransformation() [1/2]

void ViewProvider::setTransformation ( const Base::Matrix4D &  rcMatrix )

virtual

set the viewing transformation of the provider

References Base::Matrix4D::getGLMatrix(), and pcTransform.

Referenced by Gui::Dialog::TransformStrategy::acceptDataTransform(), Gui::Dialog::TransformStrategy::applyViewTransform(), Gui::ViewProviderGeoFeatureGroupExtension::extensionUpdateData(), Gui::Dialog::TransformStrategy::resetViewTransform(), RobotGui::ViewProviderRobotObject::setAxisTo(), Gui::Document::setPos(), and RobotGui::ViewProviderRobotObject::updateData().

setTransformation() [2/2]

void ViewProvider::setTransformation ( const SbMatrix &  rcMatrix )

virtual

References pcTransform.

setupContextMenu()

void ViewProvider::setupContextMenu ( QMenu *  menu, QObject *  receiver, const char *  method  )

virtual

set up the context-menu with the supported edit modes

Reimplemented in Gui::ViewProviderAnnotationLabel, DrawingGui::ViewProviderDrawingPage, FemGui::ViewProviderFemAnalysis, FemGui::ViewProviderFemConstraint, MeshGui::ViewProviderMesh, PartGui::ViewProviderHelixParametric, PartGui::ViewProviderSpiralParametric, PartGui::ViewProviderMirror, PartGui::ViewProviderFillet, PartGui::ViewProviderChamfer, PartGui::ViewProviderOffset, PartGui::ViewProviderThickness, PartGui::ViewProviderPrimitive, PartDesignGui::ViewProviderDressUp, PartDesignGui::ViewProviderGroove, PartDesignGui::ViewProviderHelix, PartDesignGui::ViewProviderLoft, PartDesignGui::ViewProviderMultiTransform, PartDesignGui::ViewProviderPad, PartDesignGui::ViewProviderPipe, PartDesignGui::ViewProviderPocket, PartDesignGui::ViewProviderRevolution, SurfaceGui::ViewProviderFilling, SurfaceGui::ViewProviderGeomFillSurface, SurfaceGui::ViewProviderSections, TechDrawGui::ViewProviderBalloon, TechDrawGui::ViewProviderDimension, TechDrawGui::ViewProviderProjGroup, TechDrawGui::ViewProviderProjGroupItem, Gui::ViewProviderDragger, Gui::ViewProviderLink, PartGui::ViewProviderPartExt, PartDesignGui::ViewProviderBoolean, PartDesignGui::ViewProviderDatum, PartDesignGui::ViewProviderShapeBinder, PartDesignGui::ViewProviderTransformed, TechDrawGui::ViewProviderPage, Gui::ViewProviderTextDocument, FemGui::ViewProviderFemMeshShapeNetgen, PartDesignGui::ViewProviderBase, PartDesignGui::ViewProviderHole, PartDesignGui::ViewProviderPrimitive, RaytracingGui::ViewProviderLux, RaytracingGui::ViewProviderPovray, RobotGui::ViewProviderTrajectory, Gui::ViewProviderPart, PartDesignGui::ViewProvider, PartDesignGui::ViewProviderBody, PartDesignGui::ViewProviderSubShapeBinder, SketcherGui::ViewProviderSketch, and SpreadsheetGui::ViewProviderSheet.

Referenced by Gui::TreeWidget::contextMenuEvent(), TechDrawGui::ViewProviderBalloon::setupContextMenu(), TechDrawGui::ViewProviderDimension::setupContextMenu(), Gui::ViewProviderDragger::setupContextMenu(), PartDesignGui::ViewProviderDatum::setupContextMenu(), TechDrawGui::ViewProviderPage::setupContextMenu(), Gui::ViewProviderTextDocument::setupContextMenu(), PartDesignGui::ViewProvider::setupContextMenu(), and SketcherGui::ViewProviderSketch::setupContextMenu().

setUpdatesEnabled()

void ViewProvider::setUpdatesEnabled

(

bool

enable

)

References setStatus(), and Gui::UpdateData.

setVisible()

void ViewProvider::setVisible

(

bool

s

)

References hide(), and show().

Referenced by FemGui::TaskDlgFemConstraint::open(), FemGui::TaskDlgFemConstraintContact::open(), FemGui::TaskDlgFemConstraintDisplacement::open(), FemGui::TaskDlgFemConstraintFixed::open(), FemGui::TaskDlgFemConstraintForce::open(), FemGui::TaskDlgFemConstraintHeatflux::open(), FemGui::TaskDlgFemConstraintInitialTemperature::open(), FemGui::TaskDlgFemConstraintPlaneRotation::open(), FemGui::TaskDlgFemConstraintPressure::open(), FemGui::TaskDlgFemConstraintPulley::open(), FemGui::TaskDlgFemConstraintSpring::open(), FemGui::TaskDlgFemConstraintTemperature::open(), FemGui::TaskDlgFemConstraintTransform::open(), and Gui::ViewProviderOrigin::setTemporaryVisibility().

show()

void ViewProvider::show ( void  )

virtual

Shows the view provider.

Reimplemented in MeshGui::ViewProviderMeshCurvature, DrawingGui::ViewProviderDrawingPage, DrawingGui::ViewProviderDrawingView, DrawingGui::ViewProviderDrawingClip, FemGui::ViewProviderFemAnalysis, FemGui::ViewProviderFemPostObject, InspectionGui::ViewProviderInspection, TechDrawGui::ViewProviderViewClip, Gui::ViewProviderDocumentObject, TechDrawGui::ViewProviderDrawingView, TechDrawGui::ViewProviderPage, and TechDrawGui::ViewProviderTemplate.

References setModeSwitch().

Referenced by PartGui::DlgFilletEdges::accept(), PartDesignGui::ViewProvider::makeTemporaryVisible(), PartGui::ViewProviderOffset::onDelete(), PartGui::ViewProviderThickness::onDelete(), PartDesignGui::ViewProvider::onDelete(), PartGui::OffsetWidget::reject(), PartGui::ThicknessWidget::reject(), PartDesignGui::TaskDlgFeatureParameters::reject(), PartDesignGui::TaskDlgSketchBasedParameters::reject(), PartGui::DlgFilletEdges::setupFillet(), setVisible(), Gui::ViewProviderDocumentObject::show(), Mod.Show.mTempoVis.TempoVis::show_all_dependencies(), Mod.Show.mTempoVis.TempoVis::show_all_dependent(), Gui::Application::showViewProvider(), update(), and Gui::ViewProviderDocumentObject::updateView().

showInTree()

virtual bool Gui::ViewProvider::showInTree ( ) const

virtual

Tell the tree view if this object should appear there.

Reimplemented in Gui::ViewProviderDocumentObject.

startEditing()

ViewProvider * ViewProvider::startEditing ( int  ModNum = 0 )

virtual

Reimplemented in Gui::ViewProviderLink, Gui::ViewProviderDragger, and PartDesignGui::ViewProviderTransformed.

References setEdit().

Referenced by draftguitools.gui_edit.Edit::mousePressed(), SpreadsheetGui::ViewProviderSheet::showSpreadsheetView(), Gui::ViewProviderLink::startEditing(), Gui::ViewProviderDragger::startEditing(), and PartDesignGui::ViewProviderTransformed::startEditing().

testStatus()

bool Gui::ViewProvider::testStatus

(

ViewStatus

pos

)

const

Referenced by Gui::ViewProviderDocumentObject::isAttachedToDocument(), isUpdatesEnabled(), Gui::ViewProviderDocumentObject::onChanged(), PartGui::ViewProviderPartExt::setHighlightedEdges(), PartGui::ViewProviderPartExt::setHighlightedFaces(), PartGui::ViewProviderPartExt::setHighlightedPoints(), and Gui::ViewProviderDocumentObject::updateView().

toString()

std::string ViewProvider::toString

(

)

const

References pcRoot, and Gui::SoFCDB::writeNodesToString().

unsetEdit()

void ViewProvider::unsetEdit ( int  ModNum )

protectedvirtual

is called when you lose the edit mode

Reimplemented in Gui::ViewProviderAnnotationLabel, FemGui::ViewProviderFemAnalysis, FemGui::ViewProviderFemConstraint, FemGui::ViewProviderFemPostFunction, FemGui::ViewProviderFemPostObject, FemGui::ViewProviderSetElements, FemGui::ViewProviderSetFaces, FemGui::ViewProviderSetGeometry, FemGui::ViewProviderSetNodes, MeshGui::ViewProviderMesh, PartGui::ViewProvider2DObjectGrid, PartGui::ViewProviderCurveNet, PartGui::ViewProviderImport, PartGui::ViewProviderMirror, PartGui::ViewProviderFillet, PartGui::ViewProviderChamfer, PartGui::ViewProviderOffset, PartGui::ViewProviderThickness, PartGui::ViewProviderPrimitive, PartDesignGui::ViewProviderBase, PartDesignGui::ViewProviderHelix, PartDesignGui::ViewProviderLoft, PartDesignGui::ViewProviderPipe, PartDesignGui::ViewProviderPrimitive, PathGui::ViewProviderPathCompound, PointsGui::ViewProviderPoints, RaytracingGui::ViewProviderLux, RaytracingGui::ViewProviderPovray, RobotGui::ViewProviderEdge2TracObject, RobotGui::ViewProviderTrajectoryCompound, RobotGui::ViewProviderTrajectoryDressUp, SurfaceGui::ViewProviderFilling, SurfaceGui::ViewProviderGeomFillSurface, SurfaceGui::ViewProviderSections, TechDrawGui::ViewProviderBalloon, TechDrawGui::ViewProviderDimension, TechDrawGui::ViewProviderLeader, TechDrawGui::ViewProviderProjGroup, TechDrawGui::ViewProviderProjGroupItem, TechDrawGui::ViewProviderRichAnno, TechDrawGui::ViewProviderViewPart, TechDrawGui::ViewProviderViewSection, TechDrawGui::ViewProviderWeld, Gui::ViewProviderDragger, PartGui::ViewProviderPartExt, PartDesignGui::ViewProvider, PartDesignGui::ViewProviderDatum, PartDesignGui::ViewProviderShapeBinder, PartDesignGui::ViewProviderTransformed, SketcherGui::ViewProviderSketch, TechDrawGui::ViewProviderDrawingView, TechDrawGui::ViewProviderGeomHatch, TechDrawGui::ViewProviderHatch, TechDrawGui::ViewProviderPage, and Gui::ViewProviderOriginFeature.

Referenced by finishEditing(), PathScripts.PathJobGui.ViewProvider::uneditObject(), FemGui::ViewProviderFemAnalysis::unsetEdit(), and TechDrawGui::ViewProviderDrawingView::unsetEdit().

unsetEditViewer()

void ViewProvider::unsetEditViewer ( View3DInventorViewer *  )

virtual

restores viewer settings when leaving editing mode

Reimplemented in SketcherGui::ViewProviderSketch, Gui::ViewProviderDragger, and Gui::ViewProviderLink.

Referenced by Gui::View3DInventorViewer::resetEditingViewProvider().

update()

void ViewProvider::update ( const App::Property *  prop )

virtual

update the content of the ViewProvider this method have to implement the recalculation of the ViewProvider.

There are different reasons to update. E.g. only the view attribute has changed, or the data has manipulated.

Reimplemented in Gui::ViewProviderDocumentObject.

References hide(), isShow(), isUpdatesEnabled(), show(), and updateData().

Referenced by ArchStructure.CommandStructuralSystem::Activated(), ArchAxisSystem.AxisSystemTaskPanel::addElement(), ArchComponent.ComponentTaskPanel::addElement(), ArchSectionPlane.SectionPlaneTaskPanel::addElement(), DraftGui.FacebinderTaskPanel::addElement(), femtaskpanels.task_result_mechanical._TaskPanel::calculate(), Spreadsheet_legacy.SpreadsheetView::changeCell(), draftguitools.gui_edit.Edit::endEditing(), draftguitools.gui_trackers.boxTracker::height(), draftguitools.gui_trackers.rectangleTracker::p3(), Plot.Plot::plot(), Spreadsheet_legacy.SpreadsheetView::recompute(), ArchAxisSystem.AxisSystemTaskPanel::removeElement(), ArchComponent.ComponentTaskPanel::removeElement(), ArchSectionPlane.SectionPlaneTaskPanel::removeElement(), DraftGui.FacebinderTaskPanel::removeElement(), draftguitools.gui_trackers.gridTracker::reset(), ArchNesting.Nester::run(), draftguitools.gui_trackers.gridTracker::setMainlines(), draftguitools.gui_trackers.gridTracker::setSize(), draftguitools.gui_trackers.gridTracker::setSpacing(), Gui::Document::slotChangedObject(), Gui::ViewProviderDocumentObject::update(), and draftguitools.gui_edit_arch_objects.ArchWallGuiTools::update_object_from_edit_points().

updateData()

void ViewProvider::updateData ( const App::Property *  prop )

virtual

Reimplemented in Gui::ViewProviderAnnotation, Gui::ViewProviderAnnotationLabel, Gui::ViewProviderExtern, Gui::ViewProviderGeometryObject, Gui::ViewProviderInventorObject, Gui::ViewProviderMeasureDistance, Gui::ViewProviderOriginFeature, Gui::ViewProviderVRMLObject, DrawingGui::ViewProviderDrawingPage, DrawingGui::ViewProviderDrawingView, DrawingGui::ViewProviderDrawingClip, FemGui::ViewProviderFemConstraintBearing, FemGui::ViewProviderFemConstraintContact, FemGui::ViewProviderFemConstraintDisplacement, FemGui::ViewProviderFemConstraintFixed, FemGui::ViewProviderFemConstraintFluidBoundary, FemGui::ViewProviderFemConstraintForce, FemGui::ViewProviderFemConstraintGear, FemGui::ViewProviderFemConstraintHeatflux, FemGui::ViewProviderFemConstraintInitialTemperature, FemGui::ViewProviderFemConstraintPlaneRotation, FemGui::ViewProviderFemConstraintPressure, FemGui::ViewProviderFemConstraintPulley, FemGui::ViewProviderFemConstraintSpring, FemGui::ViewProviderFemConstraintTemperature, FemGui::ViewProviderFemConstraintTransform, FemGui::ViewProviderFemMesh, FemGui::ViewProviderFemMeshShapeNetgen, FemGui::ViewProviderFemPostFunctionProvider, FemGui::ViewProviderFemPostPlaneFunction, FemGui::ViewProviderFemPostSphereFunction, FemGui::ViewProviderFemPostObject, ImageGui::ViewProviderImagePlane, InspectionGui::ViewProviderInspection, MeshGui::ViewProviderMesh, MeshGui::ViewProviderIndexedFaceSet, MeshGui::ViewProviderMeshObject, MeshGui::ViewProviderMeshCurvature, MeshGui::ViewProviderMeshFaceSet, MeshGui::ViewProviderMeshNode, MeshGui::ViewProviderMeshTransform, MeshPartGui::ViewProviderCrossSections, PartGui::ViewProviderCrossSections, PartGui::ViewProvider2DObjectGrid, PartGui::ViewProviderBoolean, PartGui::ViewProviderMultiFuse, PartGui::ViewProviderMultiCommon, PartGui::ViewProviderCompound, PartGui::ViewProviderCurveNet, PartGui::ViewProviderFillet, PartGui::ViewProviderChamfer, PartGui::ViewProviderCustom, PartGui::ViewProviderPartReference, PartGui::ViewProviderRuledSurface, PartDesignGui::ViewProviderAddSub, PartDesignGui::ViewProviderDatumCoordinateSystem, PartDesignGui::ViewProviderDatumLine, PartDesignGui::ViewProviderDatumPlane, PartDesignGui::ViewProviderPrimitive, PathGui::ViewProviderArea, PathGui::ViewProviderAreaView, PathGui::ViewProviderPath, PathGui::ViewProviderPathShape, PointsGui::ViewProviderScattered, PointsGui::ViewProviderStructured, RobotGui::ViewProviderRobotObject, RobotGui::ViewProviderTrajectory, SketcherGui::ViewProviderCustom, TechDrawGui::ViewProviderAnnotation, TechDrawGui::ViewProviderBalloon, TechDrawGui::ViewProviderDimension, TechDrawGui::ViewProviderImage, TechDrawGui::ViewProviderLeader, TechDrawGui::ViewProviderProjGroup, TechDrawGui::ViewProviderProjGroupItem, TechDrawGui::ViewProviderRichAnno, TechDrawGui::ViewProviderSpreadsheet, TechDrawGui::ViewProviderSymbol, TechDrawGui::ViewProviderTile, TechDrawGui::ViewProviderViewPart, TechDrawGui::ViewProviderViewSection, TechDrawGui::ViewProviderWeld, Gui::ViewProviderDragger, Gui::ViewProviderLink, Gui::ViewProviderPlacement, PartGui::ViewProviderPartExt, PartDesignGui::ViewProvider, SketcherGui::ViewProviderSketch, TechDrawGui::ViewProviderDrawingView, TechDrawGui::ViewProviderGeomHatch, TechDrawGui::ViewProviderHatch, TechDrawGui::ViewProviderTemplate, FemGui::ViewProviderFemConstraint, FemGui::ViewProviderFemPostPipeline, TechDrawGui::ViewProviderViewClip, PartDesignGui::ViewProviderBody, SpreadsheetGui::ViewProviderSheet, and TechDrawGui::ViewProviderPage.

Referenced by ArchStructure.CommandStructuralSystem::Activated(), PathScripts.PathJobDlg.JobCreate::exec_(), draftviewproviders.view_dimension.ViewProviderLinearDimension::onChanged(), draftviewproviders.view_dimension.ViewProviderAngularDimension::onChanged(), draftviewproviders.view_wire.ViewProviderWire::onChanged(), PathScripts.PathOpGui.TaskPanelPage::pageUpdateData(), PathScripts.PathPropertyBagGui.TaskPanel::setupUi(), PathScripts.PathSetupSheetGui.OpTaskPanel::setupUi(), update(), Gui::ViewProviderAnnotation::updateData(), Gui::ViewProviderAnnotationLabel::updateData(), Gui::ViewProviderMeasureDistance::updateData(), DrawingGui::ViewProviderDrawingPage::updateData(), FemGui::ViewProviderFemPostFunctionProvider::updateData(), FemGui::ViewProviderFemPostPlaneFunction::updateData(), FemGui::ViewProviderFemPostSphereFunction::updateData(), TechDrawGui::ViewProviderBalloon::updateData(), TechDrawGui::ViewProviderDimension::updateData(), TechDrawGui::ViewProviderProjGroupItem::updateData(), Gui::ViewProviderDragger::updateData(), Gui::ViewProviderLink::updateData(), TechDrawGui::ViewProviderDrawingView::updateData(), TechDrawGui::ViewProviderGeomHatch::updateData(), TechDrawGui::ViewProviderHatch::updateData(), TechDrawGui::ViewProviderTemplate::updateData(), TechDrawGui::ViewProviderPage::updateData(), and Gui::ViewProviderDocumentObject::updateView().

useNewSelectionModel()

bool ViewProvider::useNewSelectionModel ( void  ) const

virtual

indicates if the ViewProvider use the new Selection model

Reimplemented in MeshGui::ViewProviderMesh, MeshGui::ViewProviderMeshCurvature, Gui::ViewProviderInventorObject, Gui::ViewProviderMeasureDistance, DrawingGui::ViewProviderDrawingPage, DrawingGui::ViewProviderDrawingView, DrawingGui::ViewProviderDrawingClip, FemGui::ViewProviderFemMesh, PathGui::ViewProviderPath, TechDrawGui::ViewProviderAnnotation, TechDrawGui::ViewProviderBalloon, TechDrawGui::ViewProviderDimension, TechDrawGui::ViewProviderImage, TechDrawGui::ViewProviderLeader, TechDrawGui::ViewProviderProjGroup, TechDrawGui::ViewProviderProjGroupItem, TechDrawGui::ViewProviderRichAnno, TechDrawGui::ViewProviderSpreadsheet, TechDrawGui::ViewProviderSymbol, TechDrawGui::ViewProviderTile, TechDrawGui::ViewProviderViewClip, TechDrawGui::ViewProviderViewPart, TechDrawGui::ViewProviderWeld, Gui::ViewProviderLink, Gui::ViewProviderPlacement, PartGui::ViewProviderPartExt, PartDesignGui::ViewProviderDatum, SpreadsheetGui::ViewProviderSheet, TechDrawGui::ViewProviderDrawingView, TechDrawGui::ViewProviderGeomHatch, TechDrawGui::ViewProviderHatch, TechDrawGui::ViewProviderPage, and TechDrawGui::ViewProviderTemplate.

References Gui::ViewParams::instance().

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

Member Data Documentation

overrideMode

std::string Gui::ViewProvider::overrideMode

protected

Referenced by getOverrideMode(), PartDesignGui::ViewProviderBody::onChanged(), setOverrideMode(), and PartDesignGui::ViewProviderBody::setOverrideMode().

pcAnnotation

SoSeparator* Gui::ViewProvider::pcAnnotation

protected

The root separator for annotations.

Referenced by getAnnotation(), and ~ViewProvider().

pcModeSwitch

SoSwitch* Gui::ViewProvider::pcModeSwitch

protected

this is the mode switch, all the different viewing modes are collected here

Referenced by addDisplayMaskMode(), Gui::ViewProviderExtern::adjustDocumentName(), PartGui::ViewProviderPartExt::attach(), getBoundingBox(), Gui::ViewProviderLink::getDetailPath(), Gui::ViewProviderPlacement::getDetailPath(), getDetailPath(), Gui::ViewProviderDocumentObject::getDetailPath(), getDisplayMaskMode(), Gui::ViewProviderDocumentObject::getElementPicked(), hide(), isShow(), Gui::ViewProviderLink::onBeforeChange(), Gui::ViewProviderLink::onChanged(), partialRender(), setModeSwitch(), setOverrideMode(), PartDesignGui::ViewProviderAddSub::setPreviewDisplayMode(), and ~ViewProvider().

pcRoot

SoSeparator* Gui::ViewProvider::pcRoot

protected

The root Separator of the ViewProvider.

Referenced by PartGui::ViewProviderPartExt::attach(), getAnnotation(), getBoundingBox(), Gui::ViewProviderLink::getDetailPath(), Gui::ViewProviderPlacement::getDetailPath(), getDetailPath(), Gui::ViewProviderAnnotationLabel::setEdit(), PartGui::ViewProviderMirror::setEdit(), PartDesignGui::ViewProviderTransformed::setEdit(), setRenderCacheMode(), Gui::ViewProviderGeometryObject::setSelectable(), Gui::ViewProviderGeometryObject::showBoundingBox(), MeshGui::ViewProviderIndexedFaceSet::showOpenEdges(), MeshGui::ViewProviderMeshObject::showOpenEdges(), MeshGui::ViewProviderMeshFaceSet::showOpenEdges(), toString(), Gui::ViewProviderAnnotationLabel::unsetEdit(), PartGui::ViewProviderMirror::unsetEdit(), PartDesignGui::ViewProviderTransformed::unsetEdit(), MeshPartGui::ViewProviderCrossSections::ViewProviderCrossSections(), PartGui::ViewProviderCrossSections::ViewProviderCrossSections(), and ~ViewProvider().

pcTransform

SoTransform* Gui::ViewProvider::pcTransform

protected

this is transformation for the provider

Referenced by Gui::ViewProviderDragger::setEdit(), setTransformation(), Gui::ViewProviderDragger::unsetEdit(), Gui::ViewProviderInventorObject::updateData(), Gui::ViewProviderVRMLObject::updateData(), MeshGui::ViewProviderMeshCurvature::updateData(), Gui::ViewProviderDragger::updateData(), Gui::ViewProviderLink::updateDataPrivate(), and ~ViewProvider().

pyViewObject

ViewProviderPy* Gui::ViewProvider::pyViewObject

protected

Referenced by getPyObject(), MeshGui::ViewProviderMesh::getPyObject(), Gui::ViewProviderDocumentObject::getPyObject(), Gui::ViewProviderLink::getPyObject(), SpreadsheetGui::ViewProviderSheet::getPyObject(), PartDesignGui::ViewProvider::getPyObject(), and ~ViewProvider().

signalChangeIcon

boost::signals2::signal<void ()> Gui::ViewProvider::signalChangeIcon

signal on icon change

Referenced by Gui::ViewProviderLink::checkIcon(), Gui::DocumentObjectData::DocumentObjectData(), PartGui::ViewProviderAttachExtension::extensionUpdateData(), Gui::LinkInfo::LinkInfo(), PartDesignGui::ViewProvider::setTipIcon(), TechDrawGui::ViewProviderPage::updateData(), and Gui::ViewProviderLink::updateDataPrivate().

signalChangeStatusTip

boost::signals2::signal<void (const QString&)> Gui::ViewProvider::signalChangeStatusTip

signal on status tip change

Referenced by Gui::DocumentObjectData::DocumentObjectData().

signalChangeToolTip

boost::signals2::signal<void (const QString&)> Gui::ViewProvider::signalChangeToolTip

signal on tooltip change

Referenced by Gui::DocumentObjectData::DocumentObjectData().

sPixmap

const char* Gui::ViewProvider::sPixmap

protected

Referenced by TechDrawGui::ViewProviderDimension::attach(), TechDrawGui::ViewProviderViewPart::attach(), Gui::ViewProviderLink::checkIcon(), PartGui::ViewProviderSpline::getIcon(), getIcon(), Gui::ViewProviderDocumentObjectGroup::getIcon(), Gui::ViewProviderLink::getIcon(), Gui::ViewProviderPart::getIcon(), TechDrawGui::ViewProviderDimension::updateData(), TechDrawGui::ViewProviderProjGroupItem::updateData(), TechDrawGui::ViewProviderPage::updateData(), PartDesignGui::ViewProviderBoolean::ViewProviderBoolean(), PartDesignGui::ViewProviderDatumCoordinateSystem::ViewProviderDatumCoordinateSystem(), FemGui::ViewProviderFemMesh::ViewProviderFemMesh(), FemGui::ViewProviderFemPostPlaneFunction::ViewProviderFemPostPlaneFunction(), Gui::ViewProviderGeometryObject::ViewProviderGeometryObject(), TechDrawGui::ViewProviderLeader::ViewProviderLeader(), Gui::ViewProviderLink::ViewProviderLink(), PartGui::ViewProviderOffset2D::ViewProviderOffset2D(), PartGui::ViewProviderPartExt::ViewProviderPartExt(), TechDrawGui::ViewProviderRichAnno::ViewProviderRichAnno(), Gui::ViewProviderTextDocument::ViewProviderTextDocument(), and TechDrawGui::ViewProviderViewPart::ViewProviderViewPart().

StatusBits

std::bitset<32> Gui::ViewProvider::StatusBits

protected

---

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

• FreeCAD/src/Gui/ViewProvider.h
• FreeCAD/src/Gui/ViewProvider.cpp