interface IModelReader in Tinman.AddOns.Models

Base interface for classes that read 3D models.

interface	IModelReader	extends	IConfigurable
			IDisposable
			IValidatable
		base of	ModelReaderBase

Attributes

LifecycleState

Returns the lifecycle state of this object.

property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	ILifecycleState.LifecycleState

Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	IDisposable.AcquireTry

Remarks:

The object will not be actually disposed by calls to Dispose when there is at least one strong reference left. Code that calls the AcquireTry method is responsible for calling the Dispose method accordingly.

This method is not intended to be used in performance-critical code. It should only be used to high-level resource management.

Dispose

Releases all resources held by this object if there are no more strong references to it, decrements the reference counter by one otherwise.

[Dispose, OwnerThis, ThreadSafe]
method	Dispose ()
inherited	IDisposable.Dispose

Remarks:

The Dispose method silently returns if the object has already been disposed.

ReadModel

Reads the 3D model using the current options.

method	ReadModel ()
type	IModel
returns		[not-null]	The read 3D model.

Remarks:

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

ToConfig

Returns the configuration value that describes this object.

method	ToConfig ()
type	ConfigValue
returns		[not-null]	The configuration value.
inherited	IConfigurable.ToConfig

Remarks:

All configurable objects need to implement this interface. For simple types, it is preferable to delegate to ToValue.

The returned value may be of type Invalid, which means that this object in its current state cannot be described with the configuration API.

Before returning the resulting configuration value, Cache must be called on it, passing this IConfigurable object as parameter.

Validate

Validates the state of this object.

method	Validate (Validator validator)
params	validator	[not-null]	The validator object.
inherited	IValidatable.Validate

Extensions

WriteCMH

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

[OwnerReturn, OwnerThis]
method	WriteCMH (Path filePath)
type	IOperation
params	filePath	[not-null]	Path to the output file.
returns		[not-null]	The background operation.

See also:

ModelFormat.CMH