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

    Interface BarrelOptions

    Configuration options for barrel geometry (Fass / prolated spheroid with truncated ends).

    interface BarrelOptions {
        height?: number;
        heightSegments?: number;
        openEnded?: boolean;
        radialSegments?: number;
        radiusBottom?: number;
        radiusEnds?: number;
        radiusMiddle?: number;
        radiusTop?: number;
        thetaLength?: number;
        thetaStart?: number;
    }
    Index
    height? heightSegments? openEnded? radialSegments? radiusBottom? radiusEnds? radiusMiddle? radiusTop? thetaLength? thetaStart?
    height?: number

    The total height (h) of the barrel. Defaults to 2.5.

    heightSegments?: number

    The number of height subdivisions along the vertical axis. Defaults to 16.

    openEnded?: boolean

    Whether the barrel ends are open (no top and bottom circular caps). Defaults to false.

    radialSegments?: number

    The number of radial subdivisions around the circumference. Defaults to 32.

    radiusBottom?: number

    The bottom radius (r_bottom) at y = -height/2. Defaults to radiusEnds.

    radiusEnds?: number

    The default end radius (r) for top and bottom if not explicitly specified. Defaults to 1.0.

    radiusMiddle?: number

    The belly/middle radius (R) at the equator (y = 0). Defaults to 1.3.

    radiusTop?: number

    The top radius (r_top) at y = +height/2. Defaults to radiusEnds.

    thetaLength?: number

    The central angle of the sector in radians (2π for full barrel). Defaults to 2π.

    thetaStart?: number

    The start angle of the sector in radians. Defaults to 0.

    Settings
    Member Visibility

    On This Page
    Properties