Gui::ViewProviderGeometryObject Class Reference

The base class for all view providers that display geometric data, like mesh, point cloudes and shapes. More...

#include <ViewProviderGeometryObject.h>

Inheritance diagram for Gui::ViewProviderGeometryObject:

Public Member Functions
void	attach (App::DocumentObject *pcObject)
	Attaches the document object to this view provider.
SoFCSelection *	getHighlightNode () const
SoPickedPoint *	getPickedPoint (const SbVec2s &pos, const View3DInventorViewer &viewer) const
	This method is provided for convenience and does basically the same as getPickedPoints() unless that only the closest point to the camera will be picked.
SoPickedPointList	getPickedPoints (const SbVec2s &pos, const View3DInventorViewer &viewer, bool pickAll=false) const
	Returns a list of picked points from the geometry under pcHighlight.
virtual Base::Type	getTypeId (void) const
bool	isSelectable (void) const
	indicates if the ViewProvider can be selected
void	updateData (const App::Property *)
	Gets called if some of the property hade bin changed.
	ViewProviderGeometryObject ()
	constructor.
virtual	~ViewProviderGeometryObject ()
	destructor.
Static Public Member Functions
static void *	create (void)
static Base::Type	getClassTypeId (void)
static void	init (void)
Public Attributes
App::PropertyBool	BoundingBox
App::PropertyBool	Selectable
App::PropertyColor	ShapeColor
App::PropertyMaterial	ShapeMaterial
App::PropertyPercent	Transparency
Protected Member Functions
SoFCSelection *	createFromSettings () const
virtual const App::PropertyData &	getPropertyData (void) const
void	onChanged (const App::Property *prop)
	get called by the container whenever a property has been changed
void	setSelectable (bool Selectable=true)
void	showBoundingBox (bool)
Static Protected Member Functions
static const App::PropertyData *	getPropertyDataPtr (void)
Protected Attributes
SoFCBoundingBox *	pcBoundingBox
SoSwitch *	pcBoundSwitch
SoFCSelection *	pcHighlight
SoMaterial *	pcShapeMaterial
Edit methods

bool	doubleClicked (void)
	is called by the tree if the user double click on the object
void	setupContextMenu (QMenu , QObject , const char *)
	set up the context-menu with the supported edit modes
bool	setEdit (int ModNum)
	is called by the document when the provider goes in edit mode
void	setEditViewer (View3DInventorViewer *, int ModNum)
	adjust viewer settings when editing a view provider
void	unsetEdit (int ModNum)
	is called when you loose the edit mode
void	unsetEditViewer (View3DInventorViewer *)
	restores viewer settings when leaving editing mode

Detailed Description

The base class for all view providers that display geometric data, like mesh, point cloudes and shapes.

Author:: Werner Mayer

Definition at line 46 of file ViewProviderGeometryObject.h.

Constructor & Destructor Documentation

ViewProviderGeometryObject::ViewProviderGeometryObject ( )

ViewProviderGeometryObject::~ViewProviderGeometryObject ( ) [virtual]

destructor.

Definition at line 96 of file ViewProviderGeometryObject.cpp.

References pcBoundingBox, pcHighlight, and pcShapeMaterial.

Member Function Documentation

void ViewProviderGeometryObject::attach ( App::DocumentObject * pcObject ) [virtual]

Attaches the document object to this view provider.

Reimplemented from Gui::ViewProviderDocumentObject.

Reimplemented in FemGui::ViewProviderFemMesh, ImageGui::ViewProviderImagePlane, MeshGui::ViewProviderMesh, MeshGui::ViewProviderIndexedFaceSet, MeshGui::ViewProviderMeshObject, MeshGui::ViewProviderMeshFaceSet, MeshGui::ViewProviderMeshNode, MeshGui::ViewProviderMeshTransform, MeshGui::ViewProviderMeshTransformDemolding, PartGui::ViewProviderPartBase, PartGui::ViewProvider2DObject, PartGui::ViewProviderCurveNet, PartGui::ViewProviderPartExt, PartGui::ViewProviderPartReference, PointsGui::ViewProviderPoints, RobotGui::ViewProviderRobotObject, RobotGui::ViewProviderTrajectory, and SketcherGui::ViewProviderSketch.

Definition at line 149 of file ViewProviderGeometryObject.cpp.

References Gui::SoFCSelection::documentName, App::DocumentObject::getDocument(), App::Document::getName(), App::DocumentObject::getNameInDocument(), Gui::SoFCSelection::objectName, pcHighlight, and Gui::SoFCSelection::subElementName.

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

Reimplemented from Gui::ViewProviderDocumentObject.

Definition at line 67 of file ViewProviderGeometryObject.cpp.

SoFCSelection * ViewProviderGeometryObject::createFromSettings ( ) const [protected]

Definition at line 499 of file ViewProviderGeometryObject.cpp.

References Gui::SoFCSelection::colorHighlight, Gui::SoFCSelection::colorSelection, Gui::WindowParameter::getDefaultParameter(), App::PropertyBool::getValue(), Gui::SoFCSelection::highlightMode, Py::long, Gui::SoFCSelection::OFF, Gui::SoFCSelection::SEL_OFF, Selectable, and Gui::SoFCSelection::selectionMode.

Referenced by PartGui::ViewProviderPartBase::computeEdges(), PartGui::ViewProviderPartBase::computeFaces(), PartGui::ViewProviderPartBase::computeVertices(), and ViewProviderGeometryObject().

bool ViewProviderGeometryObject::doubleClicked ( void ) [virtual]

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

Reimplemented from Gui::ViewProvider.

Reimplemented in MeshGui::ViewProviderMesh, PartDesignGui::ViewProvider, RobotGui::ViewProviderEdge2TracObject, and SketcherGui::ViewProviderSketch.

Definition at line 198 of file ViewProviderGeometryObject.cpp.

References Gui::Application::activeDocument(), Gui::ViewProvider::Default, Gui::Application::Instance, and Gui::Document::setEdit().

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

Reimplemented from Gui::ViewProviderDocumentObject.

Definition at line 67 of file ViewProviderGeometryObject.cpp.

SoFCSelection* Gui::ViewProviderGeometryObject::getHighlightNode ( ) const [inline]

Definition at line 70 of file ViewProviderGeometryObject.h.

Referenced by MeshGui::ViewProviderMeshCurvature::updateData().

SoPickedPoint * ViewProviderGeometryObject::getPickedPoint	(	const SbVec2s &	pos,
		const View3DInventorViewer &	viewer
	)			const

This method is provided for convenience and does basically the same as getPickedPoints() unless that only the closest point to the camera will be picked.

Note:: It is in the response of the client programmer to delete the returned SoPickedPoint object.

Definition at line 453 of file ViewProviderGeometryObject.cpp.

References pcHighlight.

SoPickedPointList ViewProviderGeometryObject::getPickedPoints	(	const SbVec2s &	pos,
		const View3DInventorViewer &	viewer,
		bool	pickAll = `false`
	)			const

Returns a list of picked points from the geometry under pcHighlight.

If pickAll is false (the default) only the intersection point closest to the camera will be picked, otherwise all intersection points will be picked.

Definition at line 435 of file ViewProviderGeometryObject.cpp.

References pcHighlight.

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

Reimplemented from Gui::ViewProviderDocumentObject.