BIM.works SDKs - v3.0.0-b.115
    Preparing search index...
    Index

    Constructors

    Accessors

    • get enabled(): boolean

      Whether the plane currently cuts the model

      Returns boolean

    Methods

    • Disable this section plane, it removed the visualization of the plane and makes it inactive. Its slot is free for the next plane. On a face of an active SectionBox, the box's other faces stay, as planes of their own

      Returns void

    • Returns number

      The annotation reach of this plane in mm, Infinity for no limit

    • The name a list of the planes shows (SectionPlanes.getPlanes): "Top", "Bottom", ... for a standard plane and a face of a box, "Plane 1", "Plane 2", ... for a plane through a point, or the name setName gave. Every start of a plane in this slot names it anew; a standard plane put back keeps its name

      Returns string

    • Whether the plane is drawn (setVisible); true for a plane just started

      Returns boolean

    • Set how far past this plane, in mm along its normal, its annotation mode reaches: an annotation further on the side the plane cuts away is hidden, whatever the mode. Measured from the annotation's own position, before a "project" plane moves it. With a top plane in "project" and a reach of one storey height, the storey above lands on the cut and the storeys above that are hidden. The reach follows the plane when it is dragged. Every start of a plane begins with the reach of SectionPlanes.annotationDefaults: no limit by default.

      Parameters

      • reach: number

        mm, 0 or more; Infinity for no limit

      Returns void

      Error for a negative distance, NaN or a value that is not a number

    • Show the plane as hovered, as when the pointer is on its icon, or stop showing it so: for a list of the planes whose row the pointer is on. Has no effect on a plane that does not cut or is hidden (setVisible); a plane stops being highlighted when it is disabled or hidden

      Parameters

      • highlighted: boolean

      Returns void

    • Rename the plane, for a user who tells their planes apart by name; fires SectionPlanes.onPlanesChange

      Parameters

      • name: string

        Trimmed; a name another plane has is allowed

      Returns void

      Error when the name is not a string, or nothing but white space

    • Draw the plane or not, while it keeps cutting: a hidden plane cuts the model and closes the cut with end caps as before, but its face, wireframe, drag icon and arrow are not drawn, and it is not hovered, highlighted or grabbed with Ctrl + left drag; it stays in SectionPlanes.getPlanes, and code can still move it. Fires SectionPlanes.onPlanesChange on a plane that cuts. Every start of a plane in this slot draws it again; a standard plane put back (SectionPlanes.startStandardPlane) keeps whether it is drawn, and SectionPlanes.getState keeps it too.

      Parameters

      • visible: boolean

      Returns void

      Error when visible is not a boolean