Developer Documentation
InfoSkeletonObjectPlugin Class Reference

Plugin to visualize information about objects in the scene. More...

#include <Plugin-InfoSkeleton/SkeletonObjectInfoPlugin.hh>

Inheritance diagram for InfoSkeletonObjectPlugin:
BaseInterface InformationInterface LoggingInterface StatusbarInterface

Public Slots

int jointCount (int _skeletonID)
 get total number of joints for a given skeleton More...
 
int branchCount (int _skeletonID)
 get total number of branches for a given skeleton More...
 
int leafCount (int _skeletonID)
 get total number of leaves for a given skeleton More...
 
Vector boundingBoxMin (int _skeletonID)
 get minumum bounding box point More...
 
Vector boundingBoxMax (int _skeletonID)
 get maximum bounding box point More...
 
Vector boundingBoxSize (int _skeletonID)
 get the size of the bounding box More...
 
double boneLength (int _skeletonID, int _jointID)
 get the length of a bone More...
 
double minBoneLength (int _skeletonID)
 get the minimal bone length More...
 
double maxBoneLength (int _skeletonID)
 get the maximal bone length More...
 
double meanBoneLength (int _skeletonID)
 get the mean bone length More...
 
QString version ()
 

Signals

void setSlotDescription (QString _slotName, QString _slotDescription, QStringList _parameters, QStringList _descriptions)
 
void log (Logtype _type, QString _message)
 
void log (QString _message)
 
void addWidgetToStatusbar (QWidget *_widget)
 
- Signals inherited from BaseInterface
virtual void updateView ()
 Update current view in Main Application. More...
 
virtual void setSlotDescription (QString _slotName, QString _slotDescription, QStringList _parameters, QStringList _descriptions)
 Set a description for a public slot. More...
 
virtual void setRenderer (unsigned int _viewer, QString _rendererName)
 Set a renderer for the given viewer. More...
 
- Signals inherited from LoggingInterface
virtual void log (Logtype _type, QString _message)=0
 
virtual void log (QString _message)=0
 
- Signals inherited from StatusbarInterface
virtual void showStatusMessage (QString _message, int _timeout=0)
 Show a message in the status bar. More...
 

Public Member Functions

QString name ()
 Name of the Plugin.
 
QString description ()
 Description of the Plugin.
 

Private Slots

void initializePlugin ()
 
void pluginsInitialized ()
 initialize the plugin
 
void noguiSupported ()
 
- Private Slots inherited from BaseInterface
virtual void exit ()
 
virtual QString version ()
 Return a version string for your plugin. More...
 
- Private Slots inherited from InformationInterface

Private Member Functions

void slotInformationRequested (const QPoint _clickedPoint, DataType _type)
 Show information dialog on clicked object. More...
 
DataType supportedDataTypes ()
 Get data type for information requests. More...
 
void printSkeletonInfo (Skeleton *_id, unsigned int _objectId, unsigned int _index, ACG::Vec3d &_hitPoint)
 
void setDescriptions ()
 set scripting slot descriptions More...
 
- Private Member Functions inherited from BaseInterface
virtual void noguiSupported ()
 
virtual ~BaseInterface ()
 Destructor.
 
virtual void blockScenegraphUpdates (bool _block)
 Tell the core to prevent scenegraph updates. More...
 
virtual void updatedObject (int _objectId)
 An object has been changed or added by this plugin. More...
 
virtual void updatedObject (int _identifier, const UpdateType &_type)
 An object has been changed or added by this plugin. More...
 
virtual void nodeVisibilityChanged (int _identifier)
 A scenegraph node has been shown or hidden. More...
 
virtual void getCurrentRenderer (unsigned int _viewer, QString &_rendererName)
 Get the current renderer for the given viewer. More...
 
- Private Member Functions inherited from InformationInterface
virtual ~InformationInterface ()
 Default destructor.
 
- Private Member Functions inherited from LoggingInterface
virtual ~LoggingInterface ()
 Destructor.
 
- Private Member Functions inherited from StatusbarInterface
virtual ~StatusbarInterface ()
 Destructor.
 
void setStatus (ApplicationStatus::applicationStatus _status)
 Sets the status icon of the StatusBar. More...
 
void clearStatusMessage ()
 Removes the current message from the statusBar. More...
 
void addWidgetToStatusbar (QWidget *_widget)
 Add a widget on the right side of the statusBar. More...
 

Private Attributes

InfoDialoginfo_
 

Detailed Description

Plugin to visualize information about objects in the scene.

Plugin to visualize information about objects in the scene

Definition at line 75 of file SkeletonObjectInfoPlugin.hh.

Member Function Documentation

◆ boneLength

double InfoSkeletonObjectPlugin::boneLength ( int  _skeletonID,
int  _jointID 
)
slot

get the length of a bone

get the length of a bone from a given joint to his parent

Parameters
_skeletonIDid of a skeleton
_jointIDid of the joint
Returns
bone length (from _jointID to the parent of _jointID)

Definition at line 227 of file SkeletonObjectInfoScripting.cc.

◆ boundingBoxMax

Vector InfoSkeletonObjectPlugin::boundingBoxMax ( int  _skeletonID)
slot

get maximum bounding box point

get total number of vertices for a given object

Parameters
_skeletonIDskeleton id
Returns
maximum point of the bounding box

Definition at line 185 of file SkeletonObjectInfoScripting.cc.

◆ boundingBoxMin

Vector InfoSkeletonObjectPlugin::boundingBoxMin ( int  _skeletonID)
slot

get minumum bounding box point

get total number of vertices for a given object

Parameters
_skeletonIDskeleton id
Returns
minimum point of the bounding box

Definition at line 164 of file SkeletonObjectInfoScripting.cc.

◆ boundingBoxSize

Vector InfoSkeletonObjectPlugin::boundingBoxSize ( int  _skeletonID)
slot

get the size of the bounding box

get total number of vertices for a given object

Parameters
_skeletonIDskeleton id
Returns
size of the bounding box

Definition at line 206 of file SkeletonObjectInfoScripting.cc.

◆ branchCount

int InfoSkeletonObjectPlugin::branchCount ( int  _skeletonID)
slot

get total number of branches for a given skeleton

get total number of vertices for a given object

Parameters
_skeletonIDskeleton id
Returns
number of branches (joints with multiple childs) or -1 if an error occured

Definition at line 115 of file SkeletonObjectInfoScripting.cc.

◆ jointCount

int InfoSkeletonObjectPlugin::jointCount ( int  _skeletonID)
slot

get total number of joints for a given skeleton

get total number of vertices for a given object

Parameters
_skeletonIDskeleton id
Returns
number of joints or -1 if an error occured

Definition at line 96 of file SkeletonObjectInfoScripting.cc.

◆ leafCount

int InfoSkeletonObjectPlugin::leafCount ( int  _skeletonID)
slot

get total number of leaves for a given skeleton

get total number of vertices for a given object

Parameters
_skeletonIDskeleton id
Returns
number of leaves or -1 if an error occured

Definition at line 140 of file SkeletonObjectInfoScripting.cc.

◆ maxBoneLength

double InfoSkeletonObjectPlugin::maxBoneLength ( int  _skeletonID)
slot

get the maximal bone length

get total number of vertices for a given object

Parameters
_skeletonIDskeleton id
Returns
maximal bone length or -1 if an error occured

Definition at line 286 of file SkeletonObjectInfoScripting.cc.

◆ meanBoneLength

double InfoSkeletonObjectPlugin::meanBoneLength ( int  _skeletonID)
slot

get the mean bone length

get total number of vertices for a given object

Parameters
_skeletonIDskeleton id
Returns
mean bone length or -1 if an error occured

Definition at line 316 of file SkeletonObjectInfoScripting.cc.

◆ minBoneLength

double InfoSkeletonObjectPlugin::minBoneLength ( int  _skeletonID)
slot

get the minimal bone length

get total number of vertices for a given object

Parameters
_skeletonIDskeleton id
Returns
minimal bone length or -1 if an error occured

Definition at line 256 of file SkeletonObjectInfoScripting.cc.

◆ setDescriptions()

void InfoSkeletonObjectPlugin::setDescriptions ( )
private

set scripting slot descriptions

set the descriptions for scripting slots

Definition at line 52 of file SkeletonObjectInfoScripting.cc.

◆ slotInformationRequested()

void InfoSkeletonObjectPlugin::slotInformationRequested ( const QPoint  _clickedPoint,
DataType  _type 
)
privatevirtual

Show information dialog on clicked object.

This slot is called each time the user clicks on an object. The information plugin for a specific type should display the necessary information on all entity types and the clicked object itself.

Parameters
_clickedPointThe 2D point in screen coords, which the user has clicked
_typeData type to be registered

Implements InformationInterface.

Definition at line 197 of file SkeletonObjectInfoPlugin.cc.

◆ supportedDataTypes()

DataType InfoSkeletonObjectPlugin::supportedDataTypes ( )
privatevirtual

Get data type for information requests.

This slot is called by the core in order to identify the data types for which the plugin provides information.

Returns
The supported data types (OR'ed in case of multiple types)

Implements InformationInterface.

Definition at line 81 of file SkeletonObjectInfoPlugin.cc.


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