AutoMovie API
    Preparing search index...

    Function describeAutoMovieBuildingSubject

    • Describe one building unit of a built environment as a subject.

      The unit's content box, in world metres, unions the part boxes of every element its root element owns at any depth, because a room-by-room union would leave out the envelope that makes a building readable from outside, and the placement bounds of every population in its root space or below, because a unit whose only content is a population would otherwise measure nothing. A transform-only element contributes no box, and the content is null when nothing contributes. Its members are the two roots a walk starts from, the root element and the root space. It has no owner, model, transform or materials.

      Parameters

      • environment: IAutoMovieBuiltEnvironment

        Environment the unit belongs to.

      • building: IAutoMovieBuildingUnit

        Unit to describe.

      • boxes: ReadonlyMap<string, readonly IAutoMovieSubjectBox[]>

        Part boxes of every drawn element of environment by element id, as builtEnvironmentPartBoxes returns them.

      • revision: string

        Revision of the artifact being described.

      • memberOffset: number

        Rank of the first member to name, a whole number from 0.

      Returns IAutoMovieSubjectDescription

      The unit's description.