Open Inventor Release 2023.2.3
 
Loading...
Searching...
No Matches
RemoteVizRenderArea.h
Go to the documentation of this file.
1/*=======================================================================
2*** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.), ***
3*** AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT. ***
4*** ***
5*** REPRODUCTION, DISCLOSURE, OR USE, IN WHOLE OR IN PART, OTHER THAN AS ***
6*** SPECIFIED IN THE LICENSE ARE NOT TO BE UNDERTAKEN EXCEPT WITH PRIOR ***
7*** WRITTEN AUTHORIZATION OF FEI S.A.S. ***
8*** ***
9*** RESTRICTED RIGHTS LEGEND ***
10*** USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS ***
11*** WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN ***
12*** SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT ***
13*** CLAUSE AT FAR 52.227-19 OR SUBPARAGRAPH (C)(1)(II) OF THE RIGHTS IN ***
14*** TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013. ***
15*** ***
16*** COPYRIGHT (C) 1996-2020 BY FEI S.A.S, ***
17*** BORDEAUX, FRANCE ***
18*** ALL RIGHTS RESERVED ***
19**=======================================================================*/
20
54
282{
283
284public:
285
330 RemoteVizRenderArea(String|HTMLElement container, Number containerWidth, Number containerHeight, String displayMode);
331
363 connectTo(String serviceUrl);
364
370
378
385 sendMessage(String|Uint8Array message);
386
393 requestRenderAreaSize(Number width, Number height);
394
398 resizeRenderAreaContainer(Number width, Number height);
399
401
407
415
417
423
431
433
439
446
455
457
496 serviceHandler(Object notification);
497
499
501
529
531
533
564 receivedFrameHandler(Number frameId, Number dataLength, String message);
565
567
569
600 decodedFrameHandler(Number frameId, Boolean isLossless, String message);
602
604
626 messageHandler(String|Uint8Array message);
628
630
647
649
666
668
685
687
704
706
723
725
742
744
761
763
780
782
799
801
818
820
837
839
856
858
875
885 Boolean eventHandler(Event event);
886
887};
888
char Boolean
Definition SoQtDef.h:119
<a href="IconLegend.html"><img src="extRV.gif" alt="RemoteViz" border="0"></a> HTML5 client API Docu...
removeMouseMoveListener(Function eventHandler)
Removes a listener on the container (DIV element) mouseMove event.
addResizeListener(Function resizeHandler)
Adds a listener on the renderArea resize event.
String getStreamingMode()
Returns the type of streaming currently used by the client.
addKeyUpListener(Function eventHandler)
Adds a listener on the image container keyUp event.
Boolean isConnected()
Checks if the service connection is established.
addTouchCancelListener(Function eventHandler)
Adds a listener on the image container touchCancel event.
removeMouseDownListener(Function eventHandler)
Removes a listener on the container (DIV element) mouseDown event.
removeResizeListener(Function resizeHandler)
Removes a listener on the renderArea resize event.
requestRenderAreaSize(Number width, Number height)
Sends a request to resize the renderArea associated with the connection.
messageHandler(String|Uint8Array message)
MessageHandler.
addKeyDownListener(Function eventHandler)
Adds a listener on the image container keyDown event.
addServiceListener(Function serviceHandler)
Adds an event listener on the service runtime.
removeDecodedFrameListener(Function decodedFrameHandler)
Removes a listener on the decoded frame event.
Boolean eventHandler(Event event)
EventHandler.
removeKeyDownListener(Function eventHandler)
Removes a listener on the container (DIV element) keyDown event.
addMouseDownListener(Function eventHandler)
Adds a listener on the image container mouseDown event.
disconnect()
Closes the service connection.
removeMessageListener(Function messageHandler)
Adds an event listener on the received message.
addReceivedFrameListener(Function receivedFrameHandler)
Adds a listener on the received frame event.
Number getRenderAreaHeight()
Returns the height of the renderArea managed by the RemoteViz service.
resizeHandler(Array size)
ResizeHandler.
connectTo(String serviceUrl)
Opens a new connection between the HTML webpage and the RemoteViz service.
serviceHandler(Object notification)
ServiceHandler.
Boolean isImageStreamingSupported()
Checks if the client supports image streaming.
removeTouchCancelListener(Function eventHandler)
Removes a listener on the container (DIV element) touchCancel event.
removeTouchMoveListener(Function eventHandler)
Removes a listener on the container (DIV element) touchMove event.
resizeRenderAreaContainer(Number width, Number height)
Resizes the renderArea container.
removeTouchStartListener(Function eventHandler)
Removes a listener on the container (DIV element) touchStart event.
Boolean isVideoStreamingSupported()
Checks if the client supports video streaming (H.264 or VP9).
addDecodedFrameListener(Function decodedFrameHandler)
Adds a listener on the decoded frame event.
addTouchEndListener(Function eventHandler)
Adds a listener on the image container touchEnd event.
receivedFrameHandler(Number frameId, Number dataLength, String message)
ReceivedFrameHandler.
removeMouseOutListener(Function eventHandler)
Removes a listener on the container (DIV element) mouseOver event.
addTouchStartListener(Function eventHandler)
Adds a listener on the image container touchStart event.
addMouseWheelListener(Function eventHandler)
Adds a listener on the image container mouseWheel event.
addTouchMoveListener(Function eventHandler)
Adds a listener on the image container touchMove event.
Number getRenderAreaWidth()
Returns the width of the renderArea managed by the RemoteViz service.
Number getContainerWidth()
Returns the width of the renderArea container.
RemoteVizRenderArea(String|HTMLElement container, Number containerWidth, Number containerHeight, String displayMode)
This constructor associates a RemoteViz RenderArea on the server with an HTML container.
sendMessage(String|Uint8Array message)
Sends a message to the service.
removeMouseDoubleClickListener(Function eventHandler)
Removes a listener on the container (DIV element) mouseDoubleClick event.
addMessageListener(Function messageHandler)
Adds an event listener on the received message event.
removeMouseWheelListener(Function eventHandler)
Removes a listener on the container (DIV element) mouseWheel event.
addMouseOverListener(Function eventHandler)
Adds a listener on the image container mouseOver event.
removeTouchEndListener(Function eventHandler)
Removes a listener on the container (DIV element) touchEnd event.
removeMouseOverListener(Function eventHandler)
Removes a listener on the container (DIV element) mouseOver event.
removeKeyUpListener(Function eventHandler)
Removes a listener on the container (DIV element) keyUp event.
addMouseMoveListener(Function eventHandler)
Adds a listener on the container (DIV element) mouseMove event.
addMouseUpListener(Function eventHandler)
Adds a listener on the image container mouseUp event.
decodedFrameHandler(Number frameId, Boolean isLossless, String message)
DecodedFrameHandler.
removeMouseUpListener(Function eventHandler)
Removes a listener on the container (DIV element) mouseUp event.
Number getContainerHeight()
Returns the height of the renderArea container.
addMouseOutListener(Function eventHandler)
Adds a listener on the image container mouseOut event.
addMouseDoubleClickListener(Function eventHandler)
Adds a listener on the container (DIV element) mouseDoubleClick event.
removeReceivedFrameListener(Function receivedFrameHandler)
Removes a listener on the received frame event.
removeServiceListener(Function serviceHandler)
Removes an event listener on the service runtime.
size_t size() const