X3D Model Documentation: HeadsUpDisplayExample.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='title' content=' HeadsUpDisplayExample.x3d '/>
  6            <meta name='description' content='Generic Heads Up Display (HUD) prototype to keep children on screen.'/>
  7            <meta name='creator' content='Don Brutzman'/>
  8            <meta name='created' content='9 November 2003'/>
  9            <meta name='modified' content='28 November 2019'/>
 10            <meta name='subject' content='HUD Heads Up Display'/>
 11            <meta name='identifier' content=' https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/HeadsUpDisplayExample.x3d '/>
 12            <meta name='generator' content='X3D-Edit 3.2, https://www.web3d.org/x3d/tools/X3D-Edit'/>
 13            <meta name='license' content='../../license.html'/>
 14       </head>
<!--
<!--
Event Graph ROUTE Table shows event connections.
-->
<!-- to top DEF node index: HelloWorld

Index for ExternProtoDeclare definitions: HeadsUpDisplay, ViewPositionOrientation
-->
 15       <Scene>
 16            <WorldInfo title='HeadsUpDisplayExample.x3d'/>
 17            <ExternProtoDeclare name='HeadsUpDisplay' appinfo='HeadsUpDisplay positions child geometry in screen space, movable by the user'   url=' "../../../X3dForWebAuthors/Chapter14Prototypes/HeadsUpDisplayPrototype.x3d#HeadsUpDisplay" "https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/HeadsUpDisplayPrototype.x3d#HeadsUpDisplay" "../../../X3dForWebAuthors/Chapter14Prototypes/HeadsUpDisplayPrototype.wrl#HeadsUpDisplay" "https://www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/HeadsUpDisplayPrototype.wrl#HeadsUpDisplay" '>
 18                 <field name='children' type='MFNode' accessType='inputOutput'
                appinfo='Displayed subscene positioned as a HUD.'/>
 19                 <field name='dragChildren' type='MFNode' accessType='inputOutput'
                appinfo='Additional HUD geometry which can be touched and dragged for repositioning. If this geometry goes offscreen (perhaps due to screen resizing) then it snaps back to original position.'/>
 20                 <field name='locationOffset' type='SFVec3f' accessType='initializeOnly'
                appinfo='Modified screen location and distance (for size).'/>
 21                 <field name='traceEnabled' type='SFBool' accessType='initializeOnly'
                appinfo='Enable/disable console output for troubleshooting.'/>
 22            </ExternProtoDeclare>
 23            <ExternProtoDeclare name='ViewPositionOrientation' appinfo='ViewPositionOrientation provides provides console output of local position and orientation as user navigates'   url=' "../../Tools/Authoring/ViewPositionOrientationPrototype.x3d#ViewPositionOrientation" "https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/ViewPositionOrientationPrototype.x3d#ViewPositionOrientation" "../../Tools/Authoring/ViewPositionOrientationPrototype.wrl#ViewPositionOrientation" "https://www.web3d.org/x3d/content/examples/Savage/Tools/Authoring/ViewPositionOrientationPrototype.wrl#ViewPositionOrientation" '>
 24                 <field name='enabled' type='SFBool' accessType='inputOutput'
                appinfo='Whether or not ViewPositionOrientation sends output to console.'/>
 25                 <field name='traceEnabled' type='SFBool' accessType='initializeOnly'
                appinfo='Output internal trace messages for debugging this node - developer use only can be ignored.'/>
 26                 <field name='set_traceEnabled' type='SFBool' accessType='inputOnly'
                appinfo='Ability to turn output tracing on/off at runtime.'/>
 27                 <field name='position_changed' type='SFVec3f' accessType='outputOnly'
                appinfo='Output local position.'/>
 28                 <field name='orientation_changed' type='SFRotation' accessType='outputOnly'
                appinfo='Output local orientation.'/>
 29                 <field name='outputViewpointString' type='MFString' accessType='outputOnly'
                appinfo='MFString value of new Viewpoint'/>
 30            </ExternProtoDeclare>
 31            <!-- ==================== -->
 32            <Inline DEF='HelloWorld'   url=' "../../../HelloWorld.x3d" "https://www.web3d.org/x3d/content/examples/Basic/HelloWorld.x3d" "../../../HelloWorld.wrl" "https://www.web3d.org/x3d/content/examples/Basic/HelloWorld.wrl" '/>
 33            <ProtoInstance name='HeadsUpDisplay'>
 34                 <fieldValue name='children'>
 35                      <Shape>
 36                           <Appearance>
 37                                <Material diffuseColor='0 1 1' emissiveColor='0 1 1'/>
 38                           </Appearance>
 39                           <Text string='"HUD text"'>
 40                                <FontStyle justify='"MIDDLE" "MIDDLE"' size='0.8'/>
 41                           </Text>
 42                      </Shape>
 43                 </fieldValue>
 44                 <fieldValue name='dragChildren'>
 45                      <Transform translation='0 0 -0.2'>
 46                           <Shape>
 47                                <Box size='4 2 0.001'/>
 48                                <Appearance>
 49                                     <Material diffuseColor='1 1 1' transparency='0.9'/>
 50                                </Appearance>
 51                           </Shape>
 52                      </Transform>
 53                 </fieldValue>
 54                 <fieldValue name='locationOffset' value='-4 -2 0'/>
 55            </ProtoInstance>
 56       </Scene>
 57  </X3D>
<!--
<!--
Event Graph ROUTE Table shows event connections.
-->
<!-- to top DEF node index: HelloWorld

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

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

line 33
ProtoInstance
HeadsUpDisplay 		No direct ROUTE connection found for events to/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/Savage/Tools/HeadsUpDisplays/HeadsUpDisplayExampleIndex.html -->
<!-- Version control at
https://sourceforge.net/p/x3d/code/HEAD/tree/www.web3d.org/x3d/content/examples/Savage/Tools/HeadsUpDisplays/HeadsUpDisplayExample.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. -->