X3D Model Documentation: Example05.x3d

  1  <?xml version="1.0" encoding="UTF-8"?>
  2 
<!DOCTYPE X3D PUBLIC "ISO//Web3D//DTD X3D 3.0//EN" "https://www.web3d.org/specifications/x3d-3.0.dtd">
  3  <X3D profile='Immersive' version='3.0 xmlns:xsd='http://www.w3.org/2001/XMLSchema-instance' xsd:noNamespaceSchemaLocation='https://www.web3d.org/specifications/x3d-3.0.xsd'>
  4       <head>
  5            <meta name='titlecontent='Example05.x3d'/>
  6            <meta name='creatorcontent='Don Brutzman'/>
  7            <meta name='createdcontent='24 May 2000'/>
  8            <meta name='modifiedcontent='28 October 2019'/>
  9            <meta name='creatorcontent='X3D working group'/>
 10            <meta name='descriptioncontent="VRML 97 specification 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."/>
 11            <meta name='specificationUrlcontent='originals/exampleD_5.wrl'/>
 12            <meta name='specificationSectioncontent='VRML 97, ISO/IEC 14772-1, Part 1: Functional specification and UTF-8 encoding, D.5 Scripting example'/>
 13            <meta name='specificationUrlcontent='https://www.web3d.org/documents/specifications/14772/V2.0/part1/examples.html#D.5'/>
 14            <meta name='identifiercontent='https://www.web3d.org/x3d/content/examples/Basic/Vrml97Specification/Example05.x3d'/>
 15            <meta name='generatorcontent='X3D-Edit 3.3, https://savage.nps.edu/X3D-Edit'/>
 16            <meta name='licensecontent='../license.html'/>
 17       </head>
<!--

<!--
Event Graph ROUTE Table shows event connections.
-->

<!-- to top Index for DEF nodes: Click, OpenVault, TS
-->
 18       <Scene>
 19            <!-- Warning: VRML97-style scripting, not X3D Scene Authoring Interface (SAI) -->
 20            <WorldInfo title='Example05.x3d'/>
 21 
          <!-- ROUTE information for OpenVault node:  [from TS.isOver to combinationEntered ] [from TS.touchTime to openVault ] [from vaultUnlocked to Click.startTime ] -->
          <Script DEF='OpenVault'>
 22                 <!-- field tags are declarations of what interfaces are in this Script node -->
 23                 <field name='openVaulttype='SFTimeaccessType='inputOnly'/>
 24                 <field name='combinationEnteredtype='SFBoolaccessType='inputOnly'/>
 25                 <field name='vaultUnlockedtype='SFTimeaccessType='outputOnly'/>
 26                 <field name='unlockedtype='SFBoolvalue='falseaccessType='initializeOnly'/>
  <![CDATA[
      
ecmascript:
function combinationEntered (value)
{
	unlocked = value;
}
function openVault(value)
{
	if (unlocked) vaultUnlocked = value;
}

    
]]>
 28            </Script>
 29            <Shape>
 30                 <Appearance>
 31                      <Material diffuseColor='1 0 0'/>
 32                 </Appearance>
 33                 <Sphere/>
 34            </Shape>
 35            <Sound maxBack='1000maxFront='1000minBack='1000minFront='1000'>
 36 
               <!-- ROUTE information for Click node:  [from OpenVault.vaultUnlocked to startTime ] -->
               <AudioClip DEF='Clickdescription='clickstopTime='1'   url=' "click.wav" "https://www.web3d.org/x3d/content/examples/Basic/Vrml97Specification/click.wav" '/>
 37            </Sound>
 38 
          <!-- ROUTE information for TS node:  [from isOver to OpenVault.combinationEntered ] [from touchTime to OpenVault.openVault ] -->
          <TouchSensor DEF='TSdescription='touch ball to hear a click'/>
 39            < ROUTE  fromNode='TS' fromField='isOver' toNode='OpenVault' toField='combinationEntered'/>
 40            < ROUTE  fromNode='TS' fromField='touchTime' toNode='OpenVault' toField='openVault'/>
 41            < ROUTE  fromNode='OpenVault' fromField='vaultUnlocked' toNode='Click' toField='startTime'/>
 42       </Scene>
 43  </X3D>
<!--

<!--
Event Graph ROUTE Table shows event connections.
-->

<!-- to top 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! 😀

-->
<!-- Online at
https://www.web3d.org/x3d/content/examples/Basic/Vrml97Specification/Example05Index.html -->
<!-- Version control at
https://sourceforge.net/p/x3d/code/HEAD/tree/www.web3d.org/x3d/content/examples/Basic/Vrml97Specification/Example05.x3d -->

<!-- Color legend: X3D terminology <X3dNode DEF='idName' field='value'/> matches XML terminology <XmlElement DEF='idName' attribute='value'/>
(Light-blue background: event-based behavior node or statement) (Grey background inside box: inserted documentation) (Magenta background: X3D Extensibility)
-->

to top <!-- For additional help information about X3D scenes, please see X3D Tooltips, X3D Resources, and X3D Scene Authoring Hints. -->