<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE X3D PUBLIC "ISO//Web3D//DTD X3D 3.0//EN" "http://www.web3d.org/specifications/x3d-3.0.dtd">
<X3D profile='Immersive' version='3.0' xmlns:xsd='http://www.w3.org/2001/XMLSchema-instance' xsd:noNamespaceSchemaLocation=' http://www.web3d.org/specifications/x3d-3.0.xsd '>
<head>
<meta name='title' content='EventUtilityPrototypes.x3d'/>
<meta name='description' content='Event utility node prototypes for boolean filtering and other event utility nodes.'/>
<meta name='creator' content='Nick Polys, Tony Parisi, Don Brutzman, Justin Couch'/>
<meta name='created' content='25 September 2002'/>
<meta name='modified' content='6 September 2010'/>
<meta name='warning' content='Under development, IntegerTrigger example needed.'/>
<meta name='reference' content='EventUtilityExamples.x3d'/>
<meta name='subject' content='BooleanFilter BooleanToggle BooleanTrigger IntegerTrigger TimeTrigger'/>
<meta name='identifier' content=' http://www.web3d.org/x3d/content/examples/Basic/development/EventUtilityPrototypes.x3d '/>
<meta name='generator' content='X3D-Edit 3.2, https://savage.nps.edu/X3D-Edit'/>
<meta name='license' content=' ../license.html'/>
</head>
<!--
Index for ProtoDeclare definitions: BooleanFilter, BooleanToggle, BooleanTrigger, IntegerTrigger, TimeTrigger
Index for DEF nodes: BooleanFilterScript, BooleanToggleScript, IntegerKeyHolder, TriggerBooleanScript, TriggerIntegerScript, TriggerTimeScript
-->
<Scene>
<ProtoDeclare name='BooleanFilter' appinfo='BooleanFilter selectively passes true false or negated events.'>
<ProtoInterface>
<field name='set_boolean' type='SFBool' accessType='inputOnly'
 appinfo='set_boolean is the input value to be filtered.'/>
<field name='inputTrue' type='SFBool' accessType='outputOnly'
 appinfo='inputTrue only passes a true value when set_boolean input is true.'/>
<field name='inputFalse' type='SFBool' accessType='outputOnly'
 appinfo='inputFalse only passes a false value when set_boolean is false.'/>
<field name='inputNegate' type='SFBool' accessType='outputOnly'
 appinfo='inputNegate provides opposite value by negating set_boolean input.'/>
</ProtoInterface>
<ProtoBody>
<Script DEF='BooleanFilterScript'>
<field name='set_boolean' type='SFBool' accessType='inputOnly'/>
<field name='inputTrue' type='SFBool' accessType='outputOnly'/>
<field name='inputFalse' type='SFBool' accessType='outputOnly'/>
<field name='inputNegate' type='SFBool' accessType='outputOnly'/>
<IS>
<connect nodeField='set_boolean' protoField='set_boolean'/>
<connect nodeField='inputTrue' protoField='inputTrue'/>
<connect nodeField='inputFalse' protoField='inputFalse'/>
<connect nodeField='inputNegate' protoField='inputNegate'/>
</IS>
<![CDATA[ 
          ecmascript:

function set_boolean (value, timestamp)
{
	if (value) inputTrue  = value;
	else       inputFalse = value;
	inputNegate = !value;

//	if (value) Browser.print ('[BooleanFilter] set_boolean=' + value + ', inputTrue='  + inputTrue  + ', inputNegate=' + inputNegate);
//	else       Browser.print ('[BooleanFilter] set_boolean=' + value + ', inputFalse=' + inputFalse + ', inputNegate=' + inputNegate);
}
]]>
</Script>
</ProtoBody>
</ProtoDeclare>
<!-- ======================================== -->
<ProtoDeclare name='BooleanToggle' appinfo='BooleanToggle maintains state and negates output when a true input is provided.'>
<ProtoInterface>
<field name='set_boolean' type='SFBool' accessType='inputOnly'
 appinfo='If set_boolean input is true toggle state.'/>
<!-- warning: toggle depends on exposedField functionality in Script node, not compatible with VRML 97. implemented as inputOnly/initializeOnly/outputOnly triplet. -->
<field name='set_toggle' type='SFBool' accessType='inputOnly'
 appinfo='Reset persistent state value.'/>
<field name='toggle' type='SFBool' value='false' accessType='initializeOnly'
 appinfo='Persistent state value that gets toggled or reset.'/>
<field name='toggle_changed' type='SFBool' accessType='outputOnly'
 appinfo='Output toggled persistent state value.'/>
</ProtoInterface>
<ProtoBody>
<Group>
<Script DEF='BooleanToggleScript'>
<field name='set_boolean' type='SFBool' accessType='inputOnly'/>
<field name='set_toggle' type='SFBool' accessType='inputOnly'/>
<field name='toggle' type='SFBool' value='false' accessType='initializeOnly'/>
<field name='toggle_changed' type='SFBool' accessType='outputOnly'/>
<field name='traceEnabled' type='SFBool' value='false' accessType='initializeOnly'/>
<IS>
<connect nodeField='set_boolean' protoField='set_boolean'/>
<connect nodeField='set_toggle' protoField='set_toggle'/>
<connect nodeField='toggle_changed' protoField='toggle_changed'/>
</IS>
<![CDATA[ 
            ecmascript:

function initialize ()
{
	if (traceEnabled) Browser.print ('[BooleanToggle] toggle=' + toggle);

}
function set_boolean (value, timestamp)
{
	if (value == true)  // only toggle on true input
	{
		if (toggle == true) toggle = false;
		else                toggle = true;
	}
	toggle_changed = toggle;
//	Browser.print ('[BooleanToggle] traceEnabled=' + traceEnabled);
	if (traceEnabled) Browser.print ('[BooleanToggle] set_boolean=' + value + ', toggle=' + toggle);
}
function set_toggle (value, timestamp)
{
	toggle = value;
	toggle_changed = toggle;
	if (traceEnabled) Browser.print ('[BooleanToggle] set_toggle=' + set_toggle);
}
]]>
</Script>
</Group>
</ProtoBody>
</ProtoDeclare>
<!-- ======================================== -->
<ProtoDeclare name='BooleanTrigger' appinfo='BooleanTrigger converts time events to boolean true events.'>
<ProtoInterface>
<field name='set_triggerTime' type='SFTime' accessType='inputOnly'
 appinfo='set_triggerTime provides input time event typical event sent is TouchSensor touchTime.'/>
<field name='triggerTrue' type='SFBool' accessType='outputOnly'
 appinfo='triggerTrue outputs a true value whenever a triggerTime event is received.'/>
</ProtoInterface>
<ProtoBody>
<Script DEF='TriggerBooleanScript'>
<field name='set_triggerTime' type='SFTime' accessType='inputOnly'/>
<field name='triggerTrue' type='SFBool' accessType='outputOnly'/>
<IS>
<connect nodeField='set_triggerTime' protoField='set_triggerTime'/>
<connect nodeField='triggerTrue' protoField='triggerTrue'/>
</IS>
<![CDATA[ 
          ecmascript:

function set_triggerTime (value, timestamp)
{
	triggerTrue = true;
//	Browser.print ('triggerTrue = true');
}
]]>
</Script>
</ProtoBody>
</ProtoDeclare>
<!-- ======================================== -->
<ProtoDeclare name='IntegerTrigger' appinfo='IntegerTrigger converts boolean true or time input events to integer value (suitable for Switch node).'>
<ProtoInterface>
<field name='set_boolean' type='SFBool' accessType='inputOnly'
 appinfo='If set_boolean input is true trigger output of integer value.'/>
<field name='set_integerKey' type='SFInt32' accessType='inputOnly'
 appinfo='Resets value used for output when triggered later.'/>
<field name='integerKey' type='SFInt32' value='-1' accessType='inputOutput'
 appinfo='integerKey is value for output when triggered.'/>
<field name='integerKey_changed' type='SFInt32' accessType='outputOnly'
 appinfo='Reports change in integerKey value.'/>
<field name='triggerValue' type='SFInt32' accessType='outputOnly'
 appinfo='triggerValue provides integer event output matching integerKey when true set_boolean received.'/>
</ProtoInterface>
<ProtoBody>
<Group>
<Switch DEF='IntegerKeyHolder' whichChoice='-1'>
<IS>
<connect nodeField='whichChoice' protoField='integerKey'/>
</IS>
</Switch>
<Script DEF='TriggerIntegerScript' directOutput='true'>
<field name='set_boolean' type='SFBool' accessType='inputOnly'/>
<field name='set_integerKey' type='SFInt32' accessType='inputOnly'/>
<field name='integerKeyHolderNode' type='SFNode' accessType='initializeOnly'>
<Switch USE='IntegerKeyHolder' whichChoice='-1'/>
</field>
<field name='integerKey_changed' type='SFInt32' accessType='outputOnly'/>
<field name='triggerValue' type='SFInt32' accessType='outputOnly'/>
<IS>
<connect nodeField='set_boolean' protoField='set_boolean'/>
<connect nodeField='set_integerKey' protoField='set_integerKey'/>
<connect nodeField='integerKey_changed' protoField='integerKey_changed'/>
<connect nodeField='triggerValue' protoField='triggerValue'/>
</IS>
<![CDATA[ 
            ecmascript:

function set_boolean (inputValue, timestamp)
{
	if (inputValue == true)
	{
		integerKey = integerKeyHolderNode.whichChoice;
		triggerValue = integerKey; // send output event
	}
}
function set_integerKey (inputValue, timestamp)
{
	integerKey = inputValue;
	integerKeyHolderNode.whichChoice = integerKey;
	integerKey_changed = integerKey; // send output event
}
]]>
</Script>
</Group>
</ProtoBody>
</ProtoDeclare>
<!-- ======================================== -->
<ProtoDeclare name='TimeTrigger' appinfo='TimeTrigger converts boolean true events to time events.'>
<ProtoInterface>
<field name='set_boolean' type='SFBool' accessType='inputOnly'
 appinfo='If set_boolean input is true trigger output time value.'/>
<field name='triggerTime' type='SFTime' accessType='outputOnly'
 appinfo='triggerTime is output time event sent when set_boolean input is true.'/>
</ProtoInterface>
<ProtoBody>
<Script DEF='TriggerTimeScript'>
<field name='set_boolean' type='SFBool' accessType='inputOnly'/>
<field name='triggerTime' type='SFTime' accessType='outputOnly'/>
<IS>
<connect nodeField='set_boolean' protoField='set_boolean'/>
<connect nodeField='triggerTime' protoField='triggerTime'/>
</IS>
<![CDATA[ 
          ecmascript:

function set_boolean (value, timestamp)
{
	if (value) triggerTime = timestamp;
}
]]>
</Script>
</ProtoBody>
</ProtoDeclare>
<!-- ======================================== -->
<Anchor description='EventUtilityExamples' parameter='"target=_blank"'
  url=' "EventUtilityExamples.x3d" "http://www.web3d.org/x3d/content/examples/Basic/development/EventUtilityExamples.x3d" "EventUtilityExamples.wrl" "http://www.web3d.org/x3d/content/examples/Basic/development/EventUtilityExamples.wrl" '>
<Shape>
<Text string='"EventUtilityPrototype" "defines prototypes" "" "Click text to see" "EventUtilityExamples"' solid='false'>
<FontStyle justify='"MIDDLE" "MIDDLE"' size='0.9'/>
</Text>
<Appearance>
<Material diffuseColor='1 1 0.2'/>
</Appearance>
</Shape>
</Anchor>
</Scene>
</X3D>
<!--
Index for ProtoDeclare definitions: BooleanFilter, BooleanToggle, BooleanTrigger, IntegerTrigger, TimeTrigger
Index for DEF nodes: BooleanFilterScript, BooleanToggleScript, IntegerKeyHolder, TriggerBooleanScript, TriggerIntegerScript, TriggerTimeScript
-->

<!-- Color key: <X3dNode DEF='idName' field='value'/> matches <XmlElement DEF='idName' attribute='value'/>     <Prototype name='ProtoName'> <field name='fieldName'/> </Prototype> -->