Torque3D Documentation / _generateds / forestWindAccumulator.h

forestWindAccumulator.h

Engine/source/forest/forestWindAccumulator.h

More...

Classes:

class

This simple class holds the state of the accumulated wind effect for a single tree.

Detailed Description

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#ifndef _FORESTWINDACCUMULATOR_H_
25#define _FORESTWINDACCUMULATOR_H_
26
27#ifndef _MPOINT3_H_
28#include "math/mPoint3.h"
29#endif
30
31
32struct TreePlacementInfo;
33class ForestItemData;
34
35
36/// This simple class holds the state of the accumulated 
37/// wind effect for a single tree.
38class ForestWindAccumulator
39{
40protected:
41
42   struct VerletParticle
43   {
44      Point2F position;
45      Point2F lastPosition;
46   };
47
48   F32 mCurrentStrength;
49   Point2F mCurrentDir;
50
51   Point3F mPosition;
52   F32 mScale;
53   ForestItemData *mDataBlock;
54
55   VerletParticle mParticles[2];
56
57   void _updateParticle( VerletParticle *particle, const Point2F &force, F32 timeDelta );
58
59public:
60
61   ForestWindAccumulator( const TreePlacementInfo &info );
62   ~ForestWindAccumulator();
63
64   void presimulate( const VectorF &windVector, U32 ticks );
65
66   void updateWind( const VectorF &windVector, F32 timeDelta );
67
68   void setDirection( const VectorF &dir ) { mCurrentDir.set( dir.x, dir.y ); }
69   VectorF getDirection() const { return VectorF( mCurrentDir.x, mCurrentDir.y, 0 ); }
70
71   void setStrength( F32 strength ) { mCurrentStrength = strength; }
72   F32 getStrength() const { return mCurrentStrength; }
73
74   void setPosition( const Point3F &pos ) { mPosition = pos; }
75   Point3F getPosition() const { return mPosition; }
76
77   void applyImpulse( const VectorF &impulse );
78};
79
80#endif // _FORESTWINDACCUMULATOR_H_
81