nirt::scene::IAnimatedMeshMD2 Class Reference

Interface for using some special functions of MD2 meshes. More...

#include <nirtcpp/core/engine/IAnimatedMeshMD2.hpp>

Inheritance diagram for nirt::scene::IAnimatedMeshMD2:

Collaboration diagram for nirt::scene::IAnimatedMeshMD2:

Public Member Functions
virtual void	getFrameLoop (EMD2_ANIMATION_TYPE l, s32 &outBegin, s32 &outEnd, s32 &outFPS) const =0
	Get frame loop data for a default MD2 animation type.
virtual bool	getFrameLoop (const c8 *name, s32 &outBegin, s32 &outEnd, s32 &outFPS) const =0
	Get frame loop data for a special MD2 animation type, identified by name.
virtual s32	getAnimationCount () const =0
	Get amount of md2 animations in this file.
virtual const c8 *	getAnimationName (s32 nr) const =0
	Get name of md2 animation.
Public Member Functions inherited from nirt::scene::IAnimatedMesh
virtual u32	getFrameCount () const =0
	Gets the frame count of the animated mesh.
virtual f32	getAnimationSpeed () const =0
	Gets the animation speed of the animated mesh.
virtual void	setAnimationSpeed (f32 fps)=0
	Sets the animation speed of the animated mesh.
virtual IMesh *	getMesh (s32 frame, s32 detailLevel=255, s32 startFrameLoop=-1, s32 endFrameLoop=-1)=0
	Returns the IMesh interface for a frame.
virtual E_ANIMATED_MESH_TYPE	getMeshType () const override
	Returns the type of the animated mesh.
Public Member Functions inherited from nirt::scene::IMesh
virtual u32	getMeshBufferCount () const =0
	Get the amount of mesh buffers.
virtual IMeshBuffer *	getMeshBuffer (u32 nr) const =0
	Get pointer to a mesh buffer.
virtual IMeshBuffer *	getMeshBuffer (const video::SMaterial &material) const =0
	Get pointer to a mesh buffer which fits a material.
virtual const core::aabbox3d< f32 > &	getBoundingBox () const =0
	Get an axis aligned bounding box of the mesh.
virtual void	setBoundingBox (const core::aabbox3df &box)=0
	Set user-defined axis aligned bounding box.
virtual void	setMaterialFlag (video::E_MATERIAL_FLAG flag, bool newvalue)=0
	Sets a flag of all contained materials to a new value.
virtual void	setHardwareMappingHint (E_HARDWARE_MAPPING newMappingHint, E_BUFFER_TYPE buffer=EBT_VERTEX_AND_INDEX)=0
	Set the hardware mapping hint.
virtual void	setDirty (E_BUFFER_TYPE buffer=EBT_VERTEX_AND_INDEX)=0
	Flag the meshbuffer as changed, reloads hardware buffers.
Public Member Functions inherited from nirt::IReferenceCounted
	IReferenceCounted ()
	Constructor.
virtual	~IReferenceCounted ()
	Destructor.
void	grab () const
	Grabs the object. Increments the reference counter by one.
bool	drop () const
	Drops the object. Decrements the reference counter by one.
s32	getReferenceCount () const
	Get the reference count.
const c8 *	getDebugName () const
	Returns the debug name of the object.

Additional Inherited Members
Protected Member Functions inherited from nirt::IReferenceCounted
void	setDebugName (const c8 *newName)
	Sets the debug name of the object.

Detailed Description

Interface for using some special functions of MD2 meshes.

Member Function Documentation

getAnimationName()

virtual const c8 * nirt::scene::IAnimatedMeshMD2::getAnimationName ( s32  nr ) const

pure virtual

Get name of md2 animation.

Parameters

nr	Zero based index of animation.

getFrameLoop() [1/2]

virtual bool nirt::scene::IAnimatedMeshMD2::getFrameLoop ( const c8 *  name, s32 &  outBegin, s32 &  outEnd, s32 &  outFPS  ) const

pure virtual

Get frame loop data for a special MD2 animation type, identified by name.

Parameters

name	Name of the animation.
outBegin	The returned beginning frame for animation type specified.
outEnd	The returned ending frame for the animation type specified.
outFPS	The number of frames per second, this animation should be played at.

Returns

beginframe, endframe and frames per second for a special MD2 animation type.

getFrameLoop() [2/2]

virtual void nirt::scene::IAnimatedMeshMD2::getFrameLoop ( EMD2_ANIMATION_TYPE  l, s32 &  outBegin, s32 &  outEnd, s32 &  outFPS  ) const

pure virtual

Get frame loop data for a default MD2 animation type.

Parameters

l	The EMD2_ANIMATION_TYPE to get the frames for.
outBegin	The returned beginning frame for animation type specified.
outEnd	The returned ending frame for the animation type specified.
outFPS	The number of frames per second, this animation should be played at.

Returns

beginframe, endframe and frames per second for a default MD2 animation type.

---

The documentation for this class was generated from the following file:

• include/nirtcpp/core/engine/IAnimatedMeshMD2.hpp