camera_base.h

Go to the documentation of this file.

/*
 * Copyright (c) 2008, Willow Garage, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the Willow Garage, Inc. nor the names of its
 *       contributors may be used to endorse or promote products derived from
 *       this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef OGRE_TOOLS_CAMERA_BASE_H_
#define OGRE_TOOLS_CAMERA_BASE_H_

#include <OGRE/OgreVector3.h>
#include <OGRE/OgreQuaternion.h>

namespace Ogre
{
  class Camera;
  class SceneNode;
  class SceneManager;
}

namespace rviz
{

class CameraBase
{
public:
  CameraBase( Ogre::SceneManager* scene_manager );
  virtual ~CameraBase();

  Ogre::Camera* getOgreCamera() { return camera_; }

  void setRelativeNode( Ogre::SceneNode* node );
  virtual void relativeNodeChanged() {}

  virtual void update() = 0;

  virtual void setPosition( const Ogre::Vector3& position );
  virtual void setOrientation( const Ogre::Quaternion& orientation );

  virtual void yaw( float angle ) = 0;
  virtual void pitch( float angle ) = 0;
  virtual void roll( float angle ) = 0;

  virtual void setOrientation( float x, float y, float z, float w ) = 0;
  virtual void setPosition( float x, float y, float z ) = 0;

  virtual void setFrom( CameraBase* camera ) = 0;

  virtual Ogre::Vector3 getPosition() = 0;
  virtual Ogre::Quaternion getOrientation() = 0;

  virtual void lookAt( const Ogre::Vector3& point ) = 0;

  virtual void move( float x, float y, float z ) = 0;

  virtual void mouseLeftDown( int x, int y ) {}
  virtual void mouseMiddleDown( int x, int y ) {}
  virtual void mouseRightDown( int x, int y ) {}
  virtual void mouseLeftUp( int x, int y ) {}
  virtual void mouseMiddleUp( int x, int y ) {}
  virtual void mouseRightUp( int x, int y ) {}

  virtual void mouseLeftDrag( int diff_x, int diff_y, bool ctrl, bool alt, bool shift ) = 0;
  virtual void mouseMiddleDrag( int diff_x, int diff_y, bool ctrl, bool alt, bool shift ) = 0;
  virtual void mouseRightDrag( int diff_x, int diff_y, bool ctrl, bool alt, bool shift ) = 0;
  virtual void scrollWheel( int diff, bool ctrl, bool alt, bool shift ) = 0;

  virtual void fromString(const std::string& str) = 0;
  virtual std::string toString() = 0;

protected:
  Ogre::Camera* camera_;                  
  Ogre::SceneManager* scene_manager_;     

  Ogre::SceneNode* relative_node_;
};

} // namespace rviz

#endif /*OGRE_TOOLS_CAMERA_BASE_H_*/