Small World Engine API Reference - v0.76.20
    Preparing search index...

    Class InstancedMesh

    A class for rendering multiple instances of a mesh with different transforms.

    Hierarchy (View Summary)

    Index
    constructor
    behaviors bounds castShadow children frustumCulled geometry inFrustum instanceCount instanceData? instanceDataNeedsUpdate instanceDataSize instanceMatrices instanceMatrixNeedsUpdate isCollidable isInstancedMesh isPickable isStatic isVisible localMatrix material name onPointerClick? onPointerDown? onPointerEnter? onPointerLeave? onPointerMove? onPointerUp? parent position receiveShadow rigidBody? rotation scale tag? uuid worldMatrix
    add addBehavior computeBounds getMatrixAt getObjectByName getWorldPosition initInstanceData lookAt remove removeBehavior setInstanceDataAt setMatrixAt setPosition setRotation setScale translate updateMatrixWorld
    behaviors: Behavior[] = []
    bounds: BoundingVolume | undefined = undefined

    The physical bounding volume of the object.

    castShadow: boolean = false
    children: Object3D[] = []
    frustumCulled: boolean = true
    geometry: GeometryDataInterface | undefined = undefined
    inFrustum: boolean = true
    instanceCount: number
    instanceData?: Float32Array<ArrayBufferLike>
    instanceDataNeedsUpdate: boolean = false
    instanceDataSize: number = 0
    instanceMatrices: Float32Array
    instanceMatrixNeedsUpdate: boolean = true
    isCollidable: boolean = true

    Whether this object should generate bounds and participate in physics/raycasting. Defaults to true.

    isInstancedMesh: boolean = true
    isPickable: boolean = false
    isStatic: boolean = false
    isVisible: boolean = true
    localMatrix: Matrix4 = ...
    material: AbstractMaterial | undefined = undefined
    name: string = ""
    onPointerClick?: () => void
    onPointerDown?: (ray: Ray, intersectionPoint: Vector3D) => void
    onPointerEnter?: () => void
    onPointerLeave?: () => void
    onPointerMove?: (ray: Ray) => void
    onPointerUp?: () => void
    parent: Object3D | undefined = undefined
    position: Vector3D = ...
    receiveShadow: boolean = false
    rigidBody?: RigidBody
    rotation: Vector3D = ...
    scale: Vector3D = ...
    tag?: string

    Optional app-defined category tag, for typed identification instead of matching on name.

    uuid: string = ...
    worldMatrix: Matrix4 = ...

    • Reads this object's position in world space, i.e. after resolving the full parent chain -- unlike position, which is always local to its immediate parent. Requires worldMatrix to be current (see updateMatrixWorld()).

      Parameters

      • out: Vector3D = ...

        Optional vector to write into, to avoid allocating one per call.

      Returns Vector3D

    • Initializes the extra instance data buffer.

      Parameters

      • sizePerInstance: number

        How many floats per instance (e.g. 4 for a vec4).

      Returns void

    • Sets the instance data at a specific index.

      Parameters

      • index: number

        The instance index.

      • data: number[]

        The data array (length must match instanceDataSize).

      Returns void

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods