Engine/source/scene/simPath.h

   1 //-----------------------------------------------------------------------------
   2 // Copyright (c) 2012 GarageGames, LLC
   3 //
   4 // Permission is hereby granted, free of charge, to any person obtaining a copy
   5 // of this software and associated documentation files (the "Software"), to
   6 // deal in the Software without restriction, including without limitation the
   7 // rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
   8 // sell copies of the Software, and to permit persons to whom the Software is
   9 // furnished to do so, subject to the following conditions:
  10 //
  11 // The above copyright notice and this permission notice shall be included in
  12 // all copies or substantial portions of the Software.
  13 //
  14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  15 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  16 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  17 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  18 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  19 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  20 // IN THE SOFTWARE.
  21 //-----------------------------------------------------------------------------
  22
  23 #ifndef _SIMPATH_H_
  24 #define _SIMPATH_H_
  25
  26 #ifndef _SCENEOBJECT_H_
  27 #include "scene/sceneObject.h"
  28 #endif
  29 #ifndef _GFXSTATEBLOCK_H_
  30 #include "gfx/gfxStateBlock.h"
  31 #endif
  32 #ifndef _GFXVERTEXBUFFER_H_
  33 #include "gfx/gfxVertexBuffer.h"
  34 #endif
  35 #ifndef _GFXPRIMITIVEBUFFER_H_
  36 #include "gfx/gfxPrimitiveBuffer.h"
  37 #endif
  38
  39 class BaseMatInstance;
  40
  41
  42 namespace SimPath
  43 {
  44
  45 //--------------------------------------------------------------------------
  46 /// A path!
  47 class Path : public SimGroup
  48 {
  49    typedef SimGroup Parent;
  50
  51   public:
  52    enum : U32
  53    {
  54       NoPathIndex = 0xFFFFFFFF
  55    };
  56
  57
  58   private:
  59    U32 mPathIndex;
  60    bool mIsLooping;
  61
  62   protected:
  63    bool onAdd();
  64    void onRemove();
  65
  66   public:
  67    Path();
  68    ~Path();
  69
  70    void addObject(SimObject*);
  71    void removeObject(SimObject*);
  72
  73    void sortMarkers();
  74    void updatePath();
  75    bool isLooping() { return mIsLooping; }
  76    U32 getPathIndex() const;
  77
  78    DECLARE_CONOBJECT(Path);
  79    static void initPersistFields();
  80 };
  81
  82 //--------------------------------------------------------------------------
  83 //--------------------------------------------------------------------------
  84 inline U32 Path::getPathIndex() const
  85 {
  86    return mPathIndex;
  87 }
  88
  89 } // Namespace
  90
  91
  92 //--------------------------------------------------------------------------
  93 class Marker : public SceneObject
  94 {
  95    typedef SceneObject Parent;
  96    friend class Path;
  97
  98   public:
  99    enum SmoothingType
 100    {
 101       SmoothingTypeLinear,
 102       SmoothingTypeSpline,
 103       SmoothingTypeAccelerate,
 104    };
 105
 106    enum KnotType
 107    {
 108       KnotTypeNormal,
 109       KnotTypePositionOnly,
 110       KnotTypeKink,
 111    };
 112
 113
 114    U32   mSeqNum;
 115    U32   mSmoothingType;
 116    U32   mKnotType;
 117
 118    U32   mMSToNext;
 119
 120    // Rendering
 121   protected:
 122    void prepRenderImage(SceneRenderState *state);
 123    void renderObject(ObjectRenderInst *ri, SceneRenderState *state, BaseMatInstance* overrideMat);
 124
 125   protected:
 126    bool onAdd();
 127    void onRemove();
 128    void onGroupAdd();
 129
 130    void onEditorEnable();
 131    void onEditorDisable();
 132
 133    static void initGFXResources();
 134
 135    static GFXStateBlockRef smStateBlock;
 136    static GFXVertexBufferHandle<GFXVertexPCT> smVertexBuffer;
 137    static GFXPrimitiveBufferHandle smPrimitiveBuffer;
 138
 139   public:
 140    Marker();
 141    ~Marker();
 142
 143    DECLARE_CONOBJECT(Marker);
 144    static void initPersistFields();
 145    void inspectPostApply();
 146
 147    U32  packUpdate  (NetConnection *conn, U32 mask, BitStream *stream);
 148    void unpackUpdate(NetConnection *conn,           BitStream *stream);
 149 };
 150
 151 typedef Marker::SmoothingType MarkerSmoothingType;
 152 typedef Marker::KnotType MarkerKnotType;
 153
 154 DefineEnumType( MarkerSmoothingType );
 155 DefineEnumType( MarkerKnotType );
 156
 157 #endif // _H_PATH
 158