AutoMovie API
    Preparing search index...

    Interface IAutoMovieMark

    One located finding or construction line, as plain data an inspection draws over a picture: a curve a form was built from, a defect a measurement found, a joint, a contact force, a path.

    The producer owns the meaning and the instrument owns only the drawing. A producer names the mark by path, groups it under kind with the legend label and default color of that kind, and gives its geometry as one shape of a closed set. Adding a kind of finding changes its producer only, because the instrument reads no kind it was told about in advance.

    Coordinates are metres. With anchor null they are world coordinates; with an anchor they are the local coordinates of the scene object at that path, so the mark moves with that object.

    interface IAutoMovieMark {
        anchor: string | null;
        color: number;
        flagged: boolean;
        kind: string;
        label: string;
        path: string;
        shape: IAutoMovieMark.Shape;
    }
    Index
    anchor: string | null

    Path of the scene object whose local frame shape is in and whose world transform the mark follows, or null when shape is in world coordinates.

    color: number

    Default colour of the kind as sRGB hex, which a request may replace for one picture.

    flagged: boolean

    Whether the finding is an anomaly. A flagged mark is drawn in the instrument's flag colour and counted under a flag entry of the legend.

    kind: string

    Class of the mark, which a request's marks patterns select and a legend lists once, such as curve/section, defect/open, joint or contact. Every mark of one kind has one label and one colour.

    label: string

    Legend text of the kind, such as section curve.

    path: string

    Identity of the mark under the inspection path grammar, such as hero/torso/section/3 or hero/leftHand/contact. It extends the path of the object the mark belongs to, so a pattern selecting that object selects the mark too. Several marks may share a path.

    The geometry, in metres.