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

#include <IDcsmProviderEventHandler.h>

Inheritance diagram for ramses::IDcsmProviderEventHandler:

[legend]

Public Member Functions
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 DcsmConsumer communication after calling dispatchEvents() on a DcsmProvider object.

Examples: ramses-example-dcsm-provider/src/main.cpp, and ramses-example-local-client-dcsm/src/main.cpp.

Constructor & Destructor Documentation

◆ ~IDcsmProviderEventHandler()

virtual ramses::IDcsmProviderEventHandler::~IDcsmProviderEventHandler ( )

virtualdefault

Destructor.

Member Function Documentation

◆ contentHide()

virtual void ramses::IDcsmProviderEventHandler::contentHide	(	ContentID	contentID,
		AnimationInformation	animInfo
	)

pure virtual

Called if a content will be switched to be hidden.

Parameters

contentID	The ID of the content being hidden
animInfo	animation information for hiding the content: startTime: beginning of a potential animation endTime: end of a potential animation and time point when content gets hidden

Implemented in LocalDCSMExample.

Examples: ramses-example-dcsm-provider/src/main.cpp.

◆ contentReadyRequested()

virtual void ramses::IDcsmProviderEventHandler::contentReadyRequested ( ContentID contentID )

pure virtual

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.

Parameters

contentID The ID of the content to be marked as ready

Implemented in LocalDCSMExample.

Examples: ramses-example-dcsm-provider/src/main.cpp.

◆ contentRelease()

virtual void ramses::IDcsmProviderEventHandler::contentRelease	(	ContentID	contentID,
		AnimationInformation	animInfo
	)

pure virtual

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.

Parameters

animInfo	animation information for resizing the content: startTime: beginning of a potential animation endTime: end of a potential animation and time point when content has to have new size
contentID	The ID of the content to be released

Implemented in LocalDCSMExample.

Examples: ramses-example-dcsm-provider/src/main.cpp.

◆ contentShow()

virtual void ramses::IDcsmProviderEventHandler::contentShow	(	ContentID	contentID,
		AnimationInformation	animInfo
	)

pure virtual

Called if a content will be switched to shown.

Parameters

contentID	The ID of the shown content
animInfo	animation information for showing the content: startTime: beginning of a potential animation and time point when content gets shown endTime: end of a potential animation

Implemented in LocalDCSMExample.

Examples: ramses-example-dcsm-provider/src/main.cpp.

◆ contentSizeChange()

virtual void ramses::IDcsmProviderEventHandler::contentSizeChange	(	ContentID	contentID,
		const CategoryInfoUpdate &	categoryInfo,
		AnimationInformation	animInfo
	)

pure virtual

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.

Parameters

contentID	The ID of the content for which the viewport changes
categoryInfo	the new viewport
animInfo	animation information for resizing the content: startTime: beginning of a potential animation endTime: end of a potential animation and time point when content has to have new size

Implemented in LocalDCSMExample.

Examples: ramses-example-dcsm-provider/src/main.cpp.

◆ stopOfferAccepted()

virtual void ramses::IDcsmProviderEventHandler::stopOfferAccepted	(	ContentID	contentID,
		AnimationInformation	animInfo
	)

pure virtual

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.

Parameters

contentID	The ID of the content to be unoffered
animInfo	animation information for hiding the content: startTime: beginning of a potential animation endTime: end of a potential animation and time point when content gets hidden

Implemented in LocalDCSMExample.

Examples: ramses-example-dcsm-provider/src/main.cpp.

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

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~IDcsmProviderEventHandler()

Member Function Documentation

◆ contentHide()

◆ contentReadyRequested()

◆ contentRelease()

◆ contentShow()

◆ contentSizeChange()

◆ stopOfferAccepted()