Support for scale property on model overlays

If "scale" property is present but "dimensions" are not, the model is NOT scale to fit.
And the scale of the model's natural dimensions will be affected by the scale properties.

If only the "dimensions" property is present, the model will "scale to fit" the dimensions.

If both properties are present, the model still be "scale to fit" but the dimension will be scaled by the scale factor.

For example:

If a model is loaded that is 2cm tall, is loaded with no "dimensions" or "scale" properties.
It will be displayed as 2cm tall.

    {"scale": 2}

The above properties will result in a model that is 4cm tall.

    {"dimensions": 1}

This will result in a model that is 1cm tall.

    {"scale": 2, "dimensions" 2}

Will result in a model that is 2cm tall.

interface/src/ui/overlays/Base3DOverlay.h

@@ -17,7 +17,7 @@
 
 class Base3DOverlay : public Overlay {
     Q_OBJECT
-    
+
 public:
     Base3DOverlay();
     Base3DOverlay(const Base3DOverlay* base3DOverlay);
@@ -27,10 +27,10 @@ public:
     const glm::vec3& getPosition() const { return _transform.getTranslation(); }
     const glm::quat& getRotation() const { return _transform.getRotation(); }
     const glm::vec3& getScale() const { return _transform.getScale(); }
-   
+
     // TODO: consider implementing registration points in this class
     const glm::vec3& getCenter() const { return getPosition(); }
-    
+
     float getLineWidth() const { return _lineWidth; }
     bool getIsSolid() const { return _isSolid; }
     bool getIsDashedLine() const { return _isDashedLine; }
@@ -43,7 +43,7 @@ public:
     void setRotation(const glm::quat& value) { _transform.setRotation(value); }
     void setScale(float value) { _transform.setScale(value); }
     void setScale(const glm::vec3& value) { _transform.setScale(value); }
-    
+
     void setLineWidth(float lineWidth) { _lineWidth = lineWidth; }
     void setIsSolid(bool isSolid) { _isSolid = isSolid; }
     void setIsDashedLine(bool isDashedLine) { _isDashedLine = isDashedLine; }
@@ -55,22 +55,22 @@ public:
     void setProperties(const QVariantMap& properties) override;
     QVariant getProperty(const QString& property) override;
 
-    virtual bool findRayIntersection(const glm::vec3& origin, const glm::vec3& direction, float& distance, 
+    virtual bool findRayIntersection(const glm::vec3& origin, const glm::vec3& direction, float& distance,
                                         BoxFace& face, glm::vec3& surfaceNormal);
 
-    virtual bool findRayIntersectionExtraInfo(const glm::vec3& origin, const glm::vec3& direction, 
+    virtual bool findRayIntersectionExtraInfo(const glm::vec3& origin, const glm::vec3& direction,
                                         float& distance, BoxFace& face, glm::vec3& surfaceNormal, QString& extraInfo) {
         return findRayIntersection(origin, direction, distance, face, surfaceNormal);
     }
 
 protected:
     Transform _transform;
-    
+
     float _lineWidth;
     bool _isSolid;
     bool _isDashedLine;
     bool _ignoreRayIntersection;
     bool _drawInFront;
 };
- 
+
 #endif // hifi_Base3DOverlay_h

interface/src/ui/overlays/ModelOverlay.cpp

@@ -19,8 +19,7 @@ QString const ModelOverlay::TYPE = "model";
 
 ModelOverlay::ModelOverlay()
     : _model(std::make_shared<Model>(std::make_shared<Rig>())),
-      _modelTextures(QVariantMap()),
+      _modelTextures(QVariantMap())
-      _updateModel(false)
 {
     _model->init();
     _isLoaded = false;
@@ -44,7 +43,11 @@ void ModelOverlay::update(float deltatime) {
     if (_updateModel) {
         _updateModel = false;
         _model->setSnapModelToCenter(true);
-        _model->setScaleToFit(true, getDimensions());
+        if (_scaleToFit) {
+            _model->setScaleToFit(true, getScale() * getDimensions());
+        } else {
+            _model->setScale(getScale());
+        }
         _model->setRotation(getRotation());
         _model->setTranslation(getPosition());
         _model->setURL(_url);
@@ -84,16 +87,33 @@ void ModelOverlay::render(RenderArgs* args) {
 }
 
 void ModelOverlay::setProperties(const QVariantMap& properties) {
-    auto position = getPosition();
+    auto origPosition = getPosition();
-    auto rotation = getRotation();
+    auto origRotation = getRotation();
+    auto origDimensions = getDimensions();
+    auto origScale = getScale();
 
-    Volume3DOverlay::setProperties(properties);
+    Base3DOverlay::setProperties(properties);
 
-    if (position != getPosition() || rotation != getRotation()) {
+    auto scale = properties["scale"];
-        _updateModel = true;
+    if (scale.isValid()) {
+        setScale(vec3FromVariant(scale));
     }
 
-    _updateModel = true;
+    auto dimensions = properties["dimensions"];
+    if (dimensions.isValid()) {
+        _scaleToFit = true;
+        setDimensions(vec3FromVariant(dimensions));
+    } else if (scale.isValid()) {
+        // if "scale" property is set but "dimentions" is not.
+        // do NOT scale to fit.
+        if (scale.isValid()) {
+            _scaleToFit = false;
+        }
+    }
+
+    if (origPosition != getPosition() || origRotation != getRotation() || origDimensions != getDimensions() || origScale != getScale()) {
+        _updateModel = true;
+    }
 
     auto urlValue = properties["url"];
     if (urlValue.isValid() && urlValue.canConvert<QString>()) {
@@ -101,15 +121,15 @@ void ModelOverlay::setProperties(const QVariantMap& properties) {
         _updateModel = true;
         _isLoaded = false;
     }
-    
+
     auto texturesValue = properties["textures"];
     if (texturesValue.isValid() && texturesValue.canConvert(QVariant::Map)) {
         QVariantMap textureMap = texturesValue.toMap();
         foreach(const QString& key, textureMap.keys()) {
-            
+
             QUrl newTextureURL = textureMap[key].toUrl();
             qDebug() << "Updating texture named" << key << "to texture at URL" << newTextureURL;
-            
+
             QMetaObject::invokeMethod(_model.get(), "setTextureWithNameToURL", Qt::AutoConnection,
                                       Q_ARG(const QString&, key),
                                       Q_ARG(const QUrl&, newTextureURL));
@@ -123,8 +143,11 @@ QVariant ModelOverlay::getProperty(const QString& property) {
     if (property == "url") {
         return _url.toString();
     }
-    if (property == "dimensions" || property == "scale" || property == "size") {
+    if (property == "dimensions" || property == "size") {
-        return vec3toVariant(_model->getScaleToFitDimensions());
+        return vec3toVariant(getDimensions());
+    }
+    if (property == "scale") {
+        return vec3toVariant(getScale());
     }
     if (property == "textures") {
         if (_modelTextures.size() > 0) {
@@ -143,14 +166,14 @@ QVariant ModelOverlay::getProperty(const QString& property) {
 
 bool ModelOverlay::findRayIntersection(const glm::vec3& origin, const glm::vec3& direction,
                                         float& distance, BoxFace& face, glm::vec3& surfaceNormal) {
-    
+
     QString subMeshNameTemp;
     return _model->findRayIntersectionAgainstSubMeshes(origin, direction, distance, face, surfaceNormal, subMeshNameTemp);
 }
 
 bool ModelOverlay::findRayIntersectionExtraInfo(const glm::vec3& origin, const glm::vec3& direction,
                                         float& distance, BoxFace& face, glm::vec3& surfaceNormal, QString& extraInfo) {
-    
+
     return _model->findRayIntersectionAgainstSubMeshes(origin, direction, distance, face, surfaceNormal, extraInfo);
 }
 

interface/src/ui/overlays/ModelOverlay.h

@@ -43,9 +43,10 @@ private:
 
     ModelPointer _model;
     QVariantMap _modelTextures;
-    
+
     QUrl _url;
-    bool _updateModel;
+    bool _updateModel = { false };
+    bool _scaleToFit = { false };
 };
 
 #endif // hifi_ModelOverlay_h

interface/src/ui/overlays/Volume3DOverlay.cpp

@@ -22,7 +22,7 @@ AABox Volume3DOverlay::getBounds() const {
     auto extents = Extents{_localBoundingBox};
     extents.rotate(getRotation());
     extents.shiftBy(getPosition());
-    
+
     return AABox(extents);
 }
 
@@ -31,7 +31,7 @@ void Volume3DOverlay::setProperties(const QVariantMap& properties) {
 
     auto dimensions = properties["dimensions"];
 
-    // if "dimensions" property was not there, check to see if they included aliases: scale
+    // if "dimensions" property was not there, check to see if they included aliases: scale, size
     if (!dimensions.isValid()) {
         dimensions = properties["scale"];
         if (!dimensions.isValid()) {
@@ -57,7 +57,7 @@ bool Volume3DOverlay::findRayIntersection(const glm::vec3& origin, const glm::ve
     // extents is the entity relative, scaled, centered extents of the entity
     glm::mat4 worldToEntityMatrix;
     _transform.getInverseMatrix(worldToEntityMatrix);
-    
+
     glm::vec3 overlayFrameOrigin = glm::vec3(worldToEntityMatrix * glm::vec4(origin, 1.0f));
     glm::vec3 overlayFrameDirection = glm::vec3(worldToEntityMatrix * glm::vec4(direction, 0.0f));
 

interface/src/ui/overlays/Volume3DOverlay.h

@@ -15,13 +15,13 @@
 
 class Volume3DOverlay : public Base3DOverlay {
     Q_OBJECT
-    
+
 public:
     Volume3DOverlay() {}
     Volume3DOverlay(const Volume3DOverlay* volume3DOverlay);
-    
+
     virtual AABox getBounds() const override;
-    
+
     const glm::vec3& getDimensions() const { return _localBoundingBox.getDimensions(); }
     void setDimensions(float value) { _localBoundingBox.setBox(glm::vec3(-value / 2.0f), value); }
     void setDimensions(const glm::vec3& value) { _localBoundingBox.setBox(-value / 2.0f, value); }
@@ -29,13 +29,13 @@ public:
     void setProperties(const QVariantMap& properties) override;
     QVariant getProperty(const QString& property) override;
 
-    virtual bool findRayIntersection(const glm::vec3& origin, const glm::vec3& direction, float& distance, 
+    virtual bool findRayIntersection(const glm::vec3& origin, const glm::vec3& direction, float& distance,
-                                        BoxFace& face, glm::vec3& surfaceNormal) override;
+                                     BoxFace& face, glm::vec3& surfaceNormal) override;
-    
+
 protected:
     // Centered local bounding box
     AABox _localBoundingBox{ vec3(0.0f), 1.0f };
 };
 
- 
+
 #endif // hifi_Volume3DOverlay_h