Viz Artist

Version 3.9.0 | Published December 13, 2017 ©

BrowserCEF

images/download/attachments/27789524/viz_icons_browsercef.png
The BrowserCEF plug-in gives the ability to stream browser content on a Texture.

Note: This plug-in is located in: Built Ins -> Container plug-ins -> Texture

This section contains information on the following topics:

BrowserCEF Properties

images/download/attachments/27789524/plugins_container_browsercef_properties.png

  • URL: Enter the URL address to be opened

  • Texture Width: Width in pixels of the browser window

  • Texture Height: Height in pixels of the browser window

  • Allow Popups: Allow the browser to render popup windows. The popup will be rendered into the current texture. Close the popup by navigating back

  • Disable JavaScript: Disable JavaScript execution

  • Generate Mipmaps: Generate all mipmap levels.

    • Set to OFF for more performance

    • Set to ON for more quality when the texture is rendered on a smaller area on the screen than the width/height of the browser itself

  • Alpha: Enable a transparent browser window

  • Snapshot Filename: The full path and name for saving a snapshot. The location can be either a local file or on the Graphic Hub, and must be specified as a Uniform Resource Identifier (URI), for example:

    • File: file:///c:/temp/BrowserCEF/example.png

    • Graphic Hub: vizgh:///BrowserCEF/example.png

    • Graphic Hub UUID: vizgh:///<F3F3F087-B85A-4AEE-B5019F78CB6AE5EC>/example.png

  • Snapshot: Take a snapshot of the current browser texture. The snapshot is saved as a file or to the Graphic Hub, as specified in Snapshot Filename

  • Navigate Back: Navigate back to the previous page

  • Navigate Forward: Navigate forward to the next page

  • Reload Page: Reload the current page

  • Zoom In: Zoom into the page, incrementing per click

  • Zoom Out: Zoom out of the page, incrementing per click

  • Zoom Reset: Reset zoom to default value

  • Zoom: Enter the desired zoom value. The fields supported range is from -10.0 to 10.0. The default value is 0.0.
    Like any other parameter, the value of this field can be controlled from a ControlObject. Please enable Show Advanced and then add the parameter under Channel:
    ControlObject exposure with direct address

    zoom:MAIN_SCENE*TREE*$Browser*FUNCTION*BrowserCEF*zoom:float:0.0:-10.0:10.0:zoom level

    ControlObject exposure with control channel address

    zoom:MAIN_SCENE*TREE*@zoom:float:0.0:-10.0:10.0:zoom level

    Note: The BrowserCEF plug-in works asynchronously. Therefore, the zoom value needs to be applied after a successful load of an URL. This means that the value stored in the plug-in may not be the currently active zoom value until it has been applied.

  • ScrollBy X: Set the scroll in the horizontal axis.

  • ScrollBy Y: Set the scroll in the vertical axis.

  • ScrollBy: Execute ScrollBy X and Y values.

  • Execute: Execute the code entered in the code entry field.

  • Disable Native Mouse Events: Disables all mouse events, such as move, click and wheel events. Useful to control mouse events from outside, for example in scripts; or if it interferes with other plug-ins, such as Graffiti.

  • Mouse Position X and Y: The u/v parameters control the position of the mouse cursor. The coordinates are normalized in [0,1], being (0,0) the lower left corner and (1,1) the upper right corner of the browser window. All mouse click and move events described below relate to this coordinate:

    • Left Click: Emulates a click (both mouse down and mouse up events) of the left mouse button.

    • Left Mouse Down: Emulates a left mouse button down event

    • Left Mouse Up: Emulates a left mouse button up event

    • Right Mouse Down: Emulates a right mouse button down event

    • Right Mouse Up: Emulates a right mouse button up event

    • Mouse Move: Emulates a mouse move event (might be triggered after the u/v coordinate has been changed

    • Wheel Up: Emulates a mouse wheel up event

    • Wheel Down: Emulates a mouse wheel down event

    • Wheel Left: Emulates a mouse wheel left event

    • Wheel Right: Emulates a mouse wheel right event

  • Proxy User: The user name in case the system’s http-proxy requires authentication

  • Proxy Password: The user name password in case the system’s http-proxy requires authentication

  • Read Events From Shared Memory: Enable the browser to receive events from shared memory callbacks

  • Input Events from Shared Memory: Prefix key for global shared memory. Valid commands are:

    • WB_TEXT: Can be used to emulate string input like ‘Hello World!’

    • WB_KEY: Can be used for special key strokes. Possible values are ENTER, RETURN, BACKSPACE, DELETE, HOME, END, LEFT, RIGHT, UP, DOWN, PAGE_UP, PAGE_DOWN
      Sample for viz-scripting supposing ShmemVarName is WB_EVENTS:

      System.map["WB_EVENTS"] = "WB_TEXT Hello World!" System.map["WB_EVENTS"] = "WB_KEY ENTER"

      Note that a Shared Memory change event will only occur if the memory actually changes. Sending the same text twice, for example, will thus not trigger a Shared Memory event.

  • Enable Multitouch Events: Enable native multitouch events (scroll, pinch to zoom, double tap)

To Create a Simple Scene with BrowserCEF

images/download/attachments/27789524/plugins_container_browsercef_image.png

  1. Add a new Container to the Scene tree.

  2. Add a rectangle geometry to the Container

  3. Add the BrowserCEF plug-in.

  4. Open the BrowserCEF properties and enter a valid URL.

  5. Click on images/download/attachments/27789524/workbench_button_e.png (enable the handling of interactive script/plug-in events (Scene Editor)).

  6. Use the mouse or controls to navigate the web site.

Interact with a Scene with JavaScript

It is possible to interact with a Scene from within the JavaScript of a HTML document, for example, colorpicker.html.

images/download/attachments/27789524/plugins_container_browsercef_java_example.png
In the JavaScript section of a HTML document interact with the Scene with the window.vizrt object. Append any function name on this object, for example, window.vizrt.colorChange( "255 100 100" ). The function colorChange must be defined in the JavaScript function section of the BrowserCEF plug-in.

images/download/attachments/27789524/plugins_container_browsercef_java_1.png
To add more functions, add them in this GUI section, separated by new lines:

images/download/attachments/27789524/plugins_container_browsercef_java_2.png
Only one argument is supported for each function, to add more arguments to a function use separators and encode all arguments into one string.

Calls from JavaScript are translated into Viz Shared Memory variable changes, on the system.map. To register these changes use the Shared Memory variable composed by the Container ID of the BrowserCEF plug-in and the string, for example, " BROWSER STATUS".

IMPORTANT! There must be a space between the double quotation mark (") and BROWSER{{: " BROWSER STATUS"}}.

Script Example: When the script sits on the same Container:

sub OnInit()
System.map.RegisterChangedCallback( this.VizId & " BROWSER STATUS" )
end sub
 
sub OnSharedMemoryVariableChanged(map As SharedMemory, mapKey As String)
println( "shared map changed: " & map[mapKey] )
 
Dim str As String = map[mapKey]
Dim strstr As array[String]
 
str.split(" ", strstr)
if strstr[1] = "javascript" then
if strstr[2] = "colorChange" then
scene.findContainer("iso").Material.diffuse.red = cDbl(strstr[3])/255.0
scene.findContainer("iso").Material.diffuse.green = cDbl(strstr[4])/255.0
scene.findContainer("iso").Material.diffuse.blue = cDbl(strstr[5])/255.0
end if
end if
end sub

Example string passed to Shared Memory:

"0 JavaScript colorChange 0 53 4"
  • The first number, either 0 or 1, can be ignored

  • JavaScript, shows that a JavaScript function was invoked

  • The function name (colorChange) itself followed by the argument(s).
    Example call in the HTML document:

window.vizrt.colorChange(r + " " + g + " " + b);

Example HTML Document

Entered in URL: file:///C:/test/colorpicker.htm (see BrowserCEF Properties):

<script type="text/javascript">
function colorAnim()
{
window.vizrt.colorAnim()
}
 
function objectmove(x, y)
{
PositionX.value = x;
PositionY.value = y;
}
</script>
 
<!DOCTYPE html>
<html lang="en">
<head>
<title id='Description'>The jqxColorPicker widget allows you to easily pick a color.</title>
<link rel="stylesheet" href="http://www.jqwidgets.com/jquery-widgets-demo/jqwidgets/styles/jqx.base.css" type="text/css" />
<script type="text/javascript" src="http://www.jqwidgets.com/jquery-widgets-demo/scripts/jquery-1.11.1.min.js"></script>
<script type="text/javascript" src="http://www.jqwidgets.com/jquery-widgets-demo/scripts/demos.js"></script>
<script type="text/javascript" src="http://www.jqwidgets.com/jquery-widgets-demo/jqwidgets/jqxcore.js"></script>
<script type="text/javascript" src="http://www.jqwidgets.com/jquery-widgets-demo/jqwidgets/jqxcolorpicker.js"></script>
<script type="text/javascript" src="http://www.jqwidgets.com/jquery-widgets-demo/jqwidgets/jqxradiobutton.js"></script>
</head>  
<body class='default'>
<div id='content'>
<script type="text/javascript">
$(document).ready(function ()
{
// Create jqxColorPicker widgets.
$("#jqxColorPicker").jqxColorPicker({ width: '250', height: '250'});
$("#hueMode").jqxRadioButton({ width: '150', height: '25'});
$("#saturationMode").jqxRadioButton({ checked: true, width: '180', height: '25'});
$("#hueMode").on('change', function (event)
{
if (event.args.checked)
{
$("#jqxColorPicker").jqxColorPicker({ colorMode: 'hue' });
}
else {
$("#jqxColorPicker").jqxColorPicker({ colorMode: 'saturation' });
}
});
 
$("#jqxColorPicker").on('colorchange', function (event)
{
//console.log(event.args.color.r);
window.vizrt.colorChange(event.args.color.r + " " + event.args.color.g + " " + event.args.color.b);
$("#colorlog").html("<div>Color: #" + event.args.color.hex + "</div>");
});
});
</script>
<div id='jqxWidget'>
<div id="jqxColorPicker"></div>
<div style="font-size: 13px; font-family: verdana; margin-top: 10px;">
<div style="margin-bottom: 5px;">Color Modes</div>
<div id="saturationMode">Saturation Color Mode</div>
<div id="hueMode">Hue Color Mode</div>
</div>
<div style="font-family: Verdana; font-size:13px;" id="colorlog"></div>
</div>
</div>
</body>
</html>