X3D Model Documentation: HeadsUpDisplayPrototype.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='HeadsUpDisplayPrototype.x3d'/>
  6            <meta name='descriptioncontent='Reusable Prototype definition that applies a ProximitySensor for 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='HeadsUpDisplayExample.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/HeadsUpDisplayPrototype.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: HereIAm, HudContainer

Index for Viewpoint node: Viewpoint_1

Index for ProtoDeclare definition: HeadsUpDisplay
-->
 19       <Scene>
 20            <WorldInfo title='HeadsUpDisplayPrototype.x3d'/>
 21            <ProtoDeclare name='HeadsUpDisplayappinfo='Heads-up display (HUD) keeps child geometry aligned on screen in a consistent location'>
 22                 <ProtoInterface>
 23                      <field name='screenOffsettype='SFVec3fvalue='0 0 -5accessType='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                           <!-- initialization nodes (if any) go here -->
 26                      </field>
 27                      <field name='position_changedtype='SFVec3faccessType='outputOnly'
                     appinfo='HUD position update (in world coordinates) relative to original location'/>
 28                      <field name='orientation_changedtype='SFRotationaccessType='outputOnly'
                     appinfo='HUD orientation update relative to original location'/>
 29                 </ProtoInterface>
 30                 <ProtoBody>
 31                      <Group>
 32 
                         <!-- ROUTE information for HudContainer node:  [from HereIAm.orientation_changed to rotation ] [from HereIAm.position_changed to translation ] -->
                         <Transform DEF='HudContainer'>
 33                                <Transform>
 34                                     <IS>
 35                                          <connect nodeField='translationprotoField='screenOffset'/>
 36                                     </IS>
 37                                     <Group>
 38                                          <IS>
 39                                               <connect nodeField='childrenprotoField='children'/>
 40                                          </IS>
 41                                     </Group>
 42                                </Transform>
 43                           </Transform>
 44 
                         <!-- ROUTE information for HereIAm node:  [from orientation_changed to HudContainer.rotation ] [from position_changed to HudContainer.translation ] -->
                         <ProximitySensor DEF='HereIAmsize='10000000 10000000 10000000'>
 45                                <IS>
 46                                     <connect nodeField='position_changedprotoField='position_changed'/>
 47                                     <connect nodeField='orientation_changedprotoField='orientation_changed'/>
 48                                </IS>
 49                           </ProximitySensor>
 50                           < ROUTE  fromNode='HereIAm' fromField='orientation_changed' toNode='HudContainer' toField='rotation'/>
 51                           < ROUTE  fromNode='HereIAm' fromField='position_changed' toNode='HudContainer' toField='translation'/>
 52                      </Group>
 53                 </ProtoBody>
 54            </ProtoDeclare>
 55            <Viewpoint description='Heads-up display (HUD)'/>
 56            <!-- ProtoDeclare is the "cookie cutter" template, ProtoInstance creates an actual occurrence -->
 57            <!-- Example use is in separate scene -->
 58            <Anchor description='HeadsUpDisplay Exampleparameter='"target=_blank"'   url=' "HeadsUpDisplayExample.x3d" "https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/HeadsUpDisplayExample.x3d" "HeadsUpDisplayExample.wrl" "https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/HeadsUpDisplayExample.wrl" '>
 59                 <Shape>
 60                      <Appearance>
 61                           <Material diffuseColor='0.8 0.4 0'/>
 62                      </Appearance>
 63                      <Text string='"HeadsUpDisplayExample.x3d" "is a Prototype declaration file." "" "For an example scene using this node," "click this text and view" "HeadsUpDisplayExample.x3d"'>
 64                           <FontStyle justify='"MIDDLE" "MIDDLE"size='0.8'/>
 65                      </Text>
 66                 </Shape>
 67            </Anchor>
 68       </Scene>
 69  </X3D>
<!--

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

<!-- to top Index for DEF nodes: HereIAm, HudContainer

Index for Viewpoint node: Viewpoint_1

Index for ProtoDeclare definition: HeadsUpDisplay
-->
X3D Tooltips element index: Anchor, Appearance, connect, field, FontStyle, Group, head, IS, Material, meta, ProtoBody, ProtoDeclare, ProtoInterface, ProximitySensor, ROUTE, Scene, Shape, Text, Transform, Viewpoint, WorldInfo, X3D, accessType and type, XML data types, field types

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

HereIAm
ProximitySensor
orientation_changed
SFRotation

ROUTE
event to
(1)
HudContainer
Transform
rotation
SFRotation
HereIAm
ProximitySensor
position_changed
SFVec3f

ROUTE
event to
(1)
HudContainer
Transform
translation
SFVec3f


Anchor
description='HeadsUpDisplay Example' 
User-interaction hint for this node. 
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/HeadsUpDisplayPrototypeIndex.html -->
<!-- Version control at
https://sourceforge.net/p/x3d/code/HEAD/tree/www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter14Prototypes/HeadsUpDisplayPrototype.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)
    <ProtoDeclare name='ProtoName'> <field name='fieldName'/> </ProtoDeclare> -->

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