IModelReader

Description

interface Tinman.Engine.Models.IModelReader

Derived from: IDisposableGeneric<IModelReader>
IConfigurable
IValidatable
Extended by: ModelReader ^abstract

Base interface for classes that read 3D models.

See also: ModelFormat.ReadModel

Public / Methods

ReadModel

public method ReadModel → ()

returns → IModel: The read 3D model.

Reads the 3D model using the current options.

When the ReadModel method is called multiple times, the same IModel object will be returned, unless the model reader options have been modified.

After calling ReadModel, the IValidatable.Validate method may be called in order to receive additional errors and warnings that might have occurred while reading the model data.

IOException: If an I/O error has occurred.

ValidatingException: If the model reader has reported a critical error, for example an unsupported file format feature.

ReadModelDebug

public method ReadModelDebug → (2)

fileName ⁱⁿ : string: [not-empty]
The base file name to use for diagnostics output (see remarks).
directory ⁱⁿ : Path: [not-null]
The output directory for diagnostic files.

Runs diagnostics on this model reader, in order to analyse and fix problems.

This method will generated diagnostic files in the given directory ⁱⁿ, which will be named according to fileName ⁱⁿ and a file suffix that is defined by the implementation. Each implementation must output the following standard files:

$(fileName).txt
The ModelInfo dump of the IModel that has been returned by ReadModel.
$(fileName).json
A JSON file with timing results (in milli-seconds) for the calls to ReadModel, IModel.PrepareLazy, IModelGeometry.ReadIndices, IModelGeometry.ReadVertices and IModelTexture.ReadTexels.
$(fileName).err
The string representation of the ValidateResult object that has been obtained from IValidatable.ValidateInfo, after the ReadModel method has been called. If there are no errors and warnings, the file will be deleted, if it exists.
$(fileName).$(geometry).err
If IModelGeometry.ReadIndices and/or IModelGeometry.ReadVertices have thrown an exception, this file will contain the exception dump. If no exceptions were thrown, the file will be deleted. The $(geometry) token refers to the name of the IModelGeometry in the model info dump file, for example: Geometry_123.
$(fileName).$(texture).err
If IModelTexture.ReadTexels has thrown an exception, this file will contain the exception dump. If no exceptions were thrown, the file will be deleted. The $(texture) token refers to the name of the IModelTexture in the model info dump file, for example: Texture_123.

IOException: If an I/O error has occurred.

See also: ModelsUtil.ReadModelDebug

Public / Attributes

FileFormat

[Constant]
public attribute FileFormat → (get)

value : ModelFormat: [not-null]
The model format.

The model format that has created this reader.

See also: IModelReader.Options

Options

[Constant]
public attribute Options → (get)

value : ModelReaderOptions: [not-null]
The model reader options to use.

The options of the model reader object.

A IModelReader implementation may choose freely which options to support and which to ignore. Please refer to the documentation of the ModelFormat that is returned by FileFormat for details on which options are supported.

Extensions

WriteCMH

[OwnerReturn] [OwnerThis]
public static method WriteCMH → (1)

filePath ⁱⁿ : Path: [not-null]
Path to the output file.
returns → IOperation: The background operation.

Writes the whole model hierarchy to a self-contained CMH file.

See also: ModelFormat.CMH