PluginFunctions.hh File Reference

#include <QPair>
#include <OpenFlipper/common/Types.hh>
#include <ACG/Scenegraph/SceneGraph.hh>
#include <OpenFlipper/BasePlugin/PluginFunctionsViewControls.hh>

Include dependency graph for PluginFunctions.hh:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	PluginFunctions::ObjectIterator
	Core Data Iterator. More...
class	PluginFunctions::BaseObjectIterator
	Core Data Iterator used to iterate over all objects (Including groups). More...
Namespaces
namespace	PluginFunctions
Functions
int	PluginFunctions::viewerId ()
	Return unique viewer id.
BaseObject *&	PluginFunctions::objectRoot ()
	Get the root of the object structure.
Active Objects
bool	PluginFunctions::getPickedObject (const unsigned int _node_idx, BaseObjectData *&_object)
	Get the picked mesh.
Identifier handling
bool	PluginFunctions::getSourceIdentifiers (std::vector< int > &_identifiers)
	Get the identifiers of all objects marked as a source object.
bool	PluginFunctions::getTargetIdentifiers (std::vector< int > &_identifiers)
	Get the identifiers of all objects marked as a target object.
bool	PluginFunctions::getAllMeshes (std::vector< int > &_identifiers)
	Get identifiers of all meshes.
DLLEXPORT bool	PluginFunctions::getAllObjectIdentifiers (std::vector< int > &_identifiers)
	Get identifiers of all objects.
bool	PluginFunctions::getObject (const int _identifier, BaseObject *&_object)
	Get the object which has the given identifier.
bool	PluginFunctions::getObject (const int _identifier, BaseObjectData *&_object)
int	PluginFunctions::getObjectId (const QString _name)
DLLEXPORT bool	PluginFunctions::objectExists (const int _identifier)
	Check if an object with this identifier exists.
int	PluginFunctions::objectCount ()
	Get the number of available objects.
int	PluginFunctions::targetCount ()
	Get the number of target objects.
int	PluginFunctions::sourceCount ()
	Get the number of source objects.
int	PluginFunctions::visibleCount ()
	Get the number of visible objects.
Examiner handling
int	PluginFunctions::viewers ()
	Get the number of viewers.
void	PluginFunctions::setActiveExaminer (const unsigned int _id)
	Set the active id of the examiner which got the last mouse events.
unsigned int	PluginFunctions::activeExaminer ()
	Get the id of the examiner which got the last mouse events.
QString	PluginFunctions::getEncodedExaminerView ()
	Get the encoded view for the active examiner.
QString	PluginFunctions::getEncodedExaminerView (int _viewerId)
	Get the encoded view for the given.
void	PluginFunctions::setEncodedExaminerView (QString _view)
	Set the encoded view for the active examiner.
void	PluginFunctions::setEncodedExaminerView (int _viewerId, QString _view)
	Set the encoded view for the given.
void	PluginFunctions::setSceneCenter (const ACG::Vec3d &_center, int _viewer)
const ACG::Vec3d &	PluginFunctions::sceneCenter (int _viewer=ALL_VIEWERS)
	Get the current scene center.
bool	PluginFunctions::scenegraphPick (ACG::SceneGraph::PickTarget _pickTarget, const QPoint &_mousePos, unsigned int &_nodeIdx, unsigned int &_targetIdx, ACG::Vec3d *_hitPointPtr=0)
bool	PluginFunctions::scenegraphPick (const unsigned int _examiner, ACG::SceneGraph::PickTarget _pickTarget, const QPoint &_mousePos, unsigned int &_nodeIdx, unsigned int &_targetIdx, ACG::Vec3d *_hitPointPtr=0)
bool	PluginFunctions::scenegraphRegionPick (ACG::SceneGraph::PickTarget _pickTarget, const QRegion &_region, QList< QPair< unsigned int, unsigned int > > &_list)
bool	PluginFunctions::scenegraphRegionPick (const unsigned int _examiner, ACG::SceneGraph::PickTarget _pickTarget, const QRegion &_region, QList< QPair< unsigned int, unsigned int > > &_list)
void	PluginFunctions::traverse (ACG::SceneGraph::MouseEventAction &_action)
void	PluginFunctions::traverse (const unsigned int _examiner, ACG::SceneGraph::MouseEventAction &_action)
	Execute Scenegraph traversal with action and a specified examiner.
const std::string	PluginFunctions::pickMode ()
	Get the current Picking mode.
void	PluginFunctions::pickMode (std::string _mode)
	Set the current Picking mode for all examiner widgets.
void	PluginFunctions::getCurrentViewImage (QImage &_image)
	Returns a QImage of the current View.
ACG::SceneGraph::BaseNode *	PluginFunctions::getSceneGraphRootNode ()
	get scenegraph root node
ACG::SceneGraph::BaseNode *	PluginFunctions::getRootNode ()
	Get the root node for data objects.
void	PluginFunctions::addGlobalNode (ACG::SceneGraph::BaseNode *_node)
	Add a node under the root node.
void	PluginFunctions::addObjectRenderingNode (ACG::SceneGraph::BaseNode *_node)
	Add scenegraph node modifing object rendering.
void	PluginFunctions::actionMode (Viewer::ActionMode _mode)
	Set the current Action Mode (PickMode,ExamineMode,...).
Viewer::ActionMode	PluginFunctions::actionMode ()
	Get the current Action mode.
void	PluginFunctions::shareGLWidget (QGLWidget *_widget)
	Sets the main QGLWidget for gl data sharing.
QGLWidget *	PluginFunctions::shareGLWidget ()
	Returns the main QGLWidget for gl data sharing.
DLLEXPORT void	PluginFunctions::allowRotation (bool _mode)
QPoint	PluginFunctions::mapToGlobal (const QPoint _point)
	Map coordinates of GL Widget to global coordinates.
QPoint	PluginFunctions::mapToLocal (const QPoint _point)
	Map global coordinates to GL Widget local coordinates.
void	PluginFunctions::setViewObjectMarker (ViewObjectMarker *_marker)
void	PluginFunctions::setDefaultViewObjectMarker (ViewObjectMarker *_marker)
ViewObjectMarker *	PluginFunctions::defaultViewObjectMarker ()
	Get the default ViewObjectMarker.
Do never use!!
void	PluginFunctions::setDataRoot (BaseObject *_root)
Getting data from objects and casting between them
BaseObjectData *	PluginFunctions::baseObjectData (BaseObject *_object)
	Cast an BaseObject to a BaseObjectData if possible.
Iterators
typedef QStringList	PluginFunctions::IteratorRestriction
const QStringList	PluginFunctions::ALL_OBJECTS
const QStringList	PluginFunctions::TARGET_OBJECTS ("target")
const QStringList	PluginFunctions::SOURCE_OBJECTS ("source")
DLLEXPORT ObjectIterator	PluginFunctions::objectsEnd ()
	Return Iterator to Object End.
DLLEXPORT BaseObjectIterator	PluginFunctions::baseObjectsEnd ()
	Return Iterator to Object End.

---

Detailed Description

This file contains functions which can be used by plugins to access data in the framework.

This file contains functions to setup the internal structures for PluginFunctions. Dont Use these Functions in your Plugins!

Definition in file PluginFunctions.hh.