Merge pull request #9436 from AndrewMeadows/cauterization-cleanup

Cleanup of code that decides not to render head when in first-person

interface/src/avatar/Avatar.cpp

@@ -1044,10 +1044,14 @@ void Avatar::setModelURLFinished(bool success) {
 
 
 // create new model, can return an instance of a SoftAttachmentModel rather then Model
-static std::shared_ptr<Model> allocateAttachmentModel(bool isSoft, RigPointer rigOverride) {
+static std::shared_ptr<Model> allocateAttachmentModel(bool isSoft, RigPointer rigOverride, bool isCauterized) {
     if (isSoft) {
         // cast to std::shared_ptr<Model>
-        return std::dynamic_pointer_cast<Model>(std::make_shared<SoftAttachmentModel>(std::make_shared<Rig>(), nullptr, rigOverride));
+        std::shared_ptr<SoftAttachmentModel> softModel = std::make_shared<SoftAttachmentModel>(std::make_shared<Rig>(), nullptr, rigOverride);
+        if (isCauterized) {
+            softModel->flagAsCauterized();
+        }
+        return std::dynamic_pointer_cast<Model>(softModel);
     } else {
         return std::make_shared<Model>(std::make_shared<Rig>());
     }
@@ -1073,12 +1077,12 @@ void Avatar::setAttachmentData(const QVector<AttachmentData>& attachmentData) {
     for (int i = 0; i < attachmentData.size(); i++) {
         if (i == (int)_attachmentModels.size()) {
             // if number of attachments has been increased, we need to allocate a new model
-            _attachmentModels.push_back(allocateAttachmentModel(attachmentData[i].isSoft, _skeletonModel->getRig()));
+            _attachmentModels.push_back(allocateAttachmentModel(attachmentData[i].isSoft, _skeletonModel->getRig(), isMyAvatar()));
         }
         else if (i < oldAttachmentData.size() && oldAttachmentData[i].isSoft != attachmentData[i].isSoft) {
             // if the attachment has changed type, we need to re-allocate a new one.
             _attachmentsToRemove.push_back(_attachmentModels[i]);
-            _attachmentModels[i] = allocateAttachmentModel(attachmentData[i].isSoft, _skeletonModel->getRig());
+            _attachmentModels[i] = allocateAttachmentModel(attachmentData[i].isSoft, _skeletonModel->getRig(), isMyAvatar());
         }
         _attachmentModels[i]->setURL(attachmentData[i].modelURL);
     }
@@ -1363,4 +1367,4 @@ void Avatar::ensureInScene(AvatarSharedPointer self) {
     if (!_inScene) {
         addToScene(self);
     }
-}
+}

interface/src/avatar/CauterizedMeshPartPayload.cpp

@@ -0,0 +1,74 @@
+//
+//  CauterizedMeshPartPayload.cpp
+//  interface/src/renderer
+//
+//  Created by Andrew Meadows 2017.01.17
+//  Copyright 2017 High Fidelity, Inc.
+//
+//  Distributed under the Apache License, Version 2.0.
+//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
+//
+
+#include "CauterizedMeshPartPayload.h"
+
+#include <PerfStat.h>
+
+#include "SkeletonModel.h"
+
+using namespace render;
+
+CauterizedMeshPartPayload::CauterizedMeshPartPayload(Model* model, int meshIndex, int partIndex, int shapeIndex, const Transform& transform, const Transform& offsetTransform)
+    : ModelMeshPartPayload(model, meshIndex, partIndex, shapeIndex, transform, offsetTransform) {}
+
+void CauterizedMeshPartPayload::updateTransformForSkinnedCauterizedMesh(const Transform& transform,
+        const QVector<glm::mat4>& clusterMatrices,
+        const QVector<glm::mat4>& cauterizedClusterMatrices) {
+    _transform = transform;
+    _cauterizedTransform = transform;
+
+    if (clusterMatrices.size() > 0) {
+        _worldBound = AABox();
+        for (auto& clusterMatrix : clusterMatrices) {
+            AABox clusterBound = _localBound;
+            clusterBound.transform(clusterMatrix);
+            _worldBound += clusterBound;
+        }
+
+        _worldBound.transform(transform);
+        if (clusterMatrices.size() == 1) {
+            _transform = _transform.worldTransform(Transform(clusterMatrices[0]));
+            if (cauterizedClusterMatrices.size() != 0) {
+                _cauterizedTransform = _cauterizedTransform.worldTransform(Transform(cauterizedClusterMatrices[0]));
+            } else {
+                _cauterizedTransform = _transform;
+            }
+        }
+    } else {
+        _worldBound = _localBound;
+        _worldBound.transform(_drawTransform);
+    }
+}
+
+void CauterizedMeshPartPayload::bindTransform(gpu::Batch& batch, const render::ShapePipeline::LocationsPointer locations, RenderArgs::RenderMode renderMode) const {
+    // Still relying on the raw data from the model
+    const Model::MeshState& state = _model->getMeshState(_meshIndex);
+    SkeletonModel* skeleton = static_cast<SkeletonModel*>(_model);
+    bool useCauterizedMesh = (renderMode != RenderArgs::RenderMode::SHADOW_RENDER_MODE) && skeleton->getEnableCauterization();
+
+    if (state.clusterBuffer) {
+        if (useCauterizedMesh) {
+            const Model::MeshState& cState = skeleton->getCauterizeMeshState(_meshIndex);
+            batch.setUniformBuffer(ShapePipeline::Slot::BUFFER::SKINNING, cState.clusterBuffer);
+        } else {
+            batch.setUniformBuffer(ShapePipeline::Slot::BUFFER::SKINNING, state.clusterBuffer);
+        }
+        batch.setModelTransform(_transform);
+    } else {
+        if (useCauterizedMesh) {
+            batch.setModelTransform(_cauterizedTransform);
+        } else {
+            batch.setModelTransform(_transform);
+        }
+    }
+}
+

interface/src/avatar/CauterizedMeshPartPayload.h

@@ -0,0 +1,29 @@
+//
+//  CauterizedModelMeshPartPayload.h
+//  interface/src/avatar
+//
+//  Created by AndrewMeadows 2017.01.17
+//  Copyright 2017 High Fidelity, Inc.
+//
+//  Distributed under the Apache License, Version 2.0.
+//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
+//
+
+#ifndef hifi_CauterizedMeshPartPayload_h
+#define hifi_CauterizedMeshPartPayload_h
+
+#include <MeshPartPayload.h>
+
+class CauterizedMeshPartPayload : public ModelMeshPartPayload {
+public:
+    CauterizedMeshPartPayload(Model* model, int meshIndex, int partIndex, int shapeIndex, const Transform& transform, const Transform& offsetTransform);
+    void updateTransformForSkinnedCauterizedMesh(const Transform& transform,
+            const QVector<glm::mat4>& clusterMatrices,
+            const QVector<glm::mat4>& cauterizedClusterMatrices);
+
+    void bindTransform(gpu::Batch& batch, const render::ShapePipeline::LocationsPointer locations, RenderArgs::RenderMode renderMode) const override;
+private:
+    Transform _cauterizedTransform;
+};
+
+#endif // hifi_CauterizedMeshPartPayload_h

interface/src/avatar/CauterizedModel.cpp

@@ -0,0 +1,254 @@
+//
+//  CauterizedModel.cpp
+//  interface/src/avatar
+//
+//  Created by Andrew Meadows 2017.01.17
+//  Copyright 2017 High Fidelity, Inc.
+//
+//  Distributed under the Apache License, Version 2.0.
+//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
+//
+
+#include "CauterizedModel.h"
+
+#include <AbstractViewStateInterface.h>
+#include <MeshPartPayload.h>
+#include <PerfStat.h>
+
+#include "CauterizedMeshPartPayload.h"
+
+
+CauterizedModel::CauterizedModel(RigPointer rig, QObject* parent) :
+        Model(rig, parent) {
+}
+
+CauterizedModel::~CauterizedModel() {
+}
+
+void CauterizedModel::deleteGeometry() {
+	Model::deleteGeometry();
+	_cauterizeMeshStates.clear();
+}
+
+bool CauterizedModel::updateGeometry() {
+    bool needsFullUpdate = Model::updateGeometry();
+    if (_isCauterized && needsFullUpdate) {
+        assert(_cauterizeMeshStates.empty());
+        const FBXGeometry& fbxGeometry = getFBXGeometry();
+        foreach (const FBXMesh& mesh, fbxGeometry.meshes) {
+            Model::MeshState state;
+            state.clusterMatrices.resize(mesh.clusters.size());
+            _cauterizeMeshStates.append(state);
+        }
+    }
+	return needsFullUpdate;
+}
+
+void CauterizedModel::createVisibleRenderItemSet() {
+    if (_isCauterized) {
+        assert(isLoaded());
+        const auto& meshes = _renderGeometry->getMeshes();
+
+        // all of our mesh vectors must match in size
+        if ((int)meshes.size() != _meshStates.size()) {
+            qCDebug(renderlogging) << "WARNING!!!! Mesh Sizes don't match! We will not segregate mesh groups yet.";
+            return;
+        }
+
+        // We should not have any existing renderItems if we enter this section of code
+        Q_ASSERT(_modelMeshRenderItemsSet.isEmpty());
+
+        _modelMeshRenderItemsSet.clear();
+
+        Transform transform;
+        transform.setTranslation(_translation);
+        transform.setRotation(_rotation);
+
+        Transform offset;
+        offset.setScale(_scale);
+        offset.postTranslate(_offset);
+
+        // Run through all of the meshes, and place them into their segregated, but unsorted buckets
+        int shapeID = 0;
+        uint32_t numMeshes = (uint32_t)meshes.size();
+        for (uint32_t i = 0; i < numMeshes; i++) {
+            const auto& mesh = meshes.at(i);
+            if (!mesh) {
+                continue;
+            }
+
+            // Create the render payloads
+            int numParts = (int)mesh->getNumParts();
+            for (int partIndex = 0; partIndex < numParts; partIndex++) {
+                auto ptr = std::make_shared<CauterizedMeshPartPayload>(this, i, partIndex, shapeID, transform, offset);
+                _modelMeshRenderItemsSet << std::static_pointer_cast<ModelMeshPartPayload>(ptr);
+                shapeID++;
+            }
+        }
+    } else {
+	    Model::createVisibleRenderItemSet();
+    }
+}
+
+void CauterizedModel::createCollisionRenderItemSet() {
+    // Temporary HACK: use base class method for now
+	Model::createCollisionRenderItemSet();
+}
+
+// Called within Model::simulate call, below.
+void CauterizedModel::updateRig(float deltaTime, glm::mat4 parentTransform) {
+    Model::updateRig(deltaTime, parentTransform);
+    _needsUpdateClusterMatrices = true;
+}
+
+void CauterizedModel::updateClusterMatrices() {
+    PerformanceTimer perfTimer("CauterizedModel::updateClusterMatrices");
+
+    if (!_needsUpdateClusterMatrices || !isLoaded()) {
+        return;
+    }
+    _needsUpdateClusterMatrices = false;
+    const FBXGeometry& geometry = getFBXGeometry();
+
+    for (int i = 0; i < _meshStates.size(); i++) {
+        Model::MeshState& state = _meshStates[i];
+        const FBXMesh& mesh = geometry.meshes.at(i);
+        for (int j = 0; j < mesh.clusters.size(); j++) {
+            const FBXCluster& cluster = mesh.clusters.at(j);
+            auto jointMatrix = _rig->getJointTransform(cluster.jointIndex);
+#if GLM_ARCH & GLM_ARCH_SSE2
+            glm::mat4 out, inverseBindMatrix = cluster.inverseBindMatrix;
+            glm_mat4_mul((glm_vec4*)&jointMatrix, (glm_vec4*)&inverseBindMatrix, (glm_vec4*)&out);
+            state.clusterMatrices[j] = out;
+#else
+            state.clusterMatrices[j] = jointMatrix * cluster.inverseBindMatrix;
+#endif
+        }
+
+        // Once computed the cluster matrices, update the buffer(s)
+        if (mesh.clusters.size() > 1) {
+            if (!state.clusterBuffer) {
+                state.clusterBuffer = std::make_shared<gpu::Buffer>(state.clusterMatrices.size() * sizeof(glm::mat4),
+                                                                    (const gpu::Byte*) state.clusterMatrices.constData());
+            } else {
+                state.clusterBuffer->setSubData(0, state.clusterMatrices.size() * sizeof(glm::mat4),
+                                                (const gpu::Byte*) state.clusterMatrices.constData());
+            }
+		}
+	}
+
+    // as an optimization, don't build cautrizedClusterMatrices if the boneSet is empty.
+    if (!_cauterizeBoneSet.empty()) {
+        static const glm::mat4 zeroScale(
+            glm::vec4(0.0f, 0.0f, 0.0f, 0.0f),
+            glm::vec4(0.0f, 0.0f, 0.0f, 0.0f),
+            glm::vec4(0.0f, 0.0f, 0.0f, 0.0f),
+            glm::vec4(0.0f, 0.0f, 0.0f, 1.0f));
+        auto cauterizeMatrix = _rig->getJointTransform(geometry.neckJointIndex) * zeroScale;
+
+        for (int i = 0; i < _cauterizeMeshStates.size(); i++) {
+            Model::MeshState& state = _cauterizeMeshStates[i];
+            const FBXMesh& mesh = geometry.meshes.at(i);
+            for (int j = 0; j < mesh.clusters.size(); j++) {
+                const FBXCluster& cluster = mesh.clusters.at(j);
+                auto jointMatrix = _rig->getJointTransform(cluster.jointIndex);
+                if (_cauterizeBoneSet.find(cluster.jointIndex) != _cauterizeBoneSet.end()) {
+                    jointMatrix = cauterizeMatrix;
+                }
+#if GLM_ARCH & GLM_ARCH_SSE2
+                glm::mat4 out, inverseBindMatrix = cluster.inverseBindMatrix;
+                glm_mat4_mul((glm_vec4*)&jointMatrix, (glm_vec4*)&inverseBindMatrix, (glm_vec4*)&out);
+                state.clusterMatrices[j] = out;
+#else
+                state.clusterMatrices[j] = jointMatrix * cluster.inverseBindMatrix;
+#endif
+            }
+
+            if (!_cauterizeBoneSet.empty() && (state.clusterMatrices.size() > 1)) {
+                if (!state.clusterBuffer) {
+                    state.clusterBuffer =
+                        std::make_shared<gpu::Buffer>(state.clusterMatrices.size() * sizeof(glm::mat4),
+                                                      (const gpu::Byte*) state.clusterMatrices.constData());
+                } else {
+                    state.clusterBuffer->setSubData(0, state.clusterMatrices.size() * sizeof(glm::mat4),
+                                                              (const gpu::Byte*) state.clusterMatrices.constData());
+                }
+            }
+        }
+    }
+
+    // post the blender if we're not currently waiting for one to finish
+    if (geometry.hasBlendedMeshes() && _blendshapeCoefficients != _blendedBlendshapeCoefficients) {
+        _blendedBlendshapeCoefficients = _blendshapeCoefficients;
+        DependencyManager::get<ModelBlender>()->noteRequiresBlend(getThisPointer());
+    }
+}
+
+void CauterizedModel::updateRenderItems() {
+    if (_isCauterized) {
+        if (!_addedToScene) {
+            return;
+        }
+
+        glm::vec3 scale = getScale();
+        if (_collisionGeometry) {
+            // _collisionGeometry is already scaled
+            scale = glm::vec3(1.0f);
+        }
+        _needsUpdateClusterMatrices = true;
+        _renderItemsNeedUpdate = false;
+
+        // queue up this work for later processing, at the end of update and just before rendering.
+        // the application will ensure only the last lambda is actually invoked.
+        void* key = (void*)this;
+        std::weak_ptr<Model> weakSelf = shared_from_this();
+        AbstractViewStateInterface::instance()->pushPostUpdateLambda(key, [weakSelf, scale]() {
+            // do nothing, if the model has already been destroyed.
+            auto self = weakSelf.lock();
+            if (!self) {
+                return;
+            }
+
+            render::ScenePointer scene = AbstractViewStateInterface::instance()->getMain3DScene();
+
+            Transform modelTransform;
+            modelTransform.setTranslation(self->getTranslation());
+            modelTransform.setRotation(self->getRotation());
+
+            Transform scaledModelTransform(modelTransform);
+            scaledModelTransform.setScale(scale);
+
+            uint32_t deleteGeometryCounter = self->getGeometryCounter();
+
+            render::PendingChanges pendingChanges;
+            QList<render::ItemID> keys = self->getRenderItems().keys();
+            foreach (auto itemID, keys) {
+                pendingChanges.updateItem<CauterizedMeshPartPayload>(itemID, [modelTransform, deleteGeometryCounter](CauterizedMeshPartPayload& data) {
+                    if (data._model && data._model->isLoaded()) {
+                        // Ensure the model geometry was not reset between frames
+                        if (deleteGeometryCounter == data._model->getGeometryCounter()) {
+                            // lazy update of cluster matrices used for rendering.  We need to update them here, so we can correctly update the bounding box.
+                            data._model->updateClusterMatrices();
+
+                            // update the model transform and bounding box for this render item.
+                            const Model::MeshState& state = data._model->getMeshState(data._meshIndex);
+                            CauterizedModel* cModel = static_cast<CauterizedModel*>(data._model);
+                            assert(data._meshIndex < cModel->_cauterizeMeshStates.size());
+                            const Model::MeshState& cState = cModel->_cauterizeMeshStates.at(data._meshIndex);
+                            data.updateTransformForSkinnedCauterizedMesh(modelTransform, state.clusterMatrices, cState.clusterMatrices);
+                        }
+                    }
+                });
+            }
+
+            scene->enqueuePendingChanges(pendingChanges);
+        });
+    } else {
+        Model::updateRenderItems();
+    }
+}
+
+const Model::MeshState& CauterizedModel::getCauterizeMeshState(int index) const {
+    assert(index < _meshStates.size());
+    return _cauterizeMeshStates.at(index);
+}

interface/src/avatar/CauterizedModel.h

@@ -0,0 +1,53 @@
+//
+//  CauterizeableModel.h
+//  interface/src/avatar
+//
+//  Created by Andrew Meadows 2016.01.17
+//  Copyright 2017 High Fidelity, Inc.
+//
+//  Distributed under the Apache License, Version 2.0.
+//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
+//
+
+#ifndef hifi_CauterizedModel_h
+#define hifi_CauterizedModel_h
+
+
+#include <Model.h>
+
+class CauterizedModel : public Model {
+    Q_OBJECT
+
+public:
+    CauterizedModel(RigPointer rig, QObject* parent);
+    virtual ~CauterizedModel();
+
+    void flagAsCauterized() { _isCauterized = true; }
+    bool getIsCauterized() const { return _isCauterized; }
+
+    void setEnableCauterization(bool flag) { _enableCauterization = flag; }
+    bool getEnableCauterization() const { return _enableCauterization; }
+
+    const std::unordered_set<int>& getCauterizeBoneSet() const { return _cauterizeBoneSet; }
+    void setCauterizeBoneSet(const std::unordered_set<int>& boneSet) { _cauterizeBoneSet = boneSet; }
+
+	void deleteGeometry() override;
+	bool updateGeometry() override;
+
+	void createVisibleRenderItemSet() override;
+    void createCollisionRenderItemSet() override;
+
+    virtual void updateRig(float deltaTime, glm::mat4 parentTransform) override;
+    virtual void updateClusterMatrices() override;
+    void updateRenderItems() override;
+
+    const Model::MeshState& getCauterizeMeshState(int index) const;
+
+protected:
+    std::unordered_set<int> _cauterizeBoneSet;
+	QVector<Model::MeshState> _cauterizeMeshStates;
+    bool _isCauterized { false };
+    bool _enableCauterization { false };
+};
+
+#endif // hifi_CauterizedModel_h

interface/src/avatar/MyAvatar.cpp

@@ -116,12 +116,12 @@ MyAvatar::MyAvatar(RigPointer rig) :
     _hmdAtRestDetector(glm::vec3(0), glm::quat())
 {
     using namespace recording;
+    _skeletonModel->flagAsCauterized();
 
     for (int i = 0; i < MAX_DRIVE_KEYS; i++) {
         _driveKeys[i] = 0.0f;
     }
 
-
     // Necessary to select the correct slot
     using SlotType = void(MyAvatar::*)(const glm::vec3&, bool, const glm::quat&, bool);
 
@@ -1592,7 +1592,7 @@ void MyAvatar::preDisplaySide(RenderArgs* renderArgs) {
     // toggle using the cauterizedBones depending on where the camera is and the rendering pass type.
     const bool shouldDrawHead = shouldRenderHead(renderArgs);
     if (shouldDrawHead != _prevShouldDrawHead) {
-        _skeletonModel->setCauterizeBones(!shouldDrawHead);
+        _skeletonModel->setEnableCauterization(!shouldDrawHead);
     }
     _prevShouldDrawHead = shouldDrawHead;
 }

interface/src/avatar/SkeletonModel.cpp

@@ -24,7 +24,7 @@
 #include "AnimDebugDraw.h"
 
 SkeletonModel::SkeletonModel(Avatar* owningAvatar, QObject* parent, RigPointer rig) :
-    Model(rig, parent),
+    CauterizedModel(rig, parent),
     _owningAvatar(owningAvatar),
     _boundingCapsuleLocalOffset(0.0f),
     _boundingCapsuleRadius(0.0f),
@@ -166,7 +166,7 @@ void SkeletonModel::updateRig(float deltaTime, glm::mat4 parentTransform) {
         _rig->computeMotionAnimationState(deltaTime, position, velocity, orientation, ccState);
 
         // evaluate AnimGraph animation and update jointStates.
-        Model::updateRig(deltaTime, parentTransform);
+        CauterizedModel::updateRig(deltaTime, parentTransform);
 
         Rig::EyeParameters eyeParams;
         eyeParams.worldHeadOrientation = headParams.worldHeadOrientation;
@@ -178,10 +178,8 @@ void SkeletonModel::updateRig(float deltaTime, glm::mat4 parentTransform) {
         eyeParams.rightEyeJointIndex = geometry.rightEyeJointIndex;
 
         _rig->updateFromEyeParameters(eyeParams);
-
     } else {
-
+        CauterizedModel::updateRig(deltaTime, parentTransform);
-        Model::updateRig(deltaTime, parentTransform);
 
         // This is a little more work than we really want.
         //

interface/src/avatar/SkeletonModel.h

@@ -12,8 +12,7 @@
 #ifndef hifi_SkeletonModel_h
 #define hifi_SkeletonModel_h
 
-
+#include "CauterizedModel.h"
-#include <Model.h>
 
 class Avatar;
 class MuscleConstraint;
@@ -23,7 +22,7 @@ using SkeletonModelPointer = std::shared_ptr<SkeletonModel>;
 using SkeletonModelWeakPointer = std::weak_ptr<SkeletonModel>;
 
 /// A skeleton loaded from a model.
-class SkeletonModel : public Model {
+class SkeletonModel : public CauterizedModel {
     Q_OBJECT
 
 public:
@@ -31,10 +30,10 @@ public:
     SkeletonModel(Avatar* owningAvatar, QObject* parent = nullptr, RigPointer rig = nullptr);
     ~SkeletonModel();
 
-    virtual void initJointStates() override;
+    void initJointStates() override;
 
-    virtual void simulate(float deltaTime, bool fullUpdate = true) override;
+    void simulate(float deltaTime, bool fullUpdate = true) override;
-    virtual void updateRig(float deltaTime, glm::mat4 parentTransform) override;
+    void updateRig(float deltaTime, glm::mat4 parentTransform) override;
     void updateAttitude();
 
     /// Returns the index of the left hand joint, or -1 if not found.
@@ -105,7 +104,7 @@ public:
 
     float getHeadClipDistance() const { return _headClipDistance; }
 
-    virtual void onInvalidate() override;
+    void onInvalidate() override;
 
 signals:
 

interface/src/avatar/SoftAttachmentModel.cpp

@@ -13,7 +13,7 @@
 #include "InterfaceLogging.h"
 
 SoftAttachmentModel::SoftAttachmentModel(RigPointer rig, QObject* parent, RigPointer rigOverride) :
-    Model(rig, parent),
+    CauterizedModel(rig, parent),
     _rigOverride(rigOverride) {
     assert(_rig);
     assert(_rigOverride);

interface/src/avatar/SoftAttachmentModel.h

@@ -12,7 +12,7 @@
 #ifndef hifi_SoftAttachmentModel_h
 #define hifi_SoftAttachmentModel_h
 
-#include <Model.h>
+#include "CauterizedModel.h"
 
 // A model that allows the creator to specify a secondary rig instance.
 // When the cluster matrices are created for rendering, the
@@ -22,16 +22,15 @@
 // This is used by Avatar instances to wear clothing that follows the same
 // animated pose as the SkeletonModel.
 
-class SoftAttachmentModel : public Model {
+class SoftAttachmentModel : public CauterizedModel {
     Q_OBJECT
 
 public:
-
     SoftAttachmentModel(RigPointer rig, QObject* parent, RigPointer rigOverride);
     ~SoftAttachmentModel();
 
-    virtual void updateRig(float deltaTime, glm::mat4 parentTransform) override;
+    void updateRig(float deltaTime, glm::mat4 parentTransform) override;
-    virtual void updateClusterMatrices() override;
+    void updateClusterMatrices() override;
 
 protected:
     int getJointIndexOverride(int i) const;

libraries/render-utils/src/MeshPartPayload.cpp

@@ -251,7 +251,7 @@ void MeshPartPayload::bindMaterial(gpu::Batch& batch, const ShapePipeline::Locat
     }
 }
 
-void MeshPartPayload::bindTransform(gpu::Batch& batch, const ShapePipeline::LocationsPointer locations, bool canCauterize) const {
+void MeshPartPayload::bindTransform(gpu::Batch& batch, const ShapePipeline::LocationsPointer locations, RenderArgs::RenderMode renderMode) const {
     batch.setModelTransform(_drawTransform);
 }
 
@@ -265,7 +265,7 @@ void MeshPartPayload::render(RenderArgs* args) const {
     assert(locations);
 
     // Bind the model transform and the skinCLusterMatrices if needed
-    bindTransform(batch, locations);
+    bindTransform(batch, locations, args->_renderMode);
 
     //Bind the index buffer and vertex buffer and Blend shapes if needed
     bindMesh(batch);
@@ -359,11 +359,8 @@ void ModelMeshPartPayload::notifyLocationChanged() {
 
 }
 
-void ModelMeshPartPayload::updateTransformForSkinnedMesh(const Transform& transform,
+void ModelMeshPartPayload::updateTransformForSkinnedMesh(const Transform& transform, const QVector<glm::mat4>& clusterMatrices) {
-        const QVector<glm::mat4>& clusterMatrices,
-        const QVector<glm::mat4>& cauterizedClusterMatrices) {
     _transform = transform;
-    _cauterizedTransform = transform;
 
     if (clusterMatrices.size() > 0) {
         _worldBound = AABox();
@@ -372,16 +369,13 @@ void ModelMeshPartPayload::updateTransformForSkinnedMesh(const Transform& transf
             clusterBound.transform(clusterMatrix);
             _worldBound += clusterBound;
         }
-
+        _worldBound.transform(_transform);
-        _worldBound.transform(transform);
         if (clusterMatrices.size() == 1) {
             _transform = _transform.worldTransform(Transform(clusterMatrices[0]));
-            if (cauterizedClusterMatrices.size() != 0) {
-                _cauterizedTransform = _cauterizedTransform.worldTransform(Transform(cauterizedClusterMatrices[0]));
-            } else {
-                _cauterizedTransform = _transform;
-            }
         }
+    } else {
+        _worldBound = _localBound;
+        _worldBound.transform(_transform);
     }
 }
 
@@ -408,7 +402,7 @@ ItemKey ModelMeshPartPayload::getKey() const {
         }
     }
 
-    if (!_hasFinishedFade) {
+    if (_fadeState != FADE_COMPLETE) {
         builder.withTransparent();
     }
 
@@ -478,7 +472,7 @@ ShapeKey ModelMeshPartPayload::getShapeKey() const {
     }
 
     ShapeKey::Builder builder;
-    if (isTranslucent || !_hasFinishedFade) {
+    if (isTranslucent || _fadeState != FADE_COMPLETE) {
         builder.withTranslucent();
     }
     if (hasTangents) {
@@ -519,43 +513,39 @@ void ModelMeshPartPayload::bindMesh(gpu::Batch& batch) const {
         batch.setInputStream(2, _drawMesh->getVertexStream().makeRangedStream(2));
     }
 
-    float fadeRatio = _isFading ? Interpolate::calculateFadeRatio(_fadeStartTime) : 1.0f;
+    if (_fadeState != FADE_COMPLETE) {
-    if (!_hasColorAttrib || fadeRatio < 1.0f) {
+        batch._glColor4f(1.0f, 1.0f, 1.0f, computeFadeAlpha());
-        batch._glColor4f(1.0f, 1.0f, 1.0f, fadeRatio);
+    } else if (!_hasColorAttrib) {
+        batch._glColor4f(1.0f, 1.0f, 1.0f, 1.0f);
     }
 }
 
-void ModelMeshPartPayload::bindTransform(gpu::Batch& batch, const ShapePipeline::LocationsPointer locations, bool canCauterize) const {
+void ModelMeshPartPayload::bindTransform(gpu::Batch& batch, const ShapePipeline::LocationsPointer locations, RenderArgs::RenderMode renderMode) const {
     // Still relying on the raw data from the model
-    const Model::MeshState& state = _model->_meshStates.at(_meshIndex);
+    const Model::MeshState& state = _model->getMeshState(_meshIndex);
-
     if (state.clusterBuffer) {
-        if (canCauterize && _model->getCauterizeBones()) {
+        batch.setUniformBuffer(ShapePipeline::Slot::BUFFER::SKINNING, state.clusterBuffer);
-            batch.setUniformBuffer(ShapePipeline::Slot::BUFFER::SKINNING, state.cauterizedClusterBuffer);
-        } else {
-            batch.setUniformBuffer(ShapePipeline::Slot::BUFFER::SKINNING, state.clusterBuffer);
-        }
-        batch.setModelTransform(_transform);
-    } else {
-        if (canCauterize && _model->getCauterizeBones()) {
-            batch.setModelTransform(_cauterizedTransform);
-        } else {
-            batch.setModelTransform(_transform);
-        }
     }
+    batch.setModelTransform(_transform);
 }
 
-void ModelMeshPartPayload::startFade() {
+float ModelMeshPartPayload::computeFadeAlpha() const {
-    bool shouldFade = EntityItem::getEntitiesShouldFadeFunction()();
+    if (_fadeState == FADE_WAITING_TO_START) {
-    if (shouldFade) {
+        return 0.0f;
-        _fadeStartTime = usecTimestampNow();
-        _hasStartedFade = true;
-        _hasFinishedFade = false;
-    } else {
-        _isFading = true;
-        _hasStartedFade = true;
-        _hasFinishedFade = true;
     }
+    float fadeAlpha = 1.0f;
+    const float INV_FADE_PERIOD = 1.0f / (float)(1 * USECS_PER_SECOND);
+    float fraction = (float)(usecTimestampNow() - _fadeStartTime) * INV_FADE_PERIOD;
+    if (fraction < 1.0f) {
+        fadeAlpha = Interpolate::simpleNonLinearBlend(fraction);
+    }
+    if (fadeAlpha >= 1.0f) {
+        _fadeState = FADE_COMPLETE;
+        // when fade-in completes we flag model for one last "render item update"
+        _model->setRenderItemsNeedUpdate();
+        return 1.0f;
+    }
+    return Interpolate::simpleNonLinearBlend(fadeAlpha);
 }
 
 void ModelMeshPartPayload::render(RenderArgs* args) const {
@@ -565,40 +555,34 @@ void ModelMeshPartPayload::render(RenderArgs* args) const {
         return; // bail asap
     }
 
-    // If we didn't start the fade in, check if we are ready to now....
+    if (_fadeState == FADE_WAITING_TO_START) {
-    if (!_hasStartedFade && _model->isLoaded() && _model->getGeometry()->areTexturesLoaded()) {
+        if (_model->isLoaded() && _model->getGeometry()->areTexturesLoaded()) {
-        const_cast<ModelMeshPartPayload&>(*this).startFade();
+            if (EntityItem::getEntitiesShouldFadeFunction()()) {
+                _fadeStartTime = usecTimestampNow();
+                _fadeState = FADE_IN_PROGRESS;
+            } else {
+                _fadeState = FADE_COMPLETE;
+            }
+            _model->setRenderItemsNeedUpdate();
+        } else {
+            return;
+        }
     }
 
-    // If we still didn't start the fade in, bail
+    if (!args) {
-    if (!_hasStartedFade) {
         return;
     }
-
-    // When an individual mesh parts like this finishes its fade, we will mark the Model as
-    // having render items that need updating
-    bool nextIsFading = _isFading ? isStillFading() : false;
-    bool startFading = !_isFading && !_hasFinishedFade && _hasStartedFade;
-    bool endFading = _isFading && !nextIsFading;
-    if (startFading || endFading) {
-        _isFading = startFading;
-        _hasFinishedFade = endFading;
-        _model->setRenderItemsNeedUpdate();
-    }
-
-    gpu::Batch& batch = *(args->_batch);
-
     if (!getShapeKey().isValid()) {
         return;
     }
 
+    gpu::Batch& batch = *(args->_batch);
     auto locations =  args->_pipeline->locations;
     assert(locations);
 
     // Bind the model transform and the skinCLusterMatrices if needed
-    bool canCauterize = args->_renderMode != RenderArgs::SHADOW_RENDER_MODE;
     _model->updateClusterMatrices();
-    bindTransform(batch, locations, canCauterize);
+    bindTransform(batch, locations, args->_renderMode);
 
     //Bind the index buffer and vertex buffer and Blend shapes if needed
     bindMesh(batch);
@@ -606,9 +590,7 @@ void ModelMeshPartPayload::render(RenderArgs* args) const {
     // apply material properties
     bindMaterial(batch, locations);
 
-    if (args) {
+    args->_details._materialSwitches++;
-        args->_details._materialSwitches++;
-    }
 
     // Draw!
     {
@@ -616,9 +598,6 @@ void ModelMeshPartPayload::render(RenderArgs* args) const {
         drawCall(batch);
     }
 
-    if (args) {
+    const int INDICES_PER_TRIANGLE = 3;
-        const int INDICES_PER_TRIANGLE = 3;
+    args->_details._trianglesRendered += _drawPart._numIndices / INDICES_PER_TRIANGLE;
-        args->_details._trianglesRendered += _drawPart._numIndices / INDICES_PER_TRIANGLE;
-    }
 }
-

libraries/render-utils/src/MeshPartPayload.h

@@ -21,6 +21,10 @@
 
 #include <model/Geometry.h>
 
+const uint8_t FADE_WAITING_TO_START = 0;
+const uint8_t FADE_IN_PROGRESS = 1;
+const uint8_t FADE_COMPLETE = 2;
+
 class Model;
 
 class MeshPartPayload {
@@ -48,21 +52,20 @@ public:
     void drawCall(gpu::Batch& batch) const;
     virtual void bindMesh(gpu::Batch& batch) const;
     virtual void bindMaterial(gpu::Batch& batch, const render::ShapePipeline::LocationsPointer locations) const;
-    virtual void bindTransform(gpu::Batch& batch, const render::ShapePipeline::LocationsPointer locations, bool canCauterize = true) const;
+    virtual void bindTransform(gpu::Batch& batch, const render::ShapePipeline::LocationsPointer locations, RenderArgs::RenderMode renderMode) const;
 
     // Payload resource cached values
-    std::shared_ptr<const model::Mesh> _drawMesh;
-    int _partIndex = 0;
-    model::Mesh::Part _drawPart;
-
-    std::shared_ptr<const model::Material> _drawMaterial;
-
-    model::Box _localBound;
     Transform _drawTransform;
     Transform _transform;
-    mutable model::Box _worldBound;
+    int _partIndex = 0;
+    bool _hasColorAttrib { false };
 
-    bool _hasColorAttrib = false;
+    model::Box _localBound;
+    mutable model::Box _worldBound;
+    std::shared_ptr<const model::Mesh> _drawMesh;
+
+    std::shared_ptr<const model::Material> _drawMaterial;
+    model::Mesh::Part _drawPart;
 
     size_t getVerticesCount() const { return _drawMesh ? _drawMesh->getNumVertices() : 0; }
     size_t getMaterialTextureSize() { return _drawMaterial ? _drawMaterial->getTextureSize() : 0; }
@@ -86,13 +89,9 @@ public:
 
     void notifyLocationChanged() override;
     void updateTransformForSkinnedMesh(const Transform& transform,
-            const QVector<glm::mat4>& clusterMatrices,
+            const QVector<glm::mat4>& clusterMatrices);
-            const QVector<glm::mat4>& cauterizedClusterMatrices);
 
-    // Entity fade in
+    float computeFadeAlpha() const;
-    void startFade();
-    bool hasStartedFade() { return _hasStartedFade; }
-    bool isStillFading() const { return Interpolate::calculateFadeRatio(_fadeStartTime) < 1.0f; }
 
     // Render Item interface
     render::ItemKey getKey() const override;
@@ -102,13 +101,12 @@ public:
 
     // ModelMeshPartPayload functions to perform render
     void bindMesh(gpu::Batch& batch) const override;
-    void bindTransform(gpu::Batch& batch, const render::ShapePipeline::LocationsPointer locations, bool canCauterize = true) const override;
+    void bindTransform(gpu::Batch& batch, const render::ShapePipeline::LocationsPointer locations, RenderArgs::RenderMode renderMode) const override;
 
     void initCache();
 
     Model* _model;
 
-    Transform _cauterizedTransform;
     int _meshIndex;
     int _shapeID;
 
@@ -116,10 +114,8 @@ public:
     bool _isBlendShaped{ false };
 
 private:
-    quint64 _fadeStartTime { 0 };
+    mutable quint64 _fadeStartTime { 0 };
-    bool _hasStartedFade { false };
+    mutable uint8_t _fadeState { FADE_WAITING_TO_START };
-    mutable bool _hasFinishedFade { false };
-    mutable bool _isFading { false };
 };
 
 namespace render {

libraries/render-utils/src/Model.cpp

@@ -91,7 +91,6 @@ Model::Model(RigPointer rig, QObject* parent) :
     _scaledToFit(false),
     _snapModelToRegistrationPoint(false),
     _snappedToRegistrationPoint(false),
-    _cauterizeBones(false),
     _url(HTTP_INVALID_COM),
     _isVisible(true),
     _blendNumber(0),
@@ -228,9 +227,6 @@ void Model::updateRenderItems() {
         foreach (auto itemID, self->_modelMeshRenderItems.keys()) {
             pendingChanges.updateItem<ModelMeshPartPayload>(itemID, [modelTransform, deleteGeometryCounter](ModelMeshPartPayload& data) {
                 if (data._model && data._model->isLoaded()) {
-                    if (!data.hasStartedFade() && data._model->getGeometry()->areTexturesLoaded()) {
-                        data.startFade();
-                    }
                     // Ensure the model geometry was not reset between frames
                     if (deleteGeometryCounter == data._model->_deleteGeometryCounter) {
                         // lazy update of cluster matrices used for rendering.  We need to update them here, so we can correctly update the bounding box.
@@ -238,7 +234,7 @@ void Model::updateRenderItems() {
 
                         // update the model transform and bounding box for this render item.
                         const Model::MeshState& state = data._model->_meshStates.at(data._meshIndex);
-                        data.updateTransformForSkinnedMesh(modelTransform, state.clusterMatrices, state.cauterizedClusterMatrices);
+                        data.updateTransformForSkinnedMesh(modelTransform, state.clusterMatrices);
                     }
                 }
             });
@@ -294,8 +290,6 @@ bool Model::updateGeometry() {
         foreach (const FBXMesh& mesh, fbxGeometry.meshes) {
             MeshState state;
             state.clusterMatrices.resize(mesh.clusters.size());
-            state.cauterizedClusterMatrices.resize(mesh.clusters.size());
-
             _meshStates.append(state);
 
             // Note: we add empty buffers for meshes that lack blendshapes so we can access the buffers by index
@@ -1159,13 +1153,6 @@ void Model::updateClusterMatrices() {
     }
     _needsUpdateClusterMatrices = false;
     const FBXGeometry& geometry = getFBXGeometry();
-    static const glm::mat4 zeroScale(
-        glm::vec4(0.0f, 0.0f, 0.0f, 0.0f),
-        glm::vec4(0.0f, 0.0f, 0.0f, 0.0f),
-        glm::vec4(0.0f, 0.0f, 0.0f, 0.0f),
-        glm::vec4(0.0f, 0.0f, 0.0f, 1.0f));
-    auto cauterizeMatrix = _rig->getJointTransform(geometry.neckJointIndex) * zeroScale;
-
     for (int i = 0; i < _meshStates.size(); i++) {
         MeshState& state = _meshStates[i];
         const FBXMesh& mesh = geometry.meshes.at(i);
@@ -1179,20 +1166,6 @@ void Model::updateClusterMatrices() {
 #else
             state.clusterMatrices[j] = jointMatrix * cluster.inverseBindMatrix;
 #endif
-
-            // as an optimization, don't build cautrizedClusterMatrices if the boneSet is empty.
-            if (!_cauterizeBoneSet.empty()) {
-                if (_cauterizeBoneSet.find(cluster.jointIndex) != _cauterizeBoneSet.end()) {
-                    jointMatrix = cauterizeMatrix;
-                }
-#if GLM_ARCH & GLM_ARCH_SSE2
-                glm::mat4 out, inverseBindMatrix = cluster.inverseBindMatrix;
-                glm_mat4_mul((glm_vec4*)&jointMatrix, (glm_vec4*)&inverseBindMatrix, (glm_vec4*)&out);
-                state.cauterizedClusterMatrices[j] = out;
-#else
-                state.cauterizedClusterMatrices[j] = jointMatrix * cluster.inverseBindMatrix;
-#endif
-            }
         }
 
         // Once computed the cluster matrices, update the buffer(s)
@@ -1204,17 +1177,6 @@ void Model::updateClusterMatrices() {
                 state.clusterBuffer->setSubData(0, state.clusterMatrices.size() * sizeof(glm::mat4),
                                                 (const gpu::Byte*) state.clusterMatrices.constData());
             }
-
-            if (!_cauterizeBoneSet.empty() && (state.cauterizedClusterMatrices.size() > 1)) {
-                if (!state.cauterizedClusterBuffer) {
-                    state.cauterizedClusterBuffer =
-                        std::make_shared<gpu::Buffer>(state.cauterizedClusterMatrices.size() * sizeof(glm::mat4),
-                                                      (const gpu::Byte*) state.cauterizedClusterMatrices.constData());
-                } else {
-                    state.cauterizedClusterBuffer->setSubData(0, state.cauterizedClusterMatrices.size() * sizeof(glm::mat4),
-                                                              (const gpu::Byte*) state.cauterizedClusterMatrices.constData());
-                }
-            }
         }
     }
 
@@ -1485,7 +1447,6 @@ void ModelBlender::noteRequiresBlend(ModelPointer model) {
 
     {
         Lock lock(_mutex);
-
         _modelsRequiringBlends.insert(model);
     }
 }

libraries/render-utils/src/Model.h

@@ -101,7 +101,7 @@ public:
 
     bool isLayeredInFront() const { return _isLayeredInFront; }
 
-    void updateRenderItems();
+    virtual void updateRenderItems();
     void setRenderItemsNeedUpdate() { _renderItemsNeedUpdate = true; }
     bool getRenderItemsNeedUpdate() { return _renderItemsNeedUpdate; }
     AABox getRenderableMeshBound() const;
@@ -215,12 +215,6 @@ public:
     bool getIsScaledToFit() const { return _scaledToFit; } /// is model scaled to fit
     glm::vec3 getScaleToFitDimensions() const; /// the dimensions model is scaled to, including inferred y/z
 
-    void setCauterizeBones(bool flag) { _cauterizeBones = flag; }
-    bool getCauterizeBones() const { return _cauterizeBones; }
-
-    const std::unordered_set<int>& getCauterizeBoneSet() const { return _cauterizeBoneSet; }
-    void setCauterizeBoneSet(const std::unordered_set<int>& boneSet) { _cauterizeBoneSet = boneSet; }
-
     int getBlendshapeCoefficientsNum() const { return _blendshapeCoefficients.size(); }
     float getBlendshapeCoefficient(int index) const {
         return ((index < 0) && (index >= _blendshapeCoefficients.size())) ? 0.0f : _blendshapeCoefficients.at(index);
@@ -231,7 +225,7 @@ public:
     const glm::vec3& getRegistrationPoint() const { return _registrationPoint; }
 
     // returns 'true' if needs fullUpdate after geometry change
-    bool updateGeometry();
+    virtual bool updateGeometry();
     void setCollisionMesh(model::MeshPointer mesh);
 
     void setLoadingPriority(float priority) { _loadingPriority = priority; }
@@ -242,6 +236,18 @@ public:
     int getRenderInfoDrawCalls() const { return _renderInfoDrawCalls; }
     bool getRenderInfoHasTransparent() const { return _renderInfoHasTransparent; }
 
+    class MeshState {
+    public:
+        QVector<glm::mat4> clusterMatrices;
+        gpu::BufferPointer clusterBuffer;
+
+    };
+
+    const MeshState& getMeshState(int index) { return _meshStates.at(index); }
+
+    uint32_t getGeometryCounter() const { return _deleteGeometryCounter; }
+    const QMap<render::ItemID, render::PayloadPointer>& getRenderItems() const { return _modelMeshRenderItems; }
+
 public slots:
     void loadURLFinished(bool success);
 
@@ -298,18 +304,7 @@ protected:
     bool _snappedToRegistrationPoint; /// are we currently snapped to a registration point
     glm::vec3 _registrationPoint = glm::vec3(0.5f); /// the point in model space our center is snapped to
 
-    class MeshState {
-    public:
-        QVector<glm::mat4> clusterMatrices;
-        QVector<glm::mat4> cauterizedClusterMatrices;
-        gpu::BufferPointer clusterBuffer;
-        gpu::BufferPointer cauterizedClusterBuffer;
-
-    };
-
     QVector<MeshState> _meshStates;
-    std::unordered_set<int> _cauterizeBoneSet;
-    bool _cauterizeBones;
 
     virtual void initJointStates();
 
@@ -342,7 +337,7 @@ protected:
 
 protected:
 
-    void deleteGeometry();
+    virtual void deleteGeometry();
     void initJointTransforms();
 
     QVector<float> _blendshapeCoefficients;
@@ -371,12 +366,11 @@ protected:
     void recalculateMeshBoxes(bool pickAgainstTriangles = false);
 
     void createRenderItemSet();
-    void createVisibleRenderItemSet();
+    virtual void createVisibleRenderItemSet();
-    void createCollisionRenderItemSet();
+    virtual void createCollisionRenderItemSet();
 
     bool _isWireframe;
 
-
     // debug rendering support
     void renderDebugMeshBoxes(gpu::Batch& batch);
     int _debugMeshBoxesID = GeometryCache::UNKNOWN_ID;

libraries/shared/src/Interpolate.cpp

@@ -61,6 +61,13 @@ float Interpolate::interpolate3Points(float y1, float y2, float y3, float u) {
     }
 }
 
+float Interpolate::simpleNonLinearBlend(float fraction) {
+    // uses arctan() to map a linear distribution in domain [0,1] to a non-linear blend (slow out, slow in) in range [0,1]
+    const float WIDTH = 20.0f;
+    const float INV_ARCTAN_WIDTH = 0.339875327433f; // 1 / (2 * atan(WIDTH/2))
+    return 0.5f + atanf(WIDTH * (fraction - 0.5f)) * INV_ARCTAN_WIDTH;
+}
+
 float Interpolate::calculateFadeRatio(quint64 start) {
     const float FADE_TIME = 1.0f;
     float t = 2.0f * std::min(((float)(usecTimestampNow() - start)) / ((float)(FADE_TIME * USECS_PER_SECOND)), 1.0f);
@@ -69,4 +76,4 @@ float Interpolate::calculateFadeRatio(quint64 start) {
     // The easing function isn't exactly 1 at t = 2, so we need to scale the whole function up slightly
     const float EASING_SCALE = 1.001f;
     return std::min(EASING_SCALE * fadeRatio, 1.0f);
-}
+}

libraries/shared/src/Interpolate.h

@@ -25,6 +25,10 @@ public:
     // pass through all three y values. Return value lies wholly within the range of y values passed in.
     static float interpolate3Points(float y1, float y2, float y3, float u);
 
+    // returns smooth in and out blend between 0 and 1
+    // DANGER: assumes fraction is properly inside range [0, 1]
+    static float simpleNonLinearBlend(float fraction);
+
     static float calculateFadeRatio(quint64 start);
 };