NL3D::CSkeletonShape Class Reference

#include <skeleton_shape.h>

Inheritance diagram for NL3D::CSkeletonShape:

---

Detailed Description

a definition of a skeleton. can be instanciated into a CSkeletonModel.

Author:

Lionel Berenguier

Nevrax France

Date:

2001

Definition at line 48 of file skeleton_shape.h.

Public Member Functions
void	build (const std::vector< CBoneBase > &bones)
	CSkeletonShape ()
	Constructor.
sint32	getBoneIdByName (const std::string &name) const
	Return the id of a bone, from it's name. -1 if not present.
virtual std::string	getClassName ()=0
float	getDistMax () const
const CLod &	getLod (uint lod) const
	get lod information.
uint	getLodForDistance (float dist) const
	retrieve the lod to use for a given distance (log(n)).
uint	getNumLods () const
const sint &	getRefCount () const
virtual void	profileSceneRender (CRenderTrav *rdrTrav, CTransformShape *trans, bool opaquePass)
void	retrieve (std::vector< CBoneBase > &bones) const
void	setDistMax (float distMax)
From IShape
virtual bool	clip (const std::vector< CPlane > &pyramid, const CMatrix &worldMatrix)
	clip this skeleton.
virtual CTransformShape *	createInstance (CScene &scene)
	Create a CSkeletonModel, which contains bones.
virtual void	flushTextures (IDriver &driver, uint selectedTexture)
	flush textures used by this shape.
virtual void	getAABBox (NLMISC::CAABBox &bbox) const
virtual float	getNumTriangles (float distance)
	get an approximation of the number of triangles this instance will render for a fixed distance.
	NLMISC_DECLARE_CLASS (CSkeletonShape)
	clip this skeleton.
virtual void	render (IDriver *drv, CTransformShape *trans, bool opaquePass)
	render() this skeletonshape in a driver (no-op)
virtual void	serial (NLMISC::IStream &f) throw (NLMISC::EStream)
	serial this skeletonshape.
Data Fields
sint	crefs
CPtrInfo *	pinfo
Static Public Attributes
CPtrInfo	NullPtrInfo
Protected Attributes
float	_DistMax
	Default to -1.
Private Attributes
NLMISC::CAABBox	_BBox
std::map< std::string, uint32 >	_BoneMap
std::vector< CBoneBase >	_Bones
std::vector< CLod >	_Lods
Friends
struct	CPtrInfo

---

Constructor & Destructor Documentation

NL3D::CSkeletonShape::CSkeletonShape (   )

Constructor. Definition at line 51 of file skeleton_shape.cpp. References NLMISC::CAABBox::setCenter(), and NLMISC::CAABBox::setSize(). { // By default for now.... // Temp. Have a huge BBox, so clip badly. _BBox.setCenter(CVector(0,0,1.5)); _BBox.setSize(CVector(3,3,3)); }

---

Member Function Documentation

void NL3D::CSkeletonShape::build (  const std::vector< CBoneBase > &  bones  )

Build a skeletonShape, replacing old. WARNING: bones must be organized in Depth-first order (this is not checked). Bone.LodDisableDistance are minimized such sons have always a distance <= father distance. Definition at line 72 of file skeleton_shape.cpp. References min, sint32, and uint. { uint i; // copy bones. _Bones= bones; // for all bones for(i=0;i<_Bones.size();i++) { // build the map. _BoneMap[_Bones[i].Name]= i; // validate distances. _Bones[i].LodDisableDistance= max(0.f, _Bones[i].LodDisableDistance); // get fahter dist. sint32 fatherId= _Bones[i].FatherId; // if father exist and is not "always enabled" if(fatherId>=0 && _Bones[fatherId].LodDisableDistance!=0) { float fatherDist= _Bones[fatherId].LodDisableDistance; // I must disable me at least before my father (never after). if(_Bones[i].LodDisableDistance==0) _Bones[i].LodDisableDistance= fatherDist; else _Bones[i].LodDisableDistance= min(_Bones[i].LodDisableDistance, fatherDist); } } // build Lod Information. //============== _Lods.clear(); // build all distances used. set<float> distSet; for(i=0;i<_Bones.size();i++) { float dist= _Bones[i].LodDisableDistance; // if lod enabled for this bone, add a new distance, or do nothing if(dist>0) distSet.insert(dist); } // create a lod for each distance used + 1 (the "dist==0" distance). _Lods.resize(distSet.size() + 1); // create the default lod: all bones activated. _Lods[0].Distance=0; _Lods[0].ActiveBones.resize(_Bones.size(), 0xFF); // For each lods not 0th. set<float>::iterator it= distSet.begin(); for(uint j=1; j<_Lods.size(); j++, it++) { float lodDist= *it; // set the distance of activation _Lods[j].Distance= lodDist; // resize and default to all enabled. _Lods[j].ActiveBones.resize(_Bones.size(), 0xFF); // Search what lod are to be disabled at this distance. for(i=0;i<_Bones.size();i++) { float dist= _Bones[i].LodDisableDistance; // if the dist of the lod is greater (or equal) to the disableDist of the bone, // and if the bone is not "always enabled", disable the bone if(lodDist>=dist && dist!=0 ) _Lods[j].ActiveBones[i]= 0; } } }

bool NL3D::CSkeletonShape::clip (  const std::vector< CPlane > &  pyramid, const CMatrix &  worldMatrix )  [virtual]

clip this skeleton. Reimplemented from NL3D::IShape. Definition at line 216 of file skeleton_shape.cpp. References NLMISC::CBSphere::applyTransform(), NLMISC::CBSphere::Center, NLMISC::CAABBox::getCenter(), NLMISC::CAABBox::getRadius(), NLMISC::CBSphere::Radius, and sint. { // Speed Clip: clip just the sphere. CBSphere localSphere(_BBox.getCenter(), _BBox.getRadius()); CBSphere worldSphere; // transform the sphere in WorldMatrix (with nearly good scale info). localSphere.applyTransform(worldMatrix, worldSphere); // if out of only plane, entirely out. for(sint i=0;i<(sint)pyramid.size();i++) { // We are sure that pyramid has normalized plane normals. // if SpherMax OUT return false. float d= pyramid[i]*worldSphere.Center; if(d>worldSphere.Radius) return false; } return true; }

CTransformShape * NL3D::CSkeletonShape::createInstance (  CScene &  scene  )  [virtual]

Create a CSkeletonModel, which contains bones. Reimplemented from NL3D::IShape. Definition at line 154 of file skeleton_shape.cpp. References NL3D::CSkeletonModel::Bones, NL3D::CScene::createModel(), NL3D::CSkeletonModel::initBoneUsages(), NL3D::CTransform::setLoadBalancingGroup(), NL3D::CTransformShape::Shape, and sint. { // Create a CSkeletonModel, an instance of a mesh. //=============================================== CSkeletonModel *sm= (CSkeletonModel*)scene.createModel(NL3D::SkeletonModelId); sm->Shape= this; // setup bones. //================= sm->Bones.reserve(_Bones.size()); for(sint i=0;i<(sint)_Bones.size();i++) { // Append a new bone. sm->Bones.push_back( CBone(&_Bones[i]) ); // Must set the Animatable father of the bone (the skeleton model!). sm->Bones[i].setFather(sm, CSkeletonModel::OwnerBit); } // Must create and init skeleton bone usage to 0. sm->initBoneUsages(); // For skinning: setup skeleton in Skin LoadBalancing group sm->setLoadBalancingGroup("Skin"); return sm; }

virtual void NL3D::CSkeletonShape::flushTextures (  IDriver &  driver, uint  selectedTexture )  [inline, virtual]

flush textures used by this shape. Implements NL3D::IShape. Definition at line 110 of file skeleton_shape.h. References uint. {};

void NL3D::CSkeletonShape::getAABBox (  NLMISC::CAABBox &  bbox  )  const [virtual]

return the bounding box of the shape. Default is to return Null bbox. Reimplemented from NL3D::IShape. Definition at line 240 of file skeleton_shape.cpp. { bbox= _BBox; }

sint32 NL3D::CSkeletonShape::getBoneIdByName (  const std::string &  name  )  const

Return the id of a bone, from it's name. -1 if not present. Definition at line 61 of file skeleton_shape.cpp. References sint32. Referenced by NL3D::CSkeletonModel::getBoneIdByName(). { std::map<std::string, uint32>::const_iterator it= _BoneMap.find(name); if(it==_BoneMap.end()) return -1; else return it->second; }

virtual std::string NLMISC::IClassable::getClassName (   )  [pure virtual, inherited]

Implemented in NLAIAGENT::CNumericIndex, NLAIC::IPointerGestion, NLAIC::CIdentType, and CAutomataDesc. Referenced by NLMISC::CClassRegistry::checkObject(), and NL3D::GetTextureSize().

float NL3D::IShape::getDistMax (   )  const [inline, inherited]

return the DistMax where the shape is no more displayed. Default is to return -1, meaning DistMax = infinite. Definition at line 112 of file shape.h. {return _DistMax;}

const CLod& NL3D::CSkeletonShape::getLod (  uint  lod  )  const [inline]

get lod information. Definition at line 119 of file skeleton_shape.h. References uint. Referenced by NL3D::CSkeletonModel::traverseAnimDetail(), and NL3D::CSkeletonModel::updateBoneToCompute(). {return _Lods[lod];}

uint NL3D::CSkeletonShape::getLodForDistance (  float  dist  )  const

retrieve the lod to use for a given distance (log(n)). Definition at line 247 of file skeleton_shape.cpp. References uint. Referenced by NL3D::CSkeletonModel::traverseAnimDetail(). { uint start=0; uint end= _Lods.size(); // find lower_bound by dichotomy while(end-1>start) { uint pivot= (end+start)/2; // return the lower_bound, ie return first start with _Lods[pivot].Distance<=dist if(_Lods[pivot].Distance <= dist) start= pivot; else end= pivot; } return start; }

uint NL3D::CSkeletonShape::getNumLods (   )  const [inline]

Definition at line 120 of file skeleton_shape.h. References uint. Referenced by NL3D::CSkeletonModel::traverseAnimDetail(), and NL3D::CSkeletonModel::updateBoneToCompute(). {return _Lods.size();}

float NL3D::CSkeletonShape::getNumTriangles (  float  distance  )  [virtual]

get an approximation of the number of triangles this instance will render for a fixed distance. Implements NL3D::IShape. Definition at line 208 of file skeleton_shape.cpp. { // No polygons return 0; }

const sint& NLMISC::CRefCount::getRefCount (   )  const [inline, inherited]

Definition at line 70 of file smart_ptr.h. References NLMISC::CRefCount::crefs, and sint. { return crefs; }

NL3D::CSkeletonShape::NLMISC_DECLARE_CLASS (  CSkeletonShape   )

clip this skeleton.

virtual void NL3D::IShape::profileSceneRender (  CRenderTrav *  rdrTrav, CTransformShape *  trans, bool  opaquePass )  [inline, virtual, inherited]

Profiling. Called in RenderPass if Current Frame profiled. No-Op by default Informations must be added in rdrTrav->Scene Reimplemented in NL3D::CMesh, NL3D::CMeshMRM, NL3D::CMeshMRMSkinned, and NL3D::CMeshMultiLod. Definition at line 123 of file shape.h. {}

virtual void NL3D::CSkeletonShape::render (  IDriver *  drv, CTransformShape *  trans, bool  opaquePass )  [inline, virtual]

render() this skeletonshape in a driver (no-op) Implements NL3D::IShape. Definition at line 94 of file skeleton_shape.h. { }

void NL3D::CSkeletonShape::retrieve (  std::vector< CBoneBase > &  bones  )  const

Retrieve Bones Information. Definition at line 147 of file skeleton_shape.cpp. { bones= _Bones; }

void NL3D::CSkeletonShape::serial (  NLMISC::IStream &  f  )  throw (NLMISC::EStream) [virtual]

serial this skeletonshape. Implements NLMISC::IStreamable. Definition at line 183 of file skeleton_shape.cpp. References sint. { /* Version 1: - _Lods. */ sint ver= f.serialVersion(1); f.serialCont(_Bones); f.serialCont(_BoneMap); if(ver>=1) f.serialCont(_Lods); else { // create a skeleton shape with bones activated all the time _Lods.resize(1); // create the default lod: all bones activated. _Lods[0].Distance=0; _Lods[0].ActiveBones.resize(_Bones.size(), 0xFF); } }

void NL3D::IShape::setDistMax (  float  distMax  )  [inherited]

setup the DistMax where the shape is no more displayed. Take effect only for the next created instances. setting <0 means -1 and so means DistMax = infinite. Definition at line 66 of file shape.cpp. Referenced by NL3D::CFlareShape::CFlareShape(). { _DistMax= distMax; // normalize infinite setup. if(distMax<0) _DistMax= -1; }

virtual IMeshGeom* NL3D::IShape::supportMeshBlockRendering (  CTransformShape *  trans, float &  polygonCount )  const [inline, virtual, inherited]

return !NULL if this shape can support MeshBlock rendering for a special instance. NB: Mesh Block render cannot occurs if the Mesh is Skinned/MeshMorphed. NB: Mesh Block render can occurs only in Opaque pass NB: Mesh block render can occurs only for CMeshBase meshes. Parameters: trans  the instance to take into account (meshMultiLod may return NULL in blend transition). polygonCount  the number of polygons to render for the meshGeom returned Returns: the meshgeom to render per block if OK, else NULL (default) Reimplemented in NL3D::CMesh, NL3D::CMeshMRM, NL3D::CMeshMRMSkinned, and NL3D::CMeshMultiLod. Definition at line 158 of file shape.h. {return NULL;}

virtual bool NL3D::IShape::useLightingLocalAttenuation (   )  const [inline, virtual, inherited]

tells if the shape wants LocalAttenuation for RealTime lighting. Default is false Reimplemented in NL3D::CMeshBase. Definition at line 142 of file shape.h. {return false;}

---

Friends And Related Function Documentation

friend struct CPtrInfo [friend, inherited]

Definition at line 67 of file smart_ptr.h.

---

Field Documentation

NLMISC::CAABBox NL3D::CSkeletonShape::_BBox [private]

Definition at line 126 of file skeleton_shape.h.

std::map<std::string, uint32> NL3D::CSkeletonShape::_BoneMap [private]

Definition at line 125 of file skeleton_shape.h.

std::vector<CBoneBase> NL3D::CSkeletonShape::_Bones [private]

Definition at line 124 of file skeleton_shape.h.

float NL3D::IShape::_DistMax [protected, inherited]

Default to -1. Definition at line 165 of file shape.h.

std::vector<CLod> NL3D::CSkeletonShape::_Lods [private]

Definition at line 128 of file skeleton_shape.h.

sint NLMISC::CRefCount::crefs [mutable, inherited]

Definition at line 79 of file smart_ptr.h. Referenced by NLMISC::CRefCount::CRefCount(), NLMISC::CRefCount::getRefCount(), and NLMISC::CRefCount::~CRefCount().

CRefCount::CPtrInfo NLMISC::CRefCount::NullPtrInfo [static, inherited]

Referenced by NLMISC::CRefCount::CRefCount().

CPtrInfo* NLMISC::CRefCount::pinfo [mutable, inherited]

Definition at line 80 of file smart_ptr.h. Referenced by NLMISC::CRefCount::CRefCount(), and NLMISC::CRefCount::~CRefCount().

---

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

• skeleton_shape.h
• skeleton_shape.cpp

---