instantreality 1.0

Component:
Networking
Status:
partly implemented
Structure type:
concrete
Standard:
X3D3.0

LoadSensor

LoadSensor generates events as watchList child nodes are either loaded or fail to load. Changing watchlist child nodes restarts the LoadSensor. Hint: use multiple LoadSensor nodes to track multiple loading nodes individually. Hint: Background is not sensed due to multiple-image ambiguity. Warning: watchList child nodes are not rendered, so normally USE copies of other nodes to sense load status. Hint: use Inline 'load' field to prompt or defer loading. Warning: new X3D node, not supported in VRML 97.

Inheritance

Code

XML encoding
<LoadSensor timeOut='0'
triggerName='Timer'
description=''
enabled='TRUE'
logFeature=''
 />
Classic encoding
LoadSensor {
	timeOut 0
	triggerName "Timer"
	description ""
	enabled TRUE
	logFeature [""]
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
SFTime timeOut SFTime inputOutput 0 Time in seconds of maximum load duration prior to declaring failure. Default value zero means use browser defaults.
MFNode watchList MFNode inputOutput Contains one or more URL objects to monitor. Only nodes that contain a valid URL field (i.e., descendants of X3DUrlObject), may be specified as elements of watchList. If multiple values are specified for this field, output events are generated only when all of the children have loaded or at least one has failed. Changing watchlist child nodes restarts the LoadSensor. Warning: watchList child nodes are not rendered, so normally USE copies of other nodes to sense load status.
SFBool isLoaded SFBool outputOnly Notify when all watchList child nodes are loaded, or at least one has failed. Sends true on successfully loading all watchList child nodes. Sends false on timeOut of any watchList child nodes, failure of any watchList child nodes to load, or no local copies available and no network present. Hint: use multiple LoadSensor nodes to track multiple loading nodes individually.
SFFloat progress SFFloat outputOnly [0, 1] Sends 0.0 on start and 1.0 on completion. Intermediate values are browser dependent and always increasing (may indicate fraction of bytes, fraction of expected time or another metric). Hint: only 0 and 1 events are guaranteed.
SFTime loadTime SFTime outputOnly Time of successful load complete, not sent on failure.
SFString description SFString inputOutput Text description to comment the sensor task. Can be used in run-time systems to give usefull feedback to the user and developer
SFBool enabled SFBool inputOutput TRUE Enables/disables the sensor node.
SFBool isActive SFBool outputOnly FALSE isActive true/false events are sent when the sensor gets active
SFNode metadata SFNode inputOutput MetadataObject container for payload metadata inside MetadataSet element