vos/metaobjects/image2D/image2D.hh

Go to the documentation of this file.

/* $Id: image2D.hh,v 1.2 2003/07/22 05:08:45 tetron Exp $ */


/* This file was generated by otd2cpp.pl, a script for VOS by Reed Hedges <reed@zerohour.net>
   and Peter Amstutz <tetron@interreality.org>

   Search for TODO for stuff that needs editing. You will want to especially fill in constructors,
   destructors, message handlers, non-property subobjects...

   I can make no guarantee that this code will work, or even that it even is safe to run.
   Use it at your own risk.
*/

/** @file image2D.hh Defines MetaObject class for Image2D type (revision 0).

*/ 

#ifndef _IMAGE2D_HH_
#define _IMAGE2D_HH_

#include <vos/corelibs/vos/vos.hh>
#include <vos/metaobjects/property/property.hh>

/** MetaObject implementing Image2D Object Type. 
    
        Base object type for 2D image objects: provides position, orientation
and size properties. These three properties define a transformation for this
2D image relative to its parent image.  An image should be displayed
superimposed on top of its parent image, and its child image objects should be
displayed superimposed on top of it.
    
*/
class Image2D : public virtual MetaObject
{
protected: 
    PropertyAccessControl* accessControl;

public:

    /** Constructor */
    Image2D(MetaObject* superobject);

    /** Destructor */
    virtual ~Image2D();

    /** Return type string ("image2D") */
    virtual const string getType();

    /** Register Extenders */
    static void registerExtenders();

    /** Set default access control policy for subobjects */
    virtual void setPropertyAccessControl(PropertyAccessControl* ac) {
        accessControl = ac;
    }

    /** Get default access control policy for subobjects */
    virtual PropertyAccessControl* getPropertyAccessControl() {
        return accessControl;   
    } 

    /** @name Access Subobjects */
    //@{

    /** Get the value of position property.
            This is the position or translation of this object relative to the origin of its
parent image object.  
    */
    virtual void getPosition(double& x, double& y);


    /** Set position property. 
    */
    virtual void setPosition(double x, double y, PropertyAccessControl* ac = NULL);

    /** Get the value of orientation property.
            This is the orientation or rotation of this object relative to the orientation
of its parent image object (clockwise).  
    */
    virtual double getOrientation();

    /** Set orientation property. 
    */
    virtual void setOrientation(double o, PropertyAccessControl* ac = NULL);

    /** Get the values of scaling property. 
        This is the size of this object, and a scaling transformation to 
        apply to all children of this object.  
        All objects under the same 2D object 
        or space with the same scaling value should be rendered at the same 
        size (regardless of the size of the shape/bitmap itself).  
    */
    virtual void getScaling(double& x, double& y);

    /** Set caling property.  */
    virtual void setScaling(double x, double y, PropertyAccessControl* ac = NULL);

    /** Get the value of image property. 
        This is the image data. The datatype indicates the data format. 
        Suggested datatypes to support are: PNG, JPEG, BMP, TIFF, PCX, 
        PNM, and XPM. 
    */
    // @{
    virtual string getImage();
    virtual void getImage(string& s);
    // @}

    /** Get the datatype of image2D:image property. */
    virtual string getImageDatatype();

    /** Set image property. 
        @param value The new value
        @param datatype The new datatype: if omitted, then the existing datatype will be preserved. */
    virtual void setImage(const string& value, const string& datatype = "?", PropertyAccessControl* ac = NULL);

    /** Set contents of image property with dat aread from file.
        @param filename Filename
        @param datatype The datatype
    */
    virtual void setImageFromFile(const string& filename, const string& datatype = "?", PropertyAccessControl* ac = NULL);

    /** Get size of image data (in bytes)  */
    virtual int getImageLength();

    //@}



};



/** Local version of Image2D. */
class LocalImage2D : public virtual Image2D
{
public:

    /** Constructor */
    LocalImage2D(MetaObject* superobject);

    /** Destructor */
    ~LocalImage2D();

    /** Initialize subproperties etc. */
    virtual void initialize();

    /** Intialize subproperties and set default access control policy */
    void initialize(PropertyAccessControl* ac); 

    /** Static generator, for factory. */
    static MetaObject* new_LocalImage2D(MetaObject* superobject, const string& type);

    /** Called when this object gets a message */
    virtual void sendMessage(Message* m);


};


/** Remote version of Image2D. */
class RemoteImage2D : public virtual Image2D
{
public:

    /** Constructor */
    RemoteImage2D(MetaObject* superobject);

    /** Destructor */
    virtual ~RemoteImage2D();

    /** Static generator, for factory. */
    static MetaObject* new_RemoteImage2D(MetaObject* superobject, const string& type);

    /** Called when this object gets an update message from its Local master across the network. */
    void sendUpdateMessage(Message *m);


};


#endif // #ifdef _IMAGE2D_HH_

---