X3D Model Documentation: CircleFishPrototype.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=' CircleFishPrototype.x3d '/>
  6            <meta name='description' content='This is a prototype for a CircleFish, which is also used by CircleFishLod. Default fish size: length is 1 m (Y-axis), max Height is 1 m (Z-axis), max Width is 10 cm (X-axis).'/>
  7            <meta name='creator' content='Ildeniz Duman'/>
  8            <meta name='translator' content='Scott Tufts'/>
  9            <meta name='created' content='1 May 1998'/>
 10            <meta name='translated' content='11 December 2001'/>
 11            <meta name='modified' content='20 October 2019'/>
 12            <meta name='reference' content=' https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/KelpForestExhibit/CircleFishPrototype.x3d '/>
 13            <meta name='identifier' content=' https://www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter05AppearanceMaterialTextures/CircleFishPrototype.x3d '/>
 14            <meta name='generator' content='X3D-Edit 3.3, https://www.web3d.org/x3d/tools/X3D-Edit'/>
 15            <meta name='license' content='../license.html'/>
 16       </head>
<!--
<!--
Event Graph ROUTE Table shows event connections.
-->
<!-- to top DEF nodes index: AnimationGroup, CircleFishAngle, CirclefishPath, Eye, FinColor, FinSkin, FishBodyExtrusion, FishColor, FishTexture, FishTransform, LeftPectoral, LeftPectoralRotation, OrbitClock, RightPectoral, RightPectoralRotation, Timer, Waggler, Way

Index for ProtoDeclare definition: CircleFish
-->
 17       <Scene>
 18            <WorldInfo title='CircleFishPrototype.x3d'/>
 19            <ProtoDeclare name='CircleFish'>
 20                 <ProtoInterface>
 21                      <field name='skinTextureUrl' type='MFString' accessType='inputOutput'/>
 22                      <field name='fishScale' type='SFVec3f' value='1 1 1' accessType='inputOutput'/>
 23                      <field name='fishColor' type='SFColor' value='0.5 0.5 0.5' accessType='inputOutput'/>
 24                      <field name='finColor' type='SFColor' value='0.5 0.5 0.5' accessType='inputOutput'/>
 25                      <field name='positionKey' type='MFFloat' value='0.0 0.125 0.25 0.375 0.5 0.625 0.750 0.8751' accessType='inputOutput'/>
 26                      <field name='positionKeyValue' type='MFVec3f' value='1.5 2 0 1.5 0 -1.0 0 -1 -1.0 -1.5 0 -1.0 -1.5 2 0 -1.5 0 1.0 0 -2 1.0 1.5 0 1.0 1.5 2 0' accessType='inputOutput'/>
 27                      <field name='orientationKey' type='MFFloat' value='0.0 0.25 0.5 0.750 1' accessType='inputOutput'/>
 28                      <field name='orientationKeyValue' type='MFRotation' value='0 1 0 0 0 1 0 -1.57 0 1 0 -3.14 0 1 0 -4.71 0 1 0 -6.28' accessType='inputOutput'/>
 29                      <field name='orbitTime' type='SFTime' value='90' accessType='inputOutput'/>
 30                 </ProtoInterface>
 31                 <ProtoBody>
 32 
                    <!-- ROUTE information for Way node:  [from CirclefishPath.value_changed to set_translation ] [from CircleFishAngle.value_changed to set_rotation ] -->
                     <Transform DEF='Way'>
 33                           <Transform rotation='1 0 0 1.395'>
 34                                <Transform DEF='FishTransform'>
 35                                     <IS>
 36                                          <connect nodeField='scale' protoField='fishScale'/>
 37                                     </IS>
 38                                     <Shape>
 39                                          <Appearance>
 40                                               <Material DEF='FishColor'>
 41                                                    <IS>
 42                                                         <connect nodeField='diffuseColor' protoField='fishColor'/>
 43                                                    </IS>
 44                                               </Material>
 45                                               <ImageTexture DEF='FishTexture'>
 46                                                    <IS>
 47                                                         <connect nodeField='url' protoField='skinTextureUrl'/>
 48                                                    </IS>
 49                                               </ImageTexture>
 50                                          </Appearance>
 51 
                                        <!-- ROUTE information for FishBodyExtrusion node:  [from Waggler.value_changed to set_spine ] -->
                                         <Extrusion DEF='FishBodyExtrusion' creaseAngle='0.57' crossSection='-0.1 1.0 0.1 1 0.5 0.5 0.5 -0.5 0.1 -1 -0.1 -1 -0.5 -0.5 -0.5 0.5 -0.1 1' scale='0.03 0.03 0.05 0.3 0.05 0.45 0.1 0.5 0.05 0.45 0.05 0.2 0.03 0.4' spine='0 1 0 0 0.8 0 0 0.6 0 0 0.5 0 0 0.3 0 0 0.2 0 0 0 0'/>
 52                                     </Shape>
 53                                     <Shape>
 54 
                                        <!-- Appearance FinSkin is a DEF node that has 2 USE nodes: USE_1, USE_2 -->
                                         <Appearance DEF='FinSkin'>
 55                                               <Material DEF='FinColor' transparency='0.2'>
 56                                                    <IS>
 57                                                         <connect nodeField='diffuseColor' protoField='finColor'/>
 58                                                    </IS>
 59                                               </Material>
 60                                          </Appearance>
 61                                     </Shape>
 62                                     <Transform translation='0.015 0.8 -0.2'>
 63 
                                        <!-- Shape Eye is a DEF node that has 2 USE nodes: USE_1, USE_2 -->
                                         <Shape DEF='Eye'>
 64                                               <Appearance>
 65                                                    <Material diffuseColor='0.5 0.5 0.5' shininess='1' specularColor='0.3 0.3 0.3'/>
 66                                               </Appearance>
 67                                               <Sphere radius='0.03'/>
 68                                          </Shape>
 69                                     </Transform>
 70                                     <Transform translation='-0.015 0.8 -0.2'>
 71                                          <Shape USE='Eye'/>
 72                                     </Transform>
 73                                     <Transform scale='1 1 0.7' translation='0 0.98 0'>
 74                                          <Shape USE='Eye'/>
 75                                     </Transform>
 76 
                                   <!-- ROUTE information for LeftPectoral node:  [from LeftPectoralRotation.value_changed to set_rotation ] -->
                                    <Transform DEF='LeftPectoral' translation='0.04 0.4 0.3'>
 77                                          <Shape>
 78                                               <Appearance USE='FinSkin'/>
 79                                               <IndexedFaceSet solid='false' coordIndex='0 1 2 -1'>
 80                                                    <Coordinate point='0 0 0 0 0.2 0 0.2 0.1 0'/>
 81                                               </IndexedFaceSet>
 82                                          </Shape>
 83                                     </Transform>
 84 
                                   <!-- ROUTE information for RightPectoral node:  [from RightPectoralRotation.value_changed to set_rotation ] -->
                                    <Transform DEF='RightPectoral' translation='-0.04 0.4 0.3'>
 85                                          <Shape>
 86                                               <Appearance USE='FinSkin'/>
 87                                               <IndexedFaceSet solid='false' coordIndex='0 1 2 -1'>
 88                                                    <Coordinate point='0 0 0 0 0.2 0 -0.2 0.1 0'/>
 89                                               </IndexedFaceSet>
 90                                          </Shape>
 91                                     </Transform>
 92                                </Transform>
 93                           </Transform>
 94                           <Group DEF='AnimationGroup'>
 95 
                              <!-- ROUTE information for Timer node:  [from fraction_changed to Waggler.set_fraction ] [from fraction_changed to LeftPectoralRotation.set_fraction ] [from fraction_changed to RightPectoralRotation.set_fraction ] -->
                               <TimeSensor DEF='Timer' cycleInterval='5' loop='true'/>
 96 
                              <!-- ROUTE information for Waggler node:  [from Timer.fraction_changed to set_fraction ] [from value_changed to FishBodyExtrusion.set_spine ] -->
                               <CoordinateInterpolator DEF='Waggler' key='0.0 0.15 0.28 0.4 0.55 0.7 0.85 1' keyValue='0 1 0 0 0.8 0 0 0.6 0 0 0.5 0 0 0.3 0 0 0.2 0 0 0 0 0 1 0 0 0.8 0 0 0.6 0 0 0.5 0 0.05 0.3 0 0.1 0.2 0 0.2 0 0 0 1 0 0 0.8 0 0 0.6 0 0 0.5 0 0 0.3 0 0 0.2 0 0 0 0 0 1 0 0 0.8 0 0 0.6 0 0 0.5 0 -0.05 0.3 0 -0.1 0.2 0 -0.2 0 0 0 1 0 0 0.8 0 0 0.6 0 0 0.5 0 0 0.3 0 0.0 0.2 0 0 0 0 0 1 0 0 0.8 0 0 0.6 0 0 0.5 0 0.05 0.3 0 0.1 0.2 0 0.2 0 0 0 1 0 0 0.8 0 0 0.6 0 0 0.5 0 0 0.3 0 0 0.2 0 0 0 0 0 1 0 0 0.8 0 0 0.6 0 0 0.5 0 0 0.3 0 0 0.2 0 0 0 0'/>
 97                                < ROUTE  fromNode='Timer' fromField='fraction_changed' toNode='Waggler' toField='set_fraction'/>
 98                                < ROUTE  fromNode='Waggler' fromField='value_changed' toNode='FishBodyExtrusion' toField='set_spine'/>
 99 
                              <!-- ROUTE information for LeftPectoralRotation node:  [from Timer.fraction_changed to set_fraction ] [from value_changed to LeftPectoral.set_rotation ] -->
                               <OrientationInterpolator DEF='LeftPectoralRotation' key='0 0.3 0.7 1' keyValue='0 1 0 -.349 0 1 0 0 0 1 0 0 0 1 0 -.349'/>
100                                < ROUTE  fromNode='Timer' fromField='fraction_changed' toNode='LeftPectoralRotation' toField='set_fraction'/>
101                                < ROUTE  fromNode='LeftPectoralRotation' fromField='value_changed' toNode='LeftPectoral' toField='set_rotation'/>
102 
                              <!-- ROUTE information for RightPectoralRotation node:  [from Timer.fraction_changed to set_fraction ] [from value_changed to RightPectoral.set_rotation ] -->
                               <OrientationInterpolator DEF='RightPectoralRotation' key='0 0.3 0.7 1' keyValue='0 1 0 .349 0 1 0 0 0 1 0 0 0 1 0 .349'/>
103                                < ROUTE  fromNode='Timer' fromField='fraction_changed' toNode='RightPectoralRotation' toField='set_fraction'/>
104                                < ROUTE  fromNode='RightPectoralRotation' fromField='value_changed' toNode='RightPectoral' toField='set_rotation'/>
105 
                              <!-- ROUTE information for OrbitClock node:  [from fraction_changed to CirclefishPath.set_fraction ] [from fraction_changed to CircleFishAngle.set_fraction ] -->
                               <TimeSensor DEF='OrbitClock' loop='true'>
106                                     <IS>
107                                          <connect nodeField='cycleInterval' protoField='orbitTime'/>
108                                     </IS>
109                                </TimeSensor>
110 
                              <!-- ROUTE information for CirclefishPath node:  [from OrbitClock.fraction_changed to set_fraction ] [from value_changed to Way.set_translation ] -->
                               <PositionInterpolator DEF='CirclefishPath'>
111                                     <IS>
112                                          <connect nodeField='key' protoField='positionKey'/>
113                                          <connect nodeField='keyValue' protoField='positionKeyValue'/>
114                                     </IS>
115                                </PositionInterpolator>
116 
                              <!-- ROUTE information for CircleFishAngle node:  [from OrbitClock.fraction_changed to set_fraction ] [from value_changed to Way.set_rotation ] -->
                               <OrientationInterpolator DEF='CircleFishAngle'>
117                                     <IS>
118                                          <connect nodeField='key' protoField='orientationKey'/>
119                                          <connect nodeField='keyValue' protoField='orientationKeyValue'/>
120                                     </IS>
121                                </OrientationInterpolator>
122                                < ROUTE  fromNode='OrbitClock' fromField='fraction_changed' toNode='CirclefishPath' toField='set_fraction'/>
123                                < ROUTE  fromNode='OrbitClock' fromField='fraction_changed' toNode='CircleFishAngle' toField='set_fraction'/>
124                                < ROUTE  fromNode='CirclefishPath' fromField='value_changed' toNode='Way' toField='set_translation'/>
125                                < ROUTE  fromNode='CircleFishAngle' fromField='value_changed' toNode='Way' toField='set_rotation'/>
126                           </Group>
127                      </Transform>
128                 </ProtoBody>
129            </ProtoDeclare>
130            <!-- ==================== -->
131            <ProtoInstance name='CircleFish'/>
132       </Scene>
133  </X3D>
<!--
<!--
Event Graph ROUTE Table shows event connections.
-->
<!-- to top DEF nodes index: AnimationGroup, CircleFishAngle, CirclefishPath, Eye, FinColor, FinSkin, FishBodyExtrusion, FishColor, FishTexture, FishTransform, LeftPectoral, LeftPectoralRotation, OrbitClock, RightPectoral, RightPectoralRotation, Timer, Waggler, Way

Index for ProtoDeclare definition: CircleFish
-->
X3D Tooltips element index: Appearance, connect, Coordinate, CoordinateInterpolator, Extrusion, field, Group, head, ImageTexture, IndexedFaceSet, IS, Material, meta, OrientationInterpolator, PositionInterpolator, ProtoBody, ProtoDeclare, ProtoInstance, ProtoInterface, ROUTE, Scene, Shape, Sphere, TimeSensor, Transform, WorldInfo, X3D, plus documentation for accessType definitions, type definitions, XML data types, and field types

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

OrbitClock
TimeSensor
fraction_changed
SFFloat
→
ROUTE
event to
(1)
CirclefishPath
PositionInterpolator
set_fraction
SFFloat 		then
 
 
  		CirclefishPath
PositionInterpolator
value_changed
SFVec3f
→
ROUTE
event to
(2)
Way
Transform
set_translation
SFVec3f
OrbitClock
TimeSensor
fraction_changed
SFFloat
→
ROUTE
event to
(1)
CircleFishAngle
OrientationInterpolator
set_fraction
SFFloat 		then
 
 
  		CircleFishAngle
OrientationInterpolator
value_changed
SFRotation
→
ROUTE
event to
(2)
Way
Transform
set_rotation
SFRotation

Timer
TimeSensor
fraction_changed
SFFloat
→
ROUTE
event to
(1)
Waggler
CoordinateInterpolator
set_fraction
SFFloat 		then
 
 
  		Waggler
CoordinateInterpolator
value_changed
MFVec3f
→
ROUTE
event to
(2)
FishBodyExtrusion
Extrusion
set_spine
MFVec3f
Timer
TimeSensor
fraction_changed
SFFloat
→
ROUTE
event to
(1)
LeftPectoralRotation
OrientationInterpolator
set_fraction
SFFloat 		then
 
 
  		LeftPectoralRotation
OrientationInterpolator
value_changed
SFRotation
→
ROUTE
event to
(2)
LeftPectoral
Transform
set_rotation
SFRotation
Timer
TimeSensor
fraction_changed
SFFloat
→
ROUTE
event to
(1)
RightPectoralRotation
OrientationInterpolator
set_fraction
SFFloat 		then
 
 
  		RightPectoralRotation
OrientationInterpolator
value_changed
SFRotation
→
ROUTE
event to
(2)
RightPectoral
Transform
set_rotation
SFRotation

line 131
ProtoInstance
CircleFish 		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/X3dForWebAuthors/Chapter05AppearanceMaterialTextures/CircleFishPrototypeIndex.html -->
<!-- Version control at
https://sourceforge.net/p/x3d/code/HEAD/tree/www.web3d.org/x3d/content/examples/X3dForWebAuthors/Chapter05AppearanceMaterialTextures/CircleFishPrototype.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. -->