diff options
Diffstat (limited to 'source/blender/freestyle/intern/stroke/Canvas.h')
| -rw-r--r-- | source/blender/freestyle/intern/stroke/Canvas.h | 383 |
1 files changed, 218 insertions, 165 deletions
diff --git a/source/blender/freestyle/intern/stroke/Canvas.h b/source/blender/freestyle/intern/stroke/Canvas.h index 707455c87f6..9931bf3c97e 100644 --- a/source/blender/freestyle/intern/stroke/Canvas.h +++ b/source/blender/freestyle/intern/stroke/Canvas.h @@ -1,52 +1,60 @@ -// -// Filename : Canvas.h -// Author(s) : Stephane Grabli -// Purpose : Class to define a canvas designed to draw style modules -// Date of creation : 20/10/2002 -// -/////////////////////////////////////////////////////////////////////////////// - - -// -// Copyright (C) : Please refer to the COPYRIGHT file distributed -// with this source distribution. -// -// This program is free software; you can redistribute it and/or -// modify it under the terms of the GNU General Public License -// as published by the Free Software Foundation; either version 2 -// of the License, or (at your option) any later version. -// -// This program is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -// GNU General Public License for more details. -// -// You should have received a copy of the GNU General Public License -// along with this program; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. -// -/////////////////////////////////////////////////////////////////////////////// - -#ifndef CANVAS_H -# define CANVAS_H - -# include <cstring> -# include <deque> -# include <vector> -# include <map> -# include "../system/FreestyleConfig.h" -# include "StrokeLayer.h" -# include "../geometry/BBox.h" -# include "../geometry/Geom.h" +/* + * ***** BEGIN GPL LICENSE BLOCK ***** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + * The Original Code is Copyright (C) 2010 Blender Foundation. + * All rights reserved. + * + * The Original Code is: all of this file. + * + * Contributor(s): none yet. + * + * ***** END GPL LICENSE BLOCK ***** + */ + +#ifndef __FREESTYLE_CANVAS_H__ +#define __FREESTYLE_CANVAS_H__ + +/** \file blender/freestyle/intern/stroke/Canvas.h + * \ingroup freestyle + * \brief Class to define a canvas designed to draw style modules + * \author Stephane Grabli + * \date 20/10/2002 + */ + +#include <cstring> +#include <deque> +#include <map> +#include <vector> + +#include "StrokeLayer.h" + +#include "../geometry/BBox.h" +#include "../geometry/Geom.h" + +#include "../system/FreestyleConfig.h" using namespace Geometry; struct ltstr { - bool operator()(const char* s1, const char* s2) const - { - return strcmp(s1, s2) < 0; - } + bool operator()(const char* s1, const char* s2) const + { + return strcmp(s1, s2) < 0; + } }; class InformationMap; @@ -64,133 +72,178 @@ class StyleModule; /*! Class to define the canvas on which strokes are drawn. * It's used to store state information about the drawing. */ -class LIB_STROKE_EXPORT Canvas +class LIB_STROKE_EXPORT Canvas { public: - /*! Returns a pointer on the Canvas instance */ - static Canvas * getInstance() {return _pInstance;} - typedef std::map<const char*, ImagePyramid*, ltstr> mapsMap ; - static const int NB_STEERABLE_VIEWMAP = 5; + /*! Returns a pointer on the Canvas instance */ + static Canvas *getInstance() + { + return _pInstance; + } + + typedef std::map<const char*, ImagePyramid*, ltstr> mapsMap; + static const int NB_STEERABLE_VIEWMAP = 5; + protected: - static Canvas *_pInstance; - std::deque<StrokeLayer*> _Layers; - std::deque<StyleModule*> _StyleModules; - FEdge *_SelectedFEdge; - - StrokeRenderer *_Renderer; - StyleModule* _current_sm; - mapsMap _maps; - static const char * _MapsPath; - SteerableViewMap *_steerableViewMap; - bool _basic; + static Canvas *_pInstance; + std::deque<StrokeLayer*> _Layers; + std::deque<StyleModule*> _StyleModules; + FEdge *_SelectedFEdge; + + StrokeRenderer *_Renderer; + StyleModule *_current_sm; + mapsMap _maps; + static const char *_MapsPath; + SteerableViewMap *_steerableViewMap; + bool _basic; public: - /* Builds the Canvas */ - Canvas(); - /* Copy constructor */ - Canvas(const Canvas& iBrother); - /* Destructor */ - virtual ~Canvas(); - - /* operations that need to be done before a draw */ - virtual void preDraw(); - - /* Draw the canvas using the current shader */ - virtual void Draw(); - - /* operations that need to be done after a draw */ - virtual void postDraw(); - - /* Renders the created strokes */ - virtual void Render(const StrokeRenderer *iRenderer); - /* Basic Renders the created strokes */ - virtual void RenderBasic(const StrokeRenderer *iRenderer); - /* Renders a stroke */ - virtual void RenderStroke(Stroke *iStroke) = 0; - - /* init the canvas */ - virtual void init() = 0; - - /* Clears the Canvas (shaders stack, layers stack...)*/ - void Clear(); - - /* Erases the layers */ - virtual void Erase(); - - /* Reads a pixel area from the canvas */ - virtual void readColorPixels(int x, int y,int w, int h, RGBImage& oImage) const = 0; - /* Reads a depth pixel area from the canvas */ - virtual void readDepthPixels(int x, int y,int w, int h, GrayImage& oImage) const = 0; - - /* update the canvas (display) */ - virtual void update() = 0; - - /* checks whether the canvas is empty or not */ - bool isEmpty() const {return (_Layers.empty());} - - /* Maps management */ - /*! Loads an image map. The map will be scaled - * (without preserving the ratio in order - * to fit the actual canvas size.) - * The image must be a gray values image... - * \param iFileName - * The name of the image file - * \param iMapName - * The name that will be used to access - * this image - * \param iNbLevels - * The number of levels in the map pyramid. (default = 4). - * If iNbLevels == 0, the complete pyramid is built. - */ - void loadMap(const char *iFileName, const char *iMapName, unsigned iNbLevels=4, float iSigma = 1.f); - - /*! Reads a pixel value in a map. - * Returns a value between 0 and 1. - * \param iMapName - * The name of the map - * \param level - * The level of the pyramid from which the pixel must - * be read. - * \param x - * The abscissa of the desired pixel specified in level0 coordinate - * system. The origin is the lower left corner. - * \param y - * The ordinate of the desired pixel specified in level0 coordinate - * system. The origin is the lower left corner. - */ - float readMapPixel(const char *iMapName, int level, int x, int y); - - /*! Sets the steerable viewmap */ - void loadSteerableViewMap(SteerableViewMap * iSVM) {_steerableViewMap = iSVM;} - - /*! Returns the steerable VM */ - SteerableViewMap * getSteerableViewMap() {return _steerableViewMap;} - - /*! accessors */ - inline const FEdge * selectedFEdge() const {return _SelectedFEdge;} - inline FEdge * selectedFEdge() {return _SelectedFEdge;} - virtual int width() const = 0; - virtual int height() const = 0; - virtual BBox<Vec3r> scene3DBBox() const = 0; - inline const StrokeRenderer * renderer() const {return _Renderer;} - inline StyleModule* getCurrentStyleModule() { return _current_sm; } - virtual bool getRecordFlag() const {return false;} + /* Builds the Canvas */ + Canvas(); + /* Copy constructor */ + Canvas(const Canvas& iBrother); + /* Destructor */ + virtual ~Canvas(); + + /* operations that need to be done before a draw */ + virtual void preDraw(); + + /* Draw the canvas using the current shader */ + virtual void Draw(); + + /* operations that need to be done after a draw */ + virtual void postDraw(); + + /* Renders the created strokes */ + virtual void Render(const StrokeRenderer *iRenderer); + /* Basic Renders the created strokes */ + virtual void RenderBasic(const StrokeRenderer *iRenderer); + /* Renders a stroke */ + virtual void RenderStroke(Stroke *iStroke) = 0; + + /* init the canvas */ + virtual void init() = 0; + + /* Clears the Canvas (shaders stack, layers stack...) */ + void Clear(); + + /* Erases the layers */ + virtual void Erase(); + + /* Reads a pixel area from the canvas */ + virtual void readColorPixels(int x, int y,int w, int h, RGBImage& oImage) const = 0; + /* Reads a depth pixel area from the canvas */ + virtual void readDepthPixels(int x, int y,int w, int h, GrayImage& oImage) const = 0; + + /* update the canvas (display) */ + virtual void update() = 0; + + /* checks whether the canvas is empty or not */ + bool isEmpty() const + { + return (_Layers.empty()); + } + + /* Maps management */ + /*! Loads an image map. The map will be scaled (without preserving the ratio in order to fit the actual + * canvas size.). + * The image must be a gray values image... + * \param iFileName + * The name of the image file + * \param iMapName + * The name that will be used to access this image + * \param iNbLevels + * The number of levels in the map pyramid. (default = 4). + * If iNbLevels == 0, the complete pyramid is built. + */ + void loadMap(const char *iFileName, const char *iMapName, unsigned iNbLevels = 4, float iSigma = 1.0f); + + /*! Reads a pixel value in a map. + * Returns a value between 0 and 1. + * \param iMapName + * The name of the map + * \param level + * The level of the pyramid from which the pixel must be read. + * \param x + * The abscissa of the desired pixel specified in level0 coordinate system. The origin is the lower left corner. + * \param y + * The ordinate of the desired pixel specified in level0 coordinate system. The origin is the lower left corner. + */ + float readMapPixel(const char *iMapName, int level, int x, int y); + + /*! Sets the steerable viewmap */ + void loadSteerableViewMap(SteerableViewMap * iSVM) + { + _steerableViewMap = iSVM; + } + + /*! Returns the steerable VM */ + SteerableViewMap * getSteerableViewMap() + { + return _steerableViewMap; + } + + /*! accessors */ + inline const FEdge *selectedFEdge() const + { + return _SelectedFEdge; + } + + inline FEdge *selectedFEdge() + { + return _SelectedFEdge; + } + + virtual int width() const = 0; + virtual int height() const = 0; + virtual BBox<Vec3r> scene3DBBox() const = 0; + + inline const StrokeRenderer *renderer() const + { + return _Renderer; + } + + inline StyleModule *getCurrentStyleModule() + { + return _current_sm; + } + + virtual bool getRecordFlag() const + { + return false; + } + int stroke_count; - /*! modifiers */ - inline void setSelectedFEdge(FEdge *iFEdge) {_SelectedFEdge = iFEdge;} - /*! inserts a shader at pos index+1 */ - void PushBackStyleModule(StyleModule *iStyleModule); - void InsertStyleModule(unsigned index, StyleModule *iStyleModule); - void RemoveStyleModule(unsigned index); - void SwapStyleModules(unsigned i1, unsigned i2); - void ReplaceStyleModule(unsigned index, StyleModule *iStyleModule); - void setVisible(unsigned index, bool iVisible) ; - //inline void setDensityMap(InformationMap<RGBImage>* iMap) {_DensityMap = iMap;} - inline void AddLayer(StrokeLayer *iLayer) {_Layers.push_back(iLayer);} - void resetModified(bool iMod=false); - void causalStyleModules(std::vector<unsigned>& vec, unsigned index = 0); - void setModified(unsigned index, bool b); + /*! modifiers */ + inline void setSelectedFEdge(FEdge *iFEdge) + { + _SelectedFEdge = iFEdge; + } + + /*! inserts a shader at pos index+1 */ + void PushBackStyleModule(StyleModule *iStyleModule); + void InsertStyleModule(unsigned index, StyleModule *iStyleModule); + void RemoveStyleModule(unsigned index); + void SwapStyleModules(unsigned i1, unsigned i2); + void ReplaceStyleModule(unsigned index, StyleModule *iStyleModule); + void setVisible(unsigned index, bool iVisible) ; + +#if 0 + inline void setDensityMap(InformationMap<RGBImage> *iMap) + { + _DensityMap = iMap; + } +#endif + + inline void AddLayer(StrokeLayer *iLayer) + { + _Layers.push_back(iLayer); + } + + void resetModified(bool iMod = false); + void causalStyleModules(std::vector<unsigned>& vec, unsigned index = 0); + void setModified(unsigned index, bool b); }; -#endif // CANVAS_H +#endif // __FREESTYLE_CANVAS_H__ |