RAMSES Documentation  27.0.130
Information for RAMSES users and developers
IDcsmProviderEventHandler.h
Go to the documentation of this file.
1 // -------------------------------------------------------------------------
2 // Copyright (C) 2019 BMW AG
3 // -------------------------------------------------------------------------
4 // This Source Code Form is subject to the terms of the Mozilla Public
5 // License, v. 2.0. If a copy of the MPL was not distributed with this
6 // file, You can obtain one at https://mozilla.org/MPL/2.0/.
7 // -------------------------------------------------------------------------
8 
9 #ifndef RAMSES_IDCSMPROVIDEREVENTHANDLER_H
10 #define RAMSES_IDCSMPROVIDEREVENTHANDLER_H
11 
15 
16 namespace ramses
17 {
24  {
25  public:
35  virtual void contentHide(ContentID contentID, AnimationInformation animInfo) = 0;
36 
46  virtual void contentShow(ContentID contentID, AnimationInformation animInfo) = 0;
47 
60  virtual void stopOfferAccepted(ContentID contentID, AnimationInformation animInfo) = 0;
61 
75  virtual void contentSizeChange(ContentID contentID, const CategoryInfoUpdate& categoryInfo, AnimationInformation animInfo) = 0;
76 
84  virtual void contentReadyRequested(ContentID contentID) = 0;
85 
100  virtual void contentRelease(ContentID contentID, AnimationInformation animInfo) = 0;
101 
105  virtual ~IDcsmProviderEventHandler() = default;
106  };
107 
116  {
117  public:
124  virtual void contentStatus(ContentID contentID, DcsmStatusMessage const& message) = 0;
125  };
126 }
127 #endif
#define RAMSES_API
Definition: APIExport.h:35
Update of information about a DCSM category. Contains information like changes in size....
Definition: CategoryInfoUpdate.h:29
The base class of a message to be sent from DCSM consumer to provider.
Definition: DcsmStatusMessage.h:28
An Interface for a class, whose functions are called as reaction to a DcsmConsumer message after call...
Definition: IDcsmProviderEventHandler.h:116
virtual void contentStatus(ContentID contentID, DcsmStatusMessage const &message)=0
Called if a consumer sent a status message.
An Interface for a class, whose functions are called as reaction to DcsmConsumer communication after ...
Definition: IDcsmProviderEventHandler.h:24
virtual void contentShow(ContentID contentID, AnimationInformation animInfo)=0
Called if a content will be switched to shown.
virtual void contentSizeChange(ContentID contentID, const CategoryInfoUpdate &categoryInfo, AnimationInformation animInfo)=0
Called after the rendering viewport for the content has been changed. Will be called once after a Dcs...
virtual void stopOfferAccepted(ContentID contentID, AnimationInformation animInfo)=0
Called after a content was requested to no longer be offered. After this function returns,...
virtual void contentRelease(ContentID contentID, AnimationInformation animInfo)=0
Called after an assigned DcsmConsumer is no longer interested in the content or the scene associated ...
virtual ~IDcsmProviderEventHandler()=default
Destructor.
virtual void contentHide(ContentID contentID, AnimationInformation animInfo)=0
Called if a content will be switched to be hidden.
virtual void contentReadyRequested(ContentID contentID)=0
Called after a DcsmConsumer requested the content and it has not been marked ready yet....
Helper class to create strongly typed values out of various types.
Definition: StronglyTypedValue.h:23
The RAMSES namespace contains all client side objects and functions used to implement RAMSES applicat...
Definition: AnimatedProperty.h:15
Definition: DcsmApiTypes.h:152