picture.h

Go to the documentation of this file.

#ifndef PICTURE_CLASS
#define PICTURE_CLASS

/*****************************************************************************\
*                                                                             *
*  Name   : picture                                                           *
*  Author : Chris Koeritz                                                     *
*                                                                             *
*  Purpose:                                                                   *
*                                                                             *
*    A collection of drawables that can be drawn or erased as a group and     *
*  that share a common origin as their reference point.                       *
*                                                                             *
*******************************************************************************
* 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 "drawable.h"

#include <data_struct/amorph.h>
#include <geometric/cartesian_objects.h>

class picture_part;

class WP_PASSIVE_CLASS_STYLE picture
: public drawable, private amorph<picture_part>
{
public:
  picture(const c_point &origin);
  virtual ~picture();

  void add(drawable *to_add);
    // Adds a drawable object to the picture.  The origin of the object (at
    // the time of add) is used as the object's relationship with the
    // origin of the picture.  That is, if a drawable is added with an
    // origin of (0, 0), then it has the same origin as the picture,
    // whereas if a drawable is added with origin(20, -30), then it is
    // located at 20 pixels to the right and 30 pixels below the picture's
    // origin.  The relative origin is updated appropriately when the
    // picture is moved.

  bool remove(drawable *to_remove);
  bool remove(int index);
    // Eliminates a member from the picture, if it is present.  true is
    // returned if it was found and removed.  The size of the picture shrinks
    // after the element is removed.  The drawable object (which was until
    // recently an element in the picture) is not deleted; this must be done
    // by the real parent of the drawable.

  virtual c_rectangle dimensions() const;
    // Returns a rectangle bounding the whole picture.

  virtual void draw();
  virtual void erase();

  void draw_intersecting(const c_rectangle &region);
  void erase_intersecting(const c_rectangle &region);

  amorph<picture_part>::elements;

  const drawable *get(int index) const;
  drawable *acquire(int index);
    // returns the drawable at the "index", or NIL if the index is invalid.
    // get retains the drawable in question, acquire removes it from the
    // picture.

  virtual void set_origin(const c_point &new_origin);
    // changes the origin for the picture within the frame of reference where
    // the picture is to be drawn.  each of the drawables maintain their
    // relationship with the relative origin.

  void update();
    // reorders the list of drawables with correct layering.  this accounts
    // for an object's layer changing after it has been added to the picture.
    // all of the objects are erased and then redrawn in the correct order,
    // currently.

private:
  c_point _origin;
};

class WP_PASSIVE_CLASS_STYLE picture_part : private c_point
{
private:
  picture_part(const c_point &origin) : c_point(origin) {}
  drawable *stored;
  friend class picture;
};

#endif

---