Script-and-inputOutputField.x3d - Revision history

Flux: correct versions - final Flux is 2.1, final Vivaty is 1.0, see Player_support_for_X3D_components

2011-09-11T19:16:57Z

correct versions - final Flux is 2.1, final Vivaty is 1.0, see Player_support_for_X3D_components

Jbehr: /* Specification Notes */

2008-08-06T21:19:04Z

‎Specification Notes

Jbehr: /* Specification Notes */

2008-08-06T21:17:58Z

‎Specification Notes

Jbehr at 21:17, 6 August 2008

2008-08-06T21:17:09Z

Jbehr: /* Browser Results */

2008-08-06T21:15:06Z

‎Browser Results

Jbehr: /* Browser Results */

2008-08-06T21:14:14Z

‎Browser Results

Jbehr at 21:09, 6 August 2008

2008-08-06T21:09:59Z

Jbehr: Using inputOuput Fields in scripts

2008-08-06T21:09:18Z

Using inputOuput Fields in scripts

Jbehr at 21:08, 6 August 2008

2008-08-06T21:08:24Z

Jbehr: Using inputOuput Fields in scripts

2008-08-06T21:07:51Z

Using inputOuput Fields in scripts

@@ Line 84: / Line 84: @@
 foo() funciton gets called. Does not break X3D or ECMA spec
 but field value is not accessible.
 |-
-| Vivaty
+| Flux
 | 2.1
 | Not Expected
 | reading foo does not work but also no function called ?!?

← Older revision		Revision as of 21:19, 6 August 2008
Line 177:		Line 177:
	Browser.println( 'value: '+ value);		Browser.println( 'value: '+ value);
	}		}
		+
		+	---------------------
		+	conclusion:
		+
		+	It is a mess right now and I would suggest that we change the spec
		+	to change the event-handling function form foo to set_foo;
		+
		+	Something like:
		+
		+	ECMASCRIPT: 4 Concepts: 4.3.5.4 Receiving events
		+
		+	OLD:
		+
		+	Events sent to the containing node are passed to the corresponding ECMAScript function in the script. The function's name is the same as the field and is passed two arguments. If the function represents an inputOutput field, the name of the function shall be the same name as the field declaration, without the set_ or _changed modifiers
		+
		+	NEW:
		+
		+	Events sent to the containing node are passed to the corresponding ECMAScript function in the script. Two arguments, the value and the timestamp, are passed while calling the function. For inputOnly fields the function's name is the same as the field. If the function represents an inputOutput field, the name of the function shall be the same name as the field declaration plus a set_ prefix.

← Older revision		Revision as of 21:17, 6 August 2008
Line 119:		Line 119:

	=> There is variable/function-shadowing problem ((E) brakes (D)) which prevents reading/writing (B) or receiving of events (C)		=> There is variable/function-shadowing problem ((E) brakes (D)) which prevents reading/writing (B) or receiving of events (C)
		+
		+	-------------------------------------------
		+	Solution:
		+
		+	_S1_) Leave the X3D-Spec like it is (This breaks the ECMAScirpt spec (E))
		+	-----------------------------------------------
		+	There are ways to abuse the ECMAScript impl. (e.g SpiderMonkey)
		+	to work this way but still breaks the spec. (and slows down the object access)
		+	However there are some major browser that did exactly this
		+
		+	code snip:
		+
		+	Script {
		+	inputOutput SFBool foo TRUE
		+	...
		+	function initialize () {
		+	Browser.println( 'value: '+ foo);
		+	}
		+	...
		+	function foo (value,timeStamp) {
		+	Browser.println( 'value: '+ value);
		+	}
		+
		+	_S2_) Change the X3D-Spec, use set_foo for the event handler
		+	-----------------------------------------------
		+	change the name of the function for inputOuput from "same as field" to
		+	"set_" prefix
		+
		+	code snip:
		+
		+	Script {
		+	inputOutput SFBool foo TRUE
		+	...
		+	function initialize () {
		+	Browser.println( 'value: '+ foo);
		+	}
		+	...
		+	function set_foo (value,timeStamp) {
		+	Browser.println( 'value: '+ value);
		+	}
		+
		+
		+	_S3_) Change the X3D-Spec, use foo_value/set_foo or foo_changed to access the value
		+	-----------------------------------------------
		+	change the field-value access funciton
		+
		+	code snip:
		+
		+	Script {
		+	inputOutput SFBool foo TRUE
		+	...
		+	function initialize () {
		+	Browser.println( 'value: '+ foo_value);
		+	}
		+	...
		+	function foo (value,timeStamp) {
		+	Browser.println( 'value: '+ value);
		+	}

← Older revision		Revision as of 21:17, 6 August 2008
Line 98:		Line 98:

	\|}		\|}
		+
		+	== Specification Notes ==
		+
		+	Basic Problem:
		+
		+	A) The X3D-spec (not VRML) supports intputOutput Fields in Scripts
		+	(http://www.web3d.org/x3d/specifications/ISO-IEC-19775-X3DAbstractSpecification_Revision1_to_Part1/Part01/components/scripting.html#Scriptlanguages)
		+
		+	B) Field values can be read or written in the Script code
		+	(http://www.web3d.org/x3d/specifications/ISO-IEC-19775-X3DAbstractSpecification_Revision1_to_Part1/Part01/components/scripting.html#Accessingfieldsandevents)
		+
		+	C) Events received by the Script node are passed to the appropriate scripting language method in the script. The method's name depends on the language type used.
		+	(http://www.web3d.org/x3d/specifications/ISO-IEC-19775-X3DAbstractSpecification_Revision1_to_Part1/Part01/components/scripting.html#Eventhandling)
		+
		+	D) ECMAScript X3D-binding: If the function represents an inputOutput field, the name of the function shall be the same name as the field declaration, without the set_ or _changed modifiers
		+	(http://www.web3d.org/x3d/specifications/ISO-IEC-19777-1-(X3DLanguageBindings-ECMAScript/Part1/concepts.html#ReceivingEvents)
		+
		+	E) ECMAScript: variable and function both are objects in the same namespace.
		+	(http://www.ecma-international.org/publications/standards/Ecma-262.htm)
		+
		+	=> There is variable/function-shadowing problem ((E) brakes (D)) which prevents reading/writing (B) or receiving of events (C)

@@ Line 88: / Line 88: @@
 | Vivaty
 | 2.1
-| Expected
+| Not Expected
+| reading foo does not work but also no function called ?!?
 |-
 | Xj3D
 | 2_M1_DEV_2008-06_02
-| Expected
+| Not Expected
+| the value of foo is the function and the foo() function is
 |}

@@ Line 64: / Line 64: @@
 | 7.107
 | Not Expected
-| No objects showing, global not supported
+| Follows the X3D-Spec: read on foo gives you the field value,
-|-
+but foo() as function gets also called. Breaks the ECMAScript spec.
 | FreeWRL
+|
-| Untested
+| Not Expected
+| No support for inputOutput
 |-
 | Octaga
 | 2.2.0.12
-| Expected
+| Not Expected
+| same as bscontact but addition initialize() is not called. Breaks the ECMAScript spec
 |-
 | Instant Reality
 | 2.0.0_beta4
 | Not Expected
-| Both spheres the same intensity, expect attenuation not supported
+| reading foo returns the function not the field value.
+|
 |-

@@ Line 1: / Line 1: @@
   <?xml version="1.0" encoding="UTF-8"?>
- <X3D profile='Full' >
+    <X3D profile='Full' >
    <Scene DEF='scene'>
      <Viewpoint position='20 0 40'/>
@@ Line 17: / Line 17: @@
      text.string[0] = line;
+    }
    //-----------------------------
    function readFoo (value) {
     text.string[1] = 'readFoo called: TRUE, value: ' + foo;
+   }
    //-----------------------------
    function foo (value) {
     text.string[3] = 'foo function called: TRUE; ' + value;
+   }
    //-----------------------------
    function set_foo (value) {
     text.string[4] = 'set_foo function called: TRUE; ' + value;
+   }
    //-----------------------------
    function foo_changed (value) {
@@ Line 45: / Line 41: @@
        </field>
        <field accessType='inputOnly' name='fooCatcher' type='SFFloat'/><![CDATA[ecmascript:
    //-----------------------
    function fooCatcher (value) {
      text.string[2] = 'Foo value send: TRUE; value: ' + value;
+   }
    ]]>
      </Script>
@@ Line 57: / Line 51: @@
      <ROUTE fromNode='s1' fromField='foo_changed' toNode='s2' toField='fooCatcher'/>
    </Scene>
-</X3D>
+ </X3D>
 == Browser Results ==