MVFv3 API Documentation
    Preparing search index...

    Function isUnknownEntranceAestheticProperties

    • Checks whether this is an unknown entrance aesthetic and narrows the type to UnknownEntranceAestheticProperties if so.

      If this is true, it likely means a newer version of the Entrance Aesthetic spec is being parsed, with a new type of entrance. A developer may choose to ignore this entrance aesthetic, or display a generic entrance aesthetic, depending on their use case.

      An application should NOT crash on unknown entrance aesthetics.

      Parameters

      • properties:
            | { id: `ea_${string}` } & { geometryId: `g_${string}` } & {
                details?: {
                    description?: string;
                    externalId?: string;
                    icon?: string;
                    name?: string;
                    shortName?: string;
                };
            } & { kind: "open"; swing?: undefined; swingOrigin?: undefined }
            | { id: `ea_${string}` } & { geometryId: `g_${string}` } & {
                details?: {
                    description?: string;
                    externalId?: string;
                    icon?: string;
                    name?: string;
                    shortName?: string;
                };
            } & { kind: "single"; swing: "cw"
            | "acw"; swingOrigin: number }
            | { id: `ea_${string}` } & { geometryId: `g_${string}` } & {
                details?: {
                    description?: string;
                    externalId?: string;
                    icon?: string;
                    name?: string;
                    shortName?: string;
                };
            } & { kind: "double"; swing: "cw"
            | "acw"; swingOrigin?: undefined }
            | { id: `ea_${string}` } & { geometryId: `g_${string}` } & {
                details?: {
                    description?: string;
                    externalId?: string;
                    icon?: string;
                    name?: string;
                    shortName?: string;
                };
            } & {
                kind: "open"
                | "single"
                | "double"
                | "unknown";
                swing?: "cw" | "acw" | "unknown";
                swingOrigin?: number;
            }

        The properties to check.

        • { id: `ea_${string}` } & { geometryId: `g_${string}` } & {
              details?: {
                  description?: string;
                  externalId?: string;
                  icon?: string;
                  name?: string;
                  shortName?: string;
              };
          } & { kind: "open"; swing?: undefined; swingOrigin?: undefined }
          • id: `ea_${string}`

            The unique identifier for the entrance aesthetic.

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

            {@inheritDoc utility-types/details!Details}

            Details

          • kind: "open"
          • Optionalswing?: undefined
          • OptionalswingOrigin?: undefined
        • { id: `ea_${string}` } & { geometryId: `g_${string}` } & {
              details?: {
                  description?: string;
                  externalId?: string;
                  icon?: string;
                  name?: string;
                  shortName?: string;
              };
          } & { kind: "single"; swing: "cw"
          | "acw"; swingOrigin: number }
          • id: `ea_${string}`

            The unique identifier for the entrance aesthetic.

          • geometryId: `g_${string}`
          • Optionaldetails?: {
                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

        • { id: `ea_${string}` } & { geometryId: `g_${string}` } & {
              details?: {
                  description?: string;
                  externalId?: string;
                  icon?: string;
                  name?: string;
                  shortName?: string;
              };
          } & { kind: "double"; swing: "cw"
          | "acw"; swingOrigin?: undefined }
          • id: `ea_${string}`

            The unique identifier for the entrance aesthetic.

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

            {@inheritDoc utility-types/details!Details}

            Details

          • kind: "double"
          • swing: "cw" | "acw"

            The direction of the swing of the doors. Currently only 'cw' and 'acw' are supported. cw is clockwise, acw is anti-clockwise (counter-clockwise). For double doors, the swing is relative to the first vertex of the underlying entrance line string.

            swing cw, acw

          • OptionalswingOrigin?: undefined
        • { id: `ea_${string}` } & { geometryId: `g_${string}` } & {
              details?: {
                  description?: string;
                  externalId?: string;
                  icon?: string;
                  name?: string;
                  shortName?: string;
              };
          } & {
              kind: "open"
              | "single"
              | "double"
              | "unknown";
              swing?: "cw" | "acw" | "unknown";
              swingOrigin?: number;
          }
          • id: `ea_${string}`

            The unique identifier for the entrance aesthetic.

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

            {@inheritDoc utility-types/details!Details}

            Details

          • kind: "open" | "single" | "double" | "unknown"
          • Optionalswing?: "cw" | "acw" | "unknown"
          • OptionalswingOrigin?: number

      Returns properties is { id: `ea_${string}` } & { geometryId: `g_${string}` } & {
          details?: {
              description?: string;
              externalId?: string;
              icon?: string;
              name?: string;
              shortName?: string;
          };
      } & {
          kind: "open"
          | "single"
          | "double"
          | "unknown";
          swing?: "cw" | "acw" | "unknown";
          swingOrigin?: number;
      }

      True if the properties are an unknown entrance aesthetic, false otherwise.

    Settings

    Member Visibility