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

StaticcreateOccluder

  • createOccluder(type: "Quad" | "Cube" | "Sphere" | "RoundedCube"): Mesh

    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

    The created object

StaticcreatePrimitive

  • createPrimitive(type: "ShaderBall", opts?: ObjectOptions): Group

    Creates a primitive object like a Cube or Sphere

    Parameters

    • type: "ShaderBall"

      The type of primitive to create

    • Optionalopts: ObjectOptions

      Options to create the object

    Returns Group

    The created object

  • createPrimitive(
        type: PrimitiveType | "Quad" | "Cube" | "Sphere" | "RoundedCube",
        opts?: ObjectOptions,
    ): Mesh

    Creates a primitive object like a Cube or Sphere

    Parameters

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

      The type of primitive to create

    • Optionalopts: ObjectOptions

      Options to create the object

    Returns Mesh

    The created object

StaticcreateSprite

  • createSprite(opts?: Omit<ObjectOptions, "material">): Sprite

    Creates a Sprite object

    Parameters

    Returns Sprite

    The created object

StaticcreateText

  • createText(text: string, opts?: TextOptions): Mesh

    Creates a 3D text object

    Parameters

    • text: string

      The text to display

    • Optionalopts: TextOptions

      Options to create the object

    Returns Mesh

Settings

Member Visibility

On This Page

Constructors
Methods