Configuring CWASA for HTML5 web pages - Revision history

John.Glauert at 09:46, 31 July 2024

2024-07-31T09:46:22Z

← Older revision		Revision as of 09:46, 31 July 2024
Line 244:		Line 244:

	==== Examples ====		==== Examples ====
	Examples of use of these methods will be found on the '''~~OneAvTest~~.html''' example web page. The logging and event hook facilities are described under [[Logging and Event Hooks]].		Examples of use of these methods will be found on the '''OneAvClientTest.html''' example web page. The logging and event hook facilities are described under [[Logging and Event Hooks]].

	----		----
	[[Main Page\|Home]] >> [[CWA Signing Avatars\|CWASA]]		[[Main Page\|Home]] >> [[CWA Signing Avatars\|CWASA]]

John.Glauert: More on initialisation of CWASA.

2023-06-30T15:31:11Z

John.Glauert: Fix typos for CWASA.callHook

2023-06-30T15:14:10Z

Fix typos for CWASA.callHook

← Older revision		Revision as of 15:14, 30 June 2023
Line 236:		Line 236:
	* '''CWASA.getLogger(logger, loggerlevel)''': Configure and receive a CWASA logger.		* '''CWASA.getLogger(logger, loggerlevel)''': Configure and receive a CWASA logger.
	* '''CWASA.addHook(typ fun, av)''': Install a hook function to be called on specific events for specific avatars.		* '''CWASA.addHook(typ fun, av)''': Install a hook function to be called on specific events for specific avatars.
	* '''CWASA.~~callHookL~~(typ, msg, av)''': Post ~~and~~ event to be passed to appropriate hook functions.		* '''CWASA.callHook(typ, msg, av)''': Post an event to be passed to appropriate hook functions.

	Examples of use of these methods will be found on the '''OneAvTest.html''' example web page. The logging and event hook facilities are described under [[Logging and Event Hooks]].		Examples of use of these methods will be found on the '''OneAvTest.html''' example web page. The logging and event hook facilities are described under [[Logging and Event Hooks]].

John.Glauert: /* CWASA Web Pages */

2021-11-24T17:10:11Z

CWASA Web Pages

← Older revision		Revision as of 17:10, 24 November 2021
Line 225:		Line 225:
	<pre><body onload="CWASA.init({ambIdle:false,useClientConfig:true});"></pre>		<pre><body onload="CWASA.init({ambIdle:false,useClientConfig:true});"></pre>
	To change the initial camera position and make signing slightly slower:		To change the initial camera position and make signing slightly slower:
	<pre><body onload="CWASA.init({avSettings:{initCamera:[0.00,0.53,2.06,-12.50,18.00,30.00,-1.00,-1.00],initSpeed:-1}~~,useClientConfig:true~~});"></pre>		<pre><body onload="CWASA.init({useClientConfig:true,
			avSettings:{initCamera:[0.00,0.53,2.06,-12.50,18.00,30.00,-1.00,-1.00],initSpeed:-1}});"></pre>

	All methods to be used are found in the '''CWASA''' object. Examples of direct calls to CWASA are illustrated in the BSLExamples demo mentioned above,		All methods to be used are found in the '''CWASA''' object. Examples of direct calls to CWASA are illustrated in the BSLExamples demo mentioned above,

John.Glauert at 12:40, 24 November 2021

2021-11-24T12:40:02Z

← Older revision		Revision as of 12:40, 24 November 2021
Line 224:		Line 224:
	as for example pages using a server or Java applets. To disable ambient animation by default, but use other '''clientcfg.json''' settings:		as for example pages using a server or Java applets. To disable ambient animation by default, but use other '''clientcfg.json''' settings:
	<pre><body onload="CWASA.init({ambIdle:false,useClientConfig:true});"></pre>		<pre><body onload="CWASA.init({ambIdle:false,useClientConfig:true});"></pre>
			To change the initial camera position and make signing slightly slower:
			<pre><body onload="CWASA.init({avSettings:{initCamera:[0.00,0.53,2.06,-12.50,18.00,30.00,-1.00,-1.00],initSpeed:-1},useClientConfig:true});"></pre>


	All methods to be used are found in the '''CWASA''' object. Examples of direct calls to CWASA are illustrated in the BSLExamples demo mentioned above,		All methods to be used are found in the '''CWASA''' object. Examples of direct calls to CWASA are illustrated in the BSLExamples demo mentioned above,

John.Glauert: Add initSpeed and rateSpeed settings

2021-11-24T12:36:09Z

Add initSpeed and rateSpeed settings

← Older revision		Revision as of 12:36, 24 November 2021
Line 68:		Line 68:

	The default is to specify no [[Animgen]] server and client-side JavaScript will implement [[Animgen]].		The default is to specify no [[Animgen]] server and client-side JavaScript will implement [[Animgen]].
	Some example web pages specify a server that will be used instead.		Some example web pages specify a server that will be used instead. The public server is
			[http://vhg.cmp.uea.ac.uk/cgi-bin/animgen/animgenserver.pl http://vhg.cmp.uea.ac.uk/cgi-bin/animgen/animgenserver.pl].
	The deprecated Java Applet implementing [[Animgen]] can be accessed using a pseudo-server '''stoca:'''.		The deprecated Java Applet implementing [[Animgen]] can be accessed using a pseudo-server '''stoca:'''.
	Processing will fall back to the client-side implementation if Java is not supported in the chosen browser.		Processing will fall back to the client-side implementation if Java is not supported in the chosen browser.
Line 87:		Line 88:
	* '''background''': By default the canvas will have a transparent background but valid text for a style background in HTML can be provided. Set to '''null''' to force a transparent background.		* '''background''': By default the canvas will have a transparent background but valid text for a style background in HTML can be provided. Set to '''null''' to force a transparent background.
	* '''initCamera''': Nine numbers that define the initial camera position when the avatar is loaded.		* '''initCamera''': Nine numbers that define the initial camera position when the avatar is loaded.
			* '''initSpeed''': Initial speed setting. See below.
			* '''rateSpeed''': Rate of change to speed in GUI. See below.

	Note that an '''ambIdle''' setting may be given at installation level and will be inherited by each panel that does not provide its own setting.		Note that an '''ambIdle''' setting may be given at installation level and will be inherited by each panel that does not provide its own setting.

			The actual animation speed is given by '''2^(currSpeed/rateSpeed)''' where '''currSpeed''' is initially set to '''initSpeed''' and may be increased or decreased in the GUI. The rate determines how many steps are needed to change the speed by a factor of 2.

	The remaining parameters are mostly needed when a GUI is generated automatically as a full panel:		The remaining parameters are mostly needed when a GUI is generated automatically as a full panel:
Line 98:		Line 103:
	== CWASA Configuration Examples ==		== CWASA Configuration Examples ==
	=== Example: cwa/cwacfg.json ===		=== Example: cwa/cwacfg.json ===
	Example installation configuration ~~that would use the public [[Animgen]] server~~:		Example installation configuration:
	{		{
	"description" : "======== CWASA installation configuration data ========",		"description" : "======== CWASA installation configuration data : Main release ========",
	"jasBase" : "http://vhg.cmp.uea.ac.uk/tech/jas/vhg2021/",		"jasBase" : "http://vhg.cmp.uea.ac.uk/tech/jas/vhg2021/",
	"jasVersionTag" : "vhg2021",		"jasVersionTag" : "vhg2021",

	"sigmlBase" : "sigml",		"sigmlBase" : "sigml",
	"avJARBase" : "avatars",		"avJARBase" : "avatars",
	"avJSONBase" : "avjson",		"avJSONBase" : "avjson",
	"useAvatarJARs" : true,		"useAvatarJARs" : true,
	"animgenFPS" : 50,
	~~"animgenServer" : "http://vhg.cmp.uea.ac.uk/cgi-bin/animgen/animgenserver.pl",~~		"animgenFPS" : 30,

	"avs" : [		"avs" : [
	"anna", "marc", "francoise"		"anna", "marc", "francoise"
	],		],

	"avsfull" : [		"avsfull" : [
	"anna",		"anna", "marc", "francoise",
	"~~beatrice", "candy", "darshan~~", "francoise~~", "genie", "luna~~",		"luna", "siggi"
	"~~marc", "max", "monkey", "otis", "robotboy~~", "siggi"
	],		],

	"avSettings" : [		"avSettings" : [
	{		{
Line 125:		Line 133:
	"initAv": "anna",		"initAv": "anna",
	"initCamera": [ 0, 0.23, 3.24, 5, 18, 30, -1, -1 ],		"initCamera": [ 0, 0.23, 3.24, 5, 18, 30, -1, -1 ],
			"initSpeed": 0,
			"rateSpeed": 5
	"allowFrameSteps": true,		"allowFrameSteps": true,
	"initSiGMLURL": "iTakeMug.sigml",		"initSiGMLURL": "iTakeMug.sigml",

John.Glauert: /* CWASA Web Pages */

2021-02-23T16:28:22Z

CWASA Web Pages

← Older revision		Revision as of 16:28, 23 February 2021
Line 207:		Line 207:

	To use CWASA, include the following CSS file and JavaScript code, relative to the JASigning installation:		To use CWASA, include the following CSS file and JavaScript code, relative to the JASigning installation:
	<pre><link rel="stylesheet" href="http://vhg.cmp.uea.ac.uk/tech/jas/~~vhg2017~~/cwa/cwasa.css" />		<pre><link rel="stylesheet" href="http://vhg.cmp.uea.ac.uk/tech/jas/vhg2021/cwa/cwasa.css" />
	<script type="text/javascript" src="http://vhg.cmp.uea.ac.uk/tech/jas/~~vhg2017~~/cwa/allcsa.js"></script></pre>		<script type="text/javascript" src="http://vhg.cmp.uea.ac.uk/tech/jas/vhg2021/cwa/allcsa.js"></script></pre>
	The method '''CWASA.init();''' should be called on loading the body of the page:		The method '''CWASA.init();''' should be called on loading the body of the page:
	<pre><body onload="CWASA.init();"></pre>		<pre><body onload="CWASA.init();"></pre>

John.Glauert at 16:27, 23 February 2021

2021-02-23T16:27:09Z

← Older revision		Revision as of 16:27, 23 February 2021
Line 212:		Line 212:
	<pre><body onload="CWASA.init();"></pre>		<pre><body onload="CWASA.init();"></pre>
	Initial configuration parameters can be specified using a JSON object passed as a parameter to '''CWASA.init''', such		Initial configuration parameters can be specified using a JSON object passed as a parameter to '''CWASA.init''', such
	as for example pages using a server or Java applets.		as for example pages using a server or Java applets. To disable ambient animation by default, but use other '''clientcfg.json''' settings:
			<pre><body onload="CWASA.init({ambIdle:false,useClientConfig:true});"></pre>

	All methods to be used are found in the '''CWASA''' object. Examples of direct calls to CWASA are illustrated in the BSLExamples demo mentioned above,		All methods to be used are found in the '''CWASA''' object. Examples of direct calls to CWASA are illustrated in the BSLExamples demo mentioned above,

John.Glauert: Adding ambIdle setting and CWASAAmbBox gui element.

2021-02-22T15:08:02Z

Adding ambIdle setting and CWASAAmbBox gui element.

← Older revision		Revision as of 15:08, 22 February 2021
Line 84:		Line 84:
	* '''avList''': Name of parameter holding avatar list. This will be '''avs''' by default.		* '''avList''': Name of parameter holding avatar list. This will be '''avs''' by default.
	* '''initAv''': Name of avatar that is loaded initially. Should normally be already present in the '''avList'''.		* '''initAv''': Name of avatar that is loaded initially. Should normally be already present in the '''avList'''.
			* '''ambIdle''': Flag controlling whether ambient motion accompanies an idle avatar.
	* '''background''': By default the canvas will have a transparent background but valid text for a style background in HTML can be provided. Set to '''null''' to force a transparent background.		* '''background''': By default the canvas will have a transparent background but valid text for a style background in HTML can be provided. Set to '''null''' to force a transparent background.
	* '''initCamera''': Nine numbers that define the initial camera position when the avatar is loaded.		* '''initCamera''': Nine numbers that define the initial camera position when the avatar is loaded.

			Note that an '''ambIdle''' setting may be given at installation level and will be inherited by each panel that does not provide its own setting.

	The remaining parameters are mostly needed when a GUI is generated automatically as a full panel:		The remaining parameters are mostly needed when a GUI is generated automatically as a full panel:
Line 182:		Line 185:
	=== GUI Elements ===		=== GUI Elements ===
	* '''CWASAAvMenu''': A menu listing avatars in the expanded '''avList''' for the avatar.		* '''CWASAAvMenu''': A menu listing avatars in the expanded '''avList''' for the avatar.
			* '''CWASAAmbBox''': A checkbox controlling whether ambient motion is seen for an idle avatar.
	* '''CWASASpeed''': Controls for decreasing, increasing, and resetting the speed of animation.		* '''CWASASpeed''': Controls for decreasing, increasing, and resetting the speed of animation.
	* '''CWASASiGMLURL''': Input to hold a SiGML URL. Omitted by '''CWASAGUI''' if no initial URL is given.		* '''CWASASiGMLURL''': Input to hold a SiGML URL. Omitted by '''CWASAGUI''' if no initial URL is given.

John.Glauert at 14:54, 22 February 2021

2021-02-22T14:54:23Z

← Older revision		Revision as of 14:54, 22 February 2021
Line 42:		Line 42:
	* Settings for configuring a GUI for one or more avatar panels.		* Settings for configuring a GUI for one or more avatar panels.

	Full example configuration files are given below. Initial settings are provided using a similar JavaScript JSON object as in '''appletframe.html''' in BSLExamples ([[~~JASigning~~ Local Installation]]).		Full example configuration files are given below. Initial settings are provided using a similar JavaScript JSON object as in '''appletframe.html''' in BSLExamples ([[CWASA Local Installation]]).
	Unrecognised settings (such as '''description''') are ignored without comment.		Unrecognised settings (such as '''description''') are ignored without comment.

Line 52:		Line 52:
	* '''useCwaConfig''': Controls whether '''cwacfg.json''' is consulted. Default '''true'''.		* '''useCwaConfig''': Controls whether '''cwacfg.json''' is consulted. Default '''true'''.

	Hence '''useClientConfig''' should be set by pages using Initial settings ~~when it is~~ also ~~desired~~ to consult a '''clientcfg.json''' file.		Hence '''useClientConfig''' should be set to '''true''' by pages using Initial settings that also wish to consult a '''clientcfg.json''' file.

	== CWASA Installation Settings ==		== CWASA Installation Settings ==

← Older revision		Revision as of 15:31, 30 June 2023
Line 238:		Line 238:
	* '''CWASA.callHook(typ, msg, av)''': Post an event to be passed to appropriate hook functions.		* '''CWASA.callHook(typ, msg, av)''': Post an event to be passed to appropriate hook functions.

			==== Testing for Initialisation ====
			A call to '''CWASA.init''' sets up a promise at '''CWASA.ready''' that will be resolved when all the configuration data has been loaded.

			To test when an avatar is loaded and rendered, it is possible to add a hook for the '''avatarready''' event. This will be called for each avatar panel and on switching avatars on a panel.

			==== Examples ====
	Examples of use of these methods will be found on the '''OneAvTest.html''' example web page. The logging and event hook facilities are described under [[Logging and Event Hooks]].		Examples of use of these methods will be found on the '''OneAvTest.html''' example web page. The logging and event hook facilities are described under [[Logging and Event Hooks]].

	----		----
	[[Main Page\|Home]] >> [[CWA Signing Avatars\|CWASA]]		[[Main Page\|Home]] >> [[CWA Signing Avatars\|CWASA]]