Javascript programming with DevalVR

Javascript events

The events are the way to send orders from DevalVR to Javascript code.

To "catch" this events in a web page, it's needed to define a function in the Javascript code of this web page. This function is the "..._DoDVLCommands" function, and must be defined beginning with the ID of the plugin object.

In this example, the plugin ID is "PLUGIN1":

<OBJECT ID='PLUGIN1' classid=clsid:5D2CF9D0-113A-476B-986F-288B54571614 codeBase='http://www.devalvr.com/instalacion/plugin/devalocx.cab#version=0,6,1,3' style='WIDTH: 100%; HEIGHT: 90%' width='100%' height='90%'> <PARAM NAME='src' VALUE='script.dvl'> <EMBED NAME='PLUGIN1' TYPE='application/x-devalvrx' PLUGINSPAGE='http://www.devalvr.com/instalacion/plugin/install.html' src='script.dvl' width='100%' height='90%'></EMBED> </OBJECT>

If the plugin ID of previous code is "PLUGIN1", the events function must be defined with the name: PLUGIN1_DoDVLCommands

This function has two text parameters and must be defined this way:

<SCRIPT LANGUAGE=javascript> <!-- function PLUGIN1_DoDVLCommands(command, data) { } //--> </SCRIPT>

In addition, it's needed to define a intermediate function for browser Internet Explorer, because this browser manage the plugin events through Visual Basic events. This function is "..._DVLCommands" and must be defined beginning with the ID of the plugin object as well. 

<SCRIPT LANGUAGE=javascript> <!-- function PLUGIN1_DoDVLCommands(command, data) { } //--> </SCRIPT> <SCRIPT LANGUAGE="VBScript"> <!-- // Catch DevalVR Commands in IE, and pass them to the corresponding JavaScript function. Sub PLUGIN1_DVLCommands(ByVal command, ByVal args) call PLUGIN1_DoDVLCommands(command, args) end sub //--> </SCRIPT>

All the code to manage plugin events must be defined into PLUGIN1_DoDVLCommands function.

"panorama" event

A predefined event is sent when a panorama is loaded into a script file, this is the "panorama " event. This event can be used to know when the user loads a new panorama in the script, for example with GoToFrame() function. The first parameter of DoDVLCommands function is "panorama" text and second parameter is the name of the object in the script.

For example, if this script is loaded in the viewer:

(obj1) { TYPE=MOV; FILE=filename1.mov; NODO= 26,26,198, -26,26,198, 26,-26,198, -26,-26,198, 0,0,1, obj2; } (obj2) { TIPO=MOV; FILE=filename2.mov; NODO= 300,184,930,-195,173,962, 297,-274,912, -215,-268,935, 0,0,1, obj1; }

This Javascript code can be used to know what panorama is shown:

<SCRIPT LANGUAGE=javascript> <!-- function PLUGIN1_DoDVLCommands(command, data) { if(command=="panorama") { if(data=="obj1") { //Panorama "obj1" is loaded } else if(data=="obj2") { //Panorama "obj2" is loaded } } } //--> </SCRIPT> <SCRIPT LANGUAGE="VBScript"> <!-- // Catch DevalVR Commands in IE, and pass them to the corresponding JavaScript function. Sub PLUGIN1_DVLCommands(ByVal command, ByVal args) call PLUGIN1_DoDVLCommands(command, args) end sub //--> </SCRIPT>

See this example: panoramaevent.zip (2.80 MB)

JavascriptEvent function

This is a function of internal programming and can be defined into a BUTTON or any other script instruction. This instruction sends a defined text to DoDVLCommands function. When this function is used, the first parameter of DoDVLCommands function will be "event" text, and the second parameter is the text defined in JavascriptEvent function.

For example, you can insert JavascriptEvent function in a SETTIMER instruction into a script:

(pano) { type=MOV; file=panorama.mov; settimer= timer1, 1, 12, "JavascriptEvent("Hello!");"; }

And you can insert into DoDVLCommands the code to manage this event, for example, to show an alert window:

<SCRIPT LANGUAGE=javascript> <!-- function PLUGIN1_DoDVLCommands(command, data) { if(command=="event") { alert(data); } } //--> </SCRIPT> <SCRIPT LANGUAGE="VBScript"> <!-- // Catch DevalVR Commands in IE, and pass them to the corresponding JavaScript function. Sub PLUGIN1_DVLCommands(ByVal command, ByVal args) call PLUGIN1_DoDVLCommands(command, args) end sub //--> </SCRIPT>