RemoteVizRenderArea.h

Go to the documentation of this file.

/*=======================================================================
*** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
***                                                                                ***
***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
***                                                                                ***
***                        RESTRICTED RIGHTS LEGEND                                ***
***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
***                                                                                ***
***                   COPYRIGHT (C) 1996-2020 BY FEI S.A.S,                        ***
***                        BORDEAUX, FRANCE                                        ***
***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
 
 
class RemoteVizRenderArea
{
 
public:
 
  RemoteVizRenderArea(String|HTMLElement container, Number containerWidth, Number containerHeight, String displayMode);
 
  connectTo(String serviceUrl);
 
  disconnect();
 
  Boolean isConnected();
 
  sendMessage(String|Uint8Array message);
 
  requestRenderAreaSize(Number width, Number height);
 
  resizeRenderAreaContainer(Number width, Number height);
 
 
  Number getRenderAreaWidth();
 
  Number getRenderAreaHeight();
 
 
  Number getContainerWidth();
 
  Number getContainerHeight();
 
 
  Boolean isImageStreamingSupported();
 
  Boolean isVideoStreamingSupported();
 
  String getStreamingMode();
 
 
  addServiceListener(Function serviceHandler);
  removeServiceListener(Function serviceHandler);
  serviceHandler(Object notification);
 
 
 
  addResizeListener(Function resizeHandler);
  removeResizeListener(Function resizeHandler);
  resizeHandler(Array size);
 
 
 
  addReceivedFrameListener(Function receivedFrameHandler);
  removeReceivedFrameListener(Function receivedFrameHandler);
  receivedFrameHandler(Number frameId, Number dataLength, String message);
 
 
 
  addDecodedFrameListener(Function decodedFrameHandler);
  removeDecodedFrameListener(Function decodedFrameHandler);
  decodedFrameHandler(Number frameId, Boolean isLossless, String message);
 
 
  addMessageListener(Function messageHandler);
  removeMessageListener(Function messageHandler);
  messageHandler(String|Uint8Array message);
 
 
  addMouseUpListener(Function eventHandler);
  removeMouseUpListener(Function eventHandler);
 
 
  addMouseDownListener(Function eventHandler);
  removeMouseDownListener(Function eventHandler);
 
 
  addMouseDoubleClickListener(Function eventHandler);
  removeMouseDoubleClickListener(Function eventHandler);
 
 
  addMouseMoveListener(Function eventHandler);
  removeMouseMoveListener(Function eventHandler);
 
 
  addMouseOverListener(Function eventHandler);
  removeMouseOverListener(Function eventHandler);
 
 
  addMouseOutListener(Function eventHandler);
  removeMouseOutListener(Function eventHandler);
 
 
  addMouseWheelListener(Function eventHandler);
  removeMouseWheelListener(Function eventHandler);
 
 
  addTouchStartListener(Function eventHandler);
  removeTouchStartListener(Function eventHandler);
 
 
  addTouchEndListener(Function eventHandler);
  removeTouchEndListener(Function eventHandler);
 
 
  addTouchCancelListener(Function eventHandler);
  removeTouchCancelListener(Function eventHandler);
 
 
  addTouchMoveListener(Function eventHandler);
  removeTouchMoveListener(Function eventHandler);
 
 
  addKeyUpListener(Function eventHandler);
  removeKeyUpListener(Function eventHandler);
 
 
  addKeyDownListener(Function eventHandler);
  removeKeyDownListener(Function eventHandler);
 
  Boolean eventHandler(Event event);
 
};