PolygonBackground
A Background that renders a single polygon using the specified material.
Inheritance
Code
XML encoding
<PolygonBackground 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' doCleanup='TRUE' mode='VERTICAL' clearStencilBitplanes='-1' isDefault='FALSE' description='' triggerName='Synchronize' logFeature='' />
Classic encoding
PolygonBackground { 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 doCleanup TRUE mode "VERTICAL" clearStencilBitplanes -1 isDefault FALSE description "" triggerName "Synchronize" logFeature [""] }
Interface
Filter: X3D only | Avalon only | All
id | Name | DataType | PartType | Default | ValueType | Description |
---|---|---|---|---|---|---|
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 | ||
positions | MFVec2f | inputOutput | 0 0, 1 0, 1 1, 0 1 | The positions of the polygon to display. Default is a screen-filling quad. | ||
texCoords | MFVec3f | inputOutput | 0 0 0, 1 0 0, 1 1 0, 0 1 0 | Texture coordinates for the polygon. | ||
doCleanup | SFBool | inputOutput | TRUE | Clear depth (and stencil) buffer after applying the material. | ||
isBound | SFBool | outputOnly | FALSE | Event true sent when node becomes active, event false sent when unbound by another node. | ||
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)) | ||
normalizedX | SFBool | inputOutput | TRUE | Define whether the x coordinates are normalized (0-1) or pixel-based . | ||
normalizedY | SFBool | inputOutput | TRUE | Define whether the y coordinates are normalized (0-1) or pixel-based . | ||
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 | |||
tile | SFBool | inputOutput | TRUE | If true the background tiles in multi window settings. | ||
zoomFactor | SFFloat | inputOutput | 1.0 | Zooming factor for scaling background image. | ||
clearStencilBitplanes | SFInt32 | inputOutput | -1 | Usually 0 is used to clear all stencil bitplanes (clear is deactivated if smaller zero). | ||
appearance | SFNode | inputOutput | Appearance | The appearance used to render the polygon. | ||
metadata | SFNode | inputOutput | MetadataObject | container for payload metadata inside MetadataSet element | ||
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) | |||
mode | SFString | inputOutput | VERTICAL | [VERTICAL, HORIZONTAL, SMALLER] | Defines whether the backgound texture fits vertically, horizontally or in the smaller direction. Only takes effect if fixedImageSize is set. | |
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. | ||
bindTime | SFTime | outputOnly | Event sent when node becomes active/inactive. | |||
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. | |||
fixedImageSize | SFVec2f | inputOutput | 0,0 | Useful for keeping aspect ratio when rendering things like images by defining (width, height). | ||
bind | XFAny | inputOnly | sending any event to this slot will bind/activate the Bindable |