IDcsmContentControlEventHandler.h

Go to the documentation of this file.

//  -------------------------------------------------------------------------
//  Copyright (C) 2019 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_IDCSMCONTENTCONTROLEVENTHANDLER_H
#define RAMSES_IDCSMCONTENTCONTROLEVENTHANDLER_H
 
#include "ramses-framework-api/DcsmApiTypes.h"
#include "ramses-framework-api/RamsesFrameworkTypes.h"
 
namespace ramses
{
    class DcsmMetadataUpdate;
 
    enum class DcsmContentControlEventResult
    {
        OK,       
        TimedOut  
    };
 
    class RAMSES_API IDcsmContentControlEventHandler
    {
    public:
        virtual ~IDcsmContentControlEventHandler() = default;
 
        virtual void contentAvailable(ContentID contentID, Category categoryID) = 0;
 
        virtual void contentReady(ContentID contentID, DcsmContentControlEventResult result) = 0;
 
        virtual void contentShown(ContentID contentID) = 0;
 
        virtual void contentEnableFocusRequest(ramses::ContentID contentID, int32_t focusRequest) = 0;
 
        virtual void contentDisableFocusRequest(ramses::ContentID contentID, int32_t focusRequest) = 0;
 
        virtual void contentStopOfferRequested(ContentID contentID) = 0;
 
        virtual void contentNotAvailable(ContentID contentID) = 0;
 
        virtual void contentMetadataUpdated(ContentID contentID, const DcsmMetadataUpdate& metadataUpdate) = 0;
 
        virtual void offscreenBufferLinked(displayBufferId_t offscreenBufferId, ContentID consumerContent, dataConsumerId_t consumerId, bool success) = 0;
 
        virtual void contentLinkedToTextureConsumer(ContentID providerContent, ContentID consumerContent, dataConsumerId_t consumerId, bool success) = 0;
 
        virtual void dataLinked(ContentID providerContent, dataProviderId_t providerId, ContentID consumerContent, dataConsumerId_t consumerId, bool success) = 0;
 
        virtual void dataUnlinked(ContentID consumerContent, dataConsumerId_t consumerId, bool success) = 0;
 
        virtual void objectsPicked(ContentID content, const pickableObjectId_t* pickedObjects, uint32_t pickedObjectsCount) = 0;
 
        virtual void dataProviderCreated(ContentID contentID, dataProviderId_t dataProviderId) = 0;
 
        virtual void dataProviderDestroyed(ContentID contentID, dataProviderId_t dataProviderId) = 0;
 
        virtual void dataConsumerCreated(ContentID contentID, dataConsumerId_t dataConsumerId) = 0;
 
        virtual void dataConsumerDestroyed(ContentID contentID, dataConsumerId_t dataConsumerId) = 0;
 
        virtual void contentFlushed(ContentID contentID, sceneVersionTag_t version) = 0;
 
        virtual void contentExpirationMonitoringEnabled(ContentID contentID) = 0;
 
        virtual void contentExpirationMonitoringDisabled(ContentID contentID) = 0;
 
        virtual void contentExpired(ContentID contentID) = 0;
 
        virtual void contentRecoveredFromExpiration(ContentID contentID) = 0;
 
        virtual void streamAvailabilityChanged(waylandIviSurfaceId_t streamId, bool available) = 0;
    };
 
    class RAMSES_API DcsmContentControlEventHandlerEmpty : public IDcsmContentControlEventHandler
    {
    public:
        virtual void contentAvailable(ContentID contentID, Category categoryID) override
        {
            (void)contentID;
            (void)categoryID;
        }
 
        virtual void contentReady(ContentID contentID, DcsmContentControlEventResult result) override
        {
            (void)contentID;
            (void)result;
        }
 
        virtual void contentShown(ContentID contentID) override
        {
            (void)contentID;
        }
 
        virtual void contentStopOfferRequested(ContentID contentID) override
        {
            (void)contentID;
        }
 
        virtual void contentNotAvailable(ContentID contentID) override
        {
            (void)contentID;
        }
 
        virtual void contentMetadataUpdated(ContentID contentID, const DcsmMetadataUpdate& metadataUpdate) override
        {
            (void)contentID;
            (void)metadataUpdate;
        }
 
        virtual void offscreenBufferLinked(displayBufferId_t offscreenBufferId, ContentID consumerContent, dataConsumerId_t consumerId, bool success) override
        {
            (void)offscreenBufferId;
            (void)consumerContent;
            (void)consumerId;
            (void)success;
        }
 
        void contentLinkedToTextureConsumer(ContentID providerContent, ContentID consumerContent, dataConsumerId_t consumerId, bool success) override
        {
            (void)providerContent;
            (void)consumerContent;
            (void)consumerId;
            (void)success;
        }
 
        virtual void dataLinked(ContentID providerContent, dataProviderId_t providerId, ContentID consumerContent, dataConsumerId_t consumerId, bool success) override
        {
            (void)providerContent;
            (void)providerId;
            (void)consumerContent;
            (void)consumerId;
            (void)success;
        }
 
        virtual void dataUnlinked(ContentID consumerContent, dataConsumerId_t consumerId, bool success) override
        {
            (void)consumerContent;
            (void)consumerId;
            (void)success;
        }
 
        virtual void objectsPicked(ContentID content, const pickableObjectId_t* pickedObjects, uint32_t pickedObjectsCount) override
        {
            (void)content;
            (void)pickedObjects;
            (void)pickedObjectsCount;
        }
 
        virtual void dataProviderCreated(ContentID contentID, dataProviderId_t dataProviderId) override
        {
            (void)contentID;
            (void)dataProviderId;
        }
 
        virtual void dataProviderDestroyed(ContentID contentID, dataProviderId_t dataProviderId) override
        {
            (void)contentID;
            (void)dataProviderId;
        }
 
        virtual void dataConsumerCreated(ContentID contentID, dataConsumerId_t dataConsumerId) override
        {
            (void)contentID;
            (void)dataConsumerId;
        }
 
        virtual void dataConsumerDestroyed(ContentID contentID, dataConsumerId_t dataConsumerId) override
        {
            (void)contentID;
            (void)dataConsumerId;
        }
 
        virtual void contentFlushed(ContentID contentID, sceneVersionTag_t version) override
        {
            (void)contentID;
            (void)version;
        }
 
        virtual void contentExpirationMonitoringEnabled(ContentID contentID) override
        {
            (void)contentID;
        }
 
        virtual void contentExpirationMonitoringDisabled(ContentID contentID) override
        {
            (void)contentID;
        }
 
        virtual void contentExpired(ContentID contentID) override
        {
            (void)contentID;
        }
 
        virtual void contentRecoveredFromExpiration(ContentID contentID) override
        {
            (void)contentID;
        }
 
        virtual void streamAvailabilityChanged(waylandIviSurfaceId_t streamId, bool available) override
        {
            (void)streamId;
            (void)available;
        }
        void contentEnableFocusRequest(ramses::ContentID contentID, int32_t focusRequest) override
        {
            (void) contentID;
            (void) focusRequest;
        }
 
        void contentDisableFocusRequest(ramses::ContentID contentID, int32_t focusRequest) override
        {
            (void) contentID;
            (void) focusRequest;
        }
    };
}
 
#endif