Class ObjectUtils

Utility class to create primitive objects

Example

const cube = ObjectUtils.createPrimitive("Cube", { name: "Cube", position: { x: 0, y: 0, z: 0 } });

Constructors

constructor

Methods

createOccluder createPrimitive createSprite createText

Constructors

constructor

Methods

Static createOccluder

  • createOccluder(type): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

  • Creates an occluder object that only render depth but not color

    Parameters

    • type: "Quad" | "Cube" | "Sphere" | "RoundedCube"

      The type of primitive to create

    Returns Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

    The created object

Static createPrimitive

  • createPrimitive(type, opts?): Group<Object3DEventMap>

  • Creates a primitive object like a Cube or Sphere

    Parameters

    • type: "ShaderBall"

      The type of primitive to create

    • Optional opts: ObjectOptions

      Options to create the object

    Returns Group<Object3DEventMap>

    The created object

  • createPrimitive(type, opts?): Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

  • Parameters

    • type: PrimitiveType | "Quad" | "Cube" | "Sphere" | "RoundedCube"
    • Optional opts: ObjectOptions

    Returns Mesh<BufferGeometry<NormalBufferAttributes>, Material | Material[], Object3DEventMap>

Static createSprite

  • createSprite(opts?): Sprite<Object3DEventMap>

  • Creates a Sprite object

    Parameters

    Returns Sprite<Object3DEventMap>

    The created object

Static createText

Settings

Member Visibility

Theme

On This Page

constructorcreateOccludercreatePrimitivecreateSpritecreateText

Generated using TypeDoc