gxshapekit.h

Go to the documentation of this file.
00001 
00004 
00005 //
00006 // Copyright (c) 1998-2004 California Institute of Technology
00007 // Copyright (c) 2004-2007 University of Southern California
00008 // Rob Peters <rjpeters at usc dot edu>
00009 //
00010 // created: Tue Dec  1 08:00:00 1998 (as grobj.h)
00011 // commit: $Id: gxshapekit.h 10065 2007-04-12 05:54:56Z rjpeters $
00012 // $HeadURL: file:///lab/rjpeters/svnrepo/code/trunk/groovx/src/gfx/gxshapekit.h $
00013 //
00014 // --------------------------------------------------------------------
00015 //
00016 // This file is part of GroovX.
00017 //   [http://ilab.usc.edu/rjpeters/groovx/]
00018 //
00019 // GroovX is free software; you can redistribute it and/or modify it
00020 // under the terms of the GNU General Public License as published by
00021 // the Free Software Foundation; either version 2 of the License, or
00022 // (at your option) any later version.
00023 //
00024 // GroovX is distributed in the hope that it will be useful, but
00025 // WITHOUT ANY WARRANTY; without even the implied warranty of
00026 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00027 // General Public License for more details.
00028 //
00029 // You should have received a copy of the GNU General Public License
00030 // along with GroovX; if not, write to the Free Software Foundation,
00031 // Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
00032 //
00034 
00035 #ifndef GROOVX_GFX_GXSHAPEKIT_H_UTC20050626084023_DEFINED
00036 #define GROOVX_GFX_GXSHAPEKIT_H_UTC20050626084023_DEFINED
00037 
00038 #include "gfx/gxnode.h"
00039 
00040 #include "io/fields.h"
00041 
00042 #include "rutz/tracer.h"
00043 
00044 class GxShapeKitImpl;
00045 
00046 namespace rutz
00047 {
00048   class fstring;
00049 }
00050 
00052 
00067 
00068 
00069 class GxShapeKit : public GxNode,
00070                    public FieldContainer
00071 {
00072 public:
00073 
00075   static rutz::tracer tracer;
00076 
00077 
00079   // creators //
00081 
00083   GxShapeKit();
00085   virtual ~GxShapeKit() throw();
00086 
00087   virtual io::version_id class_version_id() const;
00088   virtual void read_from(io::reader& reader);
00089   virtual void write_to(io::writer& writer) const;
00090 
00092   static const FieldMap& classFields();
00093 
00095   //
00096   // Accessors
00097   //
00099 
00102   bool getBBVisibility() const;
00103 
00109   virtual void getBoundingCube(Gfx::Bbox& bbox) const;
00110 
00113   virtual void grGetBoundingBox(Gfx::Bbox& bbox) const = 0;
00114 
00116   int getScalingMode() const;
00117 
00119   double getWidth() const;
00120 
00122   double getHeight() const;
00123 
00130   double getAspectRatio() const;
00131 
00133   double getMaxDimension() const;
00134 
00136   int getAlignmentMode() const;
00137 
00139   double getCenterX() const;
00140 
00142   double getCenterY() const;
00143 
00146   int getPercentBorder() const;
00147 
00149   virtual int category() const;
00150 
00152   int getRenderMode() const;
00153 
00154 
00156   //
00157   // Manipulators
00158   //
00160 
00162   void setBBVisibility(bool visibility);
00163 
00167   void setScalingMode(int mode);
00168 
00173   void setWidth(double val);
00174 
00179   void setHeight(double val);
00180 
00183   void setAspectRatio(double val);
00184 
00189   void setMaxDimension(double val);
00190 
00194   void setAlignmentMode(int mode);
00195 
00199   void setCenterX(double val);
00200 
00204   void setCenterY(double val);
00205 
00208   void setPercentBorder(int pixels);
00209 
00211   virtual void setCategory(int val);
00212 
00216   void setRenderMode(int mode);
00217 
00218 
00220   //
00221   // Actions
00222   //
00224 
00227   void draw(Gfx::Canvas& canvas) const;
00228 
00231   virtual void grRender(Gfx::Canvas& canvas) const = 0;
00232 
00233 private:
00234   double getWidthFactor() const;
00235   void setWidthFactor(double val);
00236 
00237   double getHeightFactor() const;
00238   void setHeightFactor(double val);
00239 
00240   GxShapeKit(const GxShapeKit&);
00241   GxShapeKit& operator=(const GxShapeKit&);
00242 
00243   friend class GxShapeKitImpl;
00244   GxShapeKitImpl* const rep;    // opaque pointer to implementation
00245 };
00246 
00247 static const char __attribute__((used)) vcid_groovx_gfx_gxshapekit_h_utc20050626084023[] = "$Id: gxshapekit.h 10065 2007-04-12 05:54:56Z rjpeters $ $HeadURL: file:
00248 #endif // !GROOVX_GFX_GXSHAPEKIT_H_UTC20050626084023_DEFINED

The software described here is Copyright (c) 1998-2005, Rob Peters.
This page was generated Wed Dec 3 06:49:38 2008 by Doxygen version 1.5.5.