synfig-core/trunk/src/modules/lyr_std/twirl.h

   1 /* === S Y N F I G ========================================================= */
   2 /*!     \file twirl.h
   3 **      \brief Header file for implementation of the "Twirl" layer
   4 **
   5 **      $Id$
   6 **
   7 **      \legal
   8 **      Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
   9 **      Copyright (c) 2008 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 /* ========================================================================= */
  23
  24 /* === S T A R T =========================================================== */
  25
  26 #ifndef __SYNFIG_TWIRL_H
  27 #define __SYNFIG_TWIRL_H
  28
  29 /* === H E A D E R S ======================================================= */
  30
  31 #include <synfig/layer_composite.h>
  32 #include <synfig/color.h>
  33 #include <synfig/vector.h>
  34 #include <synfig/value.h>
  35 #include <synfig/gradient.h>
  36 #include <synfig/angle.h>
  37
  38 /* === M A C R O S ========================================================= */
  39
  40 /* === T Y P E D E F S ===================================================== */
  41
  42 /* === C L A S S E S & S T R U C T S ======================================= */
  43 class Twirl_Trans;
  44
  45 class Twirl : public synfig::Layer_Composite
  46 {
  47         SYNFIG_LAYER_MODULE_EXT
  48         friend class Twirl_Trans;
  49
  50 private:
  51
  52         synfig::Point center;
  53
  54         synfig::Real radius;
  55
  56         synfig::Angle rotations;
  57
  58         bool distort_inside;
  59
  60         bool distort_outside;
  61
  62         synfig::Point distort(const synfig::Point &pos, bool reverse=false)const;
  63 public:
  64
  65         Twirl();
  66
  67         virtual bool set_param(const synfig::String & param, const synfig::ValueBase &value);
  68
  69         virtual synfig::ValueBase get_param(const synfig::String & param)const;
  70
  71         virtual synfig::Color get_color(synfig::Context context, const synfig::Point &pos)const;
  72
  73         //virtual bool accelerated_render(synfig::Context context,synfig::Surface *surface,int quality, const synfig::RendDesc &renddesc, synfig::ProgressCallback *cb)const;
  74
  75         synfig::Layer::Handle hit_check(synfig::Context context, const synfig::Point &point)const;
  76
  77         virtual Vocab get_param_vocab()const;
  78         virtual etl::handle<synfig::Transform> get_transform()const;
  79         virtual bool reads_context()const { return true; }
  80 }; // END of class Twirl
  81
  82 /* === E N D =============================================================== */
  83
  84 #endif