X3D Model Documentation: Figure31_6DonutPrototype.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            <meta name='titlecontent='Figure31_6DonutPrototype.x3d'/>
  6            <meta name='creatorcontent='Figure 31.6, The VRML 2.0 Sourcebook, Copyright [1997] By Andrea L. Ames, David R. Nadeau, and John L. Moreland'/>
  7            <meta name='referencecontent='http://www.wiley.com/legacy/compbooks/vrml2sbk/ch31/31fig06.htm'/>
  8            <meta name='translatorcontent='Don Brutzman'/>
  9            <meta name='createdcontent='30 March 2001'/>
 10            <meta name='modifiedcontent='20 October 2019'/>
 11            <meta name='descriptioncontent='A donut (torus) node prototype. Also see Figures 30.5 and 31.7 for comparison.'/>
 12            <meta name='identifiercontent='https://www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Chapter31Prototypes/Figure31_6DonutPrototype.x3d'/>
 13            <meta name='generatorcontent='X3D-Edit 3.3, https://savage.nps.edu/X3D-Edit'/>
 14            <meta name='licensecontent='../../license.html'/>
 15       </head>
<!--

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

<!-- to top Index for DEF nodes: DonutExtrusion, DonutMakerInternalScript

Index for ProtoDeclare definition: Donut
-->
 16       <Scene>
 17            <WorldInfo title='Figure31_6DonutPrototype.x3d'/>
 18            <ProtoDeclare name='Donut'>
 19                 <ProtoInterface>
 20                      <field name='crossSectionRadiustype='SFFloatvalue='1accessType='initializeOnly'/>
 21                      <field name='spineRadiustype='SFFloatvalue='2accessType='initializeOnly'/>
 22                      <field name='crossSectionResolutiontype='SFInt32value='16accessType='initializeOnly'/>
 23                      <field name='spineResolutiontype='SFInt32value='16accessType='initializeOnly'/>
 24                      <field name='set_crossSectionRadiustype='SFFloataccessType='inputOnly'/>
 25                      <field name='set_spineRadiustype='SFFloataccessType='inputOnly'/>
 26                 </ProtoInterface>
 27                 <ProtoBody>
 28 
                    <!-- ROUTE information for DonutExtrusion node:  [from DonutMakerInternalScript.spine_changed to set_spine ] [from DonutMakerInternalScript.crossSection_changed to set_crossSection ] -->
                    <Extrusion DEF='DonutExtrusionbeginCap='falsecreaseAngle='1.57endCap='false'/>
 29                      <!-- Donut maker creates torus on initialization - external script. Modified script to add endpoints matching startpoints. -->
 30 
                    <!-- ROUTE information for DonutMakerInternalScript node:  [from spine_changed to DonutExtrusion.set_spine ] [from crossSection_changed to DonutExtrusion.set_crossSection ] -->
                    <Script DEF='DonutMakerInternalScript'>
 31                           <field name='crossSectionRadiustype='SFFloataccessType='initializeOnly'/>
 32                           <field name='spineRadiustype='SFFloataccessType='initializeOnly'/>
 33                           <field name='crossSectionResolutiontype='SFInt32accessType='initializeOnly'/>
 34                           <field name='spineResolutiontype='SFInt32accessType='initializeOnly'/>
 35                           <field name='set_crossSectionRadiustype='SFFloataccessType='inputOnly'/>
 36                           <field name='set_spineRadiustype='SFFloataccessType='inputOnly'/>
 37                           <field name='crossSection_changedtype='MFVec2faccessType='outputOnly'/>
 38                           <field name='spine_changedtype='MFVec3faccessType='outputOnly'/>
 39                           <IS>
 40                                <connect nodeField='crossSectionRadiusprotoField='crossSectionRadius'/>
 41                                <connect nodeField='spineRadiusprotoField='spineRadius'/>
 42                                <connect nodeField='crossSectionResolutionprotoField='crossSectionResolution'/>
 43                                <connect nodeField='spineResolutionprotoField='spineResolution'/>
 44                                <connect nodeField='set_crossSectionRadiusprotoField='set_crossSectionRadius'/>
 45                                <connect nodeField='set_spineRadiusprotoField='set_spineRadius'/>
 46                           </IS>
  <![CDATA[
          
ecmascript:

function initialize( ) {
    generateCrossSection( );
    generateSpine( );
}

function set_crossSectionRadius( csr, ts )
{
    crossSectionRadius = csr;
//  Browser.println ('crossSectionRadius =' + crossSectionRadius);
    generateCrossSection( );
}

function set_spineRadius( sr, ts )
{
    spineRadius = sr;
//  Browser.println ('spineRadius =' + spineRadius);
    generateSpine( );
}

function generateCrossSection( )
{
    newCrossSection = new MFVec2f(); // temporary hold variable
    angle = 0.0;
    delta = 6.28 / crossSectionResolution;
    for ( i = 0; i <= crossSectionResolution + 1; i++ ) {
        newCrossSection[i][0] =  crossSectionRadius * Math.cos( angle );
        newCrossSection[i][1] = -crossSectionRadius * Math.sin( angle );
        angle += delta;
    }
    // make ends meet
    newCrossSection[crossSectionResolution + 1][0] = newCrossSection[0][0];
    newCrossSection[crossSectionResolution + 1][1] = newCrossSection[0][1];

    crossSection_changed = newCrossSection;
}

function generateSpine( )
{
    newSpine = new MFVec3f(); // temporary hold variable
    angle = 0.0;
    delta = (2 * 3.141592653) / spineResolution;
    for ( i = 0; i <= spineResolution; i++ ) {
        newSpine[i][0] = spineRadius * Math.cos( angle );
        newSpine[i][1] = 0.0;
        newSpine[i][2] = -spineRadius * Math.sin( angle );
        angle += delta;
    }
    // make ends meet
    newSpine[spineResolution + 1][0] = newSpine[0][0];
    newSpine[spineResolution + 1][1] = 0.0;
    newSpine[spineResolution + 1][2] = newSpine[0][2];

    spine_changed = newSpine;
}

        
]]>
 48                      </Script>
 49                      < ROUTE  fromNode='DonutMakerInternalScript' fromField='spine_changed' toNode='DonutExtrusion' toField='set_spine'/>
 50                      < ROUTE  fromNode='DonutMakerInternalScript' fromField='crossSection_changed' toNode='DonutExtrusion' toField='set_crossSection'/>
 51                 </ProtoBody>
 52            </ProtoDeclare>
 53            <!-- It is a good practice to include default message linking to an example scene, in case a user tries to view this Prototype library directly. -->
 54            <Anchor description='Figure31_7DonutExternalPrototype exampleparameter='"target=_blank"'   url=' "Figure31_7DonutExternalPrototype.x3d" "https://www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Chapter31Prototypes/Figure31_7DonutExternalPrototype.x3d" "Figure31_7DonutExternalPrototype.wrl" "https://www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Chapter31Prototypes/Figure31_7DonutExternalPrototype.wrl" '>
 55                 <Shape>
 56                      <Text string='"Figure31_6DonutPrototype" "contains a prototype definition" "" "Click on text to see a Donut in" "Figure31_7DonutExternalPrototype"'>
 57                           <FontStyle justify='"MIDDLE" "MIDDLE"size='0.8'/>
 58                      </Text>
 59                      <Appearance>
 60                           <Material diffuseColor='0 0.6 0.6'/>
 61                      </Appearance>
 62                 </Shape>
 63            </Anchor>
 64       </Scene>
 65  </X3D>
<!--

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

<!-- to top Index for DEF nodes: DonutExtrusion, DonutMakerInternalScript

Index for ProtoDeclare definition: Donut
-->
X3D Tooltips element index: Anchor, Appearance, connect, Extrusion, field, FontStyle, head, IS, Material, meta, ProtoBody, ProtoDeclare, ProtoInterface, ROUTE, Scene, Script, Shape, Text, 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.

DonutMakerInternalScript
Script
spine_changed
MFVec3f

ROUTE
event to
(1)
DonutExtrusion
Extrusion
set_spine
MFVec3f
DonutMakerInternalScript
Script
crossSection_changed
MFVec2f

ROUTE
event to
(1)
DonutExtrusion
Extrusion
set_crossSection
MFVec2f


Anchor
description='Figure31_7DonutExternalPrototype 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/Vrml2Sourcebook/Chapter31Prototypes/Figure31_6DonutPrototypeIndex.html -->
<!-- Version control at
https://sourceforge.net/p/x3d/code/HEAD/tree/www.web3d.org/x3d/content/examples/Vrml2Sourcebook/Chapter31Prototypes/Figure31_6DonutPrototype.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. -->