Class XMesh

Namespace

OmegaEngine.Assets

Assembly

OmegaEngine.dll

A mesh loaded from an .X file.

public class XMesh : Asset, IReferenceCount, IDisposable, INamed, IComparable<Asset>

Inheritance

object

Asset

XMesh

Implements

IReferenceCount

IDisposable

INamed

IComparable<Asset>

Derived

XAnimatedMesh

Inherited Members

Asset.Name

Asset.ToString()

Asset.ReferenceCount

Asset.Disposed

Asset.Dispose()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

XmlStorage.SaveXmlZip<T>(T, Stream, string?, params EmbeddedFile[])

XmlStorage.SaveXmlZip<T>(T, string, string?, params EmbeddedFile[])

XmlStorage.SaveXml<T>(T, Stream, string?)

XmlStorage.SaveXml<T>(T, string, string?)

XmlStorage.ToXmlString<T>(T, string?)

Constructors

XMesh(Engine, Stream, string)

Loads a static mesh from an .X file.

protected XMesh(Engine engine, Stream stream, string meshName)

Parameters

engine Engine

The Engine providing rendering capabilities.

stream Stream

The .X file to load the mesh from.

meshName string

The name of the mesh. This is used for finding associated textures.

Remarks

This should only be called by Get(Engine, string) to prevent unnecessary duplicates.

Exceptions

InvalidDataException

stream does not contain a valid mesh.

Fields

Materials

Materials (diffuse/normal/height/specular map, lighting settings) associated with the mesh

public readonly XMaterial[] Materials

Field Value

XMaterial[]

Properties

BoundingBox

A bounding box surrounding this mesh

public BoundingBox BoundingBox { get; protected set; }

Property Value

BoundingBox

BoundingSphere

A bounding sphere surrounding this mesh

public BoundingSphere BoundingSphere { get; protected set; }

Property Value

BoundingSphere

Mesh

public Mesh Mesh { get; }

Property Value

Mesh

Methods

Dispose(bool)

To be called by Dispose() and the object destructor.

protected override void Dispose(bool disposing)

Parameters

disposing bool

true if called manually and not by the garbage collector.

Get(Engine, string)

Returns a cached XMesh or creates a new one if the requested ID is not cached.

public static XMesh? Get(Engine engine, string id)

Parameters

engine Engine

The Engine providing the cache and rendering capabilities.

id string

The ID of the asset to be returned.

Returns

XMesh

The requested asset; null if id was empty.

Remarks

Remember to call Clean() when done, otherwise this object will never be released.

Exceptions

FileNotFoundException

The specified file could not be found.

IOException

There was an error reading the file.

UnauthorizedAccessException

Read access to the file is not permitted.

InvalidDataException

The file does not contain a valid mesh.

HoldReference()

Increments the ReferenceCount by one.

public override void HoldReference()

ReleaseReference()

Decrements the ReferenceCount by one.

public override void ReleaseReference()

See Also

Model