instantreality 1.0

Component:
Engine
Status:
experimental
Structure type:
concrete
Standard:
Avalon

StreamViewarea

Inheritance

Code

XML encoding
<StreamViewarea streamID='video'
quality='0.9'
sample='0'
timeout='-1'
sessionID=''
red='TRUE'
green='TRUE'
blue='TRUE'
alpha='TRUE'
leftBuffer='TRUE'
rightBuffer='TRUE'
enabled='TRUE'
view=''
background=''
foreground=''
environment=''
user=''
fog=''
lowerLeft='0 0'
upperRight='1 1'
description=''
grabFrames='0'
grabFile='frame%04d.png'
statisticLevel='0'
keyPress='0'
keyRelease='0'
mousePress='0'
mouseRelease='0'
mouseMove='0 0'
logFeature=''
 />
Classic encoding
StreamViewarea {
	streamID "video"
	quality 0.9
	sample 0
	timeout -1
	sessionID ""
	red TRUE
	green TRUE
	blue TRUE
	alpha TRUE
	leftBuffer TRUE
	rightBuffer TRUE
	enabled TRUE
	view [""]
	background [""]
	foreground [""]
	environment [""]
	user [""]
	fog [""]
	lowerLeft 0 0
	upperRight 1 1
	description ""
	grabFrames 0
	grabFile "frame%04d.png"
	statisticLevel 0
	keyPress 0
	keyRelease 0
	mousePress 0
	mouseRelease 0
	mouseMove 0 0
	logFeature [""]
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
MFNode modifier MFNode initializeOnly ViewModifier Modifiers are used to add additional features to the viewing matrix. This is used for tiled displays or other complex projections.
SFString sessionID SFString initializeOnly
SFString streamID SFString initializeOnly video
SFTime timeout SFTime initializeOnly -1
SFBool mouseOver SFBool inputOnly FALSE Emits true, if mouse points to a pointing sensor
SFBool alpha SFBool inputOutput TRUE If FALSE, the alpha color component is removed.
MFString background MFString inputOutput Names of background objects that should be used on this viewarea. If no name is given, the currently bound background is used. If more than one name is given, the first valid backgound is used
SFBool blue SFBool inputOutput TRUE If FALSE, the blue color component is removed.
SFString description SFString inputOutput Textual description of this viewarea
MFNode displayFilter MFNode inputOutput DisplayFilter Holds all optional display filter nodes
SFBool enabled SFBool inputOutput TRUE If FALSE, rendering is disabled
MFString environment MFString inputOutput Names of environment objects that should be used on this viewarea. If no name is given, the currently bound background is used. If more than one name is given, the first valid environment is used
MFString fog MFString inputOutput Names of fog bindable objects that should be used on this viewarea. If no name is given, the currently bound fog is used. If more than one name is given, the first valid fog is used
MFString foreground MFString inputOutput Names of foreground objects that should be used on this viewarea. If no name is given, the currently bound foreground is used. If more than one name is given, the first valid foreground is used
SFString grabFile SFString inputOutput frame%04d.png Filename that should be used to save grabed images. A sequence number can be used with the sprintf %d operator.
SFInt32 grabFrames SFInt32 inputOutput 0 If value positive, 'value' rendered images are grabed and written into a file given by grabFile, if value=-1, grabbing is always done, if 0, it is disabled.
SFBool green SFBool inputOutput TRUE If FALSE, the green color component is removed.
SFInt32 keyPress SFInt32 inputOutput 0 Key press event output
SFInt32 keyRelease SFInt32 inputOutput 0 Key release event output
SFBool leftBuffer SFBool inputOutput TRUE If TRUE, rendering is done to the view buffer for the left eye
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
SFVec2f lowerLeft SFVec2f inputOutput 0 0 Lower left corner of the viewarea. Values less or equal then 1 are treated as relative values. If values are greater then 1, the values are treated as number of pixels
SFNode metadata SFNode inputOutput MetadataObject container for payload metadata inside MetadataSet element
SFVec2f mouseMove SFVec2f inputOutput 0 0 Mouse move event. Gives the position of the mouse in 2D window space
SFInt32 mousePress SFInt32 inputOutput 0 Mouse button press event output
SFInt32 mouseRelease SFInt32 inputOutput 0 Mouse button release event output
SFNode navigator SFNode inputOutput Navigator Navigator object used for user interaction
SFFloat quality SFFloat inputOutput 0.9
SFBool red SFBool inputOutput TRUE If FALSE, the red color component is removed.
SFBool rightBuffer SFBool inputOutput TRUE If TRUE, rendering is done to the view buffer for the right eye
SFInt32 sample SFInt32 inputOutput 0
SFInt32 statisticLevel SFInt32 inputOutput 0 Statistics level
SFVec2f upperRight SFVec2f inputOutput 1 1 Upper right corner of the viewarea. Values less or equal then 1 are treated as relative values. If values are greater then 1, the values are treated as number of pixels
MFString user MFString inputOutput Names of user bindable objects that should be used on this viewarea. If no name is given, the currently bound user is used. If more than one name is given, the first valid user is used
MFString view MFString inputOutput Names of viewpoint objects that should be used on this viewarea. If no name is given, the currently bound viewpoint is used. If more than one name is given, the first valid viewpoint is used.
SFString message SFString outputOnly Message to be processed. Valid messages are: toggleFullScreen toggleHeadlight toggleGlobalShadow nextShadowMode toggleLazyInteractionEvalution toggleDrawVolume toggleCullFrustum toggleCullOcclusion nextDrawMode pointDrawMode lineDrawMode fillDrawMode nextInfoScreen firstView lastView nextView prevView resetViewPosition showAll walkNav flyNav freeFlyNav examineNav lookatNav noneNav forward backward left right exportBackendASC exportBackendBIN exit
MFVec4f touchPoints MFVec4f outputOnly Touch points (x, y, id, button state) with button press 0, release 1, move 2.