paintable.h

Go to the documentation of this file.

#ifndef PAINTABLE_CLASS
#define PAINTABLE_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : paintable                                                         *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*  Purpose:                                                                   *
*                                                                             *
*    Represents an object that can be painted onto a canvas.                  *
*                                                                             *
*******************************************************************************
* Copyright (c) 1991-$now By Author.  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 is online at:      *
*     http://www.fsf.org/copyleft/gpl.html                                    *
* Please send any updates to: fred@gruntose.com                               *
\*****************************************************************************/

#include "canvas.h"
#include "drawable.h"

class WP_PASSIVE_CLASS_STYLE paintable : public drawable
{
public:
  paintable(canvas &to_draw_on, const c_point &origin,
          const color &foreground = colors::WHITE, bool attach = true);
    // the paintable object is created with the color "foreground".  it is
    // added to the canvas "to_draw_on" if "attach" is true.  if "attach" is
    // false, calls to draw() will show the object, but the object will
    // disappear when the canvas is redrawn.  paintables are intentionally
    // quite dumb; they should not draw or erase themselves unless
    // specifically ordered to.

  virtual ~paintable();

  canvas &target() const;
    // The paintable object will perform its draws and erases on the canvas
    // returned by target.

  void draw();
  void erase();
    // Each of these two methods uses plot to draw the paintable object on its
    // canvas in the canvas foreground and background colors respectively.

  virtual c_rectangle dimensions() const = 0;
    // This must be provided by all derived paintable objects.  It should
    // return a rectangle that bounds the extent of the paintable on the screen
    // in terms of the world coordinate system (see canvas.h).

  virtual void plot(const color &to_draw_in) = 0;
    // Draws the object on its target canvas using the color specified in
    // "to_draw_in".

  bool filled() const;
    // if this is true, then the object should be drawn filled in, if that
    // is possible.
  virtual void set_filled(bool i_am_to_be_filled = true);
    // tells the paintable to be filled (or not), if that is supported.

  color foreground() const;
  virtual void foreground(const color &new_foreground);
    // The foreground here is used for the primary color that the paintable
    // will have when draw() is called.

  virtual void set_origin(const c_point &new_origin);
    // Resets the attachment point for the paintable on the canvas.

private:
  bool _filled;  // true if the object is to be filled when drawn.
  bool _attach;  // true if the object is to be attached to the canvas.
  canvas &_canvas;  // the canvas that the object will be drawn on.

  void attach();
  void detach();
};

#endif

---