X3D Model Documentation: HeadsUpDisplayExample.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='titlecontent='HeadsUpDisplayExample.x3d'/>
  6            <meta name='descriptioncontent='Prototype definition that demonstrates use of a simple HeadsUpDisplay (HUD) prototype that maintains a stable position for its children on the screen.'/>
  7            <meta name='creatorcontent='Leonard Daly and Don Brutzman'/>
  8            <meta name='createdcontent='15 July 2006'/>
  9            <meta name='modifiedcontent='20 October 2019'/>
 10            <meta name='referencecontent='HeadsUpDisplayPrototype.x3d'/>
 11            <meta name='referencecontent='https://X3dGraphics.com'/>
 12            <meta name='referencecontent='https://www.web3d.org/x3d/content/examples/X3dResources.html'/>
 13            <meta name='rightscontent='Copyright 2006, Daly Realism and Don Brutzman'/>
 14            <meta name='subjectcontent='X3D book, X3D graphics, X3D-Edit, http://www.x3dGraphics.com'/>
 15            <meta name='identifiercontent='https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/HeadsUpDisplayExample.x3d'/>
 16            <meta name='generatorcontent='X3D-Edit 3.3, https://savage.nps.edu/X3D-Edit'/>
 17            <meta name='licensecontent='../license.html'/>
 18       </head>
<!--

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

<!-- to top Index for DEF nodes: HeadsUpDisplayInstance, SandyShallowBottom

Index for Viewpoint node: Viewpoint_1

Index for ExternProtoDeclare definition: HeadsUpDisplay
-->
 19       <Scene>
 20            <!-- Simple Heads-Up Display (HUD) Prototype\n \n Manages the display of a HUD and maintains its position on the screen.\n Changes to fieldOfView (in Viewpoint node) will change screen position\n \n Fields:\n hudSize Size of HUD (initializeOnly - SFVec3f) default="1 1 .01"\n hudColor Color of HUD (inputOutput - SFColor) default="1 1 1"\n screenOffset Offset of HUD. This field positions the HUD on the display screen (inputOutput - SFVec3f) default="0 0 0"\n hudGeometry Geometry to be placed on the HUD. Origin is center of HUD. (inputOutput - MFNode) default = []\n position_changed Current viewer location (outputOnly - SFVec3f)\n orientation_changed Current viewer orientation (outputOnly - SFRotation)\n \n \n -->
 21            <WorldInfo title='HeadsUpDisplayExample.x3d'/>
 22            <ExternProtoDeclare name='HeadsUpDisplayappinfo='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" '>
 23                 <field name='screenOffsettype='SFVec3faccessType='inputOutput'
                appinfo='offset position for HUD relative to current view location, default 0 0 -5'/>
 24                 <field name='childrentype='MFNodeaccessType='inputOutput'
                appinfo='X3D content positioned at HUD offset'/>
 25                 <field name='position_changedtype='SFVec3faccessType='outputOnly'
                appinfo='HUD position update (in world coordinates) relative to original location'/>
 26                 <field name='orientation_changedtype='SFRotationaccessType='outputOnly'
                appinfo='HUD orientation update relative to original location'/>
 27            </ExternProtoDeclare>
 28            <Background DEF='SandyShallowBottomgroundAngle='0.05 1.52 1.56 1.5707groundColor='0.2 0.2 0 0.3 0.3 0 0.5 0.5 0.3 0.1 0.3 0.4 0 0.2 0.4skyAngle='0.04 0.05 0.1 1.309 1.570skyColor='0.8 0.8 0.2 0.8 0.8 0.2 0.1 0.1 0.6 0.1 0.1 0.6 0.1 0.25 0.8 0.6 0.6 0.9'/>
 29            <Viewpoint description='Heads-up display (HUD)'/>
 30            <!-- ProtoDeclare is the "cookie cutter" template, ProtoInstance creates an actual occurrence -->
 31            <ProtoInstance name='HeadsUpDisplayDEF='HeadsUpDisplayInstance'>
 32                 <!-- example: upper left-hand corner of screen (x=-2, y=1) and set back z=-5 from user view -->
 33                 <fieldValue name='screenOffsetvalue='-0.75 1 -5'/>
 34                 <fieldValue name='children'>
 35                      <Shape>
 36                           <Text string='"HUD text stays fixed" "while user navigates"'>
 37                                <FontStyle justify='"MIDDLE" "MIDDLE"size='0.3'/>
 38                           </Text>
 39                           <Appearance>
 40                                <Material diffuseColor='0.894118 0.819608 1'/>
 41                           </Appearance>
 42                      </Shape>
 43                 </fieldValue>
 44            </ProtoInstance>
 45            <Inline   url=' "../HelloWorld.x3d" "https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/HelloWorld.x3d" "../HelloWorld.wrl" "https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/HelloWorld.wrl" '/>
 46       </Scene>
 47  </X3D>
<!--

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

<!-- to top Index for DEF nodes: HeadsUpDisplayInstance, SandyShallowBottom

Index for Viewpoint node: Viewpoint_1

Index for ExternProtoDeclare definition: HeadsUpDisplay
-->
X3D Tooltips element index: Appearance, Background, ExternProtoDeclare, field, fieldValue, FontStyle, head, Inline, Material, meta, ProtoInstance, Scene, Shape, Text, Viewpoint, WorldInfo, X3D, accessType and type, XML data types, 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.

HeadsUpDisplayInstance
ProtoInstance
HeadsUpDisplay
No ROUTE connection found for output events from this node.
This ProtoInstance contains SFNode/MFNode fieldValue declaration 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/HeadsUpDisplayExampleIndex.html -->
<!-- Version control at
https://sourceforge.net/p/x3d/code/HEAD/tree/www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/HeadsUpDisplayExample.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)
    <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. -->