ramses::IDcsmProviderEventHandlerExtended Class Reference

An Interface for a class, whose functions are called as reaction to a DcsmConsumer message after calling dispatchEventsAndMessage() on a DcsmProvider object. More...

#include <IDcsmProviderEventHandler.h>

Inheritance diagram for ramses::IDcsmProviderEventHandlerExtended:

Collaboration diagram for ramses::IDcsmProviderEventHandlerExtended:

Public Member Functions
virtual void	contentStatus (ContentID contentID, DcsmStatusMessage const &message)=0
	Called if a consumer sent a status message. More...
Public Member Functions inherited from ramses::IDcsmProviderEventHandler
virtual void	contentHide (ContentID contentID, AnimationInformation animInfo)=0
	Called if a content will be switched to be hidden. More...
virtual void	contentShow (ContentID contentID, AnimationInformation animInfo)=0
	Called if a content will be switched to shown. More...
virtual void	stopOfferAccepted (ContentID contentID, AnimationInformation animInfo)=0
	Called after a content was requested to no longer be offered. After this function returns, content is no longer offered. After the animation is finished, the associated scene can be safely unpublished. More...
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 DcsmConsumer assigned itself for the content, and every time the consumer changes the rendering viewport size. More...
virtual void	contentReadyRequested (ContentID contentID)=0
	Called after a DcsmConsumer requested the content and it has not been marked ready yet. After this function has been called, markContentReady() of the DcsmProvider shall be called. More...
virtual void	contentRelease (ContentID contentID, AnimationInformation animInfo)=0
	Called after an assigned DcsmConsumer is no longer interested in the content or the scene associated with it. After the animation has been finished, the associated scene can be safely unpublished. Note that the content has to be marked ready again after the call of this callback, should a DcsmConsumer request it to be ready again. More...
virtual	~IDcsmProviderEventHandler ()=default
	Destructor. More...

Detailed Description

An Interface for a class, whose functions are called as reaction to a DcsmConsumer message after calling dispatchEventsAndMessage() on a DcsmProvider object.

This class is deprecated and will be merged into IDcsmProviderEventHandler.

Member Function Documentation

contentStatus()

virtual void ramses::IDcsmProviderEventHandlerExtended::contentStatus ( ContentID  contentID, DcsmStatusMessage const &  message  )

pure virtual

Called if a consumer sent a status message.

Parameters

contentID	The ID of the content being hidden.
message	The message. See ramses::DcsmStatusMessage for details.

---

The documentation for this class was generated from the following file:

• /home/runner/work/ramses/ramses/framework/ramses-framework-api/include/ramses-framework-api/IDcsmProviderEventHandler.h