guiObjectView.h 7.61 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
//-----------------------------------------------------------------------------
// Copyright (c) 2012 GarageGames, LLC
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE SOFTWARE.
//-----------------------------------------------------------------------------

#ifndef _GUIOBJECTVIEW_H_
#define _GUIOBJECTVIEW_H_

#ifndef _GUITSCONTROL_H_
   #include "gui/3d/guiTSControl.h"
#endif
#ifndef _TSSHAPEINSTANCE_H_
   #include "ts/tsShapeInstance.h"
#endif


class LightInfo;


/// A control that displays a TSShape in its view.
class GuiObjectView : public GuiTSCtrl
{
   public:
   
      typedef GuiTSCtrl Parent;

	  DECLARE_CALLBACK( void, onMouseEnter, ());
	  DECLARE_CALLBACK( void, onMouseLeave, ());

   protected:
   
      /// @name Mouse Control
      /// @{
   
      enum MouseState
      {
         None,
         Rotating,
         Zooming
      };

      /// Current mouse operation.
      MouseState  mMouseState;
      
      /// Last mouse position during tracked mouse operations.
      Point2I mLastMousePoint;

      /// @}
      
      /// @name Model
      /// @{
      
      /// Name of the model loaded for display.
      String mModelName;

      /// Model being displayed in the view.
      TSShapeInstance* mModel;

      /// Name of skin to use on model.
      String mSkinName;
      
      /// @}
      
      /// @name Camera State
      /// @{

      Point3F mCameraPos;
      MatrixF mCameraMatrix;
      EulerF mCameraRot;
      Point3F mOrbitPos;
      
      F32 mMaxOrbitDist;
      F32 mMinOrbitDist;
      
      ///
      F32 mOrbitDist;
      
      /// Multiplier for camera mouse operations (rotation and zooming).
      F32 mCameraSpeed;

      /// @}
      
      /// @name Mounting
      /// @{
      
      /// Name of model to mount to the primary model.
      String mMountedModelName;
      
      ///
      String mMountSkinName;

      /// Index of the node to mount the secondary model to.  -1 (disabled) by default.
      S32 mMountNode;
      
      /// Name of node to mount the secondary model to.  Unset by default.
      String mMountNodeName;

      /// Model mounted as an image to the primary model.
      TSShapeInstance* mMountedModel;
            
      ///
      MatrixF mMountTransform;
      
      /// @}
      
      /// @name Animation
      /// @{

      /// Index of the animation sequence to play on the model.  -1 (disabled) by default.
      S32 mAnimationSeq;
      
      /// Name of the animation sequence to play on the model.  Unset by default.
      String mAnimationSeqName;

      /// Animation thread on the model.
      TSThread* mRunThread;
      
      /// Last time we rendered the model.  Used for animation.
      S32 mLastRenderTime;
      
      /// @}
      
      /// @name Lighting
      /// @{
      
      /// Light object used as sun during rendering.
      LightInfo* mLight;
      
      ///
      ColorF mLightColor;
      
      ///
      ColorF mLightAmbient;
      
      ///
      Point3F mLightDirection;
      
      /// @}

      ///
      void _initAnimation();
      
      ///
      void _initMount();
      
      ///
      void onStaticModified( StringTableEntry slotName, const char* newValue );

   public:
   
      GuiObjectView();
      ~GuiObjectView();
      
      /// @name Model
      /// @{
      
      ///
      const String& getModelName() const { return mModelName; }

      /// Return the instance of the model being rendered in the view.
      TSShapeInstance* getModel() const { return mModel; }
      
      /// Return the name of the skin used on the primary model.
      const String& getSkin() const { return mSkinName; }
            
      /// Set the skin to use on the primary model.
      void setSkin( const String& name );

      /// Set the model to show in this view.
      void setObjectModel( const String& modelName );
      
      /// @}
      
      /// @name Animation
      /// @{
      
      /// Set the animation sequence to play on the model.
      /// @param seqIndex Index of sequence to play.
      void setObjectAnimation( S32 seqIndex );
            
      /// Set the animation sequence to play on the model.
      /// @param seqIndex Name of sequence to play.
      void setObjectAnimation( const String& sequenceName );
      
      /// @}
      
      /// @name Mounting
      /// @{
      
      /// Return the model mounted to the current primary model; NULL if none.
      TSShapeInstance* getMountedModel() const { return mMountedModel; }
      
      ///
      const String& getMountedModelName() const { return mMountedModelName; }
      
      /// Return the name of the skin used on the mounted model.
      const String& getMountSkin() const { return mMountSkinName; }
      
      /// Set the skin to use on the mounted model.
      void setMountSkin( const String& name );

      ///
      void setMountNode( S32 index );
      
      ///
      void setMountNode( const String& nodeName );
      
      ///
      void setMountedObject( const String& modelName );
            
      /// @}
      
      /// @name Camera
      /// @{
      
      /// Return the current camera speed multiplier.
      F32 getCameraSpeed() const { return mCameraSpeed; }
      
      /// Set the multiplier to apply to camera rotation and zooming.
      void setCameraSpeed( F32 factor );
      
      ///
      F32 getOrbitDistance() const { return mOrbitDist; }
      
      /// Sets the distance at which the camera orbits the object. Clamped to the
      /// acceptable range defined in the class by min and max orbit distances.
      ///
      /// @param distance The distance to set the orbit to (will be clamped).
      void setOrbitDistance( F32 distance );
      
      /// @}
      
      /// @name Lighting
      /// @{
      
      ///
      void setLightColor( const ColorF& color );
      
      ///
      void setLightAmbient( const ColorF& color );
      
      ///
      void setLightDirection( const Point3F& direction );
      
      /// @}
      
      // GuiTsCtrl.
      bool onWake();

      void onMouseEnter( const GuiEvent& event );
      void onMouseLeave( const GuiEvent& event );
      void onMouseDown( const GuiEvent& event );
      void onMouseUp( const GuiEvent& event );
      void onMouseDragged( const GuiEvent& event );
      void onRightMouseDown( const GuiEvent& event );
      void onRightMouseUp( const GuiEvent& event );
      void onRightMouseDragged( const GuiEvent& event );

      bool processCameraQuery( CameraQuery* query );
      void renderWorld( const RectI& updateRect );
      
      static void initPersistFields();

      DECLARE_CONOBJECT( GuiObjectView );
      DECLARE_DESCRIPTION( "A control that shows a TSShape model." );   
};

#endif // !_GUIOBJECTVIEW_H_