OgreSimpleSpline.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 
29 #ifndef __SimpleSpline_H__
30 #define __SimpleSpline_H__
31 
32 #include "OgrePrerequisites.h"
33 #include "OgreVector3.h"
34 #include "OgreMatrix4.h"
35 #include "OgreHeaderPrefix.h"
36 
37 namespace Ogre {
38 
39 
58  {
59  public:
62 
64  void addPoint(const Vector3& p);
65 
67  const Vector3& getPoint(unsigned short index) const;
68 
70  unsigned short getNumPoints(void) const;
71 
73  void clear(void);
74 
79  void updatePoint(unsigned short index, const Vector3& value);
80 
88 
93  Vector3 interpolate(unsigned int fromIndex, Real t) const;
94 
95 
108  void setAutoCalculate(bool autoCalc);
109 
115  void recalcTangents(void);
116 
117  protected:
118 
119  bool mAutoCalc;
120 
123 
126 
127 
128 
129  };
130 
134 }
135 
136 #include "OgreHeaderSuffix.h"
137 
138 
139 #endif
140 
OgreHeaderSuffix.h
Ogre
Definition: OgreAndroidLogListener.h:35
Ogre::SimpleSpline::mTangents
vector< Vector3 >::type mTangents
Definition: OgreSimpleSpline.h:122
Ogre::SimpleSpline::getPoint
const Vector3 & getPoint(unsigned short index) const
Gets the detail of one of the control points of the spline.
Ogre::SimpleSpline::mAutoCalc
bool mAutoCalc
Definition: OgreSimpleSpline.h:119
Ogre::SimpleSpline::interpolate
Vector3 interpolate(unsigned int fromIndex, Real t) const
Interpolates a single segment of the spline given a parametric value.
Ogre::SimpleSpline::interpolate
Vector3 interpolate(Real t) const
Returns an interpolated point based on a parametric value over the whole series.
Ogre::SimpleSpline::setAutoCalculate
void setAutoCalculate(bool autoCalc)
Tells the spline whether it should automatically calculate tangents on demand as points are added.
Ogre::SimpleSpline::addPoint
void addPoint(const Vector3 &p)
Adds a control point to the end of the spline.
Ogre::SimpleSpline::recalcTangents
void recalcTangents(void)
Recalculates the tangents associated with this spline.
OgreHeaderPrefix.h
Ogre::Matrix4
Class encapsulating a standard 4x4 homogeneous matrix.
Definition: OgreMatrix4.h:79
OgrePrerequisites.h
Ogre::SimpleSpline::mCoeffs
Matrix4 mCoeffs
Matrix of coefficients.
Definition: OgreSimpleSpline.h:125
_OgreExport
#define _OgreExport
Definition: OgrePlatform.h:257
Ogre::SimpleSpline
A very simple spline class which implements the Catmull-Rom class of splines.
Definition: OgreSimpleSpline.h:58
Ogre::SimpleSpline::getNumPoints
unsigned short getNumPoints(void) const
Gets the number of control points in the spline.
OgreMatrix4.h
Ogre::SimpleSpline::mPoints
vector< Vector3 >::type mPoints
Definition: OgreSimpleSpline.h:121
Ogre::SimpleSpline::clear
void clear(void)
Clears all the points in the spline.
Ogre::SimpleSpline::updatePoint
void updatePoint(unsigned short index, const Vector3 &value)
Updates a single point in the spline.
Ogre::SimpleSpline::~SimpleSpline
~SimpleSpline()
Ogre::Real
float Real
Software floating point type.
Definition: OgrePrerequisites.h:70
Ogre::vector
Definition: OgrePrerequisites.h:492
Ogre::SimpleSpline::SimpleSpline
SimpleSpline()
OgreVector3.h
Ogre::Vector3
Standard 3-dimensional vector.
Definition: OgreVector3.h:52

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