synfig-core/tags/0.61.09/src/modules/mod_geometry/star.h

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file star.h
   3 **      \brief Header file for implementation of the "Star" layer
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **      Copyright (c) 2007 Chris Moore
  10 **
  11 **      This package is free software; you can redistribute it and/or
  12 **      modify it under the terms of the GNU General Public License as
  13 **      published by the Free Software Foundation; either version 2 of
  14 **      the License, or (at your option) any later version.
  15 **
  16 **      This package is distributed in the hope that it will be useful,
  17 **      but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 **      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19 **      General Public License for more details.
  20 **      \endlegal
  21 **
  22 ** === N O T E S ===========================================================
  23 **
  24 ** ========================================================================= */
  25
  26 /* === S T A R T =========================================================== */
  27
  28 #ifndef __SYNFIG_STAR_H
  29 #define __SYNFIG_STAR_H
  30
  31 /* === H E A D E R S ======================================================= */
  32
  33 #include <synfig/layer_polygon.h>
  34 #include <list>
  35 #include <vector>
  36
  37 /* === M A C R O S ========================================================= */
  38
  39 /* === T Y P E D E F S ===================================================== */
  40
  41 /* === C L A S S E S & S T R U C T S ======================================= */
  42
  43 using namespace synfig;
  44 using namespace std;
  45 using namespace etl;
  46
  47 class Star : protected synfig::Layer_Polygon
  48 {
  49         SYNFIG_LAYER_MODULE_EXT
  50 private:
  51
  52         Real radius1;
  53         Real radius2;
  54         int points;
  55         Angle angle;
  56         bool regular_polygon;
  57 public:
  58         Star();
  59
  60         //! Updates the polygon data to match the parameters.
  61         void sync();
  62
  63         virtual bool set_param(const String & param, const synfig::ValueBase &value);
  64
  65         virtual ValueBase get_param(const String & param)const;
  66
  67         virtual Vocab get_param_vocab()const;
  68 };
  69
  70 /* === E N D =============================================================== */
  71
  72 #endif