MVFv3 API Documentation
    Preparing search index...

    Type Alias SingleDoorEntranceAestheticProperties

    Properties for single door entrance aesthetics

    type SingleDoorEntranceAestheticProperties = {
        id: `ea_${string}`;
        geometryId: `g_${string}`;
        details?: {
            description?: string;
            externalId?: string;
            icon?: string;
            name?: string;
            shortName?: string;
        };
        kind: "single";
        swing: "cw"
        | "acw";
        swingOrigin: number;
    }
    Index

    Properties

    id geometryId details? kind swing swingOrigin

    Properties

    id: `ea_${string}`

    The unique identifier for the entrance aesthetic.

    geometryId: `g_${string}`
    details?: {
        description?: string;
        externalId?: string;
        icon?: string;
        name?: string;
        shortName?: string;
    }

    {@inheritDoc utility-types/details!Details}

    Details

    kind: "single"
    swing: "cw" | "acw"

    The direction of the swing of the door. Currently only 'cw' and 'acw' are supported. cw is clockwise, acw is anti-clockwise (counter-clockwise). This direction is relative to the swing origin vertex.

    swing cw, acw

    swingOrigin: number

    The origin of the swing. This is the point on the door that is swung. This should be minimum 0 and maxmimum the number of vertexes on the underlying line string that represents the door. Typically doors are a line string with 2 vertexes, so the swing origin is usually 0 or 1.

    0

    Settings

    Member Visibility

    On This Page

    Properties