Developer Documentation
SkeletonObject.hh
Go to the documentation of this file.
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 // Types
53 //
54 //=============================================================================
55 
62 #ifndef SKELETONOBJECT_HH
63 #define SKELETONOBJECT_HH
64 
65 
66 //== INCLUDES =================================================================
67 
68 #include "SkeletonTypes.hh"
72 
73 #include "SkeletonNodeT.hh"
74 #include "SkeletonTypes.hh"
75 
76 //== TYPEDEFS =================================================================
77 
78 //== CLASS DEFINITION =========================================================
79 
83 
84  friend class TypeSkeletonPlugin;
85 
86  public:
90  SkeletonObject(const SkeletonObject &_other);
92  virtual ~SkeletonObject();
94  virtual void cleanup();
95 
96  virtual BaseObject* copy();
97 
98  protected:
100  virtual void init();
101  void init(Skeleton* _pSkeleton);
102 
107  public:
109  void setName( QString _name );
111 
116  public:
118  Skeleton* skeleton();
119 
120  private:
124 
129  public:
132 
133  private:
137 
142  public:
144  QString getObjectinfo();
146 
151  public:
153  bool picked( uint _node_idx );
155  void enablePicking( bool _enable );
157  bool pickingEnabled();
159 
160  AnimationHandle activePose();
161  void setActivePose(const AnimationHandle &_hAni);
162 
163  void showIndices(bool _bVisible = true);
164  bool indicesVisible();
165 
166  void updateIndices();
167  void updateIndices(const AnimationHandle &_hAni);
168 
169  void showMotionPath(bool _visible = true);
170  bool motionPathVisible();
171 
172  void updateMotionPath();
173  void updateMotionPath(const AnimationHandle &_hAni);
174 
175 
176  //===========================================================================
183  //===========================================================================
184 
185  protected:
193  void update(UpdateType _type = UPDATE_ALL );
194 
196 };
197 
198 //=============================================================================
199 #endif // SKELETONOBJECT_HH defined
200 //=============================================================================
virtual void cleanup()
#define DLLEXPORT
Skeleton * skeleton_
A pointer to the skeleton data.
virtual bool picked(uint _node_idx)
detect if the node has been picked
Update type class.
Definition: UpdateType.hh:70
virtual bool pickingEnabled()
A handle used to refer to an animation or to a specific frame in an animation.
virtual void setName(QString _name)
path to the file from which the object is loaded ( defaults to "." )
virtual void update(UpdateType _type=UPDATE_ALL)
This function is called to update the object.
virtual BaseObject * copy()
Returns a full copy of the object.
Definition: BaseObject.cc:780
virtual void enablePicking(bool _enable)
virtual QString getObjectinfo()
Get all Info for the Object as a string.
Definition: BaseObject.cc:255
const UpdateType UPDATE_ALL(UpdateTypeSet(1))
Identifier for all updates.
ACG::SceneGraph::SkeletonNodeT< Skeleton > * skeletonNode_
A pointer to the scenegraph node.