vos/metaobjects/misc/avatar.hh

Go to the documentation of this file.

/* $Id: avatar.hh,v 1.26 2003/08/06 01:37:24 reed Exp $ */


/* This file was generated by otd2cpp.pl, a script for VOS by Reed Hedges <reed@zerohour.net>.

   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 garuntee that this code will work, or even that it even is safe to run.
   Use it at your own risk.
*/

/** @file avatar.hh Defines MetaObject class for Avatar type (revision 0).

*/

#ifndef _AVATAR_HH_
#define _AVATAR_HH_

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


#if defined(_WIN32) && defined(_MSC_VER)
# ifdef MISC_EXPORTS
#  define MISC_API __declspec(dllexport)
# else
#  define MISC_API __declspec(dllimport)
# endif
#else
# define MISC_API
#endif

/** MetaObject implementing Avatar Object Type.

        Indicates that this object represents a human or automated agent. This object is the
        manifestation and representative of the human user or automated agent in the virtual world.
        In a 3D environment, will usually be used with an 3dobject.* type (such as 3dobject.model).

*/

class MISC_API Avatar : public virtual MetaObject
{
protected:
    PropertyAccessControl* defaultAccessControl;

public:

    /** @name Presence Codes 
     *  This is a simple schema, that mirrors the four presence codes
     *  in the <a href="http://www.jabber.org">Jabber</a> IM system.
     *  In the future there may be more. If you think something should
     *  be added, <a href="http://interreality.org/lists">let us know</a>.
     */
    //@{
    static const unsigned short AVAILABLE;  ///< for "chat"
    static const unsigned short AWAY;       ///< for "away"
    static const unsigned short EXTENDEDAWAY;   ///< for "xa"
    static const unsigned short BUSY;   ///< for "dnd"
    //@}

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


    /** Return type string ("avatar") */
    const string getType();

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

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

    /** Get the value of avatar:nick property (A text string containing a short name that can be used to identify this avatar. If this property is omitted, the object's contextual name may be used.). */
    string getNick();

    /** Get Property object for nick. */
    Property* getNickObj();

    /** Set Property object for nick */
    void setNickObj(Property* obj);

    /** Set avatar:nick property.
        @param value The new value. Should be a short string of plain text.
    */
    void setNick(const string& value, PropertyAccessControl* pac = 0);

    /** Add a PropertyListener to the avatar:nick property. */
    void addNickListener(PropertyListener* listener);

    /** Remove a PropertyListener from the avatar:nick property. */
    void removeNickListener(PropertyListener* listener);

    /** Get the value of avatar:fullname property (A text string containing the full name of the user or agent.). */
    string getFullname();

    /** Get the datatype of avatar:fullname property. */
    string getFullnameDatatype();

    /** Set avatar:fullname property.
        @param value The new value
        @param datatype The new datatype: if omitted, then the existing datatype will be preserved.
        @param pac Property access control to set o the property. The previously set default will be used if pac is omitted or 0.
    */
    void setFullname(const string& value, const string& datatype = "?", PropertyAccessControl* pac = 0);

    /** Get the fullname Property object */
    Property* getFullnameObj();

    /** Set the fullname object */
    void setFullnameObj(Property* obj);

    /** Get the value of avatar:info property. 
     * This is for More information about the user or agent, for example a 
     * <a href="http://www.foaf-project.org">FOAF document</a>, a picture, a
     * short biographical text, a URL to a web page or email address, or
     * whatever. (Use the datatype of the property to distinguish; I 
     * recommend checking out FOAF)
     * @todo support multiple "info" properties.
     */
    string getInfo();

    /** Get the datatype of avatar:info property. */
    string getInfoDatatype();

    /** Set avatar:info property.
        @param value The new value
        @param datatype The new datatype: if omitted, then the existing datatype will be preserved. */
    void setInfo(const string& value, const string& datatype = "?", PropertyAccessControl* pac = 0);

    /** Get info Property object */
    Property* getInfoObj();

    /** Set info Property object */
    void setInfoObj(Property* obj);

    /** Add PropertyListener to avatar:info property */
    void addInfoListener(PropertyListener* listener);

    /** Remove a PropertyListener from avatar:info property */
    void removeInfoListener(PropertyListener* listener);

    /** Set the user identifier (typically "user@host") */
    void setUserId(const string& userid, PropertyAccessControl* pac = 0);

    /** Get the user identifier (typically "user@host")
     * @throws sNoSuchObjectError No user-id property exitst
     * @throws bad_cast user-id subobject is not a Property. */
    string getUserId();

    /** Get a numeric code that represents the value of avatar:presence_code property (A text string indicating the presence/status/availability of the user or agent.)  The returned value will match one of the constants Avatar::AVAILABLE Avatar::AWAY, Avatar::EXTENDEDAWAY, or Avatar::BUSY.  */
    unsigned short getPresence();

    /** Set avatar:presence_code property according to the parameter code.
        @param code The new numeric code. See above for list of constants.
    */
    void setPresence(unsigned short code, PropertyAccessControl* pac = 0);

    /** Get info Property object */
    Property* getPresenceObj();

    /** Set info Property object */
    void setPresenceObj(Property* obj);

    /** Add a PropertyListener to the avatar:presence_code property. */
    void addPresenceListener(PropertyListener* listener);

    /** Remove a PropertyListener from the avatar:presence_code property. */
    void removePresenceListener(PropertyListener* listener);

    /** Get the value of avatar:presence_description property (Text describing the presence/status/availability of the user or agent in a more free-form manner (e.g. "Went to find more coffee. Back in a bit.")). */
    string getPresenceDescription();

    /** Get the datatype of avatar:presence_description property. */
    string getPresenceDescriptionDatatype();

    /** Set avatar:presence_description property.
        @param value The new value
        @param datatype The new datatype: if omitted, then the existing datatype will be preserved. */
    void setPresenceDescription(const string& value, const string& datatype = "?", PropertyAccessControl* pac = 0);

    /** Get info Property object */
    Property* getPresenceDescriptionObj();

    /** Set info Property object */
    void setPresenceDescriptionObj(Property* obj);

    /** Get "selected" object */
    Vobject* getSelectedObj();

    /** Set "selected" object.
     *  If 'obj' is 0, then any existing object is removed. Otherwise:
     *  If there is no "misc:selected-object" child, then a new Hypercard
     *  will be created linking to 'obj' and added. If such a child does
     *  exist and is a hypercard, then its link will be replaced with obj.
     */
    void setSelectedObj(Vobject* obj);

    /** Get "selected" hypercard */
    Hypercard* getSelectedHypercard();

    /** Set "selected" hypercard. */
    void setSelectedHypercard(Hypercard* hc);
    //@}


    /** Initialize */
    virtual void initialize();

    /** Set access control policy for subobjects */
    void setPropertyAccessControl(PropertyAccessControl* pac);

    /** Get property access control policy */
    PropertyAccessControl* getPropertyAccessControl();

};



/** Local version of Avatar. */

class MISC_API LocalAvatar : public virtual Avatar
{
public:

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

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

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


};


/** Remote version of Avatar. */

class MISC_API RemoteAvatar : public virtual Avatar
{

public:

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

    /** Static generator, for factory. */
    static MetaObject* new_RemoteAvatar(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 _AVATAR_HH_

---