official documentation

  1. x3dom.org
  2. documentation
  3. Developer API

Class: Billboard

X3D: 3.3
Component: Navigation
Status:
fully implemented

Quick Links

➨ Fields
➨ Properties

.nodeTypes. Billboard

Billboard is a Grouping node that can contain most nodes. Content faces the user, rotating about the specified axis. Set axisOfRotation=0 0 0 to fully face the user's camera. Hint: Put Billboard as close to the geometry as possible, nested inside Transform for local coordinate system. Hint: don't put Viewpoint inside a Billboard. Hint: insert a Shape node before adding geometry or Appearance.

HTML Encoding and Default Values⤴

<Billboard axisOfRotation='0,1,0' bboxCenter='0,0,0' bboxColor='1, 1, 0' bboxDisplay='false' bboxMargin='0.01' bboxSize='-1,-1,-1' children='X3DChildNode' metadata='X3DMetadataObject' render='true' visible='true' ></Billboard>

Inheritance⤴


Constructor⤴

Billboard(ctx)⤴

Constructor for Billboard

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
axisOfRotation SFVec3f 0,1,0 axisOfRotation direction is relative to local coordinate system. Hint: axis 0 0 0 always faces viewer.
bboxCenter SFVec3f 0,0,0 [-inf, inf] X3DBoundedObject Center of the bounding box
bboxColor SFColor 1, 1, 0 X3DBoundedObject Color of the bounding box
bboxDisplay SFVec3f false X3DBoundedObject Flag to enable display of the bounding box
bboxMargin SFFloat 0.01 [-inf, inf] X3DBoundedObject Size of additional margin around the bounding box scaled up by the diameter.
bboxSize SFVec3f -1,-1,-1 [0, inf] or -1 X3DBoundedObject Size of the bounding box
children MFNode X3DChildNode X3DGroupingNode Grouping nodes have a field that contains a list of children nodes. Each grouping node defines a coordinate space for its children. This coordinate space is relative to the coordinate space of the node of which the group node is a child. Such a node is called a parent node. This means that transformations accumulate down the scene graph hierarchy.
metadata SFNode X3DMetadataObject X3DNode Field to add metadata information
render SFBool true X3DBoundedObject Flag to enable/disable rendering
visible SFBool true X3DBoundedObject Flag to enable/disable rendering, alias for render