class ModelReaderBase in Tinman.AddOns.Models

Abstract base class for IModelReader implementations.

abstract class	ModelReaderBase	extends	Disposable
		implements	IModelReader
		base of	ModelReader

Configuration

ToConfig

Returns the configuration value that describes this object.

public abstract method	ToConfig ()
type	ConfigValue
returns		[not-null]	The configuration value.
implements	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.

Public / Attributes

LifecycleState

Returns the lifecycle state of this object.

public virtual property	LifecycleState { get }
type	LifecycleState
value		The lifecycle state.
inherited	Disposable.LifecycleState

Public / Methods

AcquireTry

Acquires a strong reference to this disposable object.

[OwnerReturn, ThreadSafe]
public method	AcquireTry ()
type	IDisposable
returns			this if a new strong reference has been acquired, null if this object is already being disposed.
inherited	Disposable.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]
public method	Dispose ()
inherited	Disposable.Dispose

Remarks:

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

ReadModel

Reads the 3D model using the current options.

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

Remarks:

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

Validate

Validates the state of this object.

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

Protected / Attributes

data

The file data from which to read the 3D model.

protected field	data
type	IFileData

Protected / Constructors

ModelReaderBase

Creates a new instance of ModelReaderBase.

protected constructor	ModelReaderBase (IFileData data)
params	data	[not-null]	The file data from which to read the 3D model.

Protected / Methods

Dirty

Subclasses must call this method when the model reader options have been modified.

protected method

Dirty ()

DisposeManaged

Disposes the managed resources held by a concrete subclass. This method will be called at most once per subclass.

protected override method	DisposeManaged ()
overrides	Disposable.DisposeManaged

Remarks:

This method will only be called when a disposable object is explicitly destroyed by user code calling the Dispose method. It will not be called when the object is collected as garbage by the system.

Overriding methods must call the DisposeManaged method of their base class. The base call should be the last statement.

The DisposeManaged method is called before the DisposeUnmanaged method.

DisposeUnmanaged

Disposes the unmanaged resources held by a concrete subclass. This method will be called exactly once per subclass.

protected virtual method	DisposeUnmanaged ()
inherited	Disposable.DisposeUnmanaged

Remarks:

Overriding methods must call the DisposeUnmanaged method of their base class. The base call should be the last statement.

The DisposeUnmanaged method is called after the DisposeManaged method.

DoReadModel

Reads the 3D model.

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

ValidateFlush

Flushes cached validation data.

[EmptyBody]
protected virtual method	ValidateFlush ()