ogre_tools: grid.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_GRID_H
00031 #define OGRE_TOOLS_GRID_H
00032 
00033 #include <stdint.h>
00034 
00035 #include <vector>
00036 
00037 #include <OGRE/OgreColourValue.h>
00038 #include <OGRE/OgreMaterial.h>
00039 
00040 namespace Ogre
00041 {
00042 class SceneManager;
00043 
00044 class ManualObject;
00045 class SceneNode;
00046 
00047 class Any;
00048 }
00049 
00050 namespace ogre_tools
00051 {
00052 
00053 class BillboardLine;
00054 
00061 class Grid
00062 {
00063 public:
00064   enum Style
00065   {
00066     Lines,
00067     Billboards,
00068   };
00069 
00080   Grid( Ogre::SceneManager* manager, Ogre::SceneNode* parent_node, Style style, uint32_t cell_count, float cell_length, float line_width, const Ogre::ColourValue& color );
00081   ~Grid();
00082 
00083   void create();
00084 
00090   Ogre::SceneNode* getSceneNode() { return scene_node_; }
00091 
00095   void setUserData( const Ogre::Any& data );
00096 
00097   void setStyle(Style style);
00098   Style getStyle() { return style_; }
00099 
00100   void setColor(const Ogre::ColourValue& color);
00101   Ogre::ColourValue getColor() { return color_; }
00102 
00103   void setCellCount(uint32_t count);
00104   float getCellCount() { return cell_count_; }
00105 
00106   void setCellLength(float len);
00107   float getCellLength() { return cell_length_; }
00108 
00109   void setLineWidth(float width);
00110   float getLineWidth() { return line_width_; }
00111 
00112   void setHeight(uint32_t count);
00113   uint32_t getHeight() { return height_; }
00114 
00115 private:
00116   Ogre::SceneManager* scene_manager_;
00117   Ogre::SceneNode* scene_node_;           
00118   Ogre::ManualObject* manual_object_;     
00119 
00120   BillboardLine* billboard_line_;
00121 
00122   Ogre::MaterialPtr material_;
00123 
00124   Style style_;
00125   uint32_t cell_count_;
00126   float cell_length_;
00127   float line_width_;
00128   uint32_t height_;
00129   Ogre::ColourValue color_;
00130 };
00131 
00132 } // namespace ogre_tools
00133 
00134 #endif