Class: Background

X3D: 3.3
Component: EnvironmentalEffects
Status:
fully implemented

x3dom.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' bottomUrl='[]' crossOrigin='""' description='""' frontUrl='[]' groundAngle='[]' groundColor='(0,0,0)' isActive='false' leftUrl='[]' metadata='X3DMetadataObject' rightUrl='[]' scaling='[]' 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]
bind SFBool false X3DBackgroundNode Pushes/pops the node on/from the top of the bindable stack
bottomUrl MFString [] [URI]
crossOrigin SFString "" X3DBackgroundNode Cross Origin Mode
description SFString "" X3DBackgroundNode Description of the bindable node
frontUrl MFString [] [URI]
groundAngle MFFloat [] [0, pi] X3DBackgroundNode Angle of the ground
groundColor MFColor (0,0,0) [0,1] X3DBackgroundNode Color of the ground
isActive SFBool false X3DBackgroundNode
leftUrl MFString [] [URI]
metadata SFNode X3DMetadataObject X3DBackgroundNode Field to add metadata information
rightUrl MFString [] [URI]
scaling MFString []
skyAngle MFFloat [] [0, pi] X3DBackgroundNode Angle of the sky
skyColor MFColor (0,0,0) [0,1] X3DBackgroundNode Color of the sky
topUrl MFString [] [URI]
transparency SFFloat 0/1 [0,1] X3DBackgroundNode Transparency of the background