Fixing warnings from doxygen:
[synfig.git] / synfig-core / trunk / src / modules / mod_geometry / region.cpp
index 2bdc82e..adaa6eb 100644 (file)
@@ -1,18 +1,22 @@
 /*! ========================================================================
 ** Synfig
-** Template File
-** $Id: region.cpp,v 1.1.1.1 2005/01/04 01:23:10 darco Exp $
+/* === S Y N F I G ========================================================= */
+/*!    \file region.cpp
+**     \brief Template Header
 **
-** Copyright (c) 2002 Robert B. Quattlebaum Jr.
+**     \legal
+**     Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
 **
-** This software and associated documentation
-** are CONFIDENTIAL and PROPRIETARY property of
-** the above-mentioned copyright holder.
+**     This package 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.
 **
-** You may not copy, print, publish, or in any
-** other way distribute this software without
-** a prior written agreement with
-** the copyright holder.
+**     This package 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.
+**     \endlegal
 **
 ** === N O T E S ===========================================================
 **
@@ -73,15 +77,15 @@ Region::Region()
        bline_point_list.push_back(BLinePoint());
        bline_point_list.push_back(BLinePoint());
        bline_point_list.push_back(BLinePoint());
-       bline_point_list[0].set_vertex(Point(0,1));     
-       bline_point_list[1].set_vertex(Point(0,-1));    
+       bline_point_list[0].set_vertex(Point(0,1));
+       bline_point_list[1].set_vertex(Point(0,-1));
        bline_point_list[2].set_vertex(Point(1,0));
-       bline_point_list[0].set_tangent(bline_point_list[1].get_vertex()-bline_point_list[2].get_vertex()*0.5f);        
-       bline_point_list[1].set_tangent(bline_point_list[2].get_vertex()-bline_point_list[0].get_vertex()*0.5f);        
-       bline_point_list[2].set_tangent(bline_point_list[0].get_vertex()-bline_point_list[1].get_vertex()*0.5f);        
-       bline_point_list[0].set_width(1.0f);    
-       bline_point_list[1].set_width(1.0f);    
-       bline_point_list[2].set_width(1.0f);    
+       bline_point_list[0].set_tangent(bline_point_list[1].get_vertex()-bline_point_list[2].get_vertex()*0.5f);
+       bline_point_list[1].set_tangent(bline_point_list[2].get_vertex()-bline_point_list[0].get_vertex()*0.5f);
+       bline_point_list[2].set_tangent(bline_point_list[0].get_vertex()-bline_point_list[1].get_vertex()*0.5f);
+       bline_point_list[0].set_width(1.0f);
+       bline_point_list[1].set_width(1.0f);
+       bline_point_list[2].set_width(1.0f);
        bline=bline_point_list;
 }
 
@@ -105,7 +109,7 @@ Region::sync()
                clear();
                return;
        }
-       
+
        bool looped = bline.get_loop();
 
        Vector::value_type n;
@@ -114,13 +118,13 @@ Region::sync()
 
        vector<Segment>::const_iterator iter=segment_list.begin();
        //Vector                                                        last = iter->p1;
-       
+
        //make sure the shape has a clean slate for writing
        //clear();
-       
+
        //and start off at the first point
        //move_to(last[0],last[1]);
-       
+
        for(;iter!=segment_list.end();++iter)
        {
                //connect them with a line if they aren't already joined
@@ -128,14 +132,14 @@ Region::sync()
                {
                        line_to(iter->p1[0],iter->p1[1]);
                }
-               
+
                //curve to the next end point
                curve_to(iter->p1[0] + iter->t1[0]/3.0,iter->p1[1] + iter->t1[1]/3.0,
                                 iter->p2[0] - iter->t2[0]/3.0,iter->p2[1] - iter->t2[1]/3.0,
                                 iter->p2[0],iter->p2[1]);
-               
+
                last = iter->p2;*/
-               
+
                if(iter->t1.is_equal_to(Vector(0,0)) && iter->t2.is_equal_to(Vector(0,0)))
                {
                        vector_list.push_back(iter->p2);
@@ -152,7 +156,7 @@ Region::sync()
                                vector_list.push_back(curve(n));
                }
        }
-       
+
        //add a single point onto the end so it actually fits the shape, so we can be awesome...
        if(!looped)
        {
@@ -161,7 +165,7 @@ Region::sync()
 
        clear();
        add_polygon(vector_list);
-       
+
        /*close();
        endpath();*/
 }
@@ -180,12 +184,12 @@ Region::set_param(const String & param, const ValueBase &value)
                else
                        synfig::warning("Region::set_param(): The parameter \"segment_list\" is deprecated. Use \"bline\" instead.");
        }
-       
+
        if(     (param=="segment_list" || param=="bline") && value.get_type()==ValueBase::TYPE_LIST)
        {
                //if(value.get_contained_type()!=ValueBase::TYPE_BLINEPOINT)
                //      return false;
-                       
+
                bline=value;
 
                return true;