instantreality 1.0

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

GradientBackground

A background showing a vertical color gradient. The colors and positions correspond to each other, so both have to have the same number of elements. To specify the gradient a color has to be associated with a vertical position in the viewport (0 being at the bottom, 1 being at the top). An arbitrary number of gradient steps can be used, if only one is given it is used for the whole screen, if none is given black is used. Areas outside the specified gradient borders are filled with black, too.

Inheritance

Code

XML encoding
<GradientBackground logFeature=''
triggerName='Synchronize'
description=''
isDefault='FALSE'
color=''
clearStencilBitplanes='-1'
position=''
 />
Classic encoding
GradientBackground {
	logFeature [""]
	triggerName "Synchronize"
	description ""
	isDefault FALSE
	color []
	clearStencilBitplanes -1
	position []
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
MFFloat position MFFloat inputOutput [0, 1] gradient positions
MFColor color MFColor inputOutput gradient colors
SFInt32 clearStencilBitplanes SFInt32 inputOutput -1 Usually 0 is used to clear all stencil bitplanes (clear is deactivated if smaller zero).
XFAny bind XFAny inputOnly sending any event to this slot will bind/activate the Bindable
SFBool set_bind SFBool inputOnly Sending event set_bind=true makes this node active. Sending event set_bind=false makes this node inactive. Thus setting set_bind to true/false will pop/push (enable/disable) this Bindable
SFTime bindTime SFTime outputOnly Event sent when node becomes active/inactive.
SFBool isBound SFBool outputOnly FALSE Event true sent when node becomes active, event false sent when unbound by another node.
SFBool isDefault SFBool initializeOnly FALSE indicates if the object is the default bindable or not (generated if the scene did not contain any Bindable of a missing Type (e.g. Viewpoint))
SFString description SFString initializeOnly Text description or navigation hint to be displayed for this Bindable. Hint: make descriptions clear and readable. Warning: without description, Bindable (e.g. Viewpoint objs) can not be activated/deactivated with keyboard or gui messages (e.g. switched with PgUp bzw PgDn)
SFString triggerName SFString initializeOnly Synchronize name of the dynamic context-slot which is used by the run-time environment (e.g. Jobs) to trigger the node. Life-Nodes will automatically connect the context-eventOutut to the triggerSlot-eventInput Slot.
SFTime triggerSlot SFTime inputOnly slot which is used internally to connect a dynamic context-slot which name is set by the triggerName value. Its used automatically to install run-time environment trigger.
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
SFNode metadata SFNode inputOutput MetadataObject container for payload metadata inside MetadataSet element