ogre_tools: camera_base.h Source File

00001 /*
00002  * Copyright (c) 2008, Willow Garage, Inc.
00003  * All rights reserved.
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *
00008  *     * Redistributions of source code must retain the above copyright
00009  *       notice, this list of conditions and the following disclaimer.
00010  *     * Redistributions in binary form must reproduce the above copyright
00011  *       notice, this list of conditions and the following disclaimer in the
00012  *       documentation and/or other materials provided with the distribution.
00013  *     * Neither the name of the Willow Garage, Inc. nor the names of its
00014  *       contributors may be used to endorse or promote products derived from
00015  *       this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00018  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00021  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00022  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00023  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00024  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00025  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00026  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00027  * POSSIBILITY OF SUCH DAMAGE.
00028  */
00029 
00030 #ifndef OGRE_TOOLS_CAMERA_BASE_H_
00031 #define OGRE_TOOLS_CAMERA_BASE_H_
00032 
00033 #include <OGRE/OgreVector3.h>
00034 #include <OGRE/OgreQuaternion.h>
00035 
00036 namespace Ogre
00037 {
00038   class Camera;
00039   class SceneNode;
00040   class SceneManager;
00041 }
00042 
00043 namespace ogre_tools
00044 {
00045 
00053 class CameraBase
00054 {
00055 public:
00060   CameraBase( Ogre::SceneManager* scene_manager );
00061   virtual ~CameraBase();
00062 
00067   Ogre::Camera* getOgreCamera() { return camera_; }
00068 
00073   void setRelativeNode( Ogre::SceneNode* node );
00077   virtual void relativeNodeChanged() {}
00078 
00079   virtual void update() = 0;
00080 
00084   virtual void setPosition( const Ogre::Vector3& position );
00088   virtual void setOrientation( const Ogre::Quaternion& orientation );
00089 
00102   virtual void yaw( float angle ) = 0;
00115   virtual void pitch( float angle ) = 0;
00128   virtual void roll( float angle ) = 0;
00129 
00133   virtual void setOrientation( float x, float y, float z, float w ) = 0;
00137   virtual void setPosition( float x, float y, float z ) = 0;
00138 
00144   virtual void setFrom( CameraBase* camera ) = 0;
00145 
00150   virtual Ogre::Vector3 getPosition() = 0;
00155   virtual Ogre::Quaternion getOrientation() = 0;
00156 
00161   virtual void lookAt( const Ogre::Vector3& point ) = 0;
00162 
00170   virtual void move( float x, float y, float z ) = 0;
00171 
00172   virtual void mouseLeftDown( int x, int y ) {}
00173   virtual void mouseMiddleDown( int x, int y ) {}
00174   virtual void mouseRightDown( int x, int y ) {}
00175   virtual void mouseLeftUp( int x, int y ) {}
00176   virtual void mouseMiddleUp( int x, int y ) {}
00177   virtual void mouseRightUp( int x, int y ) {}
00178 
00185   virtual void mouseLeftDrag( int diff_x, int diff_y, bool ctrl, bool alt, bool shift ) = 0;
00192   virtual void mouseMiddleDrag( int diff_x, int diff_y, bool ctrl, bool alt, bool shift ) = 0;
00199   virtual void mouseRightDrag( int diff_x, int diff_y, bool ctrl, bool alt, bool shift ) = 0;
00206   virtual void scrollWheel( int diff, bool ctrl, bool alt, bool shift ) = 0;
00207 
00212   virtual void fromString(const std::string& str) = 0;
00216   virtual std::string toString() = 0;
00217 
00218 protected:
00219   Ogre::Camera* camera_;                  
00220   Ogre::SceneManager* scene_manager_;     
00221 
00222   Ogre::SceneNode* relative_node_;
00223 };
00224 
00225 } // namespace ogre_tools
00226 
00227 #endif /*OGRE_TOOLS_CAMERA_BASE_H_*/