Developer Documentation
SkeletonObjectInfoPlugin.hh
1 /*===========================================================================*\
2 * *
3 * OpenFlipper *
4  * Copyright (c) 2001-2015, RWTH-Aachen University *
5  * Department of Computer Graphics and Multimedia *
6  * All rights reserved. *
7  * www.openflipper.org *
8  * *
9  *---------------------------------------------------------------------------*
10  * This file is part of OpenFlipper. *
11  *---------------------------------------------------------------------------*
12  * *
13  * Redistribution and use in source and binary forms, with or without *
14  * modification, are permitted provided that the following conditions *
15  * are met: *
16  * *
17  * 1. Redistributions of source code must retain the above copyright notice, *
18  * this list of conditions and the following disclaimer. *
19  * *
20  * 2. Redistributions in binary form must reproduce the above copyright *
21  * notice, this list of conditions and the following disclaimer in the *
22  * documentation and/or other materials provided with the distribution. *
23  * *
24  * 3. Neither the name of the copyright holder nor the names of its *
25  * contributors may be used to endorse or promote products derived from *
26  * this software without specific prior written permission. *
27  * *
28  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS *
29  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED *
30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A *
31  * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER *
32  * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, *
33  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, *
34  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR *
35  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF *
36  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING *
37  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS *
38  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *
39 * *
40 \*===========================================================================*/
41 
42 /*===========================================================================*\
43 * *
44 * $Revision$ *
45 * $LastChangedBy$ *
46 * $Date$ *
47 * *
48 \*===========================================================================*/
49 
50 //=============================================================================
51 //
52 // CLASS InfoMeshObjectPlugin
53 //
54 // Author: David Bommes <bommes@cs.rwth-aachen.de>
55 //=============================================================================
56 
57 #ifndef INFOPLUGIN_HH
58 #define INFOPLUGIN_HH
59 
60 //== INCLUDES =================================================================
61 
62 #include <QObject>
63 
66 
71 
72 #include "infoDialog.hh"
73 
74 //== CLASS DEFINITION =========================================================
75 
76 
82 {
83  Q_OBJECT
84  Q_INTERFACES(BaseInterface)
85  Q_INTERFACES(InformationInterface)
86  Q_INTERFACES(LoggingInterface)
87  Q_INTERFACES(StatusbarInterface)
88 
89 #if QT_VERSION >= 0x050000
90  Q_PLUGIN_METADATA(IID "org.OpenFlipper.Plugins.Plugin-SkeletonObjectInfo")
91 #endif
92 
93 
94  signals:
95 
96  // BaseInterface
97  void setSlotDescription(QString _slotName, QString _slotDescription,
98  QStringList _parameters, QStringList _descriptions);
99 
100  // LoggingInterface
101  void log(Logtype _type, QString _message);
102  void log(QString _message);
103 
104  // StatusbarInterface
105  void addWidgetToStatusbar(QWidget* _widget);
106 
107  private slots :
108 
109  // BaseInterface
110  void initializePlugin();
111  void pluginsInitialized();
112 
113  void noguiSupported( ) {} ;
114 
115  // InformationInterface
116  void slotInformationRequested(const QPoint _clickedPoint, DataType _type);
118 
119  public :
120 
121  // default constructor
122  InfoSkeletonObjectPlugin(): info_(0) {};
123 
124  // default destructor
126 
128  QString name(){ return (QString("InfoSkeletonObject")); };
129 
131  QString description() { return (QString(tr("Provides Information on Skeleton Objects"))); };
132 
133  private :
134  void printSkeletonInfo( Skeleton* _id, unsigned int _objectId, unsigned int _index, ACG::Vec3d& _hitPoint );
135 
136  InfoDialog* info_;
137 
138  public slots:
140  int jointCount(int _skeletonID);
142  int branchCount(int _skeletonID);
144  int leafCount(int _skeletonID);
145 
147  Vector boundingBoxMin(int _skeletonID);
149  Vector boundingBoxMax(int _skeletonID);
151  Vector boundingBoxSize(int _skeletonID);
152 
154  double boneLength(int _skeletonID, int _jointID);
155 
157  double minBoneLength(int _skeletonID);
159  double maxBoneLength(int _skeletonID);
161  double meanBoneLength(int _skeletonID);
162 
163  private:
165  void setDescriptions();
166 
167  public slots:
168  QString version() { return QString("1.0"); };
169 
172 };
173 
174 #endif //MOVEPLUGIN_HH
175 
Vector boundingBoxSize(int _skeletonID)
get the size of the bounding box
Predefined datatypes.
Definition: DataTypes.hh:96
Logtype
Log types for Message Window.
Plugin to visualize information about objects in the scene.
QString description()
Description of the Plugin.
Control OpenFlippers status bar.
Vector boundingBoxMin(int _skeletonID)
get minumum bounding box point
double minBoneLength(int _skeletonID)
get the minimal bone length
DataType supportedDataTypes()
Get data type for information requests.
Interface class from which all plugins have to be created.
Vector boundingBoxMax(int _skeletonID)
get maximum bounding box point
QString name()
Name of the Plugin.
Interface for all Plugins which do logging to the logging window of the framework.
double boneLength(int _skeletonID, int _jointID)
get the length of a bone
double maxBoneLength(int _skeletonID)
get the maximal bone length
void pluginsInitialized()
initialize the plugin
int branchCount(int _skeletonID)
get total number of branches for a given skeleton
void setDescriptions()
set scripting slot descriptions
void slotInformationRequested(const QPoint _clickedPoint, DataType _type)
Show information dialog on clicked object.
int jointCount(int _skeletonID)
get total number of joints for a given skeleton
double meanBoneLength(int _skeletonID)
get the mean bone length
Interface class for providing information on objects.
int leafCount(int _skeletonID)
get total number of leaves for a given skeleton