X3D Model Documentation: AriesEspduPrototype.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            <component level='1name='DIS'/>
  6            <meta name='titlecontent='AriesEspduPrototype.x3d'/>
  7            <meta name='descriptioncontent='Prototype for a DIS enabled (including articulated parameters) for inclusion in a VRML Scene. Articulation parameters are in AUV Dynamics (AUV Workbench) order.'/>
  8            <meta name='creatorcontent='Duane Davis'/>
  9            <meta name='translatorcontent='Vrml97ToX3dNist'/>
 10            <meta name='createdcontent='15 November 2003'/>
 11            <meta name='modifiedcontent='20 October 2019'/>
 12            <meta name='subjectcontent='Distributed Interactive Simulation DIS ESPDU Aries AUV'/>
 13            <meta name='identifiercontent='https://www.web3d.org/x3d/content/examples/Basic/DistributedInteractiveSimulation/AriesEspduPrototype.x3d'/>
 14            <meta name='generatorcontent='Vrml97ToX3dNist, http://ovrt.nist.gov/v2_x3d.html'/>
 15            <meta name='licensecontent='../license.html'/>
 16       </head>
<!--

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

<!-- to top Index for DEF nodes: AriesAUV, ArticulationParameterControl, ET

Index for ExternProtoDeclare definition: Aries

Index for ProtoDeclare definition: AriesEspdu
-->
 17       <Scene>
 18            <WorldInfo title='AriesEspduPrototype.x3d'/>
 19            <ExternProtoDeclare name='Ariesappinfo='Acoustic Radio Interactive Exploratory Server (ARIES) is an operational NPS-designed Unmanned Underwater Vehicle (AUV)'   url=' "../../Savage/Robots/UnmannedUnderwaterVehicles/AriesPrototype.x3d#Aries" "https://savage.nps.edu/Savage/Robots/UnmannedUnderwaterVehicles/AriesPrototype.x3d#Aries" "../../Savage/Robots/UnmannedUnderwaterVehicles/AriesPrototype.wrl#Aries" "https://savage.nps.edu/Savage/Robots/UnmannedUnderwaterVehicles/AriesPrototype.wrl#Aries" '>
 20                 <field name='translationtype='SFVec3faccessType='inputOutput'/>
 21                 <field name='rotationtype='SFRotationaccessType='inputOutput'/>
 22                 <field name='portRpmtype='SFFloataccessType='inputOnly'/>
 23                 <field name='stbdRpmtype='SFFloataccessType='inputOnly'/>
 24                 <field name='forwardRudderstype='SFFloataccessType='inputOnly'/>
 25                 <field name='afterRudderstype='SFFloataccessType='inputOnly'/>
 26                 <field name='forwardPlanestype='SFFloataccessType='inputOnly'/>
 27                 <field name='afterPlanestype='SFFloataccessType='inputOnly'/>
 28                 <field name='forwardVerticalThrustertype='SFFloataccessType='inputOnly'/>
 29                 <field name='afterVerticalThrustertype='SFFloataccessType='inputOnly'/>
 30                 <field name='forwardLateralThrustertype='SFFloataccessType='inputOnly'/>
 31                 <field name='afterLateralThrustertype='SFFloataccessType='inputOnly'/>
 32                 <field name='ST725Rangetype='SFFloataccessType='inputOnly'/>
 33                 <field name='ST1000Rangetype='SFFloataccessType='inputOnly'/>
 34                 <field name='ST725Bearingtype='SFFloataccessType='inputOnly'/>
 35                 <field name='ST1000Bearingtype='SFFloataccessType='inputOnly'/>
 36                 <field name='ST725Intensitytype='SFFloataccessType='inputOnly'/>
 37                 <field name='ST1000Intensitytype='SFFloataccessType='inputOnly'/>
 38                 <field name='hullColortype='SFColoraccessType='inputOutput'
                appinfo='hull color for this UUV instance'/>
 39                 <field name='hullNametype='SFStringaccessType='inputOutput'
                appinfo='can be overridden at instantiation time only'/>
 40                 <field name='set_ST725Intensitytype='SFFloataccessType='inputOnly'
                appinfo='signal-to-noise ratio decibels'/>
 41                 <field name='set_forwardLateralThrustertype='SFFloataccessType='inputOnly'/>
 42                 <field name='set_ST1000Bearingtype='SFFloataccessType='inputOnly'
                appinfo='degrees about vertical axis'/>
 43                 <field name='set_forwardVerticalThrustertype='SFFloataccessType='inputOnly'/>
 44                 <field name='set_afterVerticalThrustertype='SFFloataccessType='inputOnly'/>
 45                 <field name='set_afterRudderstype='SFFloataccessType='inputOnly'/>
 46                 <field name='set_ST1000Intensitytype='SFFloataccessType='inputOnly'
                appinfo='signal-to-noise ratio decibels'/>
 47                 <field name='set_forwardPlanestype='SFFloataccessType='inputOnly'/>
 48                 <field name='set_ST725Rangetype='SFFloataccessType='inputOnly'
                appinfo='meters along sonar axis'/>
 49                 <field name='set_ST725Bearingtype='SFFloataccessType='inputOnly'
                appinfo='degrees about vertical axis'/>
 50                 <field name='set_afterLateralThrustertype='SFFloataccessType='inputOnly'/>
 51                 <field name='set_ST1000Rangetype='SFFloataccessType='inputOnly'
                appinfo='meters along sonar axis'/>
 52                 <field name='set_stbdRpmtype='SFFloataccessType='inputOnly'/>
 53                 <field name='set_forwardRudderstype='SFFloataccessType='inputOnly'/>
 54                 <field name='set_portRpmtype='SFFloataccessType='inputOnly'/>
 55                 <field name='planeColortype='SFColoraccessType='inputOutput'
                appinfo='plane color for this UUV instance'/>
 56                 <field name='set_afterPlanestype='SFFloataccessType='inputOnly'/>
 57            </ExternProtoDeclare>
 58            <ProtoDeclare name='AriesEspdu'>
 59                 <ProtoInterface>
 60                      <field name='markingtype='SFStringvalue='AriesAUVaccessType='inputOutput'/>
 61                      <field name='siteIDtype='SFInt32value='0accessType='inputOutput'/>
 62                      <field name='applicationIDtype='SFInt32value='1accessType='inputOutput'/>
 63                      <field name='entityIDtype='SFInt32value='2accessType='inputOutput'/>
 64                      <field name='readIntervaltype='SFTimevalue='0.1accessType='inputOutput'/>
 65                      <field name='writeIntervaltype='SFTimevalue='1.0accessType='inputOutput'/>
 66                      <field name='networkModetype='SFStringvalue='standAloneaccessType='inputOutput'/>
 67                      <field name='addresstype='SFStringvalue='224.2.181.145accessType='inputOutput'/>
 68                      <field name='porttype='SFInt32value='62040accessType='inputOutput'/>
 69                      <field name='translationtype='SFVec3fvalue='0 0 0accessType='inputOutput'/>
 70                      <field name='rotationtype='SFRotationvalue='0 0 1 0accessType='inputOutput'/>
 71                 </ProtoInterface>
 72                 <ProtoBody>
 73                      <!-- ============================= -->
 74 
                    <!-- ROUTE information for ET node:  [from articulationParameterArray to ArticulationParameterControl.set_articulationParameters ] -->
                    <EspduTransform DEF='ETcontainerField='children'>
 75                           <IS>
 76                                <connect nodeField='markingprotoField='marking'/>
 77                                <connect nodeField='siteIDprotoField='siteID'/>
 78                                <connect nodeField='applicationIDprotoField='applicationID'/>
 79                                <connect nodeField='entityIDprotoField='entityID'/>
 80                                <connect nodeField='readIntervalprotoField='readInterval'/>
 81                                <connect nodeField='writeIntervalprotoField='writeInterval'/>
 82                                <connect nodeField='networkModeprotoField='networkMode'/>
 83                                <connect nodeField='addressprotoField='address'/>
 84                                <connect nodeField='portprotoField='port'/>
 85                                <connect nodeField='translationprotoField='translation'/>
 86                                <connect nodeField='rotationprotoField='rotation'/>
 87                           </IS>
 88                           <!-- applet 0 1 2, auv dynamics 36 1 1 -->
 89                           <Switch whichChoice='0'>
 90 
 91                                     <fieldValue name='hullColorvalue='.9 .9 .9'/>
 92                                     <fieldValue name='hullNamevalue='Aries AUV'/>
 93                                </ProtoInstance>
 94                           </Switch>
 95                           <Group>
 96 
 97                                     <field name='set_articulationParameterstype='MFFloataccessType='inputOnly'/>
 98                                     <field name='portRpmtype='SFFloataccessType='outputOnly'/>
 99                                     <field name='stbdRpmtype='SFFloataccessType='outputOnly'/>
100                                     <field name='forwardVerticalThrustertype='SFFloataccessType='outputOnly'/>
101                                     <field name='afterVerticalThrustertype='SFFloataccessType='outputOnly'/>
102                                     <field name='forwardLateralThrustertype='SFFloataccessType='outputOnly'/>
103                                     <field name='afterLateralThrustertype='SFFloataccessType='outputOnly'/>
104                                     <field name='forwardRudderstype='SFFloataccessType='outputOnly'/>
105                                     <field name='afterRudderstype='SFFloataccessType='outputOnly'/>
106                                     <field name='forwardPlanestype='SFFloataccessType='outputOnly'/>
107                                     <field name='afterPlanestype='SFFloataccessType='outputOnly'/>
108                                     <field name='ST725Rangetype='SFFloataccessType='outputOnly'/>
109                                     <field name='ST725Bearingtype='SFFloataccessType='outputOnly'/>
110                                     <field name='ST1000Rangetype='SFFloataccessType='outputOnly'/>
111                                     <field name='ST1000Bearingtype='SFFloataccessType='outputOnly'/>
  <![CDATA[
              
ecmascript:

function initialize()
{
   portRpm                 = 0;
   stbdRpm                 = 0;
   forwardVerticalThruster = 0;
   afterVerticalThruster   = 0;
   forwardLateralThruster  = 0;
   afterLateralThruster    = 0;
   forwardRudders          = 0;
   afterRudders            = 0;
   forwardPlanes           = 0;
   afterPlanes             = 0;
   ST725Range              = 30;
   ST725Bearing            = 0;
   ST1000Range             = 30;
   ST1000Bearing           = 0;
}

function set_articulationParameters( value, timestamp )
{
   // TODO:  what about value[0] ?
   portRpm                 = value[1];
   stbdRpm                 = value[2];
   forwardRudders          = value[3];
   afterRudders            = value[4];
   forwardPlanes           = value[5];
   afterPlanes             = value[6];
   forwardVerticalThruster = value[7];
   afterVerticalThruster   = value[8];
   forwardLateralThruster  = value[9];
   afterLateralThruster    = value[10];
   ST725Range              = value[11];
   ST725Bearing            = value[12];
   ST1000Range             = value[13];
   ST1000Bearing           = value[14];
}

            
]]>
113                                </Script>
114                                < ROUTE  fromNode='ET' fromField='articulationParameterArray' toNode='ArticulationParameterControl' toField='set_articulationParameters'/>
115                                < ROUTE  fromNode='ArticulationParameterControl' fromField='portRpm' toNode='AriesAUV' toField='portRpm'/>
116                                < ROUTE  fromNode='ArticulationParameterControl' fromField='stbdRpm' toNode='AriesAUV' toField='stbdRpm'/>
117                                < ROUTE  fromNode='ArticulationParameterControl' fromField='forwardVerticalThruster' toNode='AriesAUV' toField='forwardVerticalThruster'/>
118                                < ROUTE  fromNode='ArticulationParameterControl' fromField='afterVerticalThruster' toNode='AriesAUV' toField='afterVerticalThruster'/>
119                                < ROUTE  fromNode='ArticulationParameterControl' fromField='forwardLateralThruster' toNode='AriesAUV' toField='forwardLateralThruster'/>
120                                < ROUTE  fromNode='ArticulationParameterControl' fromField='afterLateralThruster' toNode='AriesAUV' toField='afterLateralThruster'/>
121                                < ROUTE  fromNode='ArticulationParameterControl' fromField='forwardRudders' toNode='AriesAUV' toField='forwardRudders'/>
122                                < ROUTE  fromNode='ArticulationParameterControl' fromField='afterRudders' toNode='AriesAUV' toField='afterRudders'/>
123                                < ROUTE  fromNode='ArticulationParameterControl' fromField='forwardPlanes' toNode='AriesAUV' toField='forwardPlanes'/>
124                                < ROUTE  fromNode='ArticulationParameterControl' fromField='afterPlanes' toNode='AriesAUV' toField='afterPlanes'/>
125                                < ROUTE  fromNode='ArticulationParameterControl' fromField='ST725Range' toNode='AriesAUV' toField='ST725Range'/>
126                                < ROUTE  fromNode='ArticulationParameterControl' fromField='ST725Bearing' toNode='AriesAUV' toField='ST725Bearing'/>
127                                < ROUTE  fromNode='ArticulationParameterControl' fromField='ST1000Range' toNode='AriesAUV' toField='ST1000Range'/>
128                                < ROUTE  fromNode='ArticulationParameterControl' fromField='ST1000Bearing' toNode='AriesAUV' toField='ST1000Bearing'/>
129                           </Group>
130                      </EspduTransform>
131                 </ProtoBody>
132            </ProtoDeclare>
133            <Group>
134                 <ProtoInstance name='AriesEspdu'>
135                      <fieldValue name='networkModevalue='networkReader'/>
136                 </ProtoInstance>
137            </Group>
138       </Scene>
139  </X3D>
<!--

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

<!-- to top Index for DEF nodes: AriesAUV, ArticulationParameterControl, ET

Index for ExternProtoDeclare definition: Aries

Index for ProtoDeclare definition: AriesEspdu
-->
X3D Tooltips element index: component, connect, EspduTransform, ExternProtoDeclare, field, fieldValue, Group, head, IS, meta, ProtoBody, ProtoDeclare, ProtoInstance, ProtoInterface, ROUTE, Scene, Script, Switch, WorldInfo, X3D, accessType and type, XML data types, field types

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

     
This node has 14 outgoing ROUTEs, which is greater than $maxROUTEdepth=8
ArticulationParameterControl
Script
portRpm
SFFloat

ROUTE
event to
(1)
AriesAUV
ProtoInstance
portRpm
SFFloat
ArticulationParameterControl
Script
stbdRpm
SFFloat

ROUTE
event to
(1)
AriesAUV
ProtoInstance
stbdRpm
SFFloat
ArticulationParameterControl
Script
forwardVerticalThruster
SFFloat

ROUTE
event to
(1)
AriesAUV
ProtoInstance
forwardVerticalThruster
SFFloat
ArticulationParameterControl
Script
afterVerticalThruster
SFFloat

ROUTE
event to
(1)
AriesAUV
ProtoInstance
afterVerticalThruster
SFFloat
ArticulationParameterControl
Script
forwardLateralThruster
SFFloat

ROUTE
event to
(1)
AriesAUV
ProtoInstance
forwardLateralThruster
SFFloat
ArticulationParameterControl
Script
afterLateralThruster
SFFloat

ROUTE
event to
(1)
AriesAUV
ProtoInstance
afterLateralThruster
SFFloat
ArticulationParameterControl
Script
forwardRudders
SFFloat

ROUTE
event to
(1)
AriesAUV
ProtoInstance
forwardRudders
SFFloat
ArticulationParameterControl
Script
afterRudders
SFFloat

ROUTE
event to
(1)
AriesAUV
ProtoInstance
afterRudders
SFFloat


ProtoInstance
AriesEspdu
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. 

ET
EspduTransform
articulationParameterArray
MFFloat

ROUTE
event to
(1)
ArticulationParameterControl
Script
set_articulationParameters
MFFloat
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/DistributedInteractiveSimulation/AriesEspduPrototypeIndex.html -->
<!-- Version control at
https://sourceforge.net/p/x3d/code/HEAD/tree/www.web3d.org/x3d/content/examples/Basic/DistributedInteractiveSimulation/AriesEspduPrototype.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. -->