juce_Drawable.h

Go to the documentation of this file.

/*
  ==============================================================================

   This file is part of the JUCE library - "Jules' Utility Class Extensions"
   Copyright 2004-7 by Raw Material Software ltd.

  ------------------------------------------------------------------------------

   JUCE can be redistributed and/or modified 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.

   JUCE is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with JUCE; if not, visit www.gnu.org/licenses or write to the
   Free Software Foundation, Inc., 59 Temple Place, Suite 330,
   Boston, MA 02111-1307 USA

  ------------------------------------------------------------------------------

   If you'd like to release a closed-source product which uses JUCE, commercial
   licenses are also available: visit www.rawmaterialsoftware.com/juce for
   more information.

  ==============================================================================
*/

#ifndef __JUCE_DRAWABLE_JUCEHEADER__
#define __JUCE_DRAWABLE_JUCEHEADER__

#include "../contexts/juce_Graphics.h"
#include "../../../../juce_core/text/juce_XmlElement.h"


//==============================================================================
class JUCE_API  Drawable
{
protected:
    //==============================================================================
    Drawable();

public:
    virtual ~Drawable();

    //==============================================================================
    virtual Drawable* createCopy() const = 0;

    //==============================================================================
    virtual void draw (Graphics& g,
                       const AffineTransform& transform = AffineTransform::identity) const = 0;

    void drawAt (Graphics& g,
                 const float x,
                 const float y) const;

    void drawWithin (Graphics& g,
                     const int destX,
                     const int destY,
                     const int destWidth,
                     const int destHeight,
                     const RectanglePlacement& placement) const;


    //==============================================================================
    virtual void getBounds (float& x, float& y, float& width, float& height) const = 0;

    virtual bool hitTest (float x, float y) const = 0;

    //==============================================================================
    const String& getName() const throw()               { return name; }

    void setName (const String& newName) throw()        { name = newName; }

    //==============================================================================
    static Drawable* createFromImageData (const void* data, const int numBytes);

    static Drawable* createFromImageDataStream (InputStream& dataSource);

    static Drawable* createFromImageFile (const File& file);

    static Drawable* createFromSVG (const XmlElement& svgDocument);


    //==============================================================================
    juce_UseDebuggingNewOperator

private:
    Drawable (const Drawable&);
    const Drawable& operator= (const Drawable&);

    String name;
};


#endif   // __JUCE_DRAWABLE_JUCEHEADER__