instantreality 1.0

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

PolygonOverlay

Defines a single overlay. Overlays can only be uses as parts/childs of a Foreground node. Use a Foreground node to group overlays

Inheritance

Code

XML encoding
<PolygonOverlay positions='0 0, 1 0, 1 1, 0 1'
texCoords='0 0 0, 1 0 0, 1 1 0, 0 1 0'
normalizedX='TRUE'
normalizedY='TRUE'
fixedImageSize='0,0'
zoomFactor='1.0'
tile='TRUE'
enabled='TRUE'
exclusive='FALSE'
logFeature=''
 />
Classic encoding
PolygonOverlay {
	positions [0 0, 1 0, 1 1, 0 1]
	texCoords [0 0 0, 1 0 0, 1 1 0, 0 1 0]
	normalizedX TRUE
	normalizedY TRUE
	fixedImageSize 0,0
	zoomFactor 1.0
	tile TRUE
	enabled TRUE
	exclusive FALSE
	logFeature [""]
}

Interface

Filter: X3D only | Avalon only | All
id Name DataType PartType Default ValueType Description
SFNode appearance SFNode inputOutput Appearance The appearance used to render the polygon.
MFVec2f positions MFVec2f inputOutput 0 0, 1 0, 1 1, 0 1 The positions of the polygon to display. Default is a screen-filling quad.
MFVec3f texCoords MFVec3f inputOutput 0 0 0, 1 0 0, 1 1 0, 0 1 0 Texture coordinates for the polygon.
SFBool normalizedX SFBool inputOutput TRUE Define whether the x coordinates are normalized (0-1) or pixel-based .
SFBool normalizedY SFBool inputOutput TRUE Define whether the y coordinates are normalized (0-1) or pixel-based .
SFVec2f fixedImageSize SFVec2f inputOutput 0,0 Useful for keeping aspect ratio when rendering things like images by defining (width, height).
SFFloat zoomFactor SFFloat inputOutput 1.0 Zooming factor for scaling background image.
SFBool tile SFBool inputOutput TRUE If true the overlay tiles in multi window settings.
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
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