Ogre::Mesh

Ogre::Mesh Class Reference

#include <OgreMesh.h>

Inheritance diagram for Ogre::Mesh:

List of all members.

Public Types

typedef std::vector
< Real > LodDistanceList

typedef
std::multimap
< size_t,
VertexBoneAssignment > VertexBoneAssignmentList

Multimap of vertex bone assignments (orders by vertex index).

typedef MapIterator
< VertexBoneAssignmentList > BoneAssignmentIterator

typedef std::vector
< SubMesh * > SubMeshList

typedef std::vector
< unsigned short > IndexMap

typedef HashMap
< String, ushort > SubMeshNameMap

A hashmap used to store optional SubMesh names.

typedef
VectorIterator
< SubMeshList > SubMeshIterator

typedef
VectorIterator
< PoseList > PoseIterator

typedef
ConstVectorIterator
< PoseList > ConstPoseIterator

enum LoadingState {
LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING,
LOADSTATE_PREPARED, LOADSTATE_PREPARING
}

Enum identifying the loading state of the resource. More...

Public Member Functions

Mesh (ResourceManager *creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader *loader=0)

Default constructor - used by MeshManager.

~Mesh ()

SubMesh * createSubMesh (void)

Creates a new SubMesh.

SubMesh * createSubMesh (const String &name)

Creates a new SubMesh and gives it a name.

void nameSubMesh (const String &name, ushort index)

Gives a name to a SubMesh.

ushort _getSubMeshIndex (const String &name) const

Gets the index of a submesh with a given name.

unsigned short getNumSubMeshes (void) const

Gets the number of sub meshes which comprise this mesh.

SubMesh * getSubMesh (unsigned short index) const

Gets a pointer to the submesh indicated by the index.

SubMesh * getSubMesh (const String &name) const

Gets a SubMesh by name.

SubMeshIterator getSubMeshIterator (void)

Gets an iterator over the available submeshes.

MeshPtr clone (const String &newName, const String &newGroup=StringUtil::BLANK)

Makes a copy of this mesh object and gives it a new name.

const AxisAlignedBox & getBounds (void) const

Get the axis-aligned bounding box for this mesh.

Real getBoundingSphereRadius (void) const

Gets the radius of the bounding sphere surrounding this mesh.

void _setBounds (const AxisAlignedBox &bounds, bool pad=true)

Manually set the bounding box for this Mesh.

void _setBoundingSphereRadius (Real radius)

Manually set the bounding radius.

void setSkeletonName (const String &skelName)

Sets the name of the skeleton this Mesh uses for animation.

bool hasSkeleton (void) const

Returns true if this Mesh has a linked Skeleton.

bool hasVertexAnimation (void) const

Returns whether or not this mesh has some kind of vertex animation.

const SkeletonPtr & getSkeleton (void) const

Gets a pointer to any linked Skeleton.

const String & getSkeletonName (void) const

Gets the name of any linked Skeleton.

void _initAnimationState (AnimationStateSet *animSet)

Initialise an animation set suitable for use with this mesh.

void _refreshAnimationState (AnimationStateSet *animSet)

Refresh an animation set suitable for use with this mesh.

void addBoneAssignment (const VertexBoneAssignment &vertBoneAssign)

Assigns a vertex to a bone with a given weight, for skeletal animation.

void clearBoneAssignments (void)

Removes all bone assignments for this mesh.

void _notifySkeleton (SkeletonPtr &pSkel)

Internal notification, used to tell the Mesh which Skeleton to use without loading it.

BoneAssignmentIterator getBoneAssignmentIterator (void)

Gets an iterator for access all bone assignments.

const
VertexBoneAssignmentList & getBoneAssignments () const

Gets a const reference to the list of bone assignments.

void generateLodLevels (const LodDistanceList &lodDistances, ProgressiveMesh::VertexReductionQuota reductionMethod, Real reductionValue)

Automatically generates lower level of detail versions of this mesh for use when a simpler version of the model is acceptable for rendering.

ushort getNumLodLevels (void) const

Returns the number of levels of detail that this mesh supports.

const MeshLodUsage & getLodLevel (ushort index) const

Gets details of the numbered level of detail entry.

void createManualLodLevel (Real fromDepth, const String &meshName)

Adds a new manual level-of-detail entry to this Mesh.

void updateManualLodLevel (ushort index, const String &meshName)

Changes the alternate mesh to use as a manual LOD at the given index.

ushort getLodIndex (Real depth) const

Retrieves the level of detail index for the given depth value.

ushort getLodIndexSquaredDepth (Real squaredDepth) const

Retrieves the level of detail index for the given squared depth value.

bool isLodManual (void) const

Returns true if this mesh is using manual LOD.

void _setLodInfo (unsigned short numLevels, bool isManual)

Internal methods for loading LOD, do not use.

void _setLodUsage (unsigned short level, MeshLodUsage &usage)

Internal methods for loading LOD, do not use.

void _setSubMeshLodFaceList (unsigned short subIdx, unsigned short level, IndexData *facedata)

Internal methods for loading LOD, do not use.

void removeLodLevels (void)

Removes all LOD data from this Mesh.

void setVertexBufferPolicy (HardwareBuffer::Usage usage, bool shadowBuffer=false)

Sets the policy for the vertex buffers to be used when loading this Mesh.

void setIndexBufferPolicy (HardwareBuffer::Usage usage, bool shadowBuffer=false)

Sets the policy for the index buffers to be used when loading this Mesh.

HardwareBuffer::Usage getVertexBufferUsage (void) const

Gets the usage setting for this meshes vertex buffers.

HardwareBuffer::Usage getIndexBufferUsage (void) const

Gets the usage setting for this meshes index buffers.

bool isVertexBufferShadowed (void) const

Gets whether or not this meshes vertex buffers are shadowed.

bool isIndexBufferShadowed (void) const

Gets whether or not this meshes index buffers are shadowed.

unsigned short _rationaliseBoneAssignments (size_t vertexCount, VertexBoneAssignmentList &assignments)

Rationalises the passed in bone assignment list.

void _compileBoneAssignments (void)

Internal method, be called once to compile bone assignments into geometry buffer.

void _updateCompiledBoneAssignments (void)

Internal method, be called once to update the compiled bone assignments.

void buildTangentVectors (VertexElementSemantic targetSemantic=VES_TANGENT, unsigned short sourceTexCoordSet=0, unsigned short index=0, bool splitMirrored=false, bool splitRotated=false, bool storeParityInW=false)

This method builds a set of tangent vectors for a given mesh into a 3D texture coordinate buffer.

bool suggestTangentVectorBuildParams (VertexElementSemantic targetSemantic, unsigned short &outSourceCoordSet, unsigned short &outIndex)

Ask the mesh to suggest parameters to a future buildTangentVectors call, should you wish to use texture coordinates to store the tangents.

void buildEdgeList (void)

Builds an edge list for this mesh, which can be used for generating a shadow volume among other things.

void freeEdgeList (void)

Destroys and frees the edge lists this mesh has built.

void prepareForShadowVolume (void)

This method prepares the mesh for generating a renderable shadow volume.

EdgeData * getEdgeList (unsigned int lodIndex=0)

Return the edge list for this mesh, building it if required.

const EdgeData * getEdgeList (unsigned int lodIndex=0) const

Return the edge list for this mesh, building it if required.

bool isPreparedForShadowVolumes (void) const

Returns whether this mesh has already had it's geometry prepared for use in rendering shadow volumes.

bool isEdgeListBuilt (void) const

Returns whether this mesh has an attached edge list.

const SubMeshNameMap & getSubMeshNameMap (void) const

Gets a reference to the optional name assignments of the SubMeshes.

void setAutoBuildEdgeLists (bool autobuild)

Sets whether or not this Mesh should automatically build edge lists when asked for them, or whether it should never build them if they are not already provided.

bool getAutoBuildEdgeLists (void) const

Sets whether or not this Mesh should automatically build edge lists when asked for them, or whether it should never build them if they are not already provided.

virtual
VertexAnimationType getSharedVertexDataAnimationType (void) const

Gets the type of vertex animation the shared vertex data of this mesh supports.

virtual Animation * createAnimation (const String &name, Real length)

Creates a new Animation object for vertex animating this mesh.

virtual Animation * getAnimation (const String &name) const

Returns the named vertex Animation object.

virtual Animation * _getAnimationImpl (const String &name) const

Internal access to the named vertex Animation object - returns null if it does not exist.

virtual bool hasAnimation (const String &name)

Returns whether this mesh contains the named vertex animation.

virtual void removeAnimation (const String &name)

Removes vertex Animation from this mesh.

virtual unsigned short getNumAnimations (void) const

Gets the number of morph animations in this mesh.

virtual Animation * getAnimation (unsigned short index) const

Gets a single morph animation by index.

virtual void removeAllAnimations (void)

Removes all morph Animations from this mesh.

VertexData * getVertexDataByTrackHandle (unsigned short handle)

Gets a pointer to a vertex data element based on a morph animation track handle.

void updateMaterialForAllSubMeshes (void)

Iterates through all submeshes and requests them to apply their texture aliases to the material they use.

void _determineAnimationTypes (void) const

Internal method which, if animation types have not been determined, scans any vertex animations and determines the type for each set of vertex data (cannot have 2 different types).

bool _getAnimationTypesDirty (void) const

Are the derived animation types out of date?

Pose * createPose (ushort target, const String &name=StringUtil::BLANK)

Create a new Pose for this mesh or one of its submeshes.

size_t getPoseCount (void) const

Get the number of poses.

Pose * getPose (ushort index)

Retrieve an existing Pose by index.

Pose * getPose (const String &name)

Retrieve an existing Pose by name.

void removePose (ushort index)

Destroy a pose by index.

void removePose (const String &name)

Destroy a pose by name.

void removeAllPoses (void)

Destroy all poses.

PoseIterator getPoseIterator (void)

Get an iterator over all the poses defined.

ConstPoseIterator getPoseIterator (void) const

Get an iterator over all the poses defined.

const PoseList & getPoseList (void) const

Get pose list.

virtual void prepare ()

Prepares the resource for load, if it is not already.

virtual void load (bool backgroundThread=false)

Loads the resource, if it is not already.

virtual void reload (void)

Reloads the resource, if it is already loaded.

virtual bool isReloadable (void) const

Returns true if the Resource is reloadable, false otherwise.

virtual bool isManuallyLoaded (void) const

Is this resource manually loaded?

virtual void unload (void)

Unloads the resource; this is not permanent, the resource can be reloaded later if required.

virtual size_t getSize (void) const

Retrieves info about the size of the resource.

virtual void touch (void)

'Touches' the resource to indicate it has been used.

virtual const String & getName (void) const

Gets resource name.

virtual ResourceHandle getHandle (void) const

virtual bool isPrepared (void) const

Returns true if the Resource has been prepared, false otherwise.

virtual bool isLoaded (void) const

Returns true if the Resource has been loaded, false otherwise.

virtual bool isLoading () const

Returns whether the resource is currently in the process of background loading.

virtual LoadingState getLoadingState () const

Returns the current loading state.

virtual bool isBackgroundLoaded (void) const

Returns whether this Resource has been earmarked for background loading.

virtual void setBackgroundLoaded (bool bl)

Tells the resource whether it is background loaded or not.

virtual void escalateLoading ()

Escalates the loading of a background loaded resource.

virtual void addListener (Listener *lis)

Register a listener on this resource.

virtual void removeListener (Listener *lis)

Remove a listener on this resource.

virtual const String & getGroup (void)

Gets the group which this resource is a member of.

virtual void changeGroupOwnership (const String &newGroup)

Change the resource group ownership of a Resource.

virtual ResourceManager * getCreator (void)

Gets the manager which created this resource.

virtual const String & getOrigin (void) const

Get the origin of this resource, e.g.

virtual void _notifyOrigin (const String &origin)

Notify this resource of it's origin.

virtual size_t getStateCount () const

Returns the number of times this resource has changed state, which generally means the number of times it has been loaded.

virtual void _dirtyState ()

Manually mark the state of this resource as having been changed.

virtual void _fireBackgroundLoadingComplete (void)

Firing of background loading complete event.

virtual void _fireBackgroundPreparingComplete (void)

Firing of background preparing complete event.

ParamDictionary * getParamDictionary (void)

Retrieves the parameter dictionary for this class.

const ParamDictionary * getParamDictionary (void) const

const ParameterList & getParameters (void) const

Retrieves a list of parameters valid for this object.

virtual bool setParameter (const String &name, const String &value)

Generic parameter setting method.

virtual void setParameterList (const NameValuePairList &paramList)

Generic multiple parameter setting method.

virtual String getParameter (const String &name) const

Generic parameter retrieval method.

virtual void copyParametersTo (StringInterface *dest) const

Method for copying this object's parameters to another object.

void * operator new (size_t sz, const char *file, int line, const char *func)

operator new, with debug line info

void * operator new (size_t sz)

void * operator new (size_t sz, void *ptr)

placement operator new

void * operator new[] (size_t sz, const char *file, int line, const char *func)

array operator new, with debug line info

void * operator new[] (size_t sz)

void operator delete (void *ptr)

void operator delete (void *ptr, const char *, int, const char *)

void operator delete[] (void *ptr)

void operator delete[] (void *ptr, const char *, int, const char *)

Static Public Member Functions

static void prepareMatricesForVertexBlend (const Matrix4 **blendMatrices, const Matrix4 *boneMatrices, const IndexMap &indexMap)

Prepare matrices for software indexed vertex blend.

static void softwareVertexBlend (const VertexData *sourceVertexData, const VertexData *targetVertexData, const Matrix4 *const *blendMatrices, size_t numMatrices, bool blendNormals)

Performs a software indexed vertex blend, of the kind used for skeletal animation although it can be used for other purposes.

static void softwareVertexMorph (Real t, const HardwareVertexBufferSharedPtr &b1, const HardwareVertexBufferSharedPtr &b2, VertexData *targetVertexData)

Performs a software vertex morph, of the kind used for morph animation although it can be used for other purposes.

static void softwareVertexPoseBlend (Real weight, const std::map< size_t, Vector3 > &vertexOffsetMap, VertexData *targetVertexData)

Performs a software vertex pose blend, of the kind used for morph animation although it can be used for other purposes.

static void cleanupDictionary ()

Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.

Public Attributes

VertexData * sharedVertexData

Shared vertex data.

IndexMap sharedBlendIndexToBoneIndexMap

Shared index map for translating blend index to bone index.

Protected Types

typedef std::vector
< MeshLodUsage > MeshLodUsageList

typedef std::map
< String, Animation * > AnimationList

Storage of morph animations, lookup by name.

typedef std::list
< Listener * > ListenerList

Protected Member Functions

void organiseTangentsBuffer (VertexData *vertexData, VertexElementSemantic targetSemantic, unsigned short index, unsigned short sourceTexCoordSet)

Internal method for making the space for a vertex element to hold tangents.

void buildIndexMap (const VertexBoneAssignmentList &boneAssignments, IndexMap &boneIndexToBlendIndexMap, IndexMap &blendIndexToBoneIndexMap)

Build the index map between bone index and blend index.

void compileBoneAssignments (const VertexBoneAssignmentList &boneAssignments, unsigned short numBlendWeightsPerVertex, IndexMap &blendIndexToBoneIndexMap, VertexData *targetVertexData)

Compile bone assignments into blend index and weight buffers.

void prepareImpl (void)

Loads the mesh from disk.

void unprepareImpl (void)

Destroys data cached by prepareImpl.

void loadImpl (void)

Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader.

void postLoadImpl (void)

Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.

Note:
Mutex will have already been acquired by the loading thread. Also, this call will occur even when using a ManualResourceLoader (when loadImpl is not actually called)

void unloadImpl (void)

Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader.

size_t calculateSize (void) const

Calculate the size of a resource; this will only be called after 'load'.

virtual void preLoadImpl (void)

Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.

virtual void preUnloadImpl (void)

Internal hook to perform actions before the unload process.

virtual void postUnloadImpl (void)

Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.

virtual void queueFireBackgroundLoadingComplete (void)

Queue the firing of background loading complete event.

virtual void queueFireBackgroundPreparingComplete (void)

Queue the firing of background preparing complete event.

bool createParamDictionary (const String &className)

Internal method for creating a parameter dictionary for the class, if it does not already exist.

Protected Attributes

SubMeshList mSubMeshList

A list of submeshes which make up this mesh.

DataStreamPtr mFreshFromDisk

SubMeshNameMap mSubMeshNameMap

AxisAlignedBox mAABB

Local bounding box volume.

Real mBoundRadius

Local bounding sphere radius (centered on object).

String mSkeletonName

Optional linked skeleton.

SkeletonPtr mSkeleton

VertexBoneAssignmentList mBoneAssignments

bool mBoneAssignmentsOutOfDate

Flag indicating that bone assignments need to be recompiled.

bool mIsLodManual

ushort mNumLods

MeshLodUsageList mMeshLodUsageList

HardwareBuffer::Usage mVertexBufferUsage

HardwareBuffer::Usage mIndexBufferUsage

bool mVertexBufferShadowBuffer

bool mIndexBufferShadowBuffer

bool mPreparedForShadowVolumes

bool mEdgeListsBuilt

bool mAutoBuildEdgeLists

AnimationList mAnimationsList

VertexAnimationType mSharedVertexDataAnimationType

The vertex animation type associated with the shared vertex data.

bool mAnimationTypesDirty

Do we need to scan animations for animation types?

PoseList mPoseList

List of available poses for shared and dedicated geometryPoseList.

ResourceManager * mCreator

Creator.

String mName

Unique name of the resource.

String mGroup

The name of the resource group.

ResourceHandle mHandle

Numeric handle for more efficient look up than name.

AtomicScalar
< LoadingState > mLoadingState

Is the resource currently loaded?

volatile bool mIsBackgroundLoaded

Is this resource going to be background loaded? Only applicable for multithreaded.

size_t mSize

The size of the resource in bytes.

bool mIsManual

Is this file manually loaded?

String mOrigin

Origin of this resource (e.g. script name) - optional.

ManualResourceLoader * mLoader

Optional manual loader; if provided, data is loaded from here instead of a file.

size_t mStateCount

State count, the number of times this resource has changed state.

ListenerList mListenerList

String mParamDictName

Class name for this instance to be used as a lookup (must be initialised by subclasses).

Static Protected Attributes

static ParamDictionaryMap msDictionary

Dictionary of parameters.

Friends

class SubMesh

class MeshSerializerImpl

class MeshSerializerImpl_v1_2

class MeshSerializerImpl_v1_1

Detailed Description

Definition at line 86 of file OgreMesh.h.

Member Typedef Documentation

typedef std::vector<Real> Ogre::Mesh::LodDistanceList

Definition at line 94 of file OgreMesh.h.

typedef std::multimap<size_t, VertexBoneAssignment> Ogre::Mesh::VertexBoneAssignmentList

Multimap of vertex bone assignments (orders by vertex index).

Definition at line 96 of file OgreMesh.h.

typedef MapIterator<VertexBoneAssignmentList> Ogre::Mesh::BoneAssignmentIterator

Definition at line 97 of file OgreMesh.h.

typedef std::vector<SubMesh*> Ogre::Mesh::SubMeshList

Definition at line 98 of file OgreMesh.h.

typedef std::vector<unsigned short> Ogre::Mesh::IndexMap

Definition at line 99 of file OgreMesh.h.

typedef HashMap<String, ushort> Ogre::Mesh::SubMeshNameMap

A hashmap used to store optional SubMesh names.

Translates a name into SubMesh index

Definition at line 119 of file OgreMesh.h.

typedef std::vector<MeshLodUsage> Ogre::Mesh::MeshLodUsageList [protected]

Definition at line 154 of file OgreMesh.h.

typedef std::map<String, Animation*> Ogre::Mesh::AnimationList [protected]

Storage of morph animations, lookup by name.

Definition at line 168 of file OgreMesh.h.

typedef VectorIterator<SubMeshList> Ogre::Mesh::SubMeshIterator

Definition at line 246 of file OgreMesh.h.

typedef VectorIterator<PoseList> Ogre::Mesh::PoseIterator

Definition at line 849 of file OgreMesh.h.

typedef ConstVectorIterator<PoseList> Ogre::Mesh::ConstPoseIterator

Definition at line 850 of file OgreMesh.h.

typedef std::list<Listener*> Ogre::Resource::ListenerList [protected, inherited]

Definition at line 148 of file OgreResource.h.

Member Enumeration Documentation

enum Ogre::Resource::LoadingState [inherited]

Enum identifying the loading state of the resource.

Enumerator:

LOADSTATE_UNLOADED	Not loaded.
LOADSTATE_LOADING	Loading is in progress.
LOADSTATE_LOADED	Fully loaded.
LOADSTATE_UNLOADING	Currently unloading.
LOADSTATE_PREPARED	Fully prepared.
LOADSTATE_PREPARING	Preparing is in progress.

Definition at line 109 of file OgreResource.h.

Constructor & Destructor Documentation

Ogre::Mesh::Mesh	(	ResourceManager *	creator,
		const String &	name,
		ResourceHandle	handle,
		const String &	group,
		bool	isManual = `false`,
		ManualResourceLoader *	loader = `0`
	)

Default constructor - used by MeshManager.

Warning:: Do not call this method directly.

Ogre::Mesh::~Mesh ( )

Member Function Documentation

void Ogre::Mesh::organiseTangentsBuffer	(	VertexData *	vertexData,
		VertexElementSemantic	targetSemantic,
		unsigned short	index,
		unsigned short	sourceTexCoordSet
	)			`[protected]`

Internal method for making the space for a vertex element to hold tangents.

void Ogre::Mesh::buildIndexMap	(	const VertexBoneAssignmentList &	boneAssignments,
		IndexMap &	boneIndexToBlendIndexMap,
		IndexMap &	blendIndexToBoneIndexMap
	)			`[protected]`

Build the index map between bone index and blend index.

void Ogre::Mesh::compileBoneAssignments	(	const VertexBoneAssignmentList &	boneAssignments,
		unsigned short	numBlendWeightsPerVertex,
		IndexMap &	blendIndexToBoneIndexMap,
		VertexData *	targetVertexData
	)			`[protected]`

Compile bone assignments into blend index and weight buffers.

void Ogre::Mesh::prepareImpl ( void ) [protected, virtual]

Loads the mesh from disk.

This call only performs IO, it does not parse the bytestream or check for any errors therein. It also does not set up submeshes, etc. You have to call load() to do that.

Reimplemented from Ogre::Resource.

Reimplemented in Ogre::PatchMesh.

void Ogre::Mesh::unprepareImpl ( void ) [protected, virtual]

Destroys data cached by prepareImpl.

Reimplemented from Ogre::Resource.

void Ogre::Mesh::loadImpl ( void ) [protected, virtual]

Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader.

Implements Ogre::Resource.

Reimplemented in Ogre::PatchMesh.

void Ogre::Mesh::postLoadImpl ( void ) [protected, virtual]

Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded.

Note:: Mutex will have already been acquired by the loading thread. Also, this call will occur even when using a ManualResourceLoader (when loadImpl is not actually called)

Reimplemented from Ogre::Resource.

void Ogre::Mesh::unloadImpl ( void ) [protected, virtual]

Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader.

Implements Ogre::Resource.

size_t Ogre::Mesh::calculateSize ( void ) const [protected, virtual]

Calculate the size of a resource; this will only be called after 'load'.

Implements Ogre::Resource.

SubMesh* Ogre::Mesh::createSubMesh ( void )

Creates a new SubMesh.

Remarks:: Method for manually creating geometry for the mesh. Note - use with extreme caution - you must be sure that you have set up the geometry properly.

SubMesh* Ogre::Mesh::createSubMesh ( const String &


Public Types
typedef std::vector < Real >	LodDistanceList
typedef std::multimap < size_t, VertexBoneAssignment >	VertexBoneAssignmentList
	Multimap of vertex bone assignments (orders by vertex index).
typedef MapIterator < VertexBoneAssignmentList >	BoneAssignmentIterator
typedef std::vector < SubMesh * >	SubMeshList
typedef std::vector < unsigned short >	IndexMap
typedef HashMap < String, ushort >	SubMeshNameMap
	A hashmap used to store optional SubMesh names.
typedef VectorIterator < SubMeshList >	SubMeshIterator
typedef VectorIterator < PoseList >	PoseIterator
typedef ConstVectorIterator < PoseList >	ConstPoseIterator
enum	LoadingState { LOADSTATE_UNLOADED, LOADSTATE_LOADING, LOADSTATE_LOADED, LOADSTATE_UNLOADING, LOADSTATE_PREPARED, LOADSTATE_PREPARING }
	Enum identifying the loading state of the resource. More...
Public Member Functions
	Mesh (ResourceManager creator, const String &name, ResourceHandle handle, const String &group, bool isManual=false, ManualResourceLoader loader=0)
	Default constructor - used by MeshManager.
	~Mesh ()
SubMesh *	createSubMesh (void)
	Creates a new SubMesh.
SubMesh *	createSubMesh (const String &name)
	Creates a new SubMesh and gives it a name.
void	nameSubMesh (const String &name, ushort index)
	Gives a name to a SubMesh.
ushort	_getSubMeshIndex (const String &name) const
	Gets the index of a submesh with a given name.
unsigned short	getNumSubMeshes (void) const
	Gets the number of sub meshes which comprise this mesh.
SubMesh *	getSubMesh (unsigned short index) const
	Gets a pointer to the submesh indicated by the index.
SubMesh *	getSubMesh (const String &name) const
	Gets a SubMesh by name.
SubMeshIterator	getSubMeshIterator (void)
	Gets an iterator over the available submeshes.
MeshPtr	clone (const String &newName, const String &newGroup=StringUtil::BLANK)
	Makes a copy of this mesh object and gives it a new name.
const AxisAlignedBox &	getBounds (void) const
	Get the axis-aligned bounding box for this mesh.
Real	getBoundingSphereRadius (void) const
	Gets the radius of the bounding sphere surrounding this mesh.
void	_setBounds (const AxisAlignedBox &bounds, bool pad=true)
	Manually set the bounding box for this Mesh.
void	_setBoundingSphereRadius (Real radius)
	Manually set the bounding radius.
void	setSkeletonName (const String &skelName)
	Sets the name of the skeleton this Mesh uses for animation.
bool	hasSkeleton (void) const
	Returns true if this Mesh has a linked Skeleton.
bool	hasVertexAnimation (void) const
	Returns whether or not this mesh has some kind of vertex animation.
const SkeletonPtr &	getSkeleton (void) const
	Gets a pointer to any linked Skeleton.
const String &	getSkeletonName (void) const
	Gets the name of any linked Skeleton.
void	_initAnimationState (AnimationStateSet *animSet)
	Initialise an animation set suitable for use with this mesh.
void	_refreshAnimationState (AnimationStateSet *animSet)
	Refresh an animation set suitable for use with this mesh.
void	addBoneAssignment (const VertexBoneAssignment &vertBoneAssign)
	Assigns a vertex to a bone with a given weight, for skeletal animation.
void	clearBoneAssignments (void)
	Removes all bone assignments for this mesh.
void	_notifySkeleton (SkeletonPtr &pSkel)
	Internal notification, used to tell the Mesh which Skeleton to use without loading it.
BoneAssignmentIterator	getBoneAssignmentIterator (void)
	Gets an iterator for access all bone assignments.
const VertexBoneAssignmentList &	getBoneAssignments () const
	Gets a const reference to the list of bone assignments.
void	generateLodLevels (const LodDistanceList &lodDistances, ProgressiveMesh::VertexReductionQuota reductionMethod, Real reductionValue)
	Automatically generates lower level of detail versions of this mesh for use when a simpler version of the model is acceptable for rendering.
ushort	getNumLodLevels (void) const
	Returns the number of levels of detail that this mesh supports.
const MeshLodUsage &	getLodLevel (ushort index) const
	Gets details of the numbered level of detail entry.
void	createManualLodLevel (Real fromDepth, const String &meshName)
	Adds a new manual level-of-detail entry to this Mesh.
void	updateManualLodLevel (ushort index, const String &meshName)
	Changes the alternate mesh to use as a manual LOD at the given index.
ushort	getLodIndex (Real depth) const
	Retrieves the level of detail index for the given depth value.
ushort	getLodIndexSquaredDepth (Real squaredDepth) const
	Retrieves the level of detail index for the given squared depth value.
bool	isLodManual (void) const
	Returns true if this mesh is using manual LOD.
void	_setLodInfo (unsigned short numLevels, bool isManual)
	Internal methods for loading LOD, do not use.
void	_setLodUsage (unsigned short level, MeshLodUsage &usage)
	Internal methods for loading LOD, do not use.
void	_setSubMeshLodFaceList (unsigned short subIdx, unsigned short level, IndexData *facedata)
	Internal methods for loading LOD, do not use.
void	removeLodLevels (void)
	Removes all LOD data from this Mesh.
void	setVertexBufferPolicy (HardwareBuffer::Usage usage, bool shadowBuffer=false)
	Sets the policy for the vertex buffers to be used when loading this Mesh.
void	setIndexBufferPolicy (HardwareBuffer::Usage usage, bool shadowBuffer=false)
	Sets the policy for the index buffers to be used when loading this Mesh.
HardwareBuffer::Usage	getVertexBufferUsage (void) const
	Gets the usage setting for this meshes vertex buffers.
HardwareBuffer::Usage	getIndexBufferUsage (void) const
	Gets the usage setting for this meshes index buffers.
bool	isVertexBufferShadowed (void) const
	Gets whether or not this meshes vertex buffers are shadowed.
bool	isIndexBufferShadowed (void) const
	Gets whether or not this meshes index buffers are shadowed.
unsigned short	_rationaliseBoneAssignments (size_t vertexCount, VertexBoneAssignmentList &assignments)
	Rationalises the passed in bone assignment list.
void	_compileBoneAssignments (void)
	Internal method, be called once to compile bone assignments into geometry buffer.
void	_updateCompiledBoneAssignments (void)
	Internal method, be called once to update the compiled bone assignments.
void	buildTangentVectors (VertexElementSemantic targetSemantic=VES_TANGENT, unsigned short sourceTexCoordSet=0, unsigned short index=0, bool splitMirrored=false, bool splitRotated=false, bool storeParityInW=false)
	This method builds a set of tangent vectors for a given mesh into a 3D texture coordinate buffer.
bool	suggestTangentVectorBuildParams (VertexElementSemantic targetSemantic, unsigned short &outSourceCoordSet, unsigned short &outIndex)
	Ask the mesh to suggest parameters to a future buildTangentVectors call, should you wish to use texture coordinates to store the tangents.
void	buildEdgeList (void)
	Builds an edge list for this mesh, which can be used for generating a shadow volume among other things.
void	freeEdgeList (void)
	Destroys and frees the edge lists this mesh has built.
void	prepareForShadowVolume (void)
	This method prepares the mesh for generating a renderable shadow volume.
EdgeData *	getEdgeList (unsigned int lodIndex=0)
	Return the edge list for this mesh, building it if required.
const EdgeData *	getEdgeList (unsigned int lodIndex=0) const
	Return the edge list for this mesh, building it if required.
bool	isPreparedForShadowVolumes (void) const
	Returns whether this mesh has already had it's geometry prepared for use in rendering shadow volumes.
bool	isEdgeListBuilt (void) const
	Returns whether this mesh has an attached edge list.
const SubMeshNameMap &	getSubMeshNameMap (void) const
	Gets a reference to the optional name assignments of the SubMeshes.
void	setAutoBuildEdgeLists (bool autobuild)
	Sets whether or not this Mesh should automatically build edge lists when asked for them, or whether it should never build them if they are not already provided.
bool	getAutoBuildEdgeLists (void) const
	Sets whether or not this Mesh should automatically build edge lists when asked for them, or whether it should never build them if they are not already provided.
virtual VertexAnimationType	getSharedVertexDataAnimationType (void) const
	Gets the type of vertex animation the shared vertex data of this mesh supports.
virtual Animation *	createAnimation (const String &name, Real length)
	Creates a new Animation object for vertex animating this mesh.
virtual Animation *	getAnimation (const String &name) const
	Returns the named vertex Animation object.
virtual Animation *	_getAnimationImpl (const String &name) const
	Internal access to the named vertex Animation object - returns null if it does not exist.
virtual bool	hasAnimation (const String &name)
	Returns whether this mesh contains the named vertex animation.
virtual void	removeAnimation (const String &name)
	Removes vertex Animation from this mesh.
virtual unsigned short	getNumAnimations (void) const
	Gets the number of morph animations in this mesh.
virtual Animation *	getAnimation (unsigned short index) const
	Gets a single morph animation by index.
virtual void	removeAllAnimations (void)
	Removes all morph Animations from this mesh.
VertexData *	getVertexDataByTrackHandle (unsigned short handle)
	Gets a pointer to a vertex data element based on a morph animation track handle.
void	updateMaterialForAllSubMeshes (void)
	Iterates through all submeshes and requests them to apply their texture aliases to the material they use.
void	_determineAnimationTypes (void) const
	Internal method which, if animation types have not been determined, scans any vertex animations and determines the type for each set of vertex data (cannot have 2 different types).
bool	_getAnimationTypesDirty (void) const
	Are the derived animation types out of date?
Pose *	createPose (ushort target, const String &name=StringUtil::BLANK)
	Create a new Pose for this mesh or one of its submeshes.
size_t	getPoseCount (void) const
	Get the number of poses.
Pose *	getPose (ushort index)
	Retrieve an existing Pose by index.
Pose *	getPose (const String &name)
	Retrieve an existing Pose by name.
void	removePose (ushort index)
	Destroy a pose by index.
void	removePose (const String &name)
	Destroy a pose by name.
void	removeAllPoses (void)
	Destroy all poses.
PoseIterator	getPoseIterator (void)
	Get an iterator over all the poses defined.
ConstPoseIterator	getPoseIterator (void) const
	Get an iterator over all the poses defined.
const PoseList &	getPoseList (void) const
	Get pose list.
virtual void	prepare ()
	Prepares the resource for load, if it is not already.
virtual void	load (bool backgroundThread=false)
	Loads the resource, if it is not already.
virtual void	reload (void)
	Reloads the resource, if it is already loaded.
virtual bool	isReloadable (void) const
	Returns true if the Resource is reloadable, false otherwise.
virtual bool	isManuallyLoaded (void) const
	Is this resource manually loaded?
virtual void	unload (void)
	Unloads the resource; this is not permanent, the resource can be reloaded later if required.
virtual size_t	getSize (void) const
	Retrieves info about the size of the resource.
virtual void	touch (void)
	'Touches' the resource to indicate it has been used.
virtual const String &	getName (void) const
	Gets resource name.
virtual ResourceHandle	getHandle (void) const
virtual bool	isPrepared (void) const
	Returns true if the Resource has been prepared, false otherwise.
virtual bool	isLoaded (void) const
	Returns true if the Resource has been loaded, false otherwise.
virtual bool	isLoading () const
	Returns whether the resource is currently in the process of background loading.
virtual LoadingState	getLoadingState () const
	Returns the current loading state.
virtual bool	isBackgroundLoaded (void) const
	Returns whether this Resource has been earmarked for background loading.
virtual void	setBackgroundLoaded (bool bl)
	Tells the resource whether it is background loaded or not.
virtual void	escalateLoading ()
	Escalates the loading of a background loaded resource.
virtual void	addListener (Listener *lis)
	Register a listener on this resource.
virtual void	removeListener (Listener *lis)
	Remove a listener on this resource.
virtual const String &	getGroup (void)
	Gets the group which this resource is a member of.
virtual void	changeGroupOwnership (const String &newGroup)
	Change the resource group ownership of a Resource.
virtual ResourceManager *	getCreator (void)
	Gets the manager which created this resource.
virtual const String &	getOrigin (void) const
	Get the origin of this resource, e.g.
virtual void	_notifyOrigin (const String &origin)
	Notify this resource of it's origin.
virtual size_t	getStateCount () const
	Returns the number of times this resource has changed state, which generally means the number of times it has been loaded.
virtual void	_dirtyState ()
	Manually mark the state of this resource as having been changed.
virtual void	_fireBackgroundLoadingComplete (void)
	Firing of background loading complete event.
virtual void	_fireBackgroundPreparingComplete (void)
	Firing of background preparing complete event.
ParamDictionary *	getParamDictionary (void)
	Retrieves the parameter dictionary for this class.
const ParamDictionary *	getParamDictionary (void) const
const ParameterList &	getParameters (void) const
	Retrieves a list of parameters valid for this object.
virtual bool	setParameter (const String &name, const String &value)
	Generic parameter setting method.
virtual void	setParameterList (const NameValuePairList &paramList)
	Generic multiple parameter setting method.
virtual String	getParameter (const String &name) const
	Generic parameter retrieval method.
virtual void	copyParametersTo (StringInterface *dest) const
	Method for copying this object's parameters to another object.
void *	operator new (size_t sz, const char file, int line, const char func)
	operator new, with debug line info
void *	operator new (size_t sz)
void *	operator new (size_t sz, void *ptr)
	placement operator new
void *	operator new[] (size_t sz, const char file, int line, const char func)
	array operator new, with debug line info
void *	operator new[] (size_t sz)
void	operator delete (void *ptr)
void	operator delete (void ptr, const char , int, const char *)
void	operator delete[] (void *ptr)
void	operator delete[] (void ptr, const char , int, const char *)
Static Public Member Functions
static void	prepareMatricesForVertexBlend (const Matrix4 *blendMatrices, const Matrix4 boneMatrices, const IndexMap &indexMap)
	Prepare matrices for software indexed vertex blend.
static void	softwareVertexBlend (const VertexData sourceVertexData, const VertexData targetVertexData, const Matrix4 const blendMatrices, size_t numMatrices, bool blendNormals)
	Performs a software indexed vertex blend, of the kind used for skeletal animation although it can be used for other purposes.
static void	softwareVertexMorph (Real t, const HardwareVertexBufferSharedPtr &b1, const HardwareVertexBufferSharedPtr &b2, VertexData *targetVertexData)
	Performs a software vertex morph, of the kind used for morph animation although it can be used for other purposes.
static void	softwareVertexPoseBlend (Real weight, const std::map< size_t, Vector3 > &vertexOffsetMap, VertexData *targetVertexData)
	Performs a software vertex pose blend, of the kind used for morph animation although it can be used for other purposes.
static void	cleanupDictionary ()
	Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.
Public Attributes
VertexData *	sharedVertexData
	Shared vertex data.
IndexMap	sharedBlendIndexToBoneIndexMap
	Shared index map for translating blend index to bone index.
Protected Types
typedef std::vector < MeshLodUsage >	MeshLodUsageList
typedef std::map < String, Animation * >	AnimationList
	Storage of morph animations, lookup by name.
typedef std::list < Listener * >	ListenerList
Protected Member Functions
void	organiseTangentsBuffer (VertexData *vertexData, VertexElementSemantic targetSemantic, unsigned short index, unsigned short sourceTexCoordSet)
	Internal method for making the space for a vertex element to hold tangents.
void	buildIndexMap (const VertexBoneAssignmentList &boneAssignments, IndexMap &boneIndexToBlendIndexMap, IndexMap &blendIndexToBoneIndexMap)
	Build the index map between bone index and blend index.
void	compileBoneAssignments (const VertexBoneAssignmentList &boneAssignments, unsigned short numBlendWeightsPerVertex, IndexMap &blendIndexToBoneIndexMap, VertexData *targetVertexData)
	Compile bone assignments into blend index and weight buffers.
void	prepareImpl (void)
	Loads the mesh from disk.
void	unprepareImpl (void)
	Destroys data cached by prepareImpl.
void	loadImpl (void)
	Internal implementation of the meat of the 'load' action, only called if this resource is not being loaded from a ManualResourceLoader.
void	postLoadImpl (void)
	Internal hook to perform actions after the load process, but before the resource has been marked as fully loaded. Note: Mutex will have already been acquired by the loading thread. Also, this call will occur even when using a ManualResourceLoader (when loadImpl is not actually called)
void	unloadImpl (void)
	Internal implementation of the 'unload' action; called regardless of whether this resource is being loaded from a ManualResourceLoader.
size_t	calculateSize (void) const
	Calculate the size of a resource; this will only be called after 'load'.
virtual void	preLoadImpl (void)
	Internal hook to perform actions before the load process, but after the resource has been marked as 'loading'.
virtual void	preUnloadImpl (void)
	Internal hook to perform actions before the unload process.
virtual void	postUnloadImpl (void)
	Internal hook to perform actions after the unload process, but before the resource has been marked as fully unloaded.
virtual void	queueFireBackgroundLoadingComplete (void)
	Queue the firing of background loading complete event.
virtual void	queueFireBackgroundPreparingComplete (void)
	Queue the firing of background preparing complete event.
bool	createParamDictionary (const String &className)
	Internal method for creating a parameter dictionary for the class, if it does not already exist.
Protected Attributes
SubMeshList	mSubMeshList
	A list of submeshes which make up this mesh.
DataStreamPtr	mFreshFromDisk
SubMeshNameMap	mSubMeshNameMap
AxisAlignedBox	mAABB
	Local bounding box volume.
Real	mBoundRadius
	Local bounding sphere radius (centered on object).
String	mSkeletonName
	Optional linked skeleton.
SkeletonPtr	mSkeleton
VertexBoneAssignmentList	mBoneAssignments
bool	mBoneAssignmentsOutOfDate
	Flag indicating that bone assignments need to be recompiled.
bool	mIsLodManual
ushort	mNumLods
MeshLodUsageList	mMeshLodUsageList
HardwareBuffer::Usage	mVertexBufferUsage
HardwareBuffer::Usage	mIndexBufferUsage
bool	mVertexBufferShadowBuffer
bool	mIndexBufferShadowBuffer
bool	mPreparedForShadowVolumes
bool	mEdgeListsBuilt
bool	mAutoBuildEdgeLists
AnimationList	mAnimationsList
VertexAnimationType	mSharedVertexDataAnimationType
	The vertex animation type associated with the shared vertex data.
bool	mAnimationTypesDirty
	Do we need to scan animations for animation types?
PoseList	mPoseList
	List of available poses for shared and dedicated geometryPoseList.
ResourceManager *	mCreator
	Creator.
String	mName
	Unique name of the resource.
String	mGroup
	The name of the resource group.
ResourceHandle	mHandle
	Numeric handle for more efficient look up than name.
AtomicScalar < LoadingState >	mLoadingState
	Is the resource currently loaded?
volatile bool	mIsBackgroundLoaded
	Is this resource going to be background loaded? Only applicable for multithreaded.
size_t	mSize
	The size of the resource in bytes.
bool	mIsManual
	Is this file manually loaded?
String	mOrigin
	Origin of this resource (e.g. script name) - optional.
ManualResourceLoader *	mLoader
	Optional manual loader; if provided, data is loaded from here instead of a file.
size_t	mStateCount
	State count, the number of times this resource has changed state.
ListenerList	mListenerList
String	mParamDictName
	Class name for this instance to be used as a lookup (must be initialised by subclasses).
Static Protected Attributes
static ParamDictionaryMap	msDictionary
	Dictionary of parameters.
Friends
class	SubMesh
class	MeshSerializerImpl
class	MeshSerializerImpl_v1_2
class	MeshSerializerImpl_v1_1