X3D Model Documentation: HudKelpForest.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='HudKelpForest.x3d'/>
  6            <meta name='description' content='Demonstrates use of a ProximitySensor in building a HUD, with display values showing current view location.'/>
  7            <meta name='creator' content='Leonard Daly and Don Brutzman'/>
  8            <meta name='created' content='15 July 2006'/>
  9            <meta name='modified' content='20 October 2019'/>
 10            <meta name='Image' content='HudKelpForestScreenshot.png'/>
 11            <meta name='reference' content='https://X3dGraphics.com'/>
 12            <meta name='reference' content='https://www.web3d.org/x3d/content/examples/X3dResources.html'/>
 13            <meta name='rights' content='Copyright 2006, Daly Realism and Don Brutzman'/>
 14            <meta name='subject' content='X3D book, X3D graphics, X3D-Edit, http://www.x3dGraphics.com'/>
 15            <meta name='identifier' content='https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/HudKelpForest.x3d'/>
 16            <meta name='generator' content='X3D-Edit 3.3, https://savage.nps.edu/X3D-Edit'/>
 17            <meta name='license' content='../license.html'/>
 18       </head>
<!--
<!--
Event Graph ROUTE Table shows event connections.
-->
<!-- to top Index for DEF nodes: BottomLabel, BottomLine, ConvertValueScript, HeadsUpDisplayInstance, HudContent, TopLabel, TopLine

Index for ExternProtoDeclare definitions: HeadsUpDisplay, TextString
-->
 19       <Scene>
 20            <WorldInfo title='HudKelpForest.x3d'/>
 21            <ExternProtoDeclare name='HeadsUpDisplay' appinfo='Heads-up display (HUD) keeps child geometry aligned on screen in a consistent location'   url=' "HeadsUpDisplayPrototype.x3d#HeadsUpDisplay" "https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/HeadsUpDisplayPrototype.x3d#HeadsUpDisplay" "HeadsUpDisplayPrototype.wrl#HeadsUpDisplay" "https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/HeadsUpDisplayPrototype.wrl#HeadsUpDisplay" '>
 22                 <field name='screenOffset' type='SFVec3f' accessType='inputOutput'
                appinfo='offset position for HUD relative to current view location, default 0 0 -5'/>
 23                 <field name='children' type='MFNode' accessType='inputOutput'
                appinfo='X3D content positioned at HUD offset'/>
 24                 <field name='position_changed' type='SFVec3f' accessType='outputOnly'
                appinfo='HUD position update (in world coordinates) relative to original location'/>
 25                 <field name='orientation_changed' type='SFRotation' accessType='outputOnly'
                appinfo='HUD orientation update relative to original location'/>
 26            </ExternProtoDeclare>
 27            <ExternProtoDeclare name='TextString'   url=' "TextStringPrototype.x3d#TextString" "https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/TextStringPrototype.x3d#TextString" "TextStringPrototype.wrl#TextString" "https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/TextStringPrototype.wrl#TextString" '>
 28                 <field name='offset' type='SFVec3f' accessType='inputOutput'/>
 29                 <field name='string' type='MFString' accessType='inputOutput'/>
 30                 <field name='color' type='SFColor' accessType='inputOutput'/>
 31                 <field name='size' type='SFFloat' accessType='initializeOnly'/>
 32                 <field name='justify' type='MFString' accessType='initializeOnly'/>
 33                 <field name='style' type='SFString' accessType='initializeOnly'/>
 34                 <field name='family' type='MFString' accessType='initializeOnly'/>
 35            </ExternProtoDeclare>
 36            <Background groundAngle='1.309 1.5707' groundColor='0.1 0.1 0 0.4 0.25 0.2 0.6 0.6 0.6' skyAngle='1.309 1.5707' skyColor='0 0.5 1 0 0 1 0 0 1'   backUrl=' "urn:web3d:media:textures/panoramas/horizon_3_back.jpg" "horizon_3_back.jpg " "../../Basic/UniversalMediaPanoramas/horizon_3_back.jpg " "https://www.web3d.org/WorkingGroups/media/textures/panoramas/horizon_3_back.jpg " "https://www.web3d.org/x3d/content/examples/UniversalMediaPanoramas/horizon_3_back.jpg " "http://www.web3dmedia.com/UniversalMedia/textures/panoramas/horizon_3_back.jpg " "http://www.officetowers.com/UniversalMedia/textures/panoramas/horizon_3_back.jpg " "http://geometrek.com/UniversalMedia/textures/panoramas/horizon_3_back.jpg " "http://www.sc.ehu.es/ccwgamoa/UniversalMedia/textures/panoramas/horizon_3_back.jpg " '   bottomUrl=' "urn:web3d:media:textures/panoramas/horizon_3_bottom.jpg" "horizon_3_bottom.jpg " "../../Basic/UniversalMediaPanoramas/horizon_3_bottom.jpg " "https://www.web3d.org/WorkingGroups/media/textures/panoramas/horizon_3_bottom.jpg " "https://www.web3d.org/x3d/content/examples/UniversalMediaPanoramas/horizon_3_bottom.jpg " "http://www.web3dmedia.com/UniversalMedia/textures/panoramas/horizon_3_bottom.jpg " "http://www.officetowers.com/UniversalMedia/textures/panoramas/horizon_3_bottom.jpg " "http://geometrek.com/UniversalMedia/textures/panoramas/horizon_3_bottom.jpg " "http://www.sc.ehu.es/ccwgamoa/UniversalMedia/textures/panoramas/horizon_3_bottom.jpg " '   frontUrl=' "urn:web3d:media:textures/panoramas/horizon_3_front.jpg" "horizon_3_front.jpg " "../../Basic/UniversalMediaPanoramas/horizon_3_front.jpg " "https://www.web3d.org/WorkingGroups/media/textures/panoramas/horizon_3_front.jpg " "https://www.web3d.org/x3d/content/examples/UniversalMediaPanoramas/horizon_3_front.jpg " "http://www.web3dmedia.com/UniversalMedia/textures/panoramas/horizon_3_front.jpg " "http://www.officetowers.com/UniversalMedia/textures/panoramas/horizon_3_front.jpg " "http://geometrek.com/UniversalMedia/textures/panoramas/horizon_3_front.jpg " "http://www.sc.ehu.es/ccwgamoa/UniversalMedia/textures/panoramas/horizon_3_front.jpg " '   leftUrl=' "urn:web3d:media:textures/panoramas/horizon_3_left.jpg" "horizon_3_left.jpg " "../../Basic/UniversalMediaPanoramas/horizon_3_left.jpg " "https://www.web3d.org/WorkingGroups/media/textures/panoramas/horizon_3_left.jpg " "https://www.web3d.org/x3d/content/examples/UniversalMediaPanoramas/horizon_3_left.jpg " "http://www.web3dmedia.com/UniversalMedia/textures/panoramas/horizon_3_left.jpg " "http://www.officetowers.com/UniversalMedia/textures/panoramas/horizon_3_left.jpg " "http://geometrek.com/UniversalMedia/textures/panoramas/horizon_3_left.jpg " "http://www.sc.ehu.es/ccwgamoa/UniversalMedia/textures/panoramas/horizon_3_left.jpg " '   rightUrl=' "urn:web3d:media:textures/panoramas/horizon_3_right.jpg" "horizon_3_right.jpg " "../../Basic/UniversalMediaPanoramas/horizon_3_right.jpg " "https://www.web3d.org/WorkingGroups/media/textures/panoramas/horizon_3_right.jpg " "https://www.web3d.org/x3d/content/examples/UniversalMediaPanoramas/horizon_3_right.jpg " "http://www.web3dmedia.com/UniversalMedia/textures/panoramas/horizon_3_right.jpg " "http://www.officetowers.com/UniversalMedia/textures/panoramas/horizon_3_right.jpg " "http://geometrek.com/UniversalMedia/textures/panoramas/horizon_3_right.jpg " "http://www.sc.ehu.es/ccwgamoa/UniversalMedia/textures/panoramas/horizon_3_right.jpg " '   topUrl=' "urn:web3d:media:textures/panoramas/horizon_3_top.jpg" "horizon_3_top.jpg " "../../Basic/UniversalMediaPanoramas/horizon_3_top.jpg " "https://www.web3d.org/WorkingGroups/media/textures/panoramas/horizon_3_top.jpg " "https://www.web3d.org/x3d/content/examples/UniversalMediaPanoramas/horizon_3_top.jpg " "http://www.web3dmedia.com/UniversalMedia/textures/panoramas/horizon_3_top.jpg " "http://www.officetowers.com/UniversalMedia/textures/panoramas/horizon_3_top.jpg " "http://geometrek.com/UniversalMedia/textures/panoramas/horizon_3_top.jpg " "http://www.sc.ehu.es/ccwgamoa/UniversalMedia/textures/panoramas/horizon_3_top.jpg " '/>
 37            <Switch whichChoice='-1'>
 38 
               <!-- Transform HudContent is a DEF node that has 1 USE node: USE_1 -->
                <Transform DEF='HudContent' translation='-0.5 -0.5 .1'>
 39                      <ProtoInstance name='TextString' DEF='TopLabel'>
 40                           <fieldValue name='offset' value='-0.07 -.2 0'/>
 41                           <fieldValue name='string' value='"Position: "'/>
 42                           <fieldValue name='color' value='0 0 0'/>
 43                           <fieldValue name='size' value='.1'/>
 44                      </ProtoInstance>
 45                      <ProtoInstance name='TextString' DEF='BottomLabel'>
 46                           <fieldValue name='offset' value='-0.13 -.3 0'/>
 47                           <fieldValue name='string' value='"Orientation: "'/>
 48                           <fieldValue name='color' value='0 0 0'/>
 49                           <fieldValue name='size' value='.1'/>
 50                      </ProtoInstance>
 51 
                    <!-- ROUTE information for TopLine node:  [from ConvertValueScript.sfVec3fString to string ] -->
                     <ProtoInstance name='TextString' DEF='TopLine'>
 52                           <fieldValue name='offset' value='.5 -.2 0'/>
 53                           <fieldValue name='string' value='""'/>
 54                           <fieldValue name='color' value='0 0 1'/>
 55                           <fieldValue name='size' value='.1'/>
 56                      </ProtoInstance>
 57 
                    <!-- ROUTE information for BottomLine node:  [from ConvertValueScript.sfRotationString to string ] -->
                     <ProtoInstance name='TextString' DEF='BottomLine'>
 58                           <fieldValue name='offset' value='.5 -.3 0'/>
 59                           <fieldValue name='string' value='"0 1 0 0"'/>
 60                           <fieldValue name='color' value='0.1 .7 0.1'/>
 61                           <fieldValue name='size' value='.1'/>
 62                      </ProtoInstance>
 63                      <Transform translation='0.27 -0.25 -0.1'>
 64                           <Shape>
 65                                <Box size='1.4 0.25 0.01'/>
 66                                <Appearance>
 67                                     <Material diffuseColor='0.9 0.9 0.9' transparency='0.5'/>
 68                                </Appearance>
 69                           </Shape>
 70                      </Transform>
 71                 </Transform>
 72            </Switch>
 73 
          <!-- ROUTE information for HeadsUpDisplayInstance node:  [from position_changed to ConvertValueScript.sfVec3f ] [from orientation_changed to ConvertValueScript.sfRotation ] -->
           <ProtoInstance name='HeadsUpDisplay' DEF='HeadsUpDisplayInstance'>
 74                 <fieldValue name='screenOffset' value='0.2 0.5 -2'/>
 75                 <fieldValue name='children'>
 76                      <Transform USE='HudContent'/>
 77                 </fieldValue>
 78            </ProtoInstance>
 79 
          <!-- ROUTE information for ConvertValueScript node:  [from HeadsUpDisplayInstance.position_changed to sfVec3f ] [from HeadsUpDisplayInstance.orientation_changed to sfRotation ] [from sfVec3fString to TopLine.string ] [from sfRotationString to BottomLine.string ] -->
           <Script DEF='ConvertValueScript'   url=' "HudKelpForestScriptConvert.js" "https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/HudKelpForestScriptConvert.js" '>
 80                 <field name='sfVec3f' type='SFVec3f' accessType='inputOnly'/>
 81                 <field name='sfRotation' type='SFRotation' accessType='inputOnly'/>
 82                 <field name='sfVec3fString' type='MFString' accessType='outputOnly'/>
 83                 <field name='sfRotationString' type='MFString' accessType='outputOnly'/>
 84            </Script>
 85            < ROUTE  fromNode='HeadsUpDisplayInstance' fromField='position_changed' toNode='ConvertValueScript' toField='sfVec3f'/>
 86            < ROUTE  fromNode='HeadsUpDisplayInstance' fromField='orientation_changed' toNode='ConvertValueScript' toField='sfRotation'/>
 87            < ROUTE  fromNode='ConvertValueScript' fromField='sfVec3fString' toNode='TopLine' toField='string'/>
 88            < ROUTE  fromNode='ConvertValueScript' fromField='sfRotationString' toNode='BottomLine' toField='string'/>
 89            <Inline   url=' "../KelpForestExhibit/KelpForestMain.x3d" "https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/KelpForestExhibit/KelpForestMain.x3d" "../KelpForestExhibit//KelpForestMain.wrl" "https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/KelpForestExhibit/KelpForestMain.wrl" '/>
 90       </Scene>
 91  </X3D>
<!--
<!--
Event Graph ROUTE Table shows event connections.
-->
<!-- to top Index for DEF nodes: BottomLabel, BottomLine, ConvertValueScript, HeadsUpDisplayInstance, HudContent, TopLabel, TopLine

Index for ExternProtoDeclare definitions: HeadsUpDisplay, TextString
-->
X3D Tooltips element index: Appearance, Background, Box, ExternProtoDeclare, field, fieldValue, head, Inline, Material, meta, ProtoInstance, ROUTE, Scene, Script, Shape, Switch, Transform, WorldInfo, X3D, plus documentation for accessType definitions, type definitions, XML data types, and field types

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

BottomLabel
ProtoInstance
TextString 		No ROUTE connection found for output events from this node.
This ProtoInstance contains SFNode/MFNode fieldValue declarations with
direct access to other nodes, and thus has potential to produce run-time animation. 

      BottomLine
ProtoInstance
TextString 		No ROUTE connection found for output events from this node.
This ProtoInstance contains SFNode/MFNode fieldValue declarations with
direct access to other nodes, and thus has potential to produce run-time animation. 

HeadsUpDisplayInstance
ProtoInstance
position_changed
SFVec3f
→
ROUTE
event to
(1)
ConvertValueScript
Script
sfVec3f
SFVec3f 		then
 
 
  		ConvertValueScript
Script
sfRotationString
MFString
→
ROUTE
event to
(2)
BottomLine
ProtoInstance
string
MFString
  then
 
 
  		ConvertValueScript
Script
sfVec3fString
MFString
→
ROUTE
event to
(2)
TopLine
ProtoInstance
string
MFString
HeadsUpDisplayInstance
ProtoInstance
orientation_changed
SFRotation
→
ROUTE
event to
(1)
ConvertValueScript
Script
sfRotation
SFRotation 		then
 
 
  		ConvertValueScript
Script
sfRotationString
MFString
→
ROUTE
event to
(2)
BottomLine
ProtoInstance
string
MFString
  then
 
 
  		ConvertValueScript
Script
sfVec3fString
MFString
→
ROUTE
event to
(2)
TopLine
ProtoInstance
string
MFString

TopLabel
ProtoInstance
TextString 		No ROUTE connection found for output events from this node.
This ProtoInstance contains SFNode/MFNode fieldValue declarations with
direct access to other nodes, and thus has potential to produce run-time animation. 

      TopLine
ProtoInstance
TextString 		No ROUTE connection found for output events from this node.
This ProtoInstance contains SFNode/MFNode fieldValue declarations with
direct access to other nodes, and thus has potential to produce run-time animation. 

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/X3dForWebAuthors/Chapter14Prototypes/HudKelpForestIndex.html -->
<!-- Version control at
https://sourceforge.net/p/x3d/code/HEAD/tree/www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/HudKelpForest.x3d -->

<!-- Color-coding 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)
    <ProtoInstance name='ProtoName'> <field name='fieldName'/> </ProtoInstance> -->

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