interface IModelGeometryDynamic in Tinman.Engine.Models

Base interface for model geometries that can be updated at runtime.

interface

IModelGeometryDynamic

extends

IModelGeometry

Remarks

To update a model geometry, perform the following steps:

1. Use any of the following methods to obtain the model geometry data arrays and modify their contents:
   • UpdateAlbedo
   • UpdateIndices
   • UpdateNormal
   • UpdatePosition
   • UpdateTangentX
   • UpdateTangentY
   • UpdateTextureCoords
2. Call UpdateRange zero ore more times, in order to specify the vertex and index ranges that have been modified in step (1). The IndicesUpdated resp. VerticesUpdated methods will be called on all listeners that have been added with UpdateListenerAdd.
3. Call ColliderDirty if the updated model geometry shall be taken into account for spatial queries.

Attributes

IndexCount

The vertex index count.

property	IndexCount { get }
type	int32
value	[>=0]	The vertex index count. Will be 0 iff ReadIndices returns null.
inherited	IModelGeometry.IndexCount

InstanceBuffer

The resource handle that returns an IGeometryBuffer object that holds instance data to use for this model geometry object.

property	InstanceBuffer { get }
type	IResourceHandle
value		The instance buffer to use for geometry instancing or null if geometry instancing is disabled for this model geometry object.
inherited	IModelGeometry.InstanceBuffer

MemoryConsumption

Returns the estimated memory consumption of this object.

property	MemoryConsumption { get }
type	int64
value	[>=0]	The estimated memory consumption, in bytes.
inherited	IMemoryConsumption.MemoryConsumption

VertexCount

The vertex count.

property	VertexCount { get }
type	int32
value	[>0]	The vertex count.
inherited	IModelGeometry.VertexCount

VertexFormat

The vertex format flags.

property	VertexFormat { get }
type	ModelVertexFormat
value		The format flags.
inherited	IModelGeometry.VertexFormat

Methods

CreateResource

Creates a new resource object, using the given graphics context.

[OwnerReturn]
method	CreateResource (Graphics graphics)
type	IResource
params	graphics	[not-null]	The graphics context to use.
returns		[not-null]	The resource object.
inherited	IResourceHandle.CreateResource

Remarks:

Resource objects may implement the IMemoryConsumption interface. In this case, the reported memory consumption will be interpreted as an estimate on how much GPU memory is consumed by the resource. This estimate can then be used for resource caching (e.g. CacheMemory).

Exceptions:

• RenderException:
  If a graphics subsystem error has occurred.
• IOException:
  If an I/O error has occurred while reading the resource data.
• ValidatingException:
  If the data reader has reported an error, for example because of an unsupported file format feature.

Dynamic

Makes this model geometry dynamic.

method	Dynamic ()
type	IModelGeometryDynamic
returns		[not-null]	The dynamic model geometry.
inherited	IModelGeometry.Dynamic

Remarks:

If necessary, a new model geometry is created by copying index and vertex data from this model geometry.

Exceptions:

• IOException:
  If an I/O exception has occurred.

Equals

Compares this object with the given one.

[Pure]
method	Equals (IResourceHandle other)
type	bool
params	other		The object to compare to.
returns			true if this object is equal to other, false if not.
inherited	IEquatable.Equals

Instanced

Configures geometry instancing for this model geometry.

method	Instanced (IResourceHandle instanceBuffer)
type	IModelGeometry
params	instanceBuffer		The resource handle that returns an IVertexBuffer object that holds instance data to use for this model geometry object or null to disable geometry instancing. The instanceBuffer value will be returned by the IModelGeometry property of the returned model geometry object.
returns		[not-null]	The resulting model geometry.
inherited	IModelGeometry.Instanced

See also:

IModelGeometry

Optimized

Optimizes this model geometry by reordering those vertices that are actually referenced by the index data.

method	Optimized ()
type	IModelGeometry
returns		[not-null]	The optimized geometry, without instancing. Will be this if ReadIndices return null.
inherited	IModelGeometry.Optimized

ReadIndices

Read vertex index data.

method	ReadIndices ()
type	int32[]
returns			The vertex index data or null iff IndexCount returns 0 (i.e. the geometry is not indexed).
inherited	IModelGeometry.ReadIndices

Exceptions:

• IOException:
  If an I/O exception has occurred.

ReadVertices

Reads vertex data.

method	ReadVertices ()
type	VertexArrays
returns		[not-null]	The vertex data array.
inherited	IModelGeometry.ReadVertices

Exceptions:

• IOException:
  If an I/O exception has occurred.

Reduced

Reduce the floating-point precision for this model geometry?

method	Reduced (bool reduced)
type	IModelGeometry
params	reduced		Use 32-bit floating-point precision (true) or 64-bit floating-point precision ( false)?
returns		[not-null]	The reduced geometry.
inherited	IModelGeometry.Reduced

Remarks:

Using reduced precision will consume less memory resp. storage space, but might introduce jitter artifacts during rendering.

Transform

Transforms the model geometry using the given matrix.

method	Transform (Mat4D matrix)
type	IModelGeometry
params	matrix		The transformation matrix.
returns		[not-null]	The transformed geometry.
inherited	IModelGeometry.Transform

UpdateAlbedo

Returns the Texture vertex array that holds the per-vertex data for Albedo.

[BeginEnd]
method	UpdateAlbedo ()
type	Long1
returns			The vertex array or null iff not present.

See also:

Colors

UpdateIndices

Returns the vertex indices.

[BeginEnd]
method	UpdateIndices ()
type	int32[]
returns			The vertex indices or null iff not present.

UpdateListenerAdd

Adds a listener for model geometry updates.

method	UpdateListenerAdd (IModelGeometryListener listener)
params	listener	[not-null]	The update listener.

UpdateListenerRemove

Removes a listener for model geometry updates.

method	UpdateListenerRemove (IModelGeometryListener listener)
params	listener	[not-null]	The update listener.

UpdateNormal

Returns the Normal vertex array that holds the per-vertex data for Normal.

[BeginEnd]
method	UpdateNormal ()
type	Float3
returns			The vertex array or null iff not present.

UpdatePosition

Returns the Position vertex array that holds the per-vertex data for Position/ PositionExtra.

[BeginEnd]
method	UpdatePosition ()
type	Double3
returns		[not-null]	The vertex array.

UpdateRange

Specifies a vertex and/or index range that has been modified.

method	UpdateRange (RangeI vertices, RangeI indices)
params	vertices		The modified vertex range of Zero for none.
	indices		The modified index range or Zero for none.

UpdateTangentX

Returns the TangentX vertex array that holds the per-vertex data for TangentX.

[BeginEnd]
method	UpdateTangentX ()
type	Float3
returns			The vertex array or null iff not present.

UpdateTangentY

Returns the TangentY vertex array that holds the per-vertex data for TangentY.

[BeginEnd]
method	UpdateTangentY ()
type	Float3
returns			The vertex array or null iff not present.

UpdateTextureCoords

Returns the TextureCoords vertex array that holds the per-vertex data for TextureCoords.

[BeginEnd]
method	UpdateTextureCoords ()
type	Float2
returns			The vertex array or null iff not present.