Class TLcdNWDModelDecoder
- All Implemented Interfaces:
ILcdModelDecoder
,ILcdStatusSource
ILcdModel
.
For more information on how this model decoder handles Navisworks files,
please consult The Navisworks data format article.
Input
File | Required | Entry point | Description |
---|---|---|---|
*.nwd | x | x | A supported Navisworks file. |
File | Required | Entry point | Description |
---|---|---|---|
*.nwd.index | x | x | A text file containing relative path names to Navisworks files (one file per line) that belong to the same project and that have the same reference. Refer to the Combining multiple Navisworks files article for more details. |
Supported transfer protocols
- This decoder only supports data from a file system.
Model reference
Navisworks files don't contain geo-referencing information themselves. This section describes what strategies this decoder uses to find a suitable reference for the data.
-
The decoder obtains the model reference from an
ILcdModelReferenceDecoder
, which decodes the reference from an additional model reference file placed next to the data file. The default reference decoder set on this model decoder is based on all model reference decoders annotated with theLcdService
annotation. You can add a.prj
file with WKT information next to the input data, for example, or a.epgs
file with an EPSG code. -
Alternatively, you can use a
.llh
file next to the input data with a single text line containing a longitude, latitude and height coordinate (defined in the default EPSG 4326 reference). This will then be used as a topocentric reference to position your model in the world. -
You can set a fallback model reference to be used when no reference information can be found
next to the input data: see
setDefaultModelReference(com.luciad.model.ILcdModelReference)
.decoder.setDefaultModelReference(fallbackModelReference);
If no geo-reference information can be found with any of these strategies, then the data will be loaded in its
original, non-georeferenced coordinate system.
This is equivalent to setting a TLcdCartesianReference
as fallback reference:
decoder.setDefaultModelReference(new TLcdCartesianReference(TLcdDistanceUnit.METRE_UNIT,
TLcdDistanceUnit.METRE_UNIT,
TLcdDistanceUnit.METRE_UNIT));
Note: Data that is decoded in its original coordinate system, cannot be visualized on a geographical map. The dataset must be geo-located with an external tool, after conversion has been done.
Model structure
This decoder can create 2 different kinds of models:
- The geometry model: this model contains the Navisworks geometry. The display name has the suffix "[GEOMETRY]".
- The features model: this model contains the properties of the Navisworks types (like doors, walls, etc.),
together with their bounding box. This model is a
TLcd2DBoundsIndexedModel
, its display name has the suffix "[FEATURES]".
To specify the model type, you must use a TLcdBIMDataSource
with the appropriate Type
as input for the decodeSource(ILcdDataSource)
and decodeModelMetadata(ILcdDataSource)
methods.
The geometry type is assumed for the decode(String)
and decodeModelMetadata(String)
methods.
The possibility to decode 2 different models is also reflected through the discoverDataSources(java.lang.String)
method:
it returns 2 ILcdDataSource
instances, one for the geometry model and one for the features model, that
can both be decoded using the decodeSource(ILcdDataSource)
method.
Model descriptor
The type name of the model descriptor is "Navisworks".Model elements
The objects in the model depend on the type of the model.
- The geometry model: this model contains elements that do not implement any public LuciadLightspeed
API. However, this model can be used as input for the
TLcdOGC3DTilesModelEncoder
. - The features model: this model contains elements implementing the
ILcdDataObject
interface. They are also annotated withTLcdHasGeometryAnnotation
andTLcdPrimaryKeyAnnotation
annotations so this model can for instance be used as input for theTLcdGeoJsonModelEncoder
or other encoders supportingILcdDataObject
s.
Sample code
Obtain the default model containing the geometry: ILcdModelDecoder decoder = new TLcdNWDModelDecoder();
ILcdModel model = decoder.decode(sourceName);
TLcdBIMDataSource
:
ILcdModelDecoder decoder = new TLcdNWDModelDecoder();
ILcdModel model = decoder.decodeSource(new TLcdBIMDataSource(sourceName, TLcdBIMDataSource.Type.GEOMETRY));
TLcdBIMDataSource
:
TLcdNWDModelDecoder decoder = new TLcdNWDModelDecoder();
ILcdModel model = decoder.decodeSource(new TLcdBIMDataSource(sourceName, TLcdBIMDataSource.Type.FEATURES));
Performance tips
If your dataset contains elements outside the area that you are interested in, this can cause problems when
converting the geometry to an OGC 3D Tiles dataset, affecting a client application that consumes the 3D Tiles.
To mitigate this problem, you can define a filter that retains only objects inside the area of interest. The
tutorial Filtering BIM data describes in depth
how you can do that.
Thread safety
- The decoding of models is thread-safe.
- The decoded models are thread-safe for read access.
Supported versions and specifications
This decoder supports Navisworks versions from 2016 up to 2025.
Known limitations
- Only Navisworks Document files (.nwd) are supported. Navisworks Cache files (.nwc) or Navisworks Federated files (.nwf) are not supported.
- Some objects that are marked "hidden" in Navisworks, can still show up in the geometry and feature models, depending on the object type. If the resulting model contains such objects and that is not desired, you should remove them from the input data.
Notes
- If not available, the decoder will try to create a binzx file next to the Navisworks file. This file contains a Binz dataset and additional metadata. It is used to improve the decoding time for future decode requests of the Navisworks file. If such a binzx file cannot be written (for instance because the directory of the Navisworks file is read-only), it is generated in a temp directory and deleted again when the model is returned.
- Decoding large Navisworks files can take a considerable amount of time.
- Since:
- 2024.1
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
addStatusListener
(ILcdStatusListener aListener) Registers the given listener so it will receive status events from this source.boolean
canDecodeSource
(ILcdDataSource aDataSource) Checks whether this model decoder can decode the data source(s), identified by the passedILcdDataSource
.boolean
canDecodeSource
(String aSourceName) Checks whether this model decoder can decode the specified data source.Creates a new model from the given data source.decodeModelMetadata
(ILcdDataSource aDataSource) Decodes metadata for the specified data source.decodeModelMetadata
(String aSourceName) Decodes metadata for the specified data source.decodeSource
(ILcdDataSource aDataSource) Creates a new model from the given data source.List
<? extends ILcdDataSource> discoverDataSources
(String aPath) Retrieves a set of model-specificILcdDataSource
instances.Returns a short, displayable name for the format that is decoded by thisILcdModelDecoder
.void
removeStatusListener
(ILcdStatusListener aListener) Removes the specified listener so it is no longer notified.void
setDefaultModelReference
(ILcdModelReference aModelReference) void
setModelReferenceDecoder
(ILcdModelReferenceDecoder aModelReferenceDecoder)
-
Field Details
-
TYPE_NAME
- See Also:
-
-
Constructor Details
-
TLcdNWDModelDecoder
public TLcdNWDModelDecoder()
-
-
Method Details
-
getDisplayName
Description copied from interface:ILcdModelDecoder
Returns a short, displayable name for the format that is decoded by thisILcdModelDecoder
.- Specified by:
getDisplayName
in interfaceILcdModelDecoder
- Returns:
- the displayable name of this
ILcdModelDecoder
.
-
setDefaultModelReference
-
getDefaultModelReference
-
getModelReferenceDecoder
-
setModelReferenceDecoder
-
discoverDataSources
Description copied from interface:ILcdModelDecoder
Retrieves a set of model-specific
ILcdDataSource
instances.By default, this method:
- returns a list containing at least a single
TLcdDataSource
that contains a reference to the supplied path, whenILcdModelDecoder.canDecodeSource(String)
returnstrue
for the supplied path. - throws an
IOException
whenILcdModelDecoder.canDecodeSource(String)
returnsfalse
for the supplied path.
ILcdDataSource
, for instance, if the path references a collection of data sources.An example where this is useful is for container formats, such as NetCDF. A NetCDF file can contain multiple measurement layers. This
ILcdModelDecoder.discoverDataSources(String)
method allows you to distinguish between them usingILcdDataSource
s, where each measurement layer can be referenced to and decoded separately usingILcdModelDecoder.decodeSource(ILcdDataSource)
- Specified by:
discoverDataSources
in interfaceILcdModelDecoder
- Parameters:
aPath
- A path to the data source to be decoded; typically a file path or a URL.- Returns:
- If this model decoder returns
true
forILcdModelDecoder.canDecodeSource(String)
, it will return a list containing at least a singleILcdDataSource
. - Throws:
IOException
- If this model decoder returnsfalse
forILcdModelDecoder.canDecodeSource(String)
or if any exceptions caused by IO problems or invalid data occur.
- returns a list containing at least a single
-
canDecodeSource
Description copied from interface:ILcdModelDecoder
Checks whether this model decoder can decode the specified data source. It is acceptable for this method to returntrue
for a source name whiledecode
throws an exception for that same source name.For performance reasons, we strongly recommend that this will only be a simple test. For example: check the file extension of a file, but not that the file exists or contains expected content.
- Specified by:
canDecodeSource
in interfaceILcdModelDecoder
- Parameters:
aSourceName
- the data source to be verified; typically a file name or a URL.- Returns:
true
if this decoder can likely decode the data specified by the source name,false
otherwise.- See Also:
-
canDecodeSource
Description copied from interface:ILcdModelDecoder
Checks whether this model decoder can decode the data source(s), identified by the passed
ILcdDataSource
.For performance reasons, we strongly recommend that this will only be a simple test. For example: check the instance class of
aDataSource
, or check the file extension if it is aTLcdDataSource
.The default implementation of this method will check if the given
ILcdDataSource
is aTLcdDataSource
. If not, this method returns false. Otherwise, it delegates the source to theILcdModelDecoder.canDecodeSource(String)
method.- Specified by:
canDecodeSource
in interfaceILcdModelDecoder
- Parameters:
aDataSource
- theILcdModelSource
to be verified.- Returns:
true
if this decoder can likely decode the data specified byaDataSource
,false
otherwise.- See Also:
-
decodeSource
Description copied from interface:ILcdModelDecoder
Creates a new model from the given data source.
By default, this method:
- Throws a
NullPointerException
when anull
data source is passed. - Delegates to the
ILcdModelDecoder.decode(String)
method when aTLcdDataSource
is passed. - Throws an IOException in other case.
- Specified by:
decodeSource
in interfaceILcdModelDecoder
- Parameters:
aDataSource
- theILcdDataSource
to be decoded.- Returns:
- a model containing the decoded data. While
null
is allowed, implementors are advised to throw an error instead. - Throws:
IOException
- for any exceptions caused by IO problems or invalid data. Since decoding invalid data almost always results in RunTimeExceptions (NullPointerException, IndexOutOfBoundsException, IllegalArgumentException, ...) on unexpected places, implementations are advised to catch RuntimeExceptions in their decode() method, and wrap them into an IOException, as illustrated in the code snippet below.public ILcdModel decodeSource(ILcdDataSource aDataSource) throws IOException { try { // Perform decoding ... } catch (RuntimeException e) { throw new IOException(e); } }
- See Also:
- Throws a
-
decodeModelMetadata
Description copied from interface:ILcdModelDecoder
Decodes metadata for the specified data source. By default, this decodes the model and returns the model metadata found on that model. Implementations can override this method to speed up the retrieval.- Specified by:
decodeModelMetadata
in interfaceILcdModelDecoder
- Parameters:
aDataSource
- the data source to be decoded.- Returns:
- the model metadata for the data source, never null.
- Throws:
IOException
- if the metadata cannot be decoded for some reason.- See Also:
-
decodeModelMetadata
Description copied from interface:ILcdModelDecoder
Decodes metadata for the specified data source. By default, this decodes the model and returns the model metadata found on that model. Implementations can override this method to speed up the retrieval.- Specified by:
decodeModelMetadata
in interfaceILcdModelDecoder
- Parameters:
aSourceName
- the data source to be decoded; typically a file name or a URL.- Returns:
- the model metadata for the data source, never null.
- Throws:
IOException
- if the metadata cannot be decoded for some reason.- See Also:
-
decode
Description copied from interface:ILcdModelDecoder
Creates a new model from the given data source.- Specified by:
decode
in interfaceILcdModelDecoder
- Parameters:
aSourceName
- the data source to be decoded; typically a file name or a URL.- Returns:
- A model containing the decoded data. While
null
is allowed, implementors are advised to throw an error instead. - Throws:
IOException
- for any exceptions caused by IO problems or invalid data. Since decoding invalid data almost always results in RunTimeExceptions (NullPointerException, IndexOutOfBoundsException, IllegalArgumentException, ...) on unexpected places, implementations are advised to catch RuntimeExceptions in their decode() method, and wrap them into an IOException, as illustrated in the code snippet below.public ILcdModel decode( String aSourceName ) throws IOException { try (InputStream input = fInputStreamFactory.createInputStream(aSourceName)) { // Perform decoding ... } catch (RuntimeException e) { throw new IOException(e); } }
- See Also:
-
addStatusListener
Description copied from interface:ILcdStatusSource
Registers the given listener so it will receive status events from this source.
In case you need to register a listener which keeps a reference to an object with a shorter life-time than this status source, you can use a
ALcdWeakStatusListener
instance as status listener.- Specified by:
addStatusListener
in interfaceILcdStatusSource
- Parameters:
aListener
- The listener to be notified when the status has changed.
-
removeStatusListener
Description copied from interface:ILcdStatusSource
Removes the specified listener so it is no longer notified.- Specified by:
removeStatusListener
in interfaceILcdStatusSource
- Parameters:
aListener
- The listener to remove.
-