Interface IPatch

interface IPatch {
    clearInstances(): void;
    createInstances(
        baseMesh: { distance: number; mesh: TransformNode }[],
    ): void;
    getCurrentMesh(): TransformNode;
    getLodMeshes(): TransformNode[];
    getNbInstances(): number;
    handleLod(distance: number): void;
    isEnabled(): boolean;
    setEnabled(enabled: boolean): void;
}

Hierarchy

  • IDisposable
    • IPatch

Methods

clearInstances createInstances getCurrentMesh getLodMeshes getNbInstances handleLod isEnabled setEnabled

Methods

clearInstances

  • clearInstances(): void

    Clears all instances from the patch. They will be disposed and will not render anymore. The copy of the given base mesh will also be disposed. The matrix buffer will be kept though, which means that calling createInstances() will reuse the same buffer.

    Returns void

createInstances

  • createInstances(baseMesh: { distance: number; mesh: TransformNode }[]): void

    Creates instances of a copy of the given base mesh (or transform node in the case of HierarchyInstancePatch). The instances will be positioned according to the matrix buffer given in the constructor.

    Parameters

    • baseMesh: { distance: number; mesh: TransformNode }[]

      The mesh to create instances from.

    Returns void

    Throws

    Error if baseMesh is not a Mesh in the case of InstancePatch and ThinInstancePatch.

getCurrentMesh

getLodMeshes

getNbInstances

handleLod

isEnabled

setEnabled

Settings

Member Visibility

On This Page

Methods