official documentation

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

Class: Shape

X3D: 3.3
Component: Shape
Status:
fully implemented

Quick Links

➨ Fields
➨ Properties

.nodeTypes. Shape

The Shape node has two fields, appearance and geometry, that are used to create rendered objects in the world. The appearance field contains an Appearance node that specifies the visual attributes (e.g., material and texture) to be applied to the geometry. The geometry field contains a geometry node. The specified geometry node is rendered with the specified appearance nodes applied.

HTML Encoding and Default Values⤴

<Shape appearance='x3dom.nodeTypes.X3DAppearanceNode' bboxCenter='0,0,0' bboxColor='1, 1, 0' bboxDisplay='false' bboxMargin='0.01' bboxSize='-1,-1,-1' geometry='x3dom.nodeTypes.X3DGeometryNode' isPickable='true' metadata='X3DMetadataObject' render='true' visible='true' ></Shape>

Inheritance⤴


Constructor⤴

Shape(ctx)⤴

Constructor for Shape

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
appearance SFNode X3DAppearanceNode X3DShapeNode Holds the appearance node.
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
geometry SFNode X3DGeometryNode X3DShapeNode Holds the geometry node.
isPickable SFBool true X3DShapeNode Defines whether the shape is pickable.
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


Properties⤴

Access Name Type Inheritance Description
idMap Map for Shape node IDs (needed for picking)
objectID Static class ID counter (needed for picking)
shaderPartID Static class ID counter (needed for caching)