instantreality 1.0

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

ScreenTextOverlay

Textual foreground, that just displays all strings according to a simple style.

Inheritance

Code

XML encoding
<ScreenTextOverlay text=''
color='1,1,1,1'
bgColor='0,0,0,0'
shadowColor='0,0,0,1'
shadowOffset='1,-1'
borderColor='-1,-1,-1,0'
borderOffset='4,4'
pointSize='12.0'
family=''
horizontalAlign='LEFT'
verticalAlign='TOP'
textMargin='0,0'
enabled='TRUE'
exclusive='FALSE'
logFeature=''
 />
Classic encoding
ScreenTextOverlay {
	text [""]
	color 1,1,1,1
	bgColor 0,0,0,0
	shadowColor 0,0,0,1
	shadowOffset 1,-1
	borderColor -1,-1,-1,0
	borderOffset 4,4
	pointSize 12.0
	family ""
	horizontalAlign "LEFT"
	verticalAlign "TOP"
	textMargin 0,0
	enabled TRUE
	exclusive FALSE
	logFeature [""]
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
SFString family SFString initializeOnly The font family to be used, e.g. "SANS", default if unset.
SFFloat pointSize SFFloat initializeOnly 12.0 Height of a single line (only used if family not empty).
SFColorRGBA bgColor SFColorRGBA inputOutput 0,0,0,0 Color of the background.
SFColorRGBA borderColor SFColorRGBA inputOutput -1,-1,-1,0 Color of the border, ignored if negative.
SFVec2f borderOffset SFVec2f inputOutput 4,4 Offset of the border in pixels.
SFColorRGBA color SFColorRGBA inputOutput 1,1,1,1 Color of the text.
SFBool enabled SFBool inputOutput TRUE flag to enable/disable the overlay
SFBool exclusive SFBool inputOutput FALSE defines if the overlay should be exclusive visible or not
SFString horizontalAlign SFString inputOutput LEFT [LEFT, MIDDLE, RIGHT] Simple form of layout management, default is left.
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
SFColorRGBA shadowColor SFColorRGBA inputOutput 0,0,0,1 Color of the text shadows.
SFVec2f shadowOffset SFVec2f inputOutput 1,-1 Offset of the text shadows, in pixels.
MFString text MFString inputOutput The text, each string corresponds to one line.
SFVec2f textMargin SFVec2f inputOutput 0,0 Text margin in pixels.
SFString verticalAlign SFString inputOutput TOP [TOP, CENTER, BOTTOM] Simple form of layout management, default is top.