com.luciad.format.object3d.obj

LuciadFusionClass TLcdOBJModelDecoder

java.lang.Object

com.luciad.format.object3d.obj.TLcdOBJModelDecoder

All Implemented Interfaces:

ILcdInputStreamFactoryCapable, ILcdModelDecoder

@LcdService(service=ILcdModelDecoder.class,
            priority=20000)
public class TLcdOBJModelDecoder
extends Object
implements ILcdModelDecoder, ILcdInputStreamFactoryCapable

A model decoder for WaveFront OBJ files. Because the OBJ format by itself is not georeferenced, this decoder requires a separate ILcdModelReferenceDecoder.

See Also:

TLcdOBJMeshDecoder

Constructor Summary

Constructors

Constructor and Description
TLcdOBJModelDecoder()

Method Summary

Modifier and Type	Method and Description
boolean	canDecodeSource(String aSourceName) Checks whether this model decoder can decode the specified data source.
ILcdModel	decode(String aSourceName) Decodes a .OBJ file.
ILcdModelReference	getDefaultModelReference() Returns the default model reference for decoded models.
String	getDisplayName() Returns a short, displayable name for the format that is decoded by this ILcdModelDecoder.
ILcdInputStreamFactory	getInputStreamFactory() Returns the input stream factory that is used.
ILcdModelReferenceDecoder	getModelReferenceDecoder() Returns the current model reference decoder.
void	setDefaultModelReference(ILcdModelReference aDefaultModelReference) Sets the default model reference for decoded models, in case the model reference decoder doesn't provide one.
void	setInputStreamFactory(ILcdInputStreamFactory aILcdInputStreamFactory) Sets the input stream factory to be used.
void	setModelReferenceDecoder(ILcdModelReferenceDecoder aModelReferenceDecoder) Sets the decoder used to create model references for decoded OBJ files.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.luciad.model.ILcdModelDecoder

canDecodeSource, decodeModelMetadata, decodeModelMetadata, decodeSource, discoverDataSources

Constructor Detail

TLcdOBJModelDecoder

public TLcdOBJModelDecoder()

Method Detail

setInputStreamFactory

public void setInputStreamFactory(ILcdInputStreamFactory aILcdInputStreamFactory)

Description copied from interface: ILcdInputStreamFactoryCapable

Sets the input stream factory to be used.

Specified by:

setInputStreamFactory in interface ILcdInputStreamFactoryCapable

Parameters:

aILcdInputStreamFactory - the input stream factory to be used.

getInputStreamFactory

public ILcdInputStreamFactory getInputStreamFactory()

Description copied from interface: ILcdInputStreamFactoryCapable

Returns the input stream factory that is used.

Specified by:

getInputStreamFactory in interface ILcdInputStreamFactoryCapable

Returns:

the input stream factory that is used.

setModelReferenceDecoder

public void setModelReferenceDecoder(ILcdModelReferenceDecoder aModelReferenceDecoder)

Sets the decoder used to create model references for decoded OBJ files. By default, a TLcdModelReferenceDecoder is used.

Parameters:

aModelReferenceDecoder - an ILcdModelReferenceDecoder

getModelReferenceDecoder

public ILcdModelReferenceDecoder getModelReferenceDecoder()

Returns the current model reference decoder.

Returns:

the current model reference decoder

See Also:

setModelReferenceDecoder(com.luciad.model.ILcdModelReferenceDecoder)

setDefaultModelReference

public void setDefaultModelReference(ILcdModelReference aDefaultModelReference)

Sets the default model reference for decoded models, in case the model reference decoder doesn't provide one.

Parameters:

aDefaultModelReference - the new default model reference

Since:

2023.1

See Also:

getDefaultModelReference()

getDefaultModelReference

public ILcdModelReference getDefaultModelReference()

Returns the default model reference for decoded models.

Returns:

the default model reference

Since:

2023.1

See Also:

setDefaultModelReference(com.luciad.model.ILcdModelReference)

getDisplayName

public String getDisplayName()

Description copied from interface: ILcdModelDecoder

Returns a short, displayable name for the format that is decoded by this ILcdModelDecoder.

Specified by:

getDisplayName in interface ILcdModelDecoder

Returns:

the displayable name of this ILcdModelDecoder.

canDecodeSource

public boolean canDecodeSource(String aSourceName)

Description copied from interface: ILcdModelDecoder

Checks whether this model decoder can decode the specified data source. It is acceptable for this method to return true for a source name while decode 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 interface ILcdModelDecoder

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:

ILcdModelDecoder.decode(String), ILcdModelDecoder.decodeModelMetadata(String)

decode

public ILcdModel decode(String aSourceName)
                 throws IOException

Decodes a .OBJ file. Returns a model containing a single ILcd3DMesh. The model reference is created by a user-specified ILcdModelReferenceDecoder. The model is given a TLcdOBJModelDescriptor.

Specified by:

decode in interface ILcdModelDecoder

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);
      }
   }
 

InterruptedIOException - When the thread on which this method is called is interrupted: it is recommended to stop the decoding and throw an InterruptedIOException. This same exception can also be used if the decoder shows UI to the user, and the user cancels the decoding through the UI.

See Also:

ILcdModelDecoder.canDecodeSource(String)