Views > Navigate

Sheet Overlay

Draws a DXF plan over the model at a level, placed by offset and rotation or by two reference points, with its texts as labels. Once placed, one click shows it again; Shift+Click places another.

Status

The public ask

No public source is on record for this tool.

Installs with

Sheet Overlay sits in a stack, so installing it also installs:

• Clear Sheet

Events it listens to

None. It runs only when you click it.

Files

Paths are relative to the Playground.extension folder.

• Views.tab/Navigate.panel/Sheet.stack/Sheet_Overlay.pushbutton/bundle.yaml
• Views.tab/Navigate.panel/Sheet.stack/Sheet_Overlay.pushbutton/config.py
• Views.tab/Navigate.panel/Sheet.stack/Sheet_Overlay.pushbutton/icon.dark.png
• Views.tab/Navigate.panel/Sheet.stack/Sheet_Overlay.pushbutton/icon.png
• Views.tab/Navigate.panel/Sheet.stack/Sheet_Overlay.pushbutton/icon.small.dark.png
• Views.tab/Navigate.panel/Sheet.stack/Sheet_Overlay.pushbutton/icon.small.png
• Views.tab/Navigate.panel/Sheet.stack/Sheet_Overlay.pushbutton/script.py

Install

1. Only this tool. In Navisworks, click pyNavis > Playground, search for Sheet Overlay, tick it and click Install.
2. The whole extension. Download Playground.extension.zip, unzip it, put the Playground.extension folder in %APPDATA%\pyNavis\extensions\, and click pyNavis > Reload. Sheet Overlay is on the Views tab, Navigate panel.

You need pyNavis 1.3.0 or later.

Source

The tool's own files, word for word as published in pynavis/Playground. Paths are relative to the Playground.extension folder.

script.py

The script that runs on a click.

"""Draws a DXF sheet over the model at a level; once placed, one click shows it again."""
import os

from namo import sheetoverlay, vp_common
from pynavis import toast

document = vp_common.active_doc()
if not vp_common.has_models(document):
    toast.info('No model open', 'Open or append a model, then run Sheet Overlay again.')
else:
    placed = sheetoverlay.saved(document)
    if placed is not None and os.path.isfile(str(placed['file'])):
        outcome = sheetoverlay.show(document, placed)
    else:
        outcome = sheetoverlay.setup(document, placed)
    if outcome is not None:
        toast.show(outcome[0], outcome[1], outcome[2])

config.py

The Shift+Click action.

"""Places a DXF sheet: file, layers, elevation and position, by offset and rotation or by two points."""
from namo import sheetoverlay, vp_common
from pynavis import toast

document = vp_common.active_doc()
if not vp_common.has_models(document):
    toast.info('No model open', 'Open or append a model first.')
else:
    outcome = sheetoverlay.setup(document, sheetoverlay.saved(document))
    if outcome is not None:
        toast.show(outcome[0], outcome[1], outcome[2])

Library modules this tool uses

From the shared namo library, which installs with every tool. Each name opens the module on GitHub.

• namo.sheetoverlaySheet Overlay: a 2D CAD sheet (DXF, read by namo.dxf) drawn over the model at one elevation with pynavis.overlay.
• namo.vp_commonShared helpers for the Views tools (Viewpoints, Capture and Navigate panels).

bundle.yaml

The bundle contract: the keys pyNavis reads for this tool.

title: Sheet Overlay
tooltip: Draws a DXF plan over the model at a level, placed by offset and rotation or by two reference points, with its texts as labels. Once placed, one click shows it again; Shift+Click places another.
context: doc