Scripting.x3d (X3dToXhtml listing)

X3D Model Documentation: Scripting.x3d

1	`<?xml version="1.0" encoding="UTF-8"?>`
2	`<!DOCTYPE X3D PUBLIC "ISO//Web3D//DTD X3D 3.3//EN" "https://www.web3d.org/specifications/x3d-3.3.dtd">`
3	<X3D profile='Immersive' version='3.3' xmlns:xsd='http://www.w3.org/2001/XMLSchema-instance' xsd:noNamespaceSchemaLocation='https://www.web3d.org/specifications/x3d-3.3.xsd'>
4	<head>
5	<meta name='title' content='Scripting.x3d'/>
6	<meta name='description' content='X3D encodings example: this Script node decides whether or not to open a bank vault given openVault and combinationEntered messages. To do this, it remembers whether or not the correct combination has been entered. The Script node combined with a Sphere, a TouchSensor and a Sound node to show how is works. When the pointing device is over the sphere, the combinationEntered eventIn of the Script is sent. Then, when the Sphere is touched (typically when the mouse button is pressed) the Script is sent the openVault eventIn. This generates the vaultUnlocked eventOut which starts a click sound.'/>
7	<meta name='creator' content='Don Brutzman and Joe Williams'/>
8	<meta name='created' content='1 June 2002'/>
9	<meta name='modified' content='28 October 2019'/>
10	<meta name='specificationSection' content='X3D encodings, ISO/IEC 19776-1.3, Part 1: XML encoding, Annex C.5 Scripting example'/>
11	<meta name='specificationUrl' content='https://www.web3d.org/documents/specifications/19776-1/V3.3/Part01/examples.html#ScriptingExample'/>
12	<meta name='identifier' content='https://www.web3d.org/x3d/content/examples/Basic/X3dSpecifications/Scripting.x3d'/>
13	<meta name='generator' content='X3D-Edit 3.3, https://savage.nps.edu/X3D-Edit'/>
14	<meta name='license' content='../license.html'/>
15	</head>

<!--

Event Graph ROUTE Table shows event connections.

-->

<!--

Index for DEF nodes: Click, OpenVault, TS

-->

16	<Scene>
17	<WorldInfo title='Scripting.x3d'/>
18	<!-- ROUTE information for OpenVault node: [from TS.isOver to combinationEntered ] [from TS.touchTime to openVault ] [from vaultUnlocked to Click.startTime ] --> <Script DEF='OpenVault'>
19	<field name='openVault' type='SFTime' accessType='inputOnly'/>
20	<field name='combinationEntered' type='SFBool' accessType='inputOnly'/>
21	<field name='vaultUnlocked' type='SFTime' accessType='outputOnly'/>
22	<field name='unlocked' type='SFBool' value='false' accessType='initializeOnly'/>
	`<![CDATA[` ecmascript: function combinationEntered (value) { unlocked = value; } function openVault(value) { if (unlocked) vaultUnlocked = value; } `]]>`
24	</Script>
25	<Shape>
26	<Appearance>
27	<Material diffuseColor='1 0 0'/>
28	</Appearance>
29	<Sphere/>
30	</Shape>
31	<Sound maxBack='1000' maxFront='1000' minBack='1000' minFront='1000'>
32	<!-- ROUTE information for Click node: [from OpenVault.vaultUnlocked to startTime ] --> <AudioClip DEF='Click' description='clicking sound' stopTime='1' url=' "click.wav" "https://www.web3d.org/x3d/content/examples/Basic/X3dSpecifications/click.wav" '/>
33	</Sound>
34	<!-- ROUTE information for TS node: [from isOver to OpenVault.combinationEntered ] [from touchTime to OpenVault.openVault ] --> <TouchSensor DEF='TS' description='touch to click'/>
35	< ROUTE fromNode='TS' fromField='isOver' toNode='OpenVault' toField='combinationEntered'/>
36	< ROUTE fromNode='TS' fromField='touchTime' toNode='OpenVault' toField='openVault'/>
37	< ROUTE fromNode='OpenVault' fromField='vaultUnlocked' toNode='Click' toField='startTime'/>
38	</Scene>
39	</X3D>

<!--

Event Graph ROUTE Table shows event connections.

-->

<!--

Index for DEF nodes: Click, OpenVault, TS

-->

X3D Tooltips element index: Appearance, AudioClip, field, head, Material, meta, ROUTE, Scene, Script, Shape, Sound, Sphere, TouchSensor, WorldInfo, X3D, accessType and type, XML data types, field types

Event Graph ROUTE Table entries with 3 ROUTE connections total, showing X3D event-model relationships for this scene.

Each row shows an event cascade that may occur during a single timestamp interval between frame renderings, as part of the X3D execution model.

TS TouchSensor isOver SFBool	→ ROUTE event to (1)	OpenVault Script combinationEntered SFBool	then	OpenVault Script vaultUnlocked SFTime	→ ROUTE event to (2)	Click AudioClip startTime SFTime
TS TouchSensor touchTime SFTime	→ ROUTE event to (1)	OpenVault Script openVault SFTime	then	OpenVault Script vaultUnlocked SFTime	→ ROUTE event to (2)	Click AudioClip startTime SFTime

Additional guidance on X3D animation can be found in the 10-Step Animation Design Process and Event Tracing hint sheets. Have fun with X3D! 😀

-->