instantreality 1.0

Component:
EnvironmentalEffects
Status:
fully implemented
Structure type:
concrete
Standard:
X3D2.0

Fog (Standard name: FogBindable)

Fog simulates atmospheric effects by blending distant objects with fog color. Background, Fog, NavigationInfo, TextureBackground and Viewpoint are bindable nodes.

Inheritance

Code

XML encoding
<Fog color='1 1 1'
fogType='LINEAR'
visibilityRange='0'
isDefault='FALSE'
description=''
triggerName='Synchronize'
logFeature=''
 />
Classic encoding
Fog {
	color 1 1 1
	fogType "LINEAR"
	visibilityRange 0
	isDefault FALSE
	description ""
	triggerName "Synchronize"
	logFeature [""]
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
XFAny bind XFAny inputOnly sending any event to this slot will bind/activate the Bindable
SFTime bindTime SFTime outputOnly Event sent when node becomes active/inactive.
SFColor color SFColor inputOutput 1 1 1 Hint: match Background color to make objects fade away.
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 fogType SFString inputOutput LINEAR Specifies algorithm for rate of increasing Fog, either linear or exponential types are supported. Exponentials are more natural but also more computationally expensive. Modes correspond the OpenGL fog modes: LINEAR: GL_LINEAR;EXPONENTIAL: GL_EXP; EXP: GL_EXP; EXPONENTIAL2: GL_EXP2; EXP2: GL_EXP2
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))
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
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
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.
SFFloat visibilityRange SFFloat inputOutput 0 [0, inf) Distance in meters where objects are totally obscured by the fog, using local coordinate system. Hint: visibilityRange 0 disables Fog.