interface IShapeReader in Tinman.Terrain.Shapes

interface	IShapeReader	extends	IDisposable
			IValidatable
		base of	ShapeReader

Attributes

HasFinished

Has the shape reader finished (i.e. all shapes have been read)?

property	HasFinished { get }
type	bool
value		true if all shapes have been read, false if not.

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.

ReadShape

Reads the next shape.

method	ReadShape ()
type	IShape
returns			The shape or null if the reader has already finished.

Validate

Validates the state of this object.

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