instantreality 1.0

Component:
Engine
Status:
fully implemented
Structure type:
concrete
Standard:
Avalon

Engine

The Engine node defines the roote node for the Enginegraph (simular to the Scene defining the root node for the Scenegraph). There can be only on Engine instance per Enginegraph. The main purpose of the node is to hold and trigger the jobs-objects.

Inheritance

Code

XML encoding
<Engine frameTime='0'
frameRate='0'
desiredFrameRate='0'
resolution='1'
collectStatistics='TRUE'
requiredJobList='TimerJob,InteractionJob,ExternalInterfaceJob,WebServiceJob,CollisionJob,SoundJob,CombinerJob,SynchronizeJob,RenderJob'
logJobStatistics='FALSE'
logFeature=''
 />
Classic encoding
Engine {
	frameTime 0
	frameRate 0
	desiredFrameRate 0
	resolution 1
	collectStatistics TRUE
	requiredJobList ["TimerJob,InteractionJob,ExternalInterfaceJob,WebServiceJob,CollisionJob,SoundJob,CombinerJob,SynchronizeJob,RenderJob"]
	logJobStatistics FALSE
	logFeature [""]
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
SFBool collectStatistics SFBool inputOutput TRUE If true, some statistical fields are filled.
SFFloat desiredFrameRate SFFloat inputOutput 0 0 meens full speed
SFTime frameFinished SFTime outputOnly The finished event is emitted, after the last job is executed
SFFloat frameRate SFFloat inputOutput 0 current frame rate
SFFloat frameTime SFFloat inputOutput 0 current frame time
MFString jobExecOrder MFString outputOnly provides the exec order of jobs, this is mostly for logging and debugging
MFNode jobs MFNode inputOutput Jobs to be executed by this engine
MFString logFeature MFString inputOutput state, child, parent, route, eventIn, eventOut controls the logging of changes, state: log state changes (e.g. live), child: log child add/remove, parent: log parent add/remove, route: log route add/remove; eventIn: log receiving of events, eventOut: log sending of events: guiView, runtime system should create node-view, guiEdit: runtime system should create node-editeverything: log everything
SFBool logJobStatistics SFBool inputOutput FALSE flag to switch console-log messages of job statistics on/off
SFNode metadata SFNode inputOutput MetadataObject container for payload metadata inside MetadataSet element
MFString requiredJobList MFString initializeOnly TimerJob,InteractionJob,ExternalInterfaceJob,WebServiceJob,CollisionJob,SoundJob,CombinerJob,SynchronizeJob,RenderJob Requied job list
SFFloat resolution SFFloat initializeOnly 1 Unused
SFTime startFrame SFTime outputOnly The startFrame event is emitted, before the first job is executed