/*
 * Copyright (c) 1987, 1988, 1989 Stanford University
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided
 * that the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
 * documentation, and that the name of Stanford not be used in advertising or
 * publicity pertaining to distribution of the software without specific,
 * written prior permission.  Stanford makes no representations about
 * the suitability of this software for any purpose.  It is provided "as is"
 * without express or implied warranty.
 *
 * STANFORD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS.
 * IN NO EVENT SHALL STANFORD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
 * OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 * WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

/*
 * Interface to Stencil, an object derived from Graphic.
 */

#ifndef stencil_h
#define stencil_h

#include <InterViews/Graphic/base.h>

class Bitmap;

class Stencil : public Graphic {
public:
    Stencil();
    Stencil(Bitmap* image, Bitmap* mask = nil, Graphic* = nil);
    ~Stencil();

    void GetOriginal(Bitmap*&, Bitmap*&);

    virtual Graphic* Copy();
    virtual ClassId GetClassId();
    virtual bool IsA(ClassId);
protected:
    virtual void getExtent(float&, float&, float&, float&, float&, Graphic*);
    virtual bool contains(PointObj&, Graphic*);
    virtual bool intersects(BoxObj&, Graphic*);
    virtual void draw(Canvas*, Graphic*);

    virtual bool read(PFile*);
    virtual bool write(PFile*);
private:
    bool readBitmap(PFile*, Bitmap*&);
    bool writeBitmap(PFile*, Bitmap*);
protected:
    Bitmap* image;
    Bitmap* mask;
};

#endif