X3D Model Documentation: KmlPrototypes.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            <component level='1name='Geospatial'/>
  6            <meta name='titlecontent='KmlPrototypes.x3d'/>
  7            <meta name='descriptioncontent='X3D prototypes to render Keyhole Markup Language (KML) information.'/>
  8            <meta name='translatedcontent='20 August 2007'/>
  9            <meta name='modifiedcontent='20 October 2019'/>
 10            <meta name='creatorcontent='Don Brutzman'/>
 11            <meta name=' warning content=' under development '/>
 12            <meta name='identifiercontent='https://www.web3d.org/x3d/content/examples/Basic/Geospatial/KmlPrototypes.x3d'/>
 13            <meta name='referencecontent='http://www.opengeospatial.org/standards/kml'/>
 14            <meta name='referencecontent='http://schemas.opengis.net/kml'/>
 15            <meta name='referencecontent='http://schemas.opengis.net/kml/2.2.0/ogckml22.xsd'/>
 16            <meta name='referencecontent='KmlToX3d.xslt'/>
 17            <meta name='generatorcontent='X3D-Edit 3.3, https://savage.nps.edu/X3D-Edit'/>
 18            <meta name='licensecontent='../license.html'/>
 19       </head>
<!--

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

<!-- to top Index for DEF nodes: BehaviorScript, GeometryGroup, MetadataHolderPlaceMark, MetadataHolderPoint, PlaceMarkBalloon, PlaceMarkMaterial, PlaceMarkName, PointScript, SnippetTranslation, SwitchVisible

Index for Viewpoint node: Viewpoint_1

Index for ProtoDeclare definitions: PlaceMark, Point
-->
 20       <Scene>
 21            <ProtoDeclare name='PlaceMarkappinfo='A Placemark with a Point has an icon associated with it that marks a point on the earth in the 3D viewer.' documentation='http://code.google.com/apis/kml/documentation/kml_tags_21.html#placemark'>
 22                 <ProtoInterface>
 23                      <field name='idtype='SFStringaccessType='initializeOnly'/>
 24                      <field name='nametype='MFStringaccessType='inputOutput'
                     appinfo='Label for the object'/>
 25                      <field name='descriptiontype='SFStringaccessType='inputOutput'
                     appinfo='User-supplied text that appears in the description balloon'/>
 26                      <field name='coordinatestype='SFVec3dvalue='0 0 0accessType='initializeOnly'
                     appinfo='longitude latitude and altitude'/>
 27                      <field name='addresstype='MFStringaccessType='inputOutput'
                     appinfo='A string value representing an unstructured address written as a standard street city state address and/or as a postal code.'/>
 28                      <field name='visibilitytype='SFBoolvalue='trueaccessType='initializeOnly'
                     appinfo='. Specifies whether the feature is drawn in the 3D viewer when it is initially loaded'/>
 29                      <field name='set_visibilitytype='SFBoolaccessType='inputOnly'/>
 30                      <field name='visibility_changedtype='SFBoolaccessType='outputOnly'/>
 31                      <!-- TODO: is the 'open' parameter appropriate for X3D? Maintain value for round-trip conversions. -->
 32                      <field name='opentype='SFBoolvalue='trueaccessType='initializeOnly'
                     appinfo='Specifies whether a Folder appears closed or open when first loaded'/>
 33                      <!-- TODO: need LookAt Prototype -->
 34                      <field name='snippettype='MFStringaccessType='initializeOnly'
                     appinfo='A short description of the feature'/>
 35                      <field name='set_snippettype='MFStringaccessType='inputOnly'/>
 36                      <field name='snippet_changedtype='MFStringaccessType='outputOnly'/>
 37                      <!-- TODO: AddressDetails, phoneNumber, TimePrimitive, styleUrl, StyleSelector, Region -->
 38                      <!-- TODO: Geometry prototypes for KML Point,LineString,LinearRing, Polygon,MultiGeometry,Model -->
 39                      <field name='geometrytype='MFNodeaccessType='inputOutput'
                     appinfo='Shape or (KML) Point LineString LinearRing Polygon MultiGeometry Model'>
 40                           <!-- default NULL node -->
 41                      </field>
 42                      <field name='diffuseColortype='SFColorvalue='0.2 0.8 0.4accessType='inputOutput'
                     appinfo='Default color for PlaceMark'/>
 43                      <field name='metadatatype='SFNodeaccessType='inputOutput'>
 44                           <!-- default NULL node -->
 45                      </field>
 46                 </ProtoInterface>
 47                 <ProtoBody>
 48                      <!-- TODO: is Switch needed to choose between balloon and provided geometry, or are both shown? -->
 49 
                    <!-- ROUTE information for SwitchVisible node:  [from BehaviorScript.visibilityChoice to whichChoice ] -->
                    <Switch DEF='SwitchVisiblewhichChoice='0'>
 50                           <Anchor>
 51                                <IS>
 52                                     <connect nodeField='urlprotoField='address'/>
 53                                     <connect nodeField='descriptionprotoField='description'/>
 54                                </IS>
 55                                <GeoLocation containerField='children'>
 56                                     <GeoOrigin>
 57                                          <IS>
 58                                               <connect nodeField='geoCoordsprotoField='coordinates'/>
 59                                          </IS>
 60                                     </GeoOrigin>
 61                                </GeoLocation>
 62                                <Shape DEF='PlaceMarkBalloon'>
 63                                     <Extrusion creaseAngle='3.14crossSection='1.00 0.00 0.92 -0.38 0.71 -0.71 0.38 -0.92 0.00 -1.00 -0.38 -0.92 -0.71 -0.71 -0.92 -0.38 -1.00 -0.00 -0.92 0.38 -0.71 0.71 -0.38 0.92 0.00 1.00 0.38 0.92 0.71 0.71 0.92 0.38 1.00 0.00scale='0.01 0.01 0.03 0.03 0.06 0.06 0.09 0.09 0.14 0.14 0.23 0.23 0.25 0.25 0.23 0.23 0.18 0.18 0.1 0.1 0.03 0.03spine='0 0 0 0 0.12 0 0 0.28 0 0 0.4 0 0 0.55 0 0 0.65 0 0 0.75 0 0 0.85 0 0 0.92 0 0 0.98 0 0 1.0 0'/>
 64                                     <Appearance>
 65 
                                        <!-- Material PlaceMarkMaterial is a DEF node that has 2 USE nodes: USE_1, USE_2 -->
                                        <Material DEF='PlaceMarkMaterial'>
 66                                               <IS>
 67                                                    <connect nodeField='diffuseColorprotoField='diffuseColor'/>
 68                                               </IS>
 69                                          </Material>
 70                                     </Appearance>
 71                                </Shape>
 72                                <Transform DEF='PlaceMarkNametranslation='0 1.2 0'>
 73                                     <Shape>
 74                                          <Text>
 75                                               <IS>
 76                                                    <connect nodeField='stringprotoField='name'/>
 77                                               </IS>
 78                                               <FontStyle justify='"MIDDLE" "MIDDLE"size='0.2'/>
 79                                          </Text>
 80                                          <Appearance>
 81                                               <Material USE='PlaceMarkMaterial'/>
 82                                          </Appearance>
 83                                     </Shape>
 84                                </Transform>
 85 
                              <!-- ROUTE information for SnippetTranslation node:  [from BehaviorScript.snippetOffset to set_translation ] -->
                              <Transform DEF='SnippetTranslationtranslation='0 2.4 0'>
 86                                     <Shape>
 87                                          <Text>
 88                                               <IS>
 89                                                    <connect nodeField='stringprotoField='snippet'/>
 90                                               </IS>
 91                                               <FontStyle justify='"MIDDLE" "MIDDLE"size='0.2'/>
 92                                          </Text>
 93                                          <Appearance>
 94                                               <Material USE='PlaceMarkMaterial'/>
 95                                          </Appearance>
 96                                     </Shape>
 97                                </Transform>
 98                                <Group DEF='GeometryGroup'>
 99                                     <IS>
100                                          <connect nodeField='childrenprotoField='geometry'/>
101                                     </IS>
102                                </Group>
103                           </Anchor>
104                      </Switch>
105                      <!-- remaining nodes in ProtoBody are not rendered -->
106                      <WorldInfo>
107                           <IS>
108                                <connect nodeField='titleprotoField='id'/>
109                           </IS>
110                      </WorldInfo>
111                      <Group DEF='MetadataHolderPlaceMark'>
112                           <IS>
113                                <connect nodeField='metadataprotoField='metadata'/>
114                           </IS>
115                      </Group>
116 
                    <!-- ROUTE information for BehaviorScript node:  [from visibilityChoice to SwitchVisible.whichChoice ] [from snippetOffset to SnippetTranslation.set_translation ] -->
                    <Script DEF='BehaviorScript'>
117                           <field name='visibilitytype='SFBoolaccessType='initializeOnly'/>
118                           <field name='set_visibilitytype='SFBoolaccessType='inputOnly'/>
119                           <field name='visibility_changedtype='SFBoolaccessType='outputOnly'/>
120                           <field name='visibilityChoicetype='SFInt32accessType='outputOnly'/>
121                           <field name='opentype='SFBoolaccessType='initializeOnly'/>
122                           <field name='snippettype='MFStringaccessType='initializeOnly'/>
123                           <field name='set_snippettype='MFStringaccessType='inputOnly'/>
124                           <field name='snippet_changedtype='MFStringaccessType='outputOnly'/>
125                           <field name='snippetOffsettype='SFVec3faccessType='outputOnly'/>
126                           <IS>
127                                <connect nodeField='visibilityprotoField='visibility'/>
128                                <connect nodeField='set_visibilityprotoField='set_visibility'/>
129                                <connect nodeField='visibility_changedprotoField='visibility_changed'/>
130                                <connect nodeField='openprotoField='open'/>
131                                <connect nodeField='snippetprotoField='snippet'/>
132                                <connect nodeField='set_snippetprotoField='set_snippet'/>
133                                <connect nodeField='snippet_changedprotoField='snippet_changed'/>
134                           </IS>
  <![CDATA[
          
ecmascript:

function initialize ()
{
	Browser.println ('visibility=' + visibility);
	if (visibility == false) visibilityChoice = -1;

	// TODO:  if (open == false) open_changed = -1;

	adjustSnippetOffset ();
}

function set_visibility (value, timestamp)
{
	visibility = value;         // remember change
	visibility_changed = value; // send eventOut
	if (visibility == false) visibilityChoice = -1;
	else                     visibilityChoice =  0;
}

function set_snippet (value, timestamp)
{
	snippet = value;         // remember change
	snippet_changed = value; // send eventOut
	adjustSnippetOffset ();
}

function adjustSnippetOffset () // TODO
{
//	snippetOffset = new SFVec3f (0.0, (snippet.length * 0.3), 0.0);
//	Browser.println ('snippet.length=' + snippet.length + ', snippetOffset=' + snippetOffset);
}

function set_open (value, timestamp) // TODO
{

}

        
]]>
136                      </Script>
137                      < ROUTE  fromNode='BehaviorScript' fromField='visibilityChoice' toNode='SwitchVisible' toField='whichChoice'/>
138                      < ROUTE  fromNode='BehaviorScript' fromField='snippetOffset' toNode='SnippetTranslation' toField='set_translation'/>
139                 </ProtoBody>
140            </ProtoDeclare>
141            <ProtoDeclare name='Pointappinfo='A geographic location defined by longitude latitude and (required) altitude.' documentation='http://code.google.com/apis/kml/documentation/kml_tags_21.html#point'>
142                 <ProtoInterface>
143                      <field name='idtype='SFStringaccessType='initializeOnly'/>
144                      <field name='altitudeModetype='SFStringvalue='clampToGroundaccessType='initializeOnly'
                     appinfo='allowed values: clampToGround relativeToGround absolute'/>
145                      <field name='coordinatestype='SFVec3dvalue='0 0 0accessType='initializeOnly'/>
146                      <field name='set_coordinatestype='SFVec3daccessType='inputOnly'/>
147                      <field name='coordinates_changedtype='SFVec3daccessType='outputOnly'/>
148                      <field name='extrudetype='SFBoolvalue='falseaccessType='initializeOnly'/>
149                      <field name='tessellatetype='SFBoolvalue='falseaccessType='initializeOnly'/>
150                      <field name='metadatatype='SFNodeaccessType='inputOutput'>
151                           <!-- default NULL node -->
152                      </field>
153                 </ProtoInterface>
154                 <ProtoBody>
155                      <Script DEF='PointScript'>
156                           <field name='altitudeModetype='SFStringaccessType='initializeOnly'/>
157                           <field name='coordinatestype='SFVec3daccessType='initializeOnly'/>
158                           <field name='set_coordinatestype='SFVec3daccessType='inputOnly'/>
159                           <field name='coordinates_changedtype='SFVec3daccessType='outputOnly'/>
160                           <field name='extrudetype='SFBoolaccessType='initializeOnly'/>
161                           <field name='tessellatetype='SFBoolaccessType='initializeOnly'/>
162                           <IS>
163                                <connect nodeField='altitudeModeprotoField='altitudeMode'/>
164                                <connect nodeField='coordinatesprotoField='coordinates'/>
165                                <connect nodeField='set_coordinatesprotoField='set_coordinates'/>
166                                <connect nodeField='coordinates_changedprotoField='coordinates_changed'/>
167                                <connect nodeField='extrudeprotoField='extrude'/>
168                                <connect nodeField='tessellateprotoField='tessellate'/>
169                           </IS>
  <![CDATA[
          
ecmascript:

function initialize ()
{
	if  (altitudeMode == '') altitudeMode = 'clampToGround';
	if ((altitudeMode != 'clampToGround') &&
	    (altitudeMode != 'relativeToGround') &&
	    (altitudeMode != 'absolute'))
	{
		warningString = '[Point';
		if (id != '') warningString += ' ' + id;
		warningString += '] illegal value ';
		warningString += 'altitudeMode=' + altitudeMode;
		Browser.println (warningString);
	}
}

function set_coordinates (value)
{
	coordinates = value;
	coordinates_changed = value;
}

// TODO: how to handle extrude, tessellate

        
]]>
171                      </Script>
172                      <WorldInfo>
173                           <IS>
174                                <connect nodeField='titleprotoField='id'/>
175                           </IS>
176                      </WorldInfo>
177                      <Group DEF='MetadataHolderPoint'>
178                           <IS>
179                                <connect nodeField='metadataprotoField='metadata'/>
180                           </IS>
181                      </Group>
182                 </ProtoBody>
183            </ProtoDeclare>
184            <!-- ========== Examples ========== -->
185            <Viewpoint description='Placemark exampleposition='0 0 4'/>
186            <!-- <?xml version="1.0" encoding="UTF-8"?> <kml "xmlns=http://earth.google.com/kml/2.1>" <Placemark> <name>Simple placemark</name> <description>Attached to the ground. Intelligently places itself at the height of the underlying terrain.</description> <Point> <coordinates>-122.0822035425683,37.42228990140251,0</coordinates> </Point> </Placemark> </kml> -->
187            <ProtoInstance name='PlaceMark'>
188                 <fieldValue name='namevalue='"Simple placemark"'/>
189                 <fieldValue name='descriptionvalue='Attached to the ground. Intelligently places itself at the height of the underlying terrain.'/>
190                 <fieldValue name='coordinatesvalue='-122.0822035425683 37.42228990140251 0'/>
191                 <fieldValue name='addressvalue='"https://www.web3d.org/x3d-earth"'/>
192            </ProtoInstance>
193       </Scene>
194  </X3D>
<!--

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

<!-- to top Index for DEF nodes: BehaviorScript, GeometryGroup, MetadataHolderPlaceMark, MetadataHolderPoint, PlaceMarkBalloon, PlaceMarkMaterial, PlaceMarkName, PointScript, SnippetTranslation, SwitchVisible

Index for Viewpoint node: Viewpoint_1

Index for ProtoDeclare definitions: PlaceMark, Point
-->
X3D Tooltips element index: Anchor, Appearance, component, connect, Extrusion, field, fieldValue, FontStyle, GeoLocation, GeoOrigin, Group, head, IS, Material, meta, ProtoBody, ProtoDeclare, ProtoInstance, ProtoInterface, ROUTE, Scene, Script, Shape, Switch, 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.

BehaviorScript
Script
visibilityChoice
SFInt32

ROUTE
event to
(1)
SwitchVisible
Switch
whichChoice
SFInt32
BehaviorScript
Script
snippetOffset
SFVec3f

ROUTE
event to
(1)
SnippetTranslation
Transform
set_translation
SFVec3f

PointScript
Script
No ROUTE connection found for output events from this node.
This Script has no direct access to other nodes. 


ProtoInstance
PlaceMark
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. 
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/Geospatial/KmlPrototypesIndex.html -->
<!-- Version control at
https://sourceforge.net/p/x3d/code/HEAD/tree/www.web3d.org/x3d/content/examples/Basic/Geospatial/KmlPrototypes.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. -->