Class: Background

X3D: 3.3
Component: EnvironmentalEffects
Status:
fully implemented

.nodeTypes. Background

A background node that uses six static images to compose the backdrop. For the backUrl, bottomUrl, frontUrl, leftUrl, rightUrl, topUrl fields, browsers shall support the JPEG and PNG (see ISO/IEC 15948) image file formats.

HTML Encoding and Default Values

<Background backUrl='[]' bind='false' bindTime='null' bottomUrl='[]' crossOrigin='""' description='""' frontUrl='[]' groundAngle='[]' groundColor='(0,0,0)' isActive='false' isBound='false' leftUrl='[]' metadata='X3DMetadataObject' rightUrl='[]' scaling='false' skyAngle='[]' skyColor='(0,0,0)' topUrl='[]' transparency='0/1' ></Background>

Inheritance


Constructor

Background(ctx)

Constructor for Background

Parameters:
Name Type Argument Default Description
ctx Object <optional>
null context object, containing initial settings like namespace

Fields

These are the X3D / X3DOM fields of this node. Values should usually be received / set as strings via DOM functions (i.e., using setAttribute("myFieldName", "myFieldValue") and getAttribute("myFieldName")).
Name Type Default Value Range Inheritance Standard Description
backUrl MFString [] [URI] Image shown at the back of the background cube
bind SFBool false X3DBindableNode Pushes/pops the node on/from the top of the bindable stack
bindTime SFTime null X3DBindableNode Event sent reporting timestamp when node becomes active/inactive. Only appears in messages
bottomUrl MFString [] [URI] Image shown at the bottom of the background cube
crossOrigin SFString "" X3DBackgroundNode Cross Origin Mode
description SFString "" X3DBindableNode Description of the bindable node
frontUrl MFString [] [URI] Image shown at the front of the background cube
groundAngle MFFloat [] [0, pi] X3DBackgroundNode Angle of the ground Multiple values are possible
groundColor MFColor (0,0,0) [0,1] X3DBackgroundNode Color of the ground Multiple color values are possible. Define 1 more color than the number of ground angles.
isActive SFBool false X3DBindableNode
isBound SFBool false X3DBindableNode Output event true gets sent when node becomes bound and activated, otherwise output event false gets sent when node becomes unbound and deactivated. Only appears in messages
leftUrl MFString [] [URI] Image shown at the left of the background cube
metadata SFNode X3DMetadataObject X3DNode Field to add metadata information
rightUrl MFString [] [URI] Image shown at the right of the background cube
scaling MFString false Scale images of the background cube
skyAngle MFFloat [] [0, pi] X3DBackgroundNode Angle of the sky Multiple values are possible
skyColor MFColor (0,0,0) [0,1] X3DBackgroundNode Color of the sky Multiple color values are possible. Define 1 more color than the number of sky angles.
topUrl MFString [] [URI] Image shown at the top of the background cube
transparency SFFloat 0/1 [0,1] X3DBackgroundNode Transparency of the background