RenderableEntityItem.h

//
//  RenderableEntityItem.h
//  interface/src
//
//  Created by Brad Hefta-Gaub on 12/6/13.
//  Copyright 2013 High Fidelity, Inc.
//  Copyright 2024 Overte e.V.
//
//  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_RenderableEntityItem_h
#define hifi_RenderableEntityItem_h
 
#include <render/Scene.h>
#include <render/HighlightStyle.h>
 
#include <EntityItem.h>
#include <Sound.h>
#include "AbstractViewStateInterface.h"
#include "EntitiesRendererLogging.h"
#include <graphics-scripting/Forward.h>
#include <RenderHifi.h>
#include "EntityTreeRenderer.h"
#include "FadeObjectParams.shared.slh"
 
class EntityTreeRenderer;
 
namespace render { namespace entities {
 
// Base class for all renderable entities
class EntityRenderer : public QObject, public std::enable_shared_from_this<EntityRenderer>, public PayloadProxyInterface, protected ReadWriteLockable, public scriptable::ModelProvider {
    Q_OBJECT
 
    using Pointer = std::shared_ptr<EntityRenderer>;
 
public:
    static void initEntityRenderers();
    static Pointer addToScene(EntityTreeRenderer& renderer, const EntityItemPointer& entity, const ScenePointer& scene, Transaction& transaction);
 
    // Allow classes to override this to interact with the user
    virtual bool wantsHandControllerPointerEvents() const { return false; }
    virtual bool wantsKeyboardFocus() const { return false; }
    virtual void setProxyWindow(QWindow* proxyWindow) {}
    virtual QObject* getEventHandler() { return nullptr; }
    virtual void emitScriptEvent(const QVariant& message) {}
    const EntityItemPointer& getEntity() const { return _entity; }
    const ItemID& getRenderItemID() const { return _renderItemID; }
 
    const SharedSoundPointer& getCollisionSound() { return _collisionSound; }
    void setCollisionSound(const SharedSoundPointer& sound) { _collisionSound = sound; }
 
    // Handlers for rendering events... executed on the main thread, only called by EntityTreeRenderer, 
    // cannot be overridden or accessed by subclasses
    virtual void updateInScene(const ScenePointer& scene, Transaction& transaction) final;
    virtual bool addToScene(const ScenePointer& scene, Transaction& transaction) final;
    virtual void removeFromScene(const ScenePointer& scene, Transaction& transaction);
 
    virtual void fade(render::Transaction& transaction, TransitionType type);
 
    const uint64_t& getUpdateTime() const { return _updateTime; }
 
    enum class Pipeline {
        SIMPLE,
        MATERIAL,
        PROCEDURAL,
        MIRROR
    };
    virtual void addMaterial(graphics::MaterialLayer material, const std::string& parentMaterialName);
    virtual void removeMaterial(graphics::MaterialPointer material, const std::string& parentMaterialName);
    virtual graphics::MaterialPointer getTopMaterial();
    Pipeline getPipelineType(const graphics::MultiMaterial& materials);
    virtual gpu::TexturePointer getTexture() { return nullptr; }
 
    virtual scriptable::ScriptableModelBase getScriptableModel() override { return scriptable::ScriptableModelBase(); }
 
    static glm::vec4 calculatePulseColor(const glm::vec4& color, const PulsePropertyGroup& pulseProperties, quint64 start);
    static glm::vec3 calculatePulseColor(const glm::vec3& color, const PulsePropertyGroup& pulseProperties, quint64 start);
 
    virtual uint32_t metaFetchMetaSubItems(ItemIDs& subItems) const override;
    virtual Item::Bound getBound(RenderArgs* args) override;
    bool passesZoneOcclusionTest(const std::unordered_set<QUuid>& containingZones) const override;
    ItemID computeMirrorView(ViewFrustum& viewFrustum) const override;
    static ItemID computeMirrorViewOperator(ViewFrustum& viewFrustum, const glm::vec3& inPropertiesPosition, const glm::quat& inPropertiesRotation,
                                            MirrorMode mirrorMode, const QUuid& portalExitID);
    virtual void renderSimulate(RenderArgs* args) override {}
    virtual HighlightStyle getOutlineStyle(const ViewFrustum& viewFrustum, const size_t height) const override;
 
    virtual FadeProperties getFadeProperties(const TransitionType type) const override;
    // Non-world layer entities do not currently support fading
    virtual ComponentMode getFadeOutMode() const { return _renderLayer == RenderLayer::WORLD ? _fadeOutMode : ComponentMode::COMPONENT_MODE_DISABLED; }
 
protected:
    virtual bool needsRenderUpdateFromEntity() const final { return needsRenderUpdateFromEntity(_entity); }
    virtual void onAddToScene(const EntityItemPointer& entity);
    virtual void onRemoveFromScene(const EntityItemPointer& entity);
 
    EntityRenderer(const EntityItemPointer& entity);
    ~EntityRenderer();
 
    // Implementing the PayloadProxyInterface methods
    virtual ItemKey getKey() override;
    virtual ShapeKey getShapeKey() override;
    virtual void render(RenderArgs* args) override final;
    virtual render::hifi::Tag getTagMask() const;
    virtual render::hifi::Layer getHifiRenderLayer() const;
 
    // Returns true if the item in question needs to have updateInScene called because of internal rendering state changes
    virtual bool needsRenderUpdate() const;
 
    // Returns true if the item in question needs to have updateInScene called because of changes in the entity
    virtual bool needsRenderUpdateFromEntity(const EntityItemPointer& entity) const;
 
    // Will be called on the main thread from updateInScene.  This can be used to fetch things like 
    // network textures or model geometry from resource caches
    virtual void doRenderUpdateSynchronous(const ScenePointer& scene, Transaction& transaction, const EntityItemPointer& entity);
 
    // Will be called by the lambda posted to the scene in updateInScene.  
    // This function will execute on the rendering thread, so you cannot use network caches to fetch
    // data in this method if using multi-threaded rendering
    virtual void doRenderUpdateAsynchronous(const EntityItemPointer& entity);
 
    // Called by the `render` method after `needsRenderUpdate`
    virtual void doRender(RenderArgs* args) = 0;
 
    virtual void updateModelTransformAndBound(const EntityItemPointer& entity);
    virtual bool isTransparent() const { return false; }
    inline bool isValidRenderItem() const { return _renderItemID != Item::INVALID_ITEM_ID; }
 
    virtual void setIsVisibleInSecondaryCamera(bool value) { _isVisibleInSecondaryCamera = value; }
    virtual void setRenderLayer(RenderLayer value) { _renderLayer = value; }
    virtual void setCullWithParent(bool value) { _cullWithParent = value; }
    virtual void setMirrorMode(MirrorMode value) { _mirrorMode = value; }
    virtual void setPortalExitID(const QUuid& value) { _portalExitID = value; }
 
    template<typename T>
    std::shared_ptr<T> asTypedEntity() { return std::static_pointer_cast<T>(_entity); }
 
    static void makeStatusGetters(const EntityItemPointer& entity, Item::Status::Getters& statusGetters);
    const Transform& getModelTransform() const;
 
    Transform getTransformToCenterWithMaybeOnlyLocalRotation(const EntityItemPointer& entity, bool& success) const;
 
    FadeObjectParams getFadeParams(const render::ScenePointer& scene) const;
 
    // Shared methods for entities that support materials
    using MaterialMap = std::unordered_map<std::string, graphics::MultiMaterial>;
    bool needsRenderUpdateFromMaterials() const;
    void updateMaterials(bool baseMaterialChanged = false);
    bool materialsTransparent() const;
    Item::Bound getMaterialBound(RenderArgs* args);
    void updateItemKeyBuilderFromMaterials(ItemKey::Builder& builder);
    void updateShapeKeyBuilderFromMaterials(ShapeKey::Builder& builder);
 
    Item::Bound _bound;
    SharedSoundPointer _collisionSound;
    QUuid _changeHandlerId;
    ItemID _renderItemID{ Item::INVALID_ITEM_ID };
    uint64_t _updateTime{ usecTimestampNow() }; // used when sorting/throttling render updates
    bool _prevIsTransparent { false };
    bool _visible { false };
    bool _isVisibleInSecondaryCamera { false };
    bool _canCastShadow { false };
    bool _cullWithParent { false };
    RenderLayer _renderLayer { RenderLayer::WORLD };
    PrimitiveMode _primitiveMode { PrimitiveMode::SOLID };
    QVector<QUuid> _renderWithZones;
    BillboardMode _billboardMode { BillboardMode::NONE };
    bool _cauterized { false };
    bool _moving { false };
    MirrorMode _mirrorMode { MirrorMode::NONE };
    QUuid _portalExitID;
    Transform _renderTransform;
    Transform _prevRenderTransform; // each subclass is responsible for updating this after they render because they all handle transforms differently
 
    FadeInPropertyGroup _fadeInProperties;
    FadeOutPropertyGroup _fadeOutProperties;
    ComponentMode _fadeInMode { COMPONENT_MODE_INHERIT };
    ComponentMode _fadeOutMode { COMPONENT_MODE_INHERIT };
 
    MaterialMap _materials;
    mutable std::mutex _materialsLock;
 
    quint64 _created;
 
    // The base class relies on comparing the model transform to the entity transform in order 
    // to trigger an update, so the member must not be visible to derived classes as a modifiable
    // transform
    Transform _modelTransform;
    // The rendering code only gets access to the entity in very specific circumstances
    // i.e. to see if the rendering code needs to update because of a change in state of the 
    // entity.  This forces all the rendering code itself to be independent of the entity
    const EntityItemPointer _entity;
 
    QUuid _entityID;
 
signals:
    void requestRenderUpdate();
};
 
template <typename T>
class TypedEntityRenderer : public EntityRenderer {
    using Parent = EntityRenderer;
 
public:
    TypedEntityRenderer(const EntityItemPointer& entity) : Parent(entity), _typedEntity(asTypedEntity<T>()) {}
 
protected:
    using TypedEntityPointer = std::shared_ptr<T>;
 
    virtual void onAddToScene(const EntityItemPointer& entity) override final {
        Parent::onAddToScene(entity);
        onAddToSceneTyped(_typedEntity);
    }
 
    virtual void onRemoveFromScene(const EntityItemPointer& entity) override final {
        Parent::onRemoveFromScene(entity);
        onRemoveFromSceneTyped(_typedEntity);
    }
 
    using Parent::needsRenderUpdateFromEntity;
    // Returns true if the item in question needs to have updateInScene called because of changes in the entity
    virtual bool needsRenderUpdateFromEntity(const EntityItemPointer& entity) const override final {
        return Parent::needsRenderUpdateFromEntity(entity) || needsRenderUpdateFromTypedEntity(_typedEntity);
    }
 
    virtual void doRenderUpdateSynchronous(const ScenePointer& scene, Transaction& transaction, const EntityItemPointer& entity) override final {
        Parent::doRenderUpdateSynchronous(scene, transaction, entity);
        doRenderUpdateSynchronousTyped(scene, transaction, _typedEntity);
    }
 
    virtual void doRenderUpdateAsynchronous(const EntityItemPointer& entity) override final {
        Parent::doRenderUpdateAsynchronous(entity);
        doRenderUpdateAsynchronousTyped(_typedEntity);
    }
 
    virtual bool needsRenderUpdateFromTypedEntity(const TypedEntityPointer& entity) const { return false; }
    virtual void doRenderUpdateSynchronousTyped(const ScenePointer& scene, Transaction& transaction, const TypedEntityPointer& entity) { }
    virtual void doRenderUpdateAsynchronousTyped(const TypedEntityPointer& entity) { }
    virtual void onAddToSceneTyped(const TypedEntityPointer& entity) { }
    virtual void onRemoveFromSceneTyped(const TypedEntityPointer& entity) { }
 
private:
    const TypedEntityPointer _typedEntity;
};
 
} } // namespace render::entities
 
#endif // hifi_RenderableEntityItem_h