Variable VisibilitySchemaConst

VisibilitySchema: ZodObject<{
    components: ZodArray<ZodObject<({ uuid: ZodString; ifcGuid: ZodOptional<ZodString>; originatingSystem: ZodOptional<ZodString>; authoringToolId: ZodOptional<ZodString>; }), "strip", ZodTypeAny, ({ uuid: string; ifcGuid?: string | undefined; originatingSystem?: string | undefined; authoringToolId?: string | undefined; }), ({ uuid: string; ifcGuid?: string | undefined; originatingSystem?: string | undefined; authoringToolId?: string | undefined; })>, "many">;
    defaultVisibility: ZodBoolean;
    uuid: ZodString;
    viewSetupHints: ZodObject<{
        openingsVisible: ZodBoolean;
        spaceBoundariesVisible: ZodBoolean;
        spacesVisible: ZodBoolean;
    }, "strip", ZodTypeAny, {
        openingsVisible: boolean;
        spaceBoundariesVisible: boolean;
        spacesVisible: boolean;
    }, {
        openingsVisible: boolean;
        spaceBoundariesVisible: boolean;
        spacesVisible: boolean;
    }>;
}, "strip", ZodTypeAny, {
    components: ({ uuid: string; ifcGuid?: string | undefined; originatingSystem?: string | undefined; authoringToolId?: string | undefined; })[];
    defaultVisibility: boolean;
    uuid: string;
    viewSetupHints: {
        openingsVisible: boolean;
        spaceBoundariesVisible: boolean;
        spacesVisible: boolean;
    };
}, {
    components: ({ uuid: string; ifcGuid?: string | undefined; originatingSystem?: string | undefined; authoringToolId?: string | undefined; })[];
    defaultVisibility: boolean;
    uuid: string;
    viewSetupHints: {
        openingsVisible: boolean;
        spaceBoundariesVisible: boolean;
        spacesVisible: boolean;
    };
}> = ...

The Visibility element decides which objects are visible and which are hidden.

Type declaration

  • components: ZodArray<ZodObject<({ uuid: ZodString; ifcGuid: ZodOptional<ZodString>; originatingSystem: ZodOptional<ZodString>; authoringToolId: ZodOptional<ZodString>; }), "strip", ZodTypeAny, ({ uuid: string; ifcGuid?: string | undefined; originatingSystem?: string | undefined; authoringToolId?: string | undefined; }), ({ uuid: string; ifcGuid?: string | undefined; originatingSystem?: string | undefined; authoringToolId?: string | undefined; })>, "many">

    A list of components to

    • hide when DefaultVisibility=true
    • show when DefaultVisibility=false
  • defaultVisibility: ZodBoolean

    Defaults to false

    When true, all components should be visible unless listed in the exceptions When false all components should be invisible unless listed in the exceptions

  • uuid: ZodString

    The unique identifier of the entity.

    This is not in the BCF spec, but is used internally. However, when a BCF component requires a GUID, the uuid property is used.

  • viewSetupHints: ZodObject<{
        openingsVisible: ZodBoolean;
        spaceBoundariesVisible: ZodBoolean;
        spacesVisible: ZodBoolean;
    }, "strip", ZodTypeAny, {
        openingsVisible: boolean;
        spaceBoundariesVisible: boolean;
        spacesVisible: boolean;
    }, {
        openingsVisible: boolean;
        spaceBoundariesVisible: boolean;
        spacesVisible: boolean;
    }>

Type declaration

  • components: ({ uuid: string; ifcGuid?: string | undefined; originatingSystem?: string | undefined; authoringToolId?: string | undefined; })[]

    A list of components to

    • hide when DefaultVisibility=true
    • show when DefaultVisibility=false
  • defaultVisibility: boolean

    Defaults to false

    When true, all components should be visible unless listed in the exceptions When false all components should be invisible unless listed in the exceptions

  • uuid: string

    The unique identifier of the entity.

    This is not in the BCF spec, but is used internally. However, when a BCF component requires a GUID, the uuid property is used.

  • viewSetupHints: {
        openingsVisible: boolean;
        spaceBoundariesVisible: boolean;
        spacesVisible: boolean;
    }
    • openingsVisible: boolean

      Same as DefaultVisibility but restricted to openings only.

    • spaceBoundariesVisible: boolean

      Same as DefaultVisibility but restricted to space boundaries only.

    • spacesVisible: boolean

      Same as DefaultVisibility but restricted to spaces only.

Type declaration

  • components: ({ uuid: string; ifcGuid?: string | undefined; originatingSystem?: string | undefined; authoringToolId?: string | undefined; })[]

    A list of components to

    • hide when DefaultVisibility=true
    • show when DefaultVisibility=false
  • defaultVisibility: boolean

    Defaults to false

    When true, all components should be visible unless listed in the exceptions When false all components should be invisible unless listed in the exceptions

  • uuid: string

    The unique identifier of the entity.

    This is not in the BCF spec, but is used internally. However, when a BCF component requires a GUID, the uuid property is used.

  • viewSetupHints: {
        openingsVisible: boolean;
        spaceBoundariesVisible: boolean;
        spacesVisible: boolean;
    }
    • openingsVisible: boolean

      Same as DefaultVisibility but restricted to openings only.

    • spaceBoundariesVisible: boolean

      Same as DefaultVisibility but restricted to space boundaries only.

    • spacesVisible: boolean

      Same as DefaultVisibility but restricted to spaces only.

Generated using TypeDoc