instantreality 1.0

Component:
SpatialUserInterface
Status:
fully implemented
Structure type:
abstract
Standard:
Avalon

WidgetTexture

Abstract base class for textures that handle 2D GUIs like typical desktop widget sets. If the slots pointer and button1 are filled with valid values, it is possible to interact with the user interface.

Inheritance

Code

XML encoding
<WidgetTexture show='FALSE'
updateMode='auto'
opaque='TRUE'
pointer='0 0'
button1='FALSE'
button2='FALSE'
button3='FALSE'
enabled='TRUE'
triggerName='Timer'
logFeature=''
 />
Classic encoding
WidgetTexture {
	show FALSE
	updateMode "auto"
	opaque TRUE
	pointer 0 0
	button1 FALSE
	button2 FALSE
	button3 FALSE
	enabled TRUE
	triggerName "Timer"
	logFeature [""]
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
SFBool opaque SFBool initializeOnly TRUE render widget with background.
SFNode textureProperties SFNode initializeOnly TextureProperties Definition of a texture property set. When set, the corresponding fields like repeat etc of the texture itself are ignored.
SFString triggerName SFString initializeOnly Timer 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-eventOutput to the triggerSlot-eventInput Slot.
SFInt32 actionKeyPress SFInt32 inputOnly To be used for incoming actionKeyPress events.
SFInt32 actionKeyRelease SFInt32 inputOnly To be used for incoming actionKeyRelease events.
SFString keyPress SFString inputOnly To be used as key pressed event.
SFString keyRelease SFString inputOnly To be used as key released event.
SFTime triggerSlot SFTime inputOnly Slot which is used internally to connect a dynamic context-slot whose name is set by the triggerName value. It is used automatically to install a run-time environment trigger.
SFBool button1 SFBool inputOutput FALSE If gets TRUE, process button1 pressed event (usually treated as left mouse button), else trigger release.
SFBool button2 SFBool inputOutput FALSE If gets TRUE, process button2 pressed event (usually treated as middle mouse button), else trigger release.
SFBool button3 SFBool inputOutput FALSE If gets TRUE, process button3 pressed event (usually treated as right mouse button), else trigger release.
SFBool enabled SFBool inputOutput TRUE Flag to enable/disable the update.
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
SFVec2f pointer SFVec2f inputOutput 0 0 Position of the pointing device (generally between 0 and 1).
SFBool show SFBool inputOutput FALSE If TRUE, the dialog form is shown in a separate window.
SFString updateMode SFString inputOutput auto [auto, always, onInteraction, conservative] Defines the update mode, always can handle time based content, but gets slow with many textures, onInteraction handles mouse-like events (default), and conservative only regards click-like events and widget updates.
SFImage image_changed SFImage outputOnly sends a singe image on change