X3D Model Documentation: GuidedTour.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='Interactive' 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='titlecontent='GuidedTour.x3d'/>
  6            <meta name='descriptioncontent='X3D encodings example: provides control of the viewpoint through use of a script. This is useful for things such as guided tours, merry-go-round rides, and transportation devices such as buses and elevators. These next two examples show a couple of ways to use this feature. This example is a simple guided tour through the world. Upon entry, a guide orb hovers in front of the viewer. Click on this and a tour through the world begins. The orb follows the user around on his tour. A ProximitySensor ensures that the tour is started only if the user is close to the initial starting point. Note that this is done without scripts thanks to the touchTime output of the TouchSensor.'/>
  7            <meta name='creatorcontent='Don Brutzman and Joe Williams'/>
  8            <meta name='createdcontent='1 June 2002'/>
  9            <meta name='modifiedcontent='28 October 2019'/>
 10            <meta name='specificationSectioncontent='X3D encodings, ISO/IEC 19776-1.3, Part 1: XML encoding, Annex C.17 Guided tour'/>
 11            <meta name='specificationUrlcontent='https://www.web3d.org/documents/specifications/19776-1/V3.3/Part01/examples.html#GuidedTour'/>
 12            <meta name='identifiercontent='https://www.web3d.org/x3d/content/examples/Basic/X3dSpecifications/GuidedTour.x3d'/>
 13            <meta name='generatorcontent='X3D-Edit 3.3, https://savage.nps.edu/X3D-Edit'/>
 14            <meta name='licensecontent='../license.html'/>
 15       </head>
<!--

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

<!-- to top Index for DEF nodes: GuidePI, GuideRI, GuideTransform, ProxSensor, StartTour, TourGuide, TS

Index for Viewpoint node: TourGuide
-->
 16       <Scene>
 17            <WorldInfo title='GuidedTour.x3d'/>
 18            <Group>
 19                 <Transform translation='0.0 -1.0 0.0'>
 20                      <Shape>
 21                           <Box size='30.0 0.2 30.0'/>
 22                           <Appearance>
 23                                <Material/>
 24                           </Appearance>
 25                      </Shape>
 26                 </Transform>
 27                 <Transform translation='-1.0 0.0 0.0'>
 28                      <Shape>
 29                           <Cone/>
 30                           <Appearance>
 31                                <Material diffuseColor='0.5 0.8 0.0'/>
 32                           </Appearance>
 33                      </Shape>
 34                 </Transform>
 35                 <Transform translation='1.0 0.0 0.0'>
 36                      <Shape>
 37                           <Cylinder/>
 38                           <Appearance>
 39                                <Material diffuseColor='0.0 0.2 0.7'/>
 40                           </Appearance>
 41                      </Shape>
 42                 </Transform>
 43 
               <!-- ROUTE information for GuideTransform node:  [from GuidePI.value_changed to translation ] [from GuideRI.value_changed to rotation ] -->
               <Transform DEF='GuideTransform'>
 44 
                    <!-- ROUTE information for TourGuide node:  [from TS.isActive to set_bind ] -->
                    <Viewpoint DEF='TourGuidedescription='Tour Guidejump='false'/>
 45 
                    <!-- ROUTE information for ProxSensor node:  [from isActive to StartTour.enabled ] -->
                    <ProximitySensor DEF='ProxSensorsize='50.0 50.0 50.0'/>
 46 
                    <!-- ROUTE information for StartTour node:  [from ProxSensor.isActive to enabled ] [from touchTime to TS.startTime ] -->
                    <TouchSensor DEF='StartTourdescription='click to start guided tour'/>
 47                      <Transform translation='0.6 0.4 8.0'>
 48                           <Shape>
 49                                <Sphere radius='0.2'/>
 50                                <Appearance>
 51                                     <Material diffuseColor='1.0 0.6 0.0'/>
 52                                </Appearance>
 53                           </Shape>
 54                      </Transform>
 55                 </Transform>
 56            </Group>
 57 
          <!-- ROUTE information for GuidePI node:  [from TS.fraction_changed to set_fraction ] [from value_changed to GuideTransform.translation ] -->
          <PositionInterpolator DEF='GuidePIkey='0.0 0.2 0.3 0.5 0.6 0.8 0.9 1.0keyValue='0.0 0.0 0.0 0.0 0.0 -5.0 2.0 0.0 -5.0 2.0 6.0 -15.0 -4.0 6.0 -15.0 -4.0 0.0 -5.0 0.0 0.0 -5.0 0.0 0.0 0.0'/>
 58 
          <!-- ROUTE information for GuideRI node:  [from TS.fraction_changed to set_fraction ] [from value_changed to GuideTransform.rotation ] -->
          <OrientationInterpolator DEF='GuideRIkey='0.0 0.2 0.3 0.5 0.6 0.8 0.9 1.0keyValue='0.0 1.0 0.0 0.0 0.0 1.0 0.0 0.0 0.0 1.0 0.0 1.2 0.0 1.0 0.0 3.3 0.0 1.0 0.0 3.5 0.0 1.0 0.0 5.0 0.0 1.0 0.0 0.0 0.0 1.0 0.0 0.0'/>
 59 
          <!-- ROUTE information for TS node:  [from StartTour.touchTime to startTime ] [from isActive to TourGuide.set_bind ] [from fraction_changed to GuidePI.set_fraction ] [from fraction_changed to GuideRI.set_fraction ] -->
          <TimeSensor DEF='TScycleInterval='30.0'/>
 60            < ROUTE  fromNode='ProxSensor' fromField='isActive' toNode='StartTour' toField='enabled'/>
 61            < ROUTE  fromNode='StartTour' fromField='touchTime' toNode='TS' toField='startTime'/>
 62            < ROUTE  fromNode='TS' fromField='isActive' toNode='TourGuide' toField='set_bind'/>
 63            < ROUTE  fromNode='TS' fromField='fraction_changed' toNode='GuidePI' toField='set_fraction'/>
 64            < ROUTE  fromNode='TS' fromField='fraction_changed' toNode='GuideRI' toField='set_fraction'/>
 65            < ROUTE  fromNode='GuidePI' fromField='value_changed' toNode='GuideTransform' toField='translation'/>
 66            < ROUTE  fromNode='GuideRI' fromField='value_changed' toNode='GuideTransform' toField='rotation'/>
 67       </Scene>
 68  </X3D>
<!--

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

<!-- to top Index for DEF nodes: GuidePI, GuideRI, GuideTransform, ProxSensor, StartTour, TourGuide, TS

Index for Viewpoint node: TourGuide
-->
X3D Tooltips element index: Appearance, Box, Cone, Cylinder, Group, head, Material, meta, OrientationInterpolator, PositionInterpolator, ProximitySensor, ROUTE, Scene, Shape, Sphere, TimeSensor, TouchSensor, Transform, Viewpoint, WorldInfo, X3D, accessType and type, XML data types, field types

Event Graph ROUTE Table entries with 7 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.

StartTour
TouchSensor
touchTime
SFTime

ROUTE
event to
(1)
TS
TimeSensor
startTime
SFTime
then
 
 
 
TS
TimeSensor
fraction_changed
SFFloat

ROUTE
event to
(2)
GuidePI
PositionInterpolator
set_fraction
SFFloat
then
 
 
 
GuidePI
PositionInterpolator
value_changed
SFVec3f

ROUTE
event to
(3)
GuideTransform
Transform
translation
SFVec3f
  then
 
 
 
TS
TimeSensor
fraction_changed
SFFloat

ROUTE
event to
(2)
GuideRI
OrientationInterpolator
set_fraction
SFFloat
then
 
 
 
GuideRI
OrientationInterpolator
value_changed
SFRotation

ROUTE
event to
(3)
GuideTransform
Transform
rotation
SFRotation
  then
 
 
 
TS
TimeSensor
isActive
SFBool

ROUTE
event to
(2)
TourGuide
Viewpoint
set_bind
SFBool

ProxSensor
ProximitySensor
isActive
SFBool

ROUTE
event to
(1)
StartTour
TouchSensor
enabled
SFBool
then
 
 
 
StartTour
TouchSensor
touchTime
SFTime

ROUTE
event to
(2)
TS
TimeSensor
startTime
SFTime
then
 
 
 
TS
TimeSensor
fraction_changed
SFFloat

ROUTE
event to
(3)
GuidePI
PositionInterpolator
set_fraction
SFFloat
then
 
 
 
GuidePI
PositionInterpolator
value_changed
SFVec3f

ROUTE
event to
(4)
GuideTransform
Transform
translation
SFVec3f
  then
 
 
 
TS
TimeSensor
fraction_changed
SFFloat

ROUTE
event to
(3)
GuideRI
OrientationInterpolator
set_fraction
SFFloat
then
 
 
 
GuideRI
OrientationInterpolator
value_changed
SFRotation

ROUTE
event to
(4)
GuideTransform
Transform
rotation
SFRotation
  then
 
 
 
TS
TimeSensor
isActive
SFBool

ROUTE
event to
(3)
TourGuide
Viewpoint
set_bind
SFBool
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/X3dSpecifications/GuidedTourIndex.html -->
<!-- Version control at
https://sourceforge.net/p/x3d/code/HEAD/tree/www.web3d.org/x3d/content/examples/Basic/X3dSpecifications/GuidedTour.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. -->