babylon.quarks - v1.0.0
    Preparing search index...

    Interface ShapeJSON

    The JSON form of an emitter shape. type names the shape; the other fields are the ones that shape has, under the names of its own fields.

    interface ShapeJSON {
        angle?: number;
        arc?: number;
        boxThickness?: number[];
        column?: number;
        depth?: number;
        donutRadius?: number;
        emitFrom?: number;
        height?: number;
        length?: number;
        mesh?: string;
        mode?: number;
        particleSystem?: string;
        radius?: number;
        row?: number;
        sampling?: number;
        speed?: ValueGeneratorJSON;
        spread?: number;
        thickness?: number;
        transform?: ShapeTransformJSON;
        type: string;
        width?: number;
    }
    Index
    angle?: number

    Opening angle of a cone, in radians.

    arc?: number

    Arc in radians that a round shape emits from.

    boxThickness?: number[]

    Thickness of a box's shell along x, y and z.

    column?: number

    Columns of a grid.

    depth?: number

    Depth of a box.

    donutRadius?: number

    Radius of a donut's tube.

    emitFrom?: number

    Where a box emits from (its volume, shell or edges), a BoxEmitFrom value; where a cone does (its base or volume), a ConeEmitFrom value.

    height?: number

    Height of a rectangle, box or grid.

    length?: number

    Height of the volume a cone emits from with ConeEmitFrom.Volume.

    mesh?: string

    Uuid of the mesh a mesh-surface shape emits from.

    mode?: number

    The EmitterMode of the shape's arc.

    particleSystem?: string

    Kept for three.quarks files, which can name a system here; no built-in shape reads it.

    radius?: number

    Radius of a sphere, hemisphere, circle, cone or donut.

    row?: number

    Rows of a grid.

    sampling?: number

    How a grid picks its cells, a GridSampling value.

    Speed of the arc sweep in arcs per second, a value generator's JSON.

    spread?: number

    Spread of the arc: emission points snap to multiples of it; 0 for none.

    thickness?: number

    Fraction of a round shape's radius it emits from, measured in from the surface: 0 the surface, 1 the whole volume.

    transform?: ShapeTransformJSON

    Local offset / rotation / scale of the shape; omitted when there is none.

    type: string

    The shape's type ('sphere', 'cone', …).

    width?: number

    Width of a rectangle, box or grid.