NL3D::CLodCharacterBuilder Class Reference

#include <lod_character_builder.h>

---

Detailed Description

A tool class used to build a CLodCharacterShape Use it by first calling setShape(), then add animations to it, and finally get result with getLodShape

Author:

Lionel Berenguier

Nevrax France

Date:

2002

Definition at line 49 of file lod_character_builder.h.

Public Member Functions
void	addAnim (const char *animName, CAnimation *animation, float frameRate)
	CLodCharacterBuilder ()
	Constructor.
const CLodCharacterShape &	getLodShape () const
	return the lod shape in its current state.
void	setShape (const std::string &name, CSkeletonShape *skeletonShape, CLodCharacterShapeBuild *lodBuild)
	~CLodCharacterBuilder ()
Private Member Functions
void	applySkin (CSkeletonModel *skeleton, CVector *dstVertices)
Private Attributes
std::vector< uint >	_BoneRemap
CLodCharacterShapeBuild *	_LodBuild
CLodCharacterShape	_LodCharacterShape
NLMISC::CSmartPtr< CSkeletonShape >	_SkeletonShape
CScene *	_TmpScene

---

Constructor & Destructor Documentation

NL3D::CLodCharacterBuilder::CLodCharacterBuilder (   )

Constructor. Definition at line 45 of file lod_character_builder.cpp. References _LodBuild, _SkeletonShape, and _TmpScene. { _SkeletonShape= NULL; _LodBuild= NULL; _TmpScene= NULL; }

NL3D::CLodCharacterBuilder::~CLodCharacterBuilder (   )

Definition at line 52 of file lod_character_builder.cpp. References _TmpScene, and NL3D::CScene::release(). { // release the scene if(_TmpScene) { _TmpScene->release(); delete _TmpScene; _TmpScene= NULL; } }

---

Member Function Documentation

void NL3D::CLodCharacterBuilder::addAnim (  const char *  animName, CAnimation *  animation, float  frameRate )

add an animation to the process Parameters: animName  is the name of the animation, used as a key to receover animations in the CLodCharacterShape built animation  is the animation to bake/over sample. NB: the animation is deleted at the end of addAnim frameRate  is the desired overSampling rate. eg: 20 frame per second. Definition at line 111 of file lod_character_builder.cpp. References _LodCharacterShape, _SkeletonShape, _TmpScene, NL3D::CLodCharacterShape::addAnim(), NL3D::CAnimationSet::addAnimation(), NL3D::CLodCharacterShape::CAnimBuild::AnimLength, applySkin(), NL3D::CAnimationSet::build(), NL3D::CSkeletonModel::computeAllBones(), NL3D::CScene::deleteModel(), NL3D::CChannelMixer::eval(), NL3D::CAnimationSet::getAnimationIdByName(), NL3D::CAnimation::getEndTime(), NL3D::CLodCharacterShape::getNumVertices(), NL3D::CLodCharacterShape::CAnimBuild::Keys, min, NL3D::CLodCharacterShape::CAnimBuild::Name, nlassert, NL3D::CLodCharacterShape::CAnimBuild::NumKeys, NL3D::CSkeletonModel::registerToChannelMixer(), NL3D::CChannelMixer::setAnimationSet(), NL3D::CChannelMixer::setSlotAnimation(), NL3D::CChannelMixer::setSlotTime(), uint, and uint64. { nlassert(frameRate>0); nlassert(animation); /* Create a Scene, a skeletonModel, an animation set, and a channel mixer to play the animation NB: no render is made and no driver is created. The scene is just here for correct creation of the skeleton Yoyo: This is a tricky way, but I found it the easier one... */ // Create Components necesssary to play the animation //========================== // create an animationSet, and a channelMixer. //-------------- // build an animation set with the only one animation. This animation will be deleted with the animationSet CAnimationSet *tmpAnimationSet= new CAnimationSet; tmpAnimationSet->addAnimation(animName, animation); tmpAnimationSet->build(); // Build a channelMixer. CChannelMixer *tmpChannelMixer= new CChannelMixer; tmpChannelMixer->setAnimationSet(tmpAnimationSet); // create a skeleton Model for animation //--------------- CSkeletonModel *skeleton= (CSkeletonModel*)_SkeletonShape->createInstance(*_TmpScene); // and skeleton it with animation skeleton->registerToChannelMixer(tmpChannelMixer, ""); // activate the anim uint animID = tmpAnimationSet->getAnimationIdByName(animName); nlassert(animID != CAnimationSet::NotFound); tmpChannelMixer->setSlotAnimation(0, animID); // Build Dst Animation basics. //-------------- CLodCharacterShape::CAnimBuild dstAnim; dstAnim.Name= animName; dstAnim.AnimLength= animation->getEndTime(); dstAnim.NumKeys= (uint)ceil(dstAnim.AnimLength * frameRate); dstAnim.NumKeys= max(1U, dstAnim.NumKeys); // resize array. dstAnim.Keys.resize(_LodCharacterShape.getNumVertices() * dstAnim.NumKeys); // Bake the animation //========================== double time=0; double dt= 1.0/(double)frameRate; uint64 evalDetaiDate= 0; for(uint i=0; i<dstAnim.NumKeys; i++, time+= dt) { // clamp the time time= min(time, (double)dstAnim.AnimLength); // setup the channelMixer time tmpChannelMixer->setSlotTime(0, (float)time); // Eval the channelMixer, both global and detail tmpChannelMixer->eval(false); tmpChannelMixer->eval(true, evalDetaiDate++); // Use the skeleton model to compute bone skin matrix, supposing an identity skeleton worldMatrix skeleton->computeAllBones(CMatrix::Identity); // apply the skinning from the current skeleton state applySkin(skeleton, &dstAnim.Keys[i*_LodCharacterShape.getNumVertices()]); } // Add the animation to the lod //========================== _LodCharacterShape.addAnim(dstAnim); // Delete //========================== // release the skeleton _TmpScene->deleteModel(skeleton); // delete the channelMixer delete tmpChannelMixer; // delete the animationSet delete tmpAnimationSet; }

void NL3D::CLodCharacterBuilder::applySkin (  CSkeletonModel *  skeleton, CVector *  dstVertices )  [private]

Definition at line 199 of file lod_character_builder.cpp. References _BoneRemap, _LodBuild, NL3D::CSkeletonModel::Bones, NL3D::CMesh::CSkinWeight::MatrixId, NL3D_MESH_SKINNING_MAX_MATRIX, NL3D::CLodCharacterShapeBuild::SkinWeights, uint, NL3D::CLodCharacterShapeBuild::Vertices, and NL3D::CMesh::CSkinWeight::Weights. Referenced by addAnim(). { uint numVerts= _LodBuild->Vertices.size(); // for all vertices. for(uint i=0; i<numVerts; i++) { CMesh::CSkinWeight &skinWgt= _LodBuild->SkinWeights[i]; CVector &srcVert= _LodBuild->Vertices[i]; CVector &dstVert= dstVertices[i]; dstVert= CVector::Null; // parse all Weights, and add influence. for(uint j=0; j<NL3D_MESH_SKINNING_MAX_MATRIX; j++) { float wgt= skinWgt.Weights[j]; if(wgt==0) { // this should not happen, at least weight 0 should have an influence. if(j==0) dstVert= srcVert; // no more influence for this vertex. break; } else { // Get the skeleton bone to read. uint boneId= _BoneRemap[skinWgt.MatrixId[j]]; // Get the computed matrix from the skeleton. const CMatrix &boneMat= skeleton->Bones[boneId].getBoneSkinMatrix(); // Add the influence of this bone. dstVert+= (boneMat * srcVert) * wgt; } } } }

const CLodCharacterShape& NL3D::CLodCharacterBuilder::getLodShape (   )  const [inline]

return the lod shape in its current state. Definition at line 75 of file lod_character_builder.h. References _LodCharacterShape. {return _LodCharacterShape;}

void NL3D::CLodCharacterBuilder::setShape (  const std::string &  name, CSkeletonShape *  skeletonShape, CLodCharacterShapeBuild *  lodBuild )

init process with the Mesh and the SkeletonShape to use. NB: nlWarnings may occurs if don't find bones used by lodBuild, in the skeletonShape. In this case, root bone 0 of the skeleton shape is used. Parameters: name  is the name to give to the shape skeletonShape  the skeleton used for animation. Ptr is handled by the builder as a smartPtr. lodBuild  the mesh information. Ptr is hold by the builder, but not deleted Definition at line 64 of file lod_character_builder.cpp. References _BoneRemap, _LodBuild, _LodCharacterShape, _SkeletonShape, _TmpScene, NL3D::CLodCharacterShape::buildMesh(), NL3D::CScene::initDefaultRoots(), NL3D::CScene::initQuadGridClipManager(), nlassert, nlwarning, sint32, and uint. { nlassert(skeletonShape); nlassert(lodBuild); // SmartPtr the skeleton Shape (NB: important because skeletonModel use it) _SkeletonShape= skeletonShape; // a std ptr. _LodBuild= lodBuild; // Remap bone, with help of lodBuild and skeleton names. _BoneRemap.resize(lodBuild->BonesNames.size()); for(uint i=0; i<_BoneRemap.size(); i++) { const std::string &boneName= lodBuild->BonesNames[i]; sint32 boneId= _SkeletonShape->getBoneIdByName(boneName); // If not found if(boneId<0) { nlwarning("Not found a bone in the skeleton Shape: %s", boneName.c_str()); // use root bone. _BoneRemap[i]= 0; } else // remap _BoneRemap[i]= boneId; } // build basics _LodCharacterShape.buildMesh(name, *_LodBuild); // Build a scene, for addAnim purpose if(!_TmpScene) { _TmpScene= new CScene(false); // Must init Statics for scene (because use it in addAnim). NB: never mind if done twice. CScene::registerBasics(); // init default Roots. _TmpScene->initDefaultRoots(); // Don't Set driver/viewport // init QuadGridClipManager _TmpScene->initQuadGridClipManager (); } }

---

Field Documentation

std::vector<uint> NL3D::CLodCharacterBuilder::_BoneRemap [private]

Definition at line 84 of file lod_character_builder.h. Referenced by applySkin(), and setShape().

CLodCharacterShapeBuild* NL3D::CLodCharacterBuilder::_LodBuild [private]

Definition at line 83 of file lod_character_builder.h. Referenced by applySkin(), CLodCharacterBuilder(), and setShape().

CLodCharacterShape NL3D::CLodCharacterBuilder::_LodCharacterShape [private]

Definition at line 80 of file lod_character_builder.h. Referenced by addAnim(), getLodShape(), and setShape().

NLMISC::CSmartPtr<CSkeletonShape> NL3D::CLodCharacterBuilder::_SkeletonShape [private]

Definition at line 82 of file lod_character_builder.h. Referenced by addAnim(), CLodCharacterBuilder(), and setShape().

CScene* NL3D::CLodCharacterBuilder::_TmpScene [private]

Definition at line 87 of file lod_character_builder.h. Referenced by addAnim(), CLodCharacterBuilder(), setShape(), and ~CLodCharacterBuilder().

---

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

• lod_character_builder.h
• lod_character_builder.cpp

---