DcsmContentControl.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_DCSMCONTENTCONTROL_H
#define RAMSES_DCSMCONTENTCONTROL_H
 
#include "ramses-framework-api/StatusObject.h"
#include "ramses-framework-api/DcsmApiTypes.h"
#include "ramses-framework-api/CategoryInfoUpdate.h"
 
namespace ramses
{
    class RamsesRenderer;
    class RamsesFramework;
    class IDcsmContentControlEventHandler;
    class IRendererEventHandler;
    class DcsmStatusMessage;
 
    class RAMSES_API DcsmContentControl : public StatusObject
    {
    public:
        status_t addContentCategory(Category category, displayId_t display, const CategoryInfoUpdate& categoryInformation);
 
        status_t removeContentCategory(Category category);
 
        status_t requestContentReady(ContentID contentID, uint64_t timeOut);
 
        status_t showContent(ContentID contentID, AnimationInformation timingInfo);
 
        status_t hideContent(ContentID contentID, AnimationInformation timingInfo);
 
        status_t releaseContent(ContentID contentID, AnimationInformation timingInfo);
 
        status_t setCategoryInfo(Category categoryId, const CategoryInfoUpdate& categoryInfo, AnimationInformation timingInfo);
 
        status_t acceptStopOffer(ContentID contentID, AnimationInformation timingInfo);
 
        status_t assignContentToDisplayBuffer(ContentID contentID, displayBufferId_t displayBuffer, int32_t renderOrder = 0);
 
        status_t linkOffscreenBuffer(displayBufferId_t offscreenBufferId, ContentID consumerContentID, dataConsumerId_t consumerId);
 
        status_t linkContentToTextureConsumer(ContentID contentID, ContentID consumerContentID, dataConsumerId_t consumerId);
 
        status_t linkData(ContentID providerContentID, dataProviderId_t providerId, ContentID consumerContentID, dataConsumerId_t consumerId);
 
        status_t unlinkData(ContentID consumerContentID, dataConsumerId_t consumerId);
 
        /*
        * @brief Trigger renderer to test if given pick event with coordinates intersects with any instances
        *        of ramses::PickableObject contained in given content's scene. If so, the intersected PickableObjects are
        *        reported to the ramses::DcsmContentControl (see ramses::IDcsmContentControlEventHandler::objectsPicked) using their user IDs
        *        given at creation time (see ramses::Scene::createPickableObject).
        *
        * @details \section Coordinates
        *          Coordinates normalized to range <-1, 1> where (-1, -1) is bottom left corner of the buffer where content is mapped to
        *          and (1, 1) is top right corner.
        *          If the content to test is rendered directly to framebuffer then display size should be used,
        *          i.e. (-1, -1) is bottom left corner of the display and (1, 1) top right corner of display.
        *          If the content is mapped to an offscreen buffer and rendered as a texture mapped
        *          on a mesh in another content, the given coordinates need to be mapped to the offscreen buffer
        *          dimensions in the same way.
        *          For example if the content's offscreen buffer is mapped on a 2D quad placed somewhere on screen
        *          then the coordinates provided need to be within the region of the 2D quad, i.e. (-1, -1) at bottom left corner of the quad and (1, 1) at top right corner.
        *
        * @param contentID Content to check for intersected PickableObjects.
        * @param bufferNormalizedCoordX Normalized X pick coordinate within buffer size (see \ref Coordinates).
        * @param bufferNormalizedCoordY Normalized Y pick coordinate within buffer size (see \ref Coordinates).
        * @return StatusOK for success, otherwise the returned status can be used
        *         to resolve error message using getStatusMessage().
        */
        status_t handlePickEvent(ContentID contentID, float bufferNormalizedCoordX, float bufferNormalizedCoordY);
 
        status_t update(uint64_t timeStampNow, IDcsmContentControlEventHandler& eventHandler);
 
        status_t sendContentStatus(ContentID contentID, DcsmStatusMessage const& message);
 
        DcsmContentControl() = delete;
 
        DcsmContentControl(const DcsmContentControl&) = delete;
 
        DcsmContentControl& operator=(const DcsmContentControl& other) = delete;
 
        class DcsmContentControlImpl& m_impl;
 
    private:
        friend class RamsesRendererImpl;
 
        virtual ~DcsmContentControl();
 
        explicit DcsmContentControl(DcsmContentControlImpl&);
    };
}
 
#endif