C++ API Library Reference  4.3.2-74-ge1d4cca
Public Functions | List of all members
IRemoteRenderer Class Referenceabstract

The IRemoteRenderer interface provides methods to notify StateManager when to render an image to a remoted view, as well as methods to configure the format of the rendered images before streaming. The methods in this interface expect the view's name as a parameter. This is the name you chose for the applicable view when you registered it using RegisterView.

Public Functions

virtual void RenderViewDeferred (String const &viewName)=0
 
virtual void RenderViewImmediate (String const &viewName)=0
 
virtual void SetViewImageFormat (String const &viewName, CSI::PureWeb::Server::ViewImageFormat const &format)=0
 
virtual void SetViewInteracting (String const &viewName, bool isInteracting)=0
 
virtual CSI::PureWeb::Server::ViewImageFormat ViewImageFormat (String const &viewName) const =0
 
Constructors and Destructors
virtual ~IRemoteRenderer ()
 

Usage Description

virtual void RenderViewDeferred ( String const &  viewName)
pure virtual

Notifies StateManager that the image in the specified view has been updated and needs to be rendered. The view image bits will be acquired later via the view's IRenderedView interface (the timing of the call to RenderView is not configurable; this is handled automatically by PureWeb).

Implemented in ViewManager.

virtual void RenderViewImmediate ( String const &  viewName)
pure virtual

Notifies StateManager that the image in the specified view has been updated needs to be rendered. The view image bits will be acquired immediately via the view's IRenderedView interface. This must be called on the UI thread.

Implemented in ViewManager.

virtual void SetViewImageFormat ( String const &  viewName,
CSI::PureWeb::Server::ViewImageFormat const &  format 
)
pure virtual

Sets the view image format (pixel format, scan line order and alignment) for the specified view.

The main purpose of this method is to overwrite framework defaults when needed. For example, the default pixel format of images in a PureWeb C++ service is BGR 24, but the default pixel format of a QImage in Qt is RGB 24. When using the PureWeb C++ API in Qt, therefore, you would use SetViewImageFormat to overwrite the default C++ image format to that expected by Qt. You would call this method before using RenderView to stream the image.

Implemented in ViewManager.

virtual void SetViewInteracting ( String const &  viewName,
bool  isInteracting 
)
pure virtual

Sets the interactive mode for the specified view to either true or false.

The SetViewInteracting method is used to notify StateManager when user interaction begins and when it stops. For example, you could set the interactive mode to true on a mouse down event, and set it back to false on a mouse up event. Once this is in place, you can configure the image quality values for the interactive and non-interactive modes using the client-side APIs.

Implemented in ViewManager.

virtual CSI::PureWeb::Server::ViewImageFormat ViewImageFormat ( String const &  viewName) const
pure virtual

Returns the current view image format (pixel format, scan line order and alignment) for the specified view.

Implemented in ViewManager.