> ## Documentation Index
> Fetch the complete documentation index at: https://speckle-assistant.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Navisworks

export const app_0 = "Navisworks"

export const versions_0 = "2020, 2021, 2022, 2023 & 2024"

export const connector_0 = "Navisworks"

<div class="callout my-4 px-5 py-4 overflow-hidden rounded-2xl flex gap-3 border-2 border-red-600 bg-red-100/50 dark:border-red-600 dark:bg-red-400/20" data-callout-type="warning">
  <div class="mt-0.5 w-4" data-component-part="callout-icon">
    <svg class="flex-none w-5 h-5 text-red-700 dark:text-red-300" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2" aria-label="Warning">
      <path stroke-linecap="round" stroke-linejoin="round" d="M12 9v2m0 4h.01m-6.938 4h13.856c1.54 0 2.502-1.667 1.732-3L13.732 4c-.77-1.333-2.694-1.333-3.464 0L3.34 16c-.77 1.333.192 3 1.732 3z" />
    </svg>
  </div>

  <div class="text-sm prose min-w-0 w-full text-red-700 dark:text-red-300" data-component-part="callout-content">
    <b>Notice</b>: This user guide is based on the legacy {connector_0} connector.<br />
    We recommend using our new connectors instead, as they are easier to use and actively maintained. This legacy documentation may not be up to date.
  </div>
</div>

<Info>
  Legacy Speckle supports {app_0} versions: {versions_0}
</Info>

## Getting started

To install the Navisworks Connector and add your Speckle account, proceed by following the instructions in [Speckle Manager](/legacy/user/manager).

Once installed, you can find the Navisworks Connector in the ribbon menu under the **Speckle** tab like so:

<Frame>
  <img src="https://user-images.githubusercontent.com/760691/231277506-a539c3e0-17e2-43a7-8b1e-2d01909ec77b.png" alt="speckle-ribbon-navisworks" />
</Frame>

### Selection filters

To help you select which elements will be to sent to Speckle, we've built various filters into our Navisworks Connector. Once a filter is set, just click **Send** and all objects passing the filter will be sent to your Speckle project.

*Please Note: Elements are only sent if they are visible.*

<Frame>
  <img src="https://user-images.githubusercontent.com/760691/231277784-667e4899-e1f8-4753-a23c-96d9e5557c9a.png" alt="navisworks-selection-filters" />
</Frame>

On opening a stream card, any selected objects by default become the elements destined for send. This can be reset.

<Frame>
  <img src="https://user-images.githubusercontent.com/760691/231278189-3a228391-d16b-4048-b383-3d8d4b784674.png" alt="navisworks-setselection" />
</Frame>

#### Saved view filter

The view filter works similarly to the category one, and lets you include all elements visible in one or more views.

<Frame>
  <img src="https://user-images.githubusercontent.com/760691/231277894-c74ecec6-c18b-41eb-8758-be42aeac2c56.png" alt="navisworks-savedview-filter" />
</Frame>

This will only be visible if your model has saved views with Hide/Required selected.

<Frame>
  <img src="https://user-images.githubusercontent.com/760691/231278551-50625f13-4a2f-467e-a638-526c3b07497f.png" alt="navisworks-valid-savedview" />
</Frame>

#### Selection set filter

The selection set filter lets you select one or more selection sets or saved searches from the current model.

This will only be visible if your model has selection sets or saved searches.

<Frame>
  <img src="https://user-images.githubusercontent.com/760691/231278069-23ad3ec5-429d-46fb-bd53-54459b39aa5a.png" alt="navisworks-selectionset-filter" />
</Frame>

### Receive modes

Receiving geometry into Navisworks is not currently supported. However, you can receive data into a Revit or Rhino model and then open the model in Navisworks.

### Current limitations

Navisworks produces a lot of data, and the Speckle Navisworks Connector is still in its early stages. As such, there are a few limitations to be aware of:

* Sends may not complete first time around. If this happens, try again.
* Only a single view can be sent at a time.
* One-click send is not supported. You must select a filter first.

### Levels and collections

Where a Navisworks model has levels differentiated these will be found in the Speckle commits as a collection as any other type of collection. There is no coallescing of levels performed across collections. This is because Navisworks does not have a strong concept of levels. Essentially the hierachy of the Speckle data will match the hierachy of the selected elements.

## Navisworks and BIM data

When sending from Navisworks, Speckle will convert all embedded BIM properties alongside metadata generated in the conversion from native formats to Navisworks. This includes file paths, element ids, element types, etc.

The BIMness of objects is stored in the `properties` property of the object. This is a dictionary of key-value pairs, where the key is the name of the parameter and the value is the value of the parameter. There is no concept beyond Object+Data in the data sent.

<Note>All the parameters are stored using their <b>User Display Names</b>.</Note>

To easily explore on object's data and parameters, our Speckle Web App interface can be of great help. As well as any other applications that lets you explore the object metadata (eg Grasshopper, Dynamo, Unity, etc).

<Frame>
  <img src="https://user-images.githubusercontent.com/51519350/186416982-15eb496a-18fc-4782-b1d2-a6df01e9a5ed.png" alt="web-bim-data" />
</Frame>

## Advanced settings

The `Advanced Settings` page allows you to customize the way Speckle behaves "per-stream".

<Frame>
  <img src="https://user-images.githubusercontent.com/760691/231278734-bd54c648-eef5-456d-a035-ddb046e896eb.png" alt="navisworks-advanced-settings" />
</Frame>

### Reference point

Allows the user to specify which reference point should be used when sending data.

Available options are:

* **Model Origin** (the default option)
* The **Project Base coordinate**
* The **Bounding Box origin**

The XY Coordinate inputs are valid for defining the Project Base coordinate option.

### Coordinate Units

Allows the user to specify the units of the coordinates sent to Speckle.

### Include View

Allows the user to specify whether the current active view should be included in the data sent to Speckle.
