IRendererSceneControlEventHandler.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2020 BMW AG
//  -------------------------------------------------------------------------
//  This Source Code Form is subject to the terms of the Mozilla Public
//  License, v. 2.0. If a copy of the MPL was not distributed with this
//  file, You can obtain one at https://mozilla.org/MPL/2.0/.
//  -------------------------------------------------------------------------
 
#ifndef RAMSES_IRENDERERSCENECONTROLEVENTHANDLER_H
#define RAMSES_IRENDERERSCENECONTROLEVENTHANDLER_H
 
#include "ramses-renderer-api/Types.h"
#include "ramses-framework-api/RendererSceneState.h"
#include "ramses-framework-api/APIExport.h"
 
namespace ramses
{
    class RAMSES_API IRendererSceneControlEventHandler
    {
    public:
        virtual void sceneStateChanged(sceneId_t sceneId, RendererSceneState state) = 0;
 
        virtual void offscreenBufferLinked(displayBufferId_t offscreenBufferId, sceneId_t consumerScene, dataConsumerId_t consumerId, bool success) = 0;
 
#ifdef RAMSES_ENABLE_EXTERNAL_BUFFER_EVENTS
        virtual void externalBufferLinked(externalBufferId_t externalBufferId, sceneId_t consumerScene, dataConsumerId_t consumerId, bool success) = 0;
#endif
 
        virtual void dataLinked(sceneId_t providerScene, dataProviderId_t providerId, sceneId_t consumerScene, dataConsumerId_t consumerId, bool success) = 0;
 
        virtual void dataUnlinked(sceneId_t consumerScene, dataConsumerId_t consumerId, bool success) = 0;
 
        virtual void dataProviderCreated(sceneId_t sceneId, dataProviderId_t dataProviderId) = 0;
 
        virtual void dataProviderDestroyed(sceneId_t sceneId, dataProviderId_t dataProviderId) = 0;
 
        virtual void dataConsumerCreated(sceneId_t sceneId, dataConsumerId_t dataConsumerId) = 0;
 
        virtual void dataConsumerDestroyed(sceneId_t sceneId, dataConsumerId_t dataConsumerId) = 0;
 
        virtual void sceneFlushed(sceneId_t sceneId, sceneVersionTag_t sceneVersionTag) = 0;
 
        virtual void sceneExpirationMonitoringEnabled(sceneId_t sceneId) = 0;
 
        virtual void sceneExpirationMonitoringDisabled(sceneId_t sceneId) = 0;
 
        virtual void sceneExpired(sceneId_t sceneId) = 0;
 
        virtual void sceneRecoveredFromExpiration(sceneId_t sceneId) = 0;
 
        virtual void streamAvailabilityChanged(waylandIviSurfaceId_t streamId, bool available) = 0;
 
        virtual void objectsPicked(sceneId_t sceneId, const pickableObjectId_t* pickedObjects, uint32_t pickedObjectsCount) = 0;
 
        virtual ~IRendererSceneControlEventHandler() = default;
    };
 
    class RAMSES_API RendererSceneControlEventHandlerEmpty : public IRendererSceneControlEventHandler
    {
    public:
        virtual void sceneStateChanged(sceneId_t sceneId, RendererSceneState state) override
        {
            (void)sceneId;
            (void)state;
        }
 
        virtual void offscreenBufferLinked(displayBufferId_t offscreenBufferId, sceneId_t consumerScene, dataConsumerId_t consumerId, bool success) override
        {
            (void)offscreenBufferId;
            (void)consumerScene;
            (void)consumerId;
            (void)success;
        }
 
#ifdef RAMSES_ENABLE_EXTERNAL_BUFFER_EVENTS
        virtual void externalBufferLinked(externalBufferId_t externalBufferId, sceneId_t consumerScene, dataConsumerId_t consumerId, bool success) override
        {
            (void)externalBufferId;
            (void)consumerScene;
            (void)consumerId;
            (void)success;
        }
#endif
 
        virtual void dataLinked(sceneId_t providerScene, dataProviderId_t providerId, sceneId_t consumerScene, dataConsumerId_t consumerId, bool success) override
        {
            (void)providerScene;
            (void)providerId;
            (void)consumerScene;
            (void)consumerId;
            (void)success;
        }
 
        virtual void dataUnlinked(sceneId_t consumerScene, dataConsumerId_t consumerId, bool success) override
        {
            (void)consumerScene;
            (void)consumerId;
            (void)success;
        }
 
        virtual void dataProviderCreated(sceneId_t sceneId, dataProviderId_t dataProviderId) override
        {
            (void)sceneId;
            (void)dataProviderId;
        }
 
        virtual void dataProviderDestroyed(sceneId_t sceneId, dataProviderId_t dataProviderId) override
        {
            (void)sceneId;
            (void)dataProviderId;
        }
 
        virtual void dataConsumerCreated(sceneId_t sceneId, dataConsumerId_t dataConsumerId) override
        {
            (void)sceneId;
            (void)dataConsumerId;
        }
 
        virtual void dataConsumerDestroyed(sceneId_t sceneId, dataConsumerId_t dataConsumerId) override
        {
            (void)sceneId;
            (void)dataConsumerId;
        }
 
        virtual void sceneFlushed(sceneId_t sceneId, sceneVersionTag_t sceneVersionTag) override
        {
            (void)sceneId;
            (void)sceneVersionTag;
        }
 
        virtual void sceneExpirationMonitoringEnabled(sceneId_t sceneId) override
        {
            (void)sceneId;
        }
 
        virtual void sceneExpirationMonitoringDisabled(sceneId_t sceneId) override
        {
            (void)sceneId;
        }
 
        virtual void sceneExpired(sceneId_t sceneId) override
        {
            (void)sceneId;
        }
 
        virtual void sceneRecoveredFromExpiration(sceneId_t sceneId) override
        {
            (void)sceneId;
        }
 
        virtual void streamAvailabilityChanged(waylandIviSurfaceId_t streamId, bool available) override
        {
            (void)streamId;
            (void)available;
        }
 
        virtual void objectsPicked(sceneId_t sceneId, const pickableObjectId_t* pickedObjects, uint32_t pickedObjectsCount) override
        {
            (void)sceneId;
            (void)pickedObjects;
            (void)pickedObjectsCount;
        }
    };
}
 
#endif