overte-HifiExperiments/libraries/entities-renderer/src/RenderableTextEntityItem.cpp

//
//  RenderableTextEntityItem.cpp
//  interface/src
//
//  Created by Brad Hefta-Gaub on 8/6/14.
//  Copyright 2014 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 "RenderableTextEntityItem.h"

#include <TextEntityItem.h>
#include <GeometryCache.h>
#include <PerfStat.h>
#include <Transform.h>
#include <TextRenderer3D.h>

#include "GLMHelpers.h"

#include <DisableDeferred.h>

using namespace render;
using namespace render::entities;

static const int FIXED_FONT_POINT_SIZE = 40;
const int FIXED_FONT_SCALING_RATIO = FIXED_FONT_POINT_SIZE * 92.0f; // Determined through experimentation to fit font to line 
                                                                    // height.
const float LINE_SCALE_RATIO = 1.2f;

TextEntityRenderer::TextEntityRenderer(const EntityItemPointer& entity) :
    Parent(entity),
    _textRenderer(TextRenderer3D::getInstance(SANS_FONT_FAMILY, FIXED_FONT_POINT_SIZE / 2.0f)) {
    auto geometryCache = DependencyManager::get<GeometryCache>();
    if (geometryCache) {
        _geometryID = geometryCache->allocateID();
    }
}

TextEntityRenderer::~TextEntityRenderer() {
    auto geometryCache = DependencyManager::get<GeometryCache>();
    if (_geometryID && geometryCache) {
        geometryCache->releaseID(_geometryID);
    }
}

bool TextEntityRenderer::isTransparent() const {
    return Parent::isTransparent() || _textAlpha < 1.0f || _backgroundAlpha < 1.0f || _pulseProperties.getAlphaMode() != PulseMode::NONE;
}

Item::Bound TextEntityRenderer::getBound() {
    auto bound = Parent::getBound();
    if (_billboardMode != BillboardMode::NONE) {
        glm::vec3 dimensions = bound.getScale();
        float max = glm::max(dimensions.x, glm::max(dimensions.y, dimensions.z));
        const float SQRT_2 = 1.41421356237f;
        bound.setScaleStayCentered(glm::vec3(SQRT_2 * max));
    }
    return bound;
}

ShapeKey TextEntityRenderer::getShapeKey() {
    auto builder = render::ShapeKey::Builder().withOwnPipeline();
    if (isTransparent()) {
        builder.withTranslucent();
    }
    if (_primitiveMode == PrimitiveMode::LINES) {
        builder.withWireframe();
    }
    return builder.build();
}

bool TextEntityRenderer::needsRenderUpdateFromTypedEntity(const TypedEntityPointer& entity) const {
    if (_text != entity->getText()) {
        return true;
    }

    if (_lineHeight != entity->getLineHeight()) {
        return true;
    }

    if (_textColor != toGlm(entity->getTextColor())) {
        return true;
    }

    if (_textAlpha != entity->getTextAlpha()) {
        return true;
    }

    if (_backgroundColor != toGlm(entity->getBackgroundColor())) {
        return true;
    }

    if (_backgroundAlpha != entity->getBackgroundAlpha()) {
        return true;
    }

    if (_dimensions != entity->getScaledDimensions()) {
        return true;
    }

    if (_billboardMode != entity->getBillboardMode()) {
        return true;
    }

    if (_leftMargin != entity->getLeftMargin()) {
        return true;
    }

    if (_rightMargin != entity->getRightMargin()) {
        return true;
    }

    if (_topMargin != entity->getTopMargin()) {
        return true;
    }

    if (_bottomMargin != entity->getBottomMargin()) {
        return true;
    }

    if (_pulseProperties != entity->getPulseProperties()) {
        return true;
    }

    return false;
}

void TextEntityRenderer::doRenderUpdateSynchronousTyped(const ScenePointer& scene, Transaction& transaction, const TypedEntityPointer& entity) {
    void* key = (void*)this;
    AbstractViewStateInterface::instance()->pushPostUpdateLambda(key, [this, entity] () {
        withWriteLock([&] {
            _dimensions = entity->getScaledDimensions();
            updateModelTransformAndBound();
            _renderTransform = getModelTransform();
        });
    });
}

void TextEntityRenderer::doRenderUpdateAsynchronousTyped(const TypedEntityPointer& entity) {
    withWriteLock([&] {
        _pulseProperties = entity->getPulseProperties();
        _text = entity->getText();
        _lineHeight = entity->getLineHeight();
        _textColor = toGlm(entity->getTextColor());
        _textAlpha = entity->getTextAlpha();
        _backgroundColor = toGlm(entity->getBackgroundColor());
        _backgroundAlpha = entity->getBackgroundAlpha();
        _billboardMode = entity->getBillboardMode();
        _leftMargin = entity->getLeftMargin();
        _rightMargin = entity->getRightMargin();
        _topMargin = entity->getTopMargin();
        _bottomMargin = entity->getBottomMargin();
    });
}

void TextEntityRenderer::doRender(RenderArgs* args) {
    PerformanceTimer perfTimer("RenderableTextEntityItem::render");

    glm::vec4 textColor;
    glm::vec4 backgroundColor;
    Transform modelTransform;
    glm::vec3 dimensions;
    bool forwardRendered;
    withReadLock([&] {
        modelTransform = _renderTransform;
        dimensions = _dimensions;

        float fadeRatio = _isFading ? Interpolate::calculateFadeRatio(_fadeStartTime) : 1.0f;
        textColor = glm::vec4(_textColor, fadeRatio * _textAlpha);
        textColor = EntityRenderer::calculatePulseColor(textColor, _pulseProperties, _created);
        backgroundColor = glm::vec4(_backgroundColor, fadeRatio * _backgroundAlpha);
        backgroundColor = EntityRenderer::calculatePulseColor(backgroundColor, _pulseProperties, _created);
        forwardRendered = _renderLayer != RenderLayer::WORLD || DISABLE_DEFERRED;
    });

    // Render background
    static const float SLIGHTLY_BEHIND = -0.005f;
    glm::vec3 minCorner = glm::vec3(0.0f, -dimensions.y, SLIGHTLY_BEHIND);
    glm::vec3 maxCorner = glm::vec3(dimensions.x, 0.0f, SLIGHTLY_BEHIND);

    // Batch render calls
    Q_ASSERT(args->_batch);
    gpu::Batch& batch = *args->_batch;

    auto transformToTopLeft = modelTransform;
    transformToTopLeft.setRotation(EntityItem::getBillboardRotation(transformToTopLeft.getTranslation(), transformToTopLeft.getRotation(), _billboardMode, args->getViewFrustum().getPosition()));
    transformToTopLeft.postTranslate(dimensions * glm::vec3(-0.5f, 0.5f, 0.0f)); // Go to the top left
    transformToTopLeft.setScale(1.0f); // Use a scale of one so that the text is not deformed

    if (backgroundColor.a > 0.0f) {
        batch.setModelTransform(transformToTopLeft);
        auto geometryCache = DependencyManager::get<GeometryCache>();
        geometryCache->bindSimpleProgram(batch, false, backgroundColor.a < 1.0f, false, false, false, true, forwardRendered);
        geometryCache->renderQuad(batch, minCorner, maxCorner, backgroundColor, _geometryID);
    }

    if (textColor.a > 0.0f) {
        // FIXME: Factor out textRenderer so that text parts can be grouped by pipeline for a gpu performance increase.
        float scale = _lineHeight / _textRenderer->getFontSize();
        transformToTopLeft.setScale(scale);  // Scale to have the correct line height
        batch.setModelTransform(transformToTopLeft);

        glm::vec2 bounds = glm::vec2(dimensions.x - (_leftMargin + _rightMargin), dimensions.y - (_topMargin + _bottomMargin));
        _textRenderer->draw(batch, _leftMargin / scale, -_topMargin / scale, _text, textColor, bounds / scale, forwardRendered);
    }
}

QSizeF TextEntityRenderer::textSize(const QString& text) const {
    auto extents = _textRenderer->computeExtent(text);
    extents.y *= 2.0f;

    float maxHeight = (float)_textRenderer->computeExtent("Xy").y * LINE_SCALE_RATIO;
    float pointToWorldScale = (maxHeight / FIXED_FONT_SCALING_RATIO) * _lineHeight;

    return QSizeF(extents.x, extents.y) * pointToWorldScale;
}