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

    Interface BillboardInstancerOptions

    interface BillboardInstancerOptions {
        axisLocked?: boolean;
        count?: number;
        geometry?: GeometryDataInterface;
        material?: AbstractMaterial;
        positions?: Vector3D[];
        scatterArea?: BillboardScatterArea;
        size?: [number, number];
    }
    Index
    axisLocked? count? geometry? material? positions? scatterArea? size?
    axisLocked?: boolean

    Only yaw (Y-axis) rotates to face the camera -- vegetation doesn't tilt with camera pitch. Defaults to true. false gives a fully spherical (always dead-on) billboard.

    count?: number

    Fixed instance pool size. Ignored (set to positions.length) when positions is given. Defaults to 300.

    geometry?: GeometryDataInterface

    Instanced quad geometry, shared by every instance. Defaults to a unit Plane.

    material?: AbstractMaterial

    Instanced material, shared by every instance. Defaults to a transparent, faintly green StandardMaterial.

    positions?: Vector3D[]

    Explicit world-space placement, one entry per instance. Takes precedence over scatterArea.

    scatterArea?: BillboardScatterArea

    Random placement within a flat rectangle, used when positions is omitted.

    size?: [number, number]

    [min, max] uniform quad scale. Defaults to [0.6, 1.2].

    Settings
    Member Visibility

    On This Page
    Properties