OgreRotationalSpline.h
Go to the documentation of this file.
1 /*
2 -----------------------------------------------------------------------------
3 This source file is part of OGRE
4  (Object-oriented Graphics Rendering Engine)
5 For the latest info, see http://www.ogre3d.org/
6 
7 Copyright (c) 2000-2013 Torus Knot Software Ltd
8 
9 Permission is hereby granted, free of charge, to any person obtaining a copy
10 of this software and associated documentation files (the "Software"), to deal
11 in the Software without restriction, including without limitation the rights
12 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 copies of the Software, and to permit persons to whom the Software is
14 furnished to do so, subject to the following conditions:
15 
16 The above copyright notice and this permission notice shall be included in
17 all copies or substantial portions of the Software.
18 
19 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
25 THE SOFTWARE.
26 -----------------------------------------------------------------------------
27 */
28 #ifndef __RotationalSpline_H__
29 #define __RotationalSpline_H__
30 
31 #include "OgrePrerequisites.h"
32 #include "OgreQuaternion.h"
33 #include "OgreHeaderPrefix.h"
34 
35 namespace Ogre {
36 
59  {
60  public:
63 
65  void addPoint(const Quaternion& p);
66 
68  const Quaternion& getPoint(unsigned short index) const;
69 
71  unsigned short getNumPoints(void) const;
72 
74  void clear(void);
75 
80  void updatePoint(unsigned short index, const Quaternion& value);
81 
89  Quaternion interpolate(Real t, bool useShortestPath=true);
90 
96  Quaternion interpolate(unsigned int fromIndex, Real t, bool useShortestPath=true);
97 
110  void setAutoCalculate(bool autoCalc);
111 
117  void recalcTangents(void);
118 
119  protected:
120 
121  bool mAutoCalc;
122 
123 
124 
127 
128  };
129 
133 }
134 
135 #include "OgreHeaderSuffix.h"
136 
137 #endif
138 
#define _OgreExport
Definition: OgrePlatform.h:257
Implementation of a Quaternion, i.e.
This class interpolates orientations (rotations) along a spline using derivatives of quaternions.
const Quaternion & getPoint(unsigned short index) const
Gets the detail of one of the control points of the spline.
Quaternion interpolate(Real t, bool useShortestPath=true)
Returns an interpolated point based on a parametric value over the whole series.
Quaternion interpolate(unsigned int fromIndex, Real t, bool useShortestPath=true)
Interpolates a single segment of the spline given a parametric value.
void addPoint(const Quaternion &p)
Adds a control point to the end of the spline.
vector< Quaternion >::type mPoints
void updatePoint(unsigned short index, const Quaternion &value)
Updates a single point in the spline.
unsigned short getNumPoints(void) const
Gets the number of control points in the spline.
void setAutoCalculate(bool autoCalc)
Tells the spline whether it should automatically calculate tangents on demand as points are added.
void recalcTangents(void)
Recalculates the tangents associated with this spline.
void clear(void)
Clears all the points in the spline.
vector< Quaternion >::type mTangents
float Real
Software floating point type.
std::vector< T, A > type

Copyright © 2012 Torus Knot Software Ltd
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 Unported License.