uima.hpp

/* ==================================================== ======== ======= *
 *
 *  uima.hpp
 *  Ubit Project
 *  Part of the Ubit Toolkit: A Brick Construction Game Model for Creating GUIs
 *  (C) 1999-2006 / Eric Lecolinet / ENST Paris / http://www.enst.fr/~elc/ubit
 *
 * ***********************************************************************
 * COPYRIGHT NOTICE : 
 * THIS PROGRAM IS DISTRIBUTED WITHOUT ANY WARRANTY AND WITHOUT EVEN THE 
 * IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 
 * 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.
 * SEE FILES 'COPYRIGHT' AND 'COPYING' FOR MORE DETAILS.
 * ***********************************************************************
 * ==================================================== [(c)Elc] ======= *
 * ==================================================== ======== ======= */

#ifndef _uima_hpp_
#define _uima_hpp_
//pragma ident  "@(#)uima.hpp   ubit:05.05.00"
#include <ubit/umode.hpp>
#include <ubit/udata.hpp>
namespace ubit {

/* ==================================================== ===== ======= */
class UIma: public UData {
public:
  UBIT_DATA_ELEMENT_CLASS(UIma, UData)

  UIma(const UStr& filename, bool load_now = false);
  UIma(const char* filename = null, bool load_now = false);
  UIma(const char** xpm_data, bool load_now = false);
  UIma(int width, int height);
  virtual ~UIma();

  friend UIma& uima(const UStr& filename)  {return *new UIma(filename);}
  friend UIma& uima(const char* filename)  {return *new UIma(filename);}
  friend UIma& uima(const char** xpm_data) {return *new UIma(xpm_data);}

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  UIma& operator=(const UIma& ima2) {copy(ima2); return *this;}
  bool copy(const UIma& ima2);
  bool setSize(int width, int height);
  bool setSize(int width, int height, bool preserve_ratio, bool preserve_smaller);
  bool rescale(float xyscale);
  bool rescale(float xscale, float yscale);
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  virtual void set(const UStr& filename);
  virtual void set(const char* filename);
  virtual void set(const char** xpm_data);
  virtual int read(const UStr& filename, int max_w = 0, int max_h =0);
  virtual int read(const char* filename, int max_w = 0, int max_h =0);
  virtual int load();
  virtual int load(const char** xpm_data);
  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

  bool isLoaded() const;
  bool isRealized() const;

  int getAlpha() const;

  int getBpp() const {return getDepth() + getAlpha();}

  int getDepth() const;
  
  int getHeight() const;
  int getWidth()  const;

  int getStatus() const;
  
  unsigned long getPixel(int x, int y);

  void setPixel(unsigned long, int x, int y);

  //const char* getNameChars() const;
  // impl (to be removed).

  virtual void update(); 

  // - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  // implementation

  int realize(int max_w = 0, int max_h = 0,
              UDisp* disp = null, bool force_reload = true) const;
  std::list<UNatIma*>& getNatImas() const {return natimas;}

  static void getFullPath(UStr& fullpath, const char* filename);
#ifndef NO_DOC
  friend class UBox;
  friend class UNatIma;
  friend class UPix;

  virtual void setImpl(const char* fname);
  virtual void setImpl(const char** xpm_data);
  virtual void setImpl(int width, int height);
  virtual void cleanCache();
  virtual void getSize(UContext&, int& w, int& h) const;
  virtual void paint(UGraph&, UContext&, const URegion&) const;

  virtual class UNatIma* getOrCreateIma(class UNatDisp*, float xyscale) const;
  virtual class UNatIma* findImaInCache(class UNatDisp*, float xyscale) const;
  virtual class UNatIma* addImaInCache(class UNatDisp*, float xyscale) const;
  virtual class UNatPix* getOrCreatePix(class UNatDisp*, float xyscale) const
  {return null;}

protected:
  UIma(const char** xpm_data, UMask);
  mutable std::list<class UNatIma*> natimas;
  char *name;
  const char **data;
  mutable signed char stat;  // can have negative values
  enum Mode {EMPTY, CREATE, READ_FROM_FILE, READ_FROM_DATA};
  mutable char mode;
  bool show_unknown_ima;
#endif
};

}
/* ==================================================== [TheEnd] ======= */
/* ==================================================== [(c)Elc] ======= */
#endif

---