Entities have user data

libraries/entities/src/EntityItem.cpp

@@ -28,6 +28,7 @@ const float EntityItem::DEFAULT_GLOW_LEVEL = 0.0f;
 const float EntityItem::DEFAULT_LOCAL_RENDER_ALPHA = 1.0f;
 const float EntityItem::DEFAULT_MASS = 1.0f;
 const float EntityItem::DEFAULT_LIFETIME = EntityItem::IMMORTAL;
+const QString EntityItem::DEFAULT_USER_DATA = QString("");
 const float EntityItem::DEFAULT_DAMPING = 0.5f;
 const glm::vec3 EntityItem::NO_VELOCITY = glm::vec3(0, 0, 0);
 const float EntityItem::EPSILON_VELOCITY_LENGTH = (1.0f / 1000.0f) / (float)TREE_SCALE; // really small: 1mm/second
@@ -71,6 +72,7 @@ void EntityItem::initFromEntityItemID(const EntityItemID& entityItemID) {
     _gravity = DEFAULT_GRAVITY;
     _damping = DEFAULT_DAMPING;
     _lifetime = DEFAULT_LIFETIME;
+    _userData = DEFAULT_USER_DATA;
     _registrationPoint = DEFAULT_REGISTRATION_POINT;
     _angularVelocity = DEFAULT_ANGULAR_VELOCITY;
     _angularDamping = DEFAULT_ANGULAR_DAMPING;
@@ -115,6 +117,7 @@ EntityPropertyFlags EntityItem::getEntityProperties(EncodeBitstreamParams& param
     requestedProperties += PROP_GRAVITY;
     requestedProperties += PROP_DAMPING;
     requestedProperties += PROP_LIFETIME;
+    requestedProperties += PROP_USER_DATA;
     requestedProperties += PROP_SCRIPT;
     requestedProperties += PROP_REGISTRATION_POINT;
     requestedProperties += PROP_ANGULAR_VELOCITY;
@@ -231,6 +234,7 @@ OctreeElement::AppendState EntityItem::appendEntityData(OctreePacketData* packet
         APPEND_ENTITY_PROPERTY(PROP_GRAVITY, appendValue, getGravity());
         APPEND_ENTITY_PROPERTY(PROP_DAMPING, appendValue, getDamping());
         APPEND_ENTITY_PROPERTY(PROP_LIFETIME, appendValue, getLifetime());
+        APPEND_ENTITY_PROPERTY(PROP_USER_DATA, appendValue, getUserData());
         APPEND_ENTITY_PROPERTY(PROP_SCRIPT, appendValue, getScript());
         APPEND_ENTITY_PROPERTY(PROP_REGISTRATION_POINT, appendValue, getRegistrationPoint());
         APPEND_ENTITY_PROPERTY(PROP_ANGULAR_VELOCITY, appendValue, getAngularVelocity());
@@ -502,6 +506,7 @@ int EntityItem::readEntityDataFromBuffer(const unsigned char* data, int bytesLef
         READ_ENTITY_PROPERTY(PROP_IGNORE_FOR_COLLISIONS, bool, _ignoreForCollisions);
         READ_ENTITY_PROPERTY(PROP_COLLISIONS_WILL_MOVE, bool, _collisionsWillMove);
         READ_ENTITY_PROPERTY(PROP_LOCKED, bool, _locked);
+        READ_ENTITY_PROPERTY(PROP_USER_DATA, QString, _userData);
 
         if (wantDebug) {
             qDebug() << "    readEntityDataFromBuffer() _registrationPoint:" << _registrationPoint;
@@ -758,6 +763,7 @@ EntityItemProperties EntityItem::getProperties() const {
     COPY_ENTITY_PROPERTY_TO_PROPERTIES(ignoreForCollisions, getIgnoreForCollisions);
     COPY_ENTITY_PROPERTY_TO_PROPERTIES(collisionsWillMove, getCollisionsWillMove);
     COPY_ENTITY_PROPERTY_TO_PROPERTIES(locked, getLocked);
+    COPY_ENTITY_PROPERTY_TO_PROPERTIES(userData, getUserData);
 
     properties._defaultSettings = false;
     
@@ -794,6 +800,7 @@ bool EntityItem::setProperties(const EntityItemProperties& properties, bool forc
     SET_ENTITY_PROPERTY_FROM_PROPERTIES(ignoreForCollisions, setIgnoreForCollisions);
     SET_ENTITY_PROPERTY_FROM_PROPERTIES(collisionsWillMove, setCollisionsWillMove);
     SET_ENTITY_PROPERTY_FROM_PROPERTIES(locked, setLocked);
+    SET_ENTITY_PROPERTY_FROM_PROPERTIES(userData, setUserData);
 
     if (somethingChanged) {
         somethingChangedNotification(); // notify derived classes that something has changed

libraries/entities/src/EntityItem.h

@@ -196,6 +196,11 @@ public:
     static const float DEFAULT_LIFETIME;
     float getLifetime() const { return _lifetime; } /// get the lifetime in seconds for the entity
     void setLifetime(float value) { _lifetime = value; } /// set the lifetime in seconds for the entity
+    
+    /// User-specified data stored in a variant map
+    static const QString DEFAULT_USER_DATA;
+    const QString& getUserData() const { return _userData; }
+    void setUserData(const QString& value) { _userData = value; }
 
     /// is this entity immortal, in that it has no lifetime set, and will exist until manually deleted
     bool isImmortal() const { return _lifetime == IMMORTAL; }
@@ -284,6 +289,7 @@ protected:
     glm::vec3 _gravity;
     float _damping;
     float _lifetime;
+    QString _userData;
     QString _script;
     glm::vec3 _registrationPoint;
     glm::vec3 _angularVelocity;

libraries/entities/src/EntityItemProperties.cpp

@@ -37,6 +37,7 @@ EntityItemProperties::EntityItemProperties() :
     _gravity(EntityItem::DEFAULT_GRAVITY),
     _damping(EntityItem::DEFAULT_DAMPING),
     _lifetime(EntityItem::DEFAULT_LIFETIME),
+    _userData(EntityItem::DEFAULT_USER_DATA),
     _script(EntityItem::DEFAULT_SCRIPT),
     _registrationPoint(EntityItem::DEFAULT_REGISTRATION_POINT),
     _angularVelocity(EntityItem::DEFAULT_ANGULAR_VELOCITY),
@@ -53,6 +54,7 @@ EntityItemProperties::EntityItemProperties() :
     _gravityChanged(false),
     _dampingChanged(false),
     _lifetimeChanged(false),
+    _userDataChanged(false),
     _scriptChanged(false),
     _registrationPointChanged(false),
     _angularVelocityChanged(false),
@@ -198,6 +200,7 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
     CHECK_PROPERTY_CHANGE(PROP_GRAVITY, gravity);
     CHECK_PROPERTY_CHANGE(PROP_DAMPING, damping);
     CHECK_PROPERTY_CHANGE(PROP_LIFETIME, lifetime);
+    CHECK_PROPERTY_CHANGE(PROP_USER_DATA, userData);
     CHECK_PROPERTY_CHANGE(PROP_SCRIPT, script);
     CHECK_PROPERTY_CHANGE(PROP_COLOR, color);
     CHECK_PROPERTY_CHANGE(PROP_MODEL_URL, modelURL);
@@ -247,6 +250,7 @@ QScriptValue EntityItemProperties::copyToScriptValue(QScriptEngine* engine) cons
     COPY_PROPERTY_TO_QSCRIPTVALUE(damping);
     COPY_PROPERTY_TO_QSCRIPTVALUE(mass);
     COPY_PROPERTY_TO_QSCRIPTVALUE(lifetime);
+    COPY_PROPERTY_TO_QSCRIPTVALUE(userData);
     COPY_PROPERTY_TO_QSCRIPTVALUE_GETTER(age, getAge()); // gettable, but not settable
     COPY_PROPERTY_TO_QSCRIPTVALUE_GETTER(ageAsText, formatSecondsElapsed(getAge())); // gettable, but not settable
     COPY_PROPERTY_TO_QSCRIPTVALUE(script);
@@ -350,6 +354,7 @@ void EntityItemProperties::copyFromScriptValue(const QScriptValue& object) {
     COPY_PROPERTY_FROM_QSCRIPTVALUE_FLOAT(cutoff, setCutoff);
     COPY_PROPERTY_FROM_QSCRIPTVALUE_BOOL(locked, setLocked);
     COPY_PROPERTY_FROM_QSCRIPTVALUE_STRING(textures, setTextures);
+    COPY_PROPERTY_FROM_QSCRIPTVALUE_STRING(userData, setUserData);
 
     _lastEdited = usecTimestampNow();
 }
@@ -512,6 +517,7 @@ bool EntityItemProperties::encodeEntityEditPacket(PacketType command, EntityItem
             APPEND_ENTITY_PROPERTY(PROP_LOCKED, appendValue, properties.getLocked());
             APPEND_ENTITY_PROPERTY(PROP_TEXTURES, appendValue, properties.getTextures());
             APPEND_ENTITY_PROPERTY(PROP_ANIMATION_SETTINGS, appendValue, properties.getAnimationSettings());
+            APPEND_ENTITY_PROPERTY(PROP_USER_DATA, appendValue, properties.getUserData());
         }
         if (propertyCount > 0) {
             int endOfEntityItemData = packetData->getUncompressedByteOffset();
@@ -722,6 +728,7 @@ bool EntityItemProperties::decodeEntityEditPacket(const unsigned char* data, int
     READ_ENTITY_PROPERTY_TO_PROPERTIES(PROP_LOCKED, bool, setLocked);
     READ_ENTITY_PROPERTY_STRING_TO_PROPERTIES(PROP_TEXTURES, setTextures);
     READ_ENTITY_PROPERTY_STRING_TO_PROPERTIES(PROP_ANIMATION_SETTINGS, setAnimationSettings);
+    READ_ENTITY_PROPERTY_TO_PROPERTIES(PROP_USER_DATA, QString, setUserData);
     
     return valid;
 }
@@ -764,6 +771,7 @@ void EntityItemProperties::markAllChanged() {
     _gravityChanged = true;
     _dampingChanged = true;
     _lifetimeChanged = true;
+    _userDataChanged = true;
     _scriptChanged = true;
     _registrationPointChanged = true;
     _angularVelocityChanged = true;

libraries/entities/src/EntityItemProperties.h

@@ -47,6 +47,7 @@ enum EntityPropertyList {
     PROP_GRAVITY,
     PROP_DAMPING,
     PROP_LIFETIME,
+    PROP_USER_DATA,
     PROP_SCRIPT,
 
     // these properties are supported by some derived classes
@@ -156,9 +157,13 @@ public:
 
     float getDamping() const { return _damping; }
     void setDamping(float value) { _damping = value; _dampingChanged = true; }
-
+    
     float getLifetime() const { return _lifetime; } /// get the lifetime in seconds for the entity
     void setLifetime(float value) { _lifetime = value; _lifetimeChanged = true; } /// set the lifetime in seconds for the entity
+    
+    const QString& getUserData() const { return _userData; }
+    void setUserData(const QString& value) { _userData = value; _userDataChanged = true; }
+    
     float getAge() const { return (float)(usecTimestampNow() - _created) / (float)USECS_PER_SECOND; }
     quint64 getCreated() const { return _created; }
     void setCreated(quint64 usecTime) { _created = usecTime; }
@@ -216,6 +221,7 @@ public:
     bool gravityChanged() const { return _gravityChanged; }
     bool dampingChanged() const { return _dampingChanged; }
     bool lifetimeChanged() const { return _lifetimeChanged; }
+    bool userDataChanged() const { return _userDataChanged; }
     bool scriptChanged() const { return _scriptChanged; }
     bool dimensionsChanged() const { return _dimensionsChanged; }
     bool registrationPointChanged() const { return _registrationPointChanged; }
@@ -315,6 +321,7 @@ private:
     glm::vec3 _gravity;
     float _damping;
     float _lifetime;
+    QString _userData;
     QString _script;
     glm::vec3 _registrationPoint;
     glm::vec3 _angularVelocity;
@@ -331,6 +338,7 @@ private:
     bool _gravityChanged;
     bool _dampingChanged;
     bool _lifetimeChanged;
+    bool _userDataChanged;
     bool _scriptChanged;
     bool _registrationPointChanged;
     bool _angularVelocityChanged;

libraries/networking/src/PacketHeaders.cpp

@@ -75,7 +75,7 @@ PacketVersion versionForPacketType(PacketType type) {
             return 1;
         case PacketTypeEntityAddOrEdit:
         case PacketTypeEntityData:
-            return VERSION_ENTITIES_MODELS_HAVE_ANIMATION_SETTINGS;
+            return VERSION_ENTITIES_HAVE_USER_DATA;
         case PacketTypeEntityErase:
             return 2;
         case PacketTypeAudioStreamStats:

libraries/networking/src/PacketHeaders.h

@@ -125,6 +125,7 @@ const PacketVersion VERSION_ENTITIES_SUPPORT_SPLIT_MTU = 3;
 const PacketVersion VERSION_ENTITIES_HAS_FILE_BREAKS = VERSION_ENTITIES_SUPPORT_SPLIT_MTU;
 const PacketVersion VERSION_ENTITIES_SUPPORT_DIMENSIONS = 4;
 const PacketVersion VERSION_ENTITIES_MODELS_HAVE_ANIMATION_SETTINGS = 5;
+const PacketVersion VERSION_ENTITIES_HAVE_USER_DATA = 6;
 const PacketVersion VERSION_VOXELS_HAS_FILE_BREAKS = 1;
 
 #endif // hifi_PacketHeaders_h