NL3D::CInstanceGroup Class Reference

#include <scene_group.h>

---

Detailed Description

A CInstanceGroup is a group of mesh instance and so composed by

• A reference to a mesh (refered by the name)
• The transformations to get it to the world
• The parent

This class can initialize a scene and be serialized.

Author:

Matthieu Besson

Nevrax France

Date:

2001

Definition at line 70 of file scene_group.h.

PointLight part
void	buildPointLightList (const std::vector< CPointLightNamed > &pointLightList, std::vector< uint > &plRemap)
	Build the list of light. NB: sort by LightGroupName the array, and return index remap.
CIGSurfaceLight	_IGSurfaceLight
	The object used to light dynamic models in town and buildings.
CPointLightNamedArray	_PointLightArray
	Array of pointLights.
bool	_RealTimeSunContribution
	RealTimeSunContribution. Used for ig_lighter and zone_ig_lighter.
Public Types
enum	{ NumStaticLightPerInstance = 2 }
	Should Never be changed. More...
typedef std::vector< CInstance >	TInstanceArray
	A vector of instance.
enum	TState { StateNotAdded = 0, StateAdding, StateAdded, StateError }
Public Member Functions
void	addCluster (CCluster *pCluster)
	To construct the cluster system by hand.
bool	addToScene (CScene &scene, IDriver *driver=NULL, uint selectedTexture=0)
bool	addToSceneAsync (CScene &scene, IDriver *driver=NULL, uint selectedTexture=0)
void	build (const CVector &vGlobalPos, const TInstanceArray &array, const std::vector< CCluster > &Clusters, const std::vector< CPortal > &Portals, const std::vector< CPointLightNamed > &pointLightList, const CIGSurfaceLight::TRetrieverGridMap *retrieverGridMap=NULL, float igSurfaceLightCellSize=0)
void	build (const CVector &vGlobalPos, const TInstanceArray &array, const std::vector< CCluster > &Clusters, const std::vector< CPortal > &Portals)
	CInstanceGroup ()
void	createRoot (CScene &scene)
	Add all the instances to the scene.
void	displayDebugClusters (IDriver *drv, class CTextContext *txtCtx)
void	freezeHRC ()
	see CTransform::freezeHRC(). Do it for all instances (not clusters), and for the root of the IG.
TState	getAddToSceneState ()
void	getBlendShapes (std::set< std::string > &BlendShapeNames)
	Get all the blendshapes from an instance group.
bool	getDynamicPortal (std::string &name)
	Get the state of a dynamic portal (true=opened, false=closed).
void	getDynamicPortals (std::vector< std::string > &names)
	Get all dynamic portals of an instance group.
const NLMISC::CVector &	getGlobalPos () const
CInstance &	getInstance (uint instanceNb)
const CInstance &	getInstance (uint instanceNb) const
void	getInstanceMatrix (uint instanceNb, NLMISC::CMatrix &dest) const
const std::string &	getInstanceName (uint instanceNb) const
	Get the instance name.
const sint32	getInstanceParent (uint instanceNb) const
const NLMISC::CVector &	getInstancePos (uint instanceNb) const
	Get an instance position.
const NLMISC::CQuat &	getInstanceRot (uint instanceNb) const
	Get an instance rotation.
const NLMISC::CVector &	getInstanceScale (uint instanceNb) const
void	getLights (std::set< std::string > &LightNames)
	Get all lights (lightmaps) from an instance group.
uint	getNumInstance () const
	Get number of instance in this group.
CInstanceGroup *	getParentClusterSystem () const
CVector	getPos ()
	Get the position of the IG.
CQuat	getRotQuat ()
	Get the rotation of the IG.
void	getShapeName (uint instanceIndex, std::string &shapeName) const
const std::string &	getShapeName (uint instanceNb) const
	Get the name of the mesh referenced.
CTransformShape *	getTransformShape (uint instanceNb) const
UInstanceGroup *	getUserInterface () const
void	linkRoot (CScene &scene, CTransform *father)
	link the root of the ig to a node. No-op if not added to scene. Pass NULL to reset by default
bool	linkToParent (CInstanceGroup *pFather)
bool	removeFromScene (CScene &scene)
	Remove all the instances from the scene.
void	retrieve (CVector &vGlobalPos, TInstanceArray &array, std::vector< CCluster > &Clusters, std::vector< CPortal > &Portals, std::vector< CPointLightNamed > &pointLightList) const
void	serial (NLMISC::IStream &f)
	Serial the group.
void	setAddRemoveInstanceCallback (IAddRemoveInstance *callback)
	Set a callback to know when an instance has been added / removed.
void	setBlendShapeFactor (const std::string &BlendShapeName, float rFactor)
	Set the blendshape factor for the whole instance group (-100 -> 100).
void	setClusterSystemForInstances (CInstanceGroup *pIG)
	Set the cluster system to test for instances that are not in a cluster of this IG.
void	setDynamicPortal (std::string &name, bool opened)
	Set the state of a dynamic portal (true=opened, false=closed).
void	setIGAddBeginCallback (IIGAddBegin *callback)
	Set a callback to know when an instance group is being created, and how many instances it contains.
void	setPos (const CVector &pos)
	Set the position of the IG.
void	setRotQuat (const CQuat &quat)
	Set the rotation of the IG.
void	setTransformNameCallback (ITransformName *pTN)
	Setup the callback in charge of changing name at the addToScene moment.
void	setUserInterface (class UInstanceGroup *uig)
	User Interface related: yes it is ugly....
void	stopAddToSceneAsync ()
void	unfreezeHRC ()
	see CTransform::unfreezeHRC(). Do it for all instances (not clusters), and for the root of the IG.
	~CInstanceGroup ()
RealTime lighting part
void	enableRealTimeSunContribution (bool enable)
	Setuped at export, tells if the ig is touched by the sun. true by default.
const CIGSurfaceLight &	getIGSurfaceLight () const
	Get the SurfaceLight info, for debug purposes.
uint	getNumPointLights () const
	Get the number of point lights.
const std::vector< CPointLightNamed > &	getPointLightList () const
	get the list of light. NB: the array is sorted by LightGroupName.
CPointLightNamed &	getPointLightNamed (uint index)
	Get a mutable ref on a point light named.
bool	getRealTimeSunContribution () const
	Setuped at export, tells if the ig is touched by the sun. true by default.
bool	getStaticLightSetup (uint retrieverIdentifier, sint surfaceId, const CVector &localPos, std::vector< CPointLightInfluence > &pointLightList, uint8 &sunContribution, NLMISC::CRGBA &localAmbient)
	See CIGSurfaceLight::getStaticLightSetup().
void	setPointLightFactor (const CScene &scene)
	set the Light factor for all pointLights "lightGroupName".
Data Fields
CClipTrav *	_ClipTrav
std::vector< CCluster >	_ClusterInfos
std::vector< CCluster * >	_ClusterInstances
CInstanceGroup *	_ClusterSystemForInstances
NLMISC::CVector	_GlobalPos
std::vector< CTransformShape * >	_Instances
TInstanceArray	_InstancesInfos
CInstanceGroup *	_ParentClusterSystem
std::vector< CPortal >	_Portals
CTransform *	_Root
Private Member Functions
bool	addToSceneWhenAllShapesLoaded (CScene &scene, IDriver *driver, uint selectedTexture)
Private Attributes
IAddRemoveInstance *	_AddRemoveInstance
IIGAddBegin *	_IGAddBeginCallback
ITransformName *	_TransformName
UInstanceGroup *	_UserIg
Async loading part
bool	_AddToSceneSignal
TState	_AddToSceneState
IDriver *	_AddToSceneTempDriver
CScene *	_AddToSceneTempScene
uint	_AddToSceneTempSelectTexture

---

Member Typedef Documentation

typedef std::vector<CInstance> NL3D::CInstanceGroup::TInstanceArray

A vector of instance. Definition at line 140 of file scene_group.h. Referenced by build(), and retrieve().

---

Member Enumeration Documentation

anonymous enum

Should Never be changed. Enumeration values: NumStaticLightPerInstance  Definition at line 75 of file scene_group.h. {NumStaticLightPerInstance= 2};

enum NL3D::CInstanceGroup::TState

Enumeration values: StateNotAdded  StateAdding  StateAdded  StateError  Definition at line 76 of file scene_group.h. { StateNotAdded = 0, StateAdding, StateAdded, StateError };

---

Constructor & Destructor Documentation

NL3D::CInstanceGroup::CInstanceGroup (   )

Construct, serialize and link to scene Definition at line 245 of file scene_group.cpp. References _AddRemoveInstance, _ClusterSystemForInstances, _GlobalPos, _IGAddBeginCallback, _IGSurfaceLight, _ParentClusterSystem, _RealTimeSunContribution, _TransformName, _UserIg, NL3D::CIGSurfaceLight::setOwner(), and StateNotAdded. { _IGSurfaceLight.setOwner(this); _GlobalPos = CVector(0,0,0); _Root = NULL; _ClusterSystemForInstances = NULL; _ParentClusterSystem = NULL; _RealTimeSunContribution= true; _AddToSceneState = StateNotAdded; _TransformName = NULL; _AddRemoveInstance = NULL; _IGAddBeginCallback = NULL; _UserIg= NULL; }

NL3D::CInstanceGroup::~CInstanceGroup (   )

Definition at line 261 of file scene_group.cpp. { }

---

Member Function Documentation

void NL3D::CInstanceGroup::addCluster (  CCluster *  pCluster  )

To construct the cluster system by hand. Cluster/Portal system part Definition at line 1050 of file scene_group.cpp. References _ClusterInstances. Referenced by NL3D::CScene::initDefaultRoots(). { _ClusterInstances.push_back(pCluster); }

bool NL3D::CInstanceGroup::addToScene (  CScene &  scene, IDriver *  driver = NULL, uint  selectedTexture = 0 )

Add all the instances to the scene. By default, freezeHRC() those instances and the root. Parameters: scene  is the scene in which you want to add the instance group. driver  is a pointer to a driver. If this pointer is not NULL, the textures used by the shapes will be preloaded in this driver. If the pointer is NULL (default), textures will ve loaded when the shape will be used. Definition at line 503 of file scene_group.cpp. References _IGAddBeginCallback, _InstancesInfos, _PointLightArray, addToSceneWhenAllShapesLoaded(), NL3D::CScene::createInstance(), getName(), getShapeName(), NL3D::CPointLightNamedArray::initAnimatedLightIndex(), nlwarning, NL3D::IIGAddBegin::startAddingIG(), uint, and uint32. Referenced by NL3D::CInstanceGroupUser::addToScene(), and getAddToSceneState(). { // Init the scene lights _PointLightArray.initAnimatedLightIndex (scene); uint32 i, j; // Test if portals are linked to their 2 clusters for (i = 0; i < _Portals.size(); ++i) for (j = 0; j < 2; ++j) { if (_Portals[i]._Clusters[j] == NULL) { nlwarning("Portal %d (name:%s) is not linked to 2 clusters. Instance Group Not Added To Scene.", i, _Portals[i].getName().c_str()); } } _Instances.resize (_InstancesInfos.size(), NULL); if (_IGAddBeginCallback) _IGAddBeginCallback->startAddingIG(_InstancesInfos.size()); // Creation and positionning of the new instance vector<CInstance>::iterator it = _InstancesInfos.begin(); for (i = 0; i < _InstancesInfos.size(); ++i, ++it) { // Get the shape name string shapeName; getShapeName (i, shapeName); if (!shapeName.empty ()) { if (!_InstancesInfos[i].DontAddToScene) { _Instances[i] = scene.createInstance (shapeName); if( _Instances[i] == NULL ) { nlwarning("Not found '%s' file\n", shapeName.c_str()); } } } } return addToSceneWhenAllShapesLoaded (scene, driver, selectedTexture); }

bool NL3D::CInstanceGroup::addToSceneAsync (  CScene &  scene, IDriver *  driver = NULL, uint  selectedTexture = 0 )

Definition at line 766 of file scene_group.cpp. References _AddToSceneSignal, _AddToSceneTempSelectTexture, _IGAddBeginCallback, _InstancesInfos, _PointLightArray, _TransformName, NL3D::CInstanceGroup::CInstance::DontAddToScene, NL3D::CPointLightNamedArray::initAnimatedLightIndex(), NL3D::CInstanceGroup::CInstance::InstanceName, NL3D::CInstanceGroup::CInstance::Name, NL3D::CInstanceGroup::CInstance::Pos, NL3D::IIGAddBegin::startAddingIG(), StateAdding, NLMISC::strlwr(), NL3D::ITransformName::transformName(), uint, and uint32. Referenced by NL3D::CInstanceGroupUser::addToSceneAsync(). { // Init the scene lights _PointLightArray.initAnimatedLightIndex (scene); uint32 i; _AddToSceneState = StateAdding; _AddToSceneTempScene = &scene; _AddToSceneTempDriver = driver; _AddToSceneTempSelectTexture = selectedTexture; _Instances.resize (_InstancesInfos.size(), NULL); if (_IGAddBeginCallback) _IGAddBeginCallback->startAddingIG(_InstancesInfos.size()); // Creation and positionning of the new instance vector<CInstance>::iterator it = _InstancesInfos.begin(); set<string> allShapesToLoad; _AddToSceneSignal = false; bool loadAsyncStarted = false; for (i = 0; i < _InstancesInfos.size(); ++i, ++it) { CInstance &rInstanceInfo = *it; if (!rInstanceInfo.DontAddToScene) { string shapeName = rInstanceInfo.Name; if (_TransformName != NULL && !rInstanceInfo.InstanceName.empty()) { shapeName = _TransformName->transformName (i, rInstanceInfo.InstanceName, rInstanceInfo.Name); } shapeName = strlwr (shapeName); if (!shapeName.empty() && shapeName.find('.') == std::string::npos) shapeName += ".shape"; if (allShapesToLoad.find(shapeName) == allShapesToLoad.end()) { allShapesToLoad.insert (shapeName); if (scene.getShapeBank()->isPresent(shapeName) != CShapeBank::Present) { // Load it from file asynchronously scene.getShapeBank()->loadAsync (shapeName, scene.getDriver(), rInstanceInfo.Pos, &_AddToSceneSignal, selectedTexture); loadAsyncStarted = true; } } } } if (!loadAsyncStarted) _AddToSceneSignal = true; else _AddToSceneSignal = false; //CAsyncFileManager::getInstance().signal (&_AddToSceneSignal); return true; }

bool NL3D::CInstanceGroup::addToSceneWhenAllShapesLoaded (  CScene &  scene, IDriver *  driver, uint  selectedTexture )  [private]

Definition at line 571 of file scene_group.cpp. References _AddRemoveInstance, _ClipTrav, _ClusterInfos, _ClusterInstances, _ClusterSystemForInstances, _InstancesInfos, _PointLightArray, NL3D::CClipTrav::Accel, NL3D::CScene::addInstanceGroupForLightAnimation(), NL3D::ClusterId, NL3D::CScene::createModel(), createRoot(), NL3D::CInstanceGroup::CInstance::DontAddToScene, NL3D::CQuadGrid< CCluster * >::erase(), NL3D::CTransform::freeze(), freezeHRC(), NL3D::CScene::getClipTrav(), NL3D::CScene::getGlobalInstanceGroup(), NL3D::CScene::getHrcTrav(), NL3D::ITransformable::getMatrix(), NL3D::CPointLightNamedArray::getPointLights(), NL3D::CScene::getRoot(), NL3D::CTransform::hrcLinkSon(), NL3D::IAddRemoveInstance::instanceGroupAdded(), NL3D::CInstanceGroup::CInstance::Light, linkToParent(), NL3D::CInstanceGroup::CInstance::LocalAmbientId, min, NL3D_MAX_LIGHT_CONTRIBUTION, NL3D::CInstanceGroup::CInstance::nParent, NL3D::CInstanceGroup::CInstance::Pos, NL3D::CClipTrav::registerCluster(), NL3D::CInstanceGroup::CInstance::Rot, NL3D::CInstanceGroup::CInstance::Scale, NL3D::CPortal::setWorldMatrix(), sint32, StateAdded, NL3D::CInstanceGroup::CInstance::StaticLightEnabled, NL3D::CInstanceGroup::CInstance::SunContribution, uint, and uint32. Referenced by addToScene(). { uint32 i, j; vector<CInstance>::iterator it = _InstancesInfos.begin(); for (i = 0; i < _InstancesInfos.size(); ++i, ++it) { CInstance &rInstanceInfo = *it; if (!rInstanceInfo.DontAddToScene) { if (_Instances[i]) { _Instances[i]->setPos (rInstanceInfo.Pos); _Instances[i]->setRotQuat (rInstanceInfo.Rot); _Instances[i]->setScale (rInstanceInfo.Scale); _Instances[i]->setPivot (CVector::Null); // Static Light Setup if( rInstanceInfo.StaticLightEnabled ) { // Count lights. uint numPointLights; for(numPointLights= 0; numPointLights<CInstanceGroup::NumStaticLightPerInstance; numPointLights++) { if(rInstanceInfo.Light[numPointLights]==0xFF) break; } // Max allowed. numPointLights= min(numPointLights, (uint)NL3D_MAX_LIGHT_CONTRIBUTION); // Get pl ptrs. CPointLight *pls[CInstanceGroup::NumStaticLightPerInstance]; for(uint j=0; j<numPointLights;j++) { uint plId= rInstanceInfo.Light[j]; pls[j]= (CPointLight*)(&_PointLightArray.getPointLights()[plId]); } // get frozenAmbientlight. CPointLight *frozenAmbientlight; if(rInstanceInfo.LocalAmbientId == 0xFF) // must take the sun one. frozenAmbientlight= NULL; else // ok, take the local ambient one. frozenAmbientlight= (CPointLight*)(&_PointLightArray.getPointLights()[rInstanceInfo.LocalAmbientId]); // Setup the instance. _Instances[i]->freezeStaticLightSetup(pls, numPointLights, rInstanceInfo.SunContribution, frozenAmbientlight); } // Driver not NULL ? if (driver) { // Flush shape's texture with this driver _Instances[i]->Shape->flushTextures (*driver, selectedTexture); } } } else { _Instances[i] = NULL; } } // Setup the hierarchy // We just have to set the traversal HRC (Hierarchy) CHrcTrav &hrcTrav = scene.getHrcTrav(); if (_Root == NULL) { createRoot (scene); } it = _InstancesInfos.begin(); for (i = 0; i < _InstancesInfos.size(); ++i, ++it) if (!_InstancesInfos[i].DontAddToScene && _Instances[i] != NULL) { CInstance &rInstanceInfo = *it; if( rInstanceInfo.nParent != -1 ) // Is the instance get a parent _Instances[rInstanceInfo.nParent]->hrcLinkSon( _Instances[i] ); else _Root->hrcLinkSon( _Instances[i] ); } // Attach the root of the instance group to the root of the hierarchy traversal scene.getRoot()->hrcLinkSon( _Root ); // Cluster / Portals // ----------------- CClipTrav *pClipTrav = &scene.getClipTrav(); _ClipTrav = pClipTrav; // Create the MOT links (create the physical clusters) _ClusterInstances.resize (_ClusterInfos.size()); for (i = 0; i < _ClusterInstances.size(); ++i) { _ClusterInstances[i] = (CCluster*)scene.createModel (ClusterId); _ClusterInstances[i]->Group = this; _ClusterInstances[i]->_Portals = _ClusterInfos[i]._Portals; _ClusterInstances[i]->_LocalVolume = _ClusterInfos[i]._LocalVolume; _ClusterInstances[i]->_LocalBBox = _ClusterInfos[i]._LocalBBox; _ClusterInstances[i]->_Volume = _ClusterInfos[i]._Volume; _ClusterInstances[i]->_BBox = _ClusterInfos[i]._BBox; _ClusterInstances[i]->FatherVisible = _ClusterInfos[i].FatherVisible; _ClusterInstances[i]->VisibleFromFather = _ClusterInfos[i].VisibleFromFather; _ClusterInstances[i]->FatherAudible = _ClusterInfos[i].FatherAudible; _ClusterInstances[i]->AudibleFromFather = _ClusterInfos[i].AudibleFromFather; _ClusterInstances[i]->Name = _ClusterInfos[i].Name; _ClusterInstances[i]->setSoundGroup(_ClusterInfos[i].getSoundGroup()); _ClusterInstances[i]->setEnvironmentFx(_ClusterInfos[i].getEnvironmentFx()); pClipTrav->registerCluster (_ClusterInstances[i]); _ClusterInstances[i]->clipUnlinkFromAll(); } // Relink portals with newly created clusters for (i = 0; i < _Portals.size(); ++i) for (j = 0; j < 2; ++j) { if (_Portals[i]._Clusters[j]) { sint32 nClusterNb; nClusterNb = (_Portals[i]._Clusters[j] - &_ClusterInfos[0]); _Portals[i]._Clusters[j] = _ClusterInstances[nClusterNb]; } } // Link shapes to clusters for (i = 0; i < _Instances.size(); ++i) if (_Instances[i] != NULL && !_InstancesInfos[i].DontAddToScene) { if (_InstancesInfos[i].Clusters.size() > 0) { _Instances[i]->clipUnlinkFromAll(); for (j = 0; j < _InstancesInfos[i].Clusters.size(); ++j) _ClusterInstances[_InstancesInfos[i].Clusters[j]]->clipAddChild( _Instances[i] ); // For the first time we have to set all the instances to NOT move (and not be rebinded) _Instances[i]->freeze(); _Instances[i]->setClusterSystem (this); } else { // These instances are not attached to a cluster at this level so we cannot freeze them // Moreover we must set their clustersystem they will be tested against _Instances[i]->setClusterSystem (_ClusterSystemForInstances); } } _Root->freeze(); // HRC OBS like for (i = 0; i < _ClusterInstances.size(); ++i) { _ClusterInstances[i]->setWorldMatrix (_Root->getMatrix()); for (j = 0; j < _ClusterInstances[i]->getNbPortals(); ++j) { CPortal *pPortal = _ClusterInstances[i]->getPortal(j); pPortal->setWorldMatrix (_Root->getMatrix()); } // Re affect the cluster to the accelerator if not the root if (!_ClusterInstances[i]->isRoot()) { _ClipTrav->Accel.erase (_ClusterInstances[i]->AccelIt); _ClipTrav->registerCluster (_ClusterInstances[i]); } } // Link the instance group to the parent linkToParent (scene.getGlobalInstanceGroup()); // Attach the clusters to the root of the instance group for (i = 0; i < _ClusterInstances.size(); ++i) _Root->hrcLinkSon( _ClusterInstances[i] ); // Default: freezeHRC all instances. freezeHRC(); // Register the instanceGroup for light animation // ----------------- // If some PointLight to animate if(_PointLightArray.getPointLights().size() > 0) scene.addInstanceGroupForLightAnimation(this); _AddToSceneState = StateAdded; if (_AddRemoveInstance) _AddRemoveInstance->instanceGroupAdded(); return true; }

void NL3D::CInstanceGroup::build (  const CVector &  vGlobalPos, const TInstanceArray &  array, const std::vector< CCluster > &  Clusters, const std::vector< CPortal > &  Portals, const std::vector< CPointLightNamed > &  pointLightList, const CIGSurfaceLight::TRetrieverGridMap *  retrieverGridMap = NULL, float  igSurfaceLightCellSize = 0 )

Build the group Build also the list of light. NB: sort by LightGroupName the array. Give also a ptr on a retrieverGridMap to build surfaces (if not NULL). Definition at line 266 of file scene_group.cpp. References _ClusterInfos, _GlobalPos, _IGSurfaceLight, _InstancesInfos, NL3D::CIGSurfaceLight::build(), buildPointLightList(), NL3D::CIGSurfaceLight::clear(), TInstanceArray, NL3D::CIGSurfaceLight::TRetrieverGridMap, and uint32. { _GlobalPos = vGlobalPos; // Copy the array _InstancesInfos = array; _Portals = Portals; _ClusterInfos = Clusters; // Link portals and clusters uint32 i, j, k; for (i = 0; i < _Portals.size(); ++i) { for (j = 0; j < _ClusterInfos.size(); ++j) { bool bPortalInCluster = true; for (k = 0; k < _Portals[i]._Poly.size(); ++k) if (!_ClusterInfos[j].isIn (_Portals[i]._Poly[k]) ) { bPortalInCluster = false; break; } if (bPortalInCluster) { _Portals[i].setCluster(&_ClusterInfos[j]); _ClusterInfos[j].link (&_Portals[i]); } } } // Create Meta Cluster if needed /* CCluster clusterTemp; bool mustAdd = false; for (i = 0; i < _Portals.size(); ++i) if (_Portals[i].getNbCluster() == 1) { mustAdd = true; break; } if (mustAdd) { CCluster clusterTemp; _ClusterInfos.push_back(clusterTemp); CCluster *pMetaCluster = &_ClusterInfos[_ClusterInfos.size()-1]; pMetaCluster->setMetaCluster(); for (i = 0; i < _Portals.size(); ++i) if (_Portals[i].getNbCluster() == 1) { _Portals[i].setCluster(pMetaCluster); pMetaCluster->link(&_Portals[i]); } }*/ // Build the list of light. NB: sort by LightGroupName the array. std::vector<uint> plRemap; buildPointLightList(pointLightList, plRemap); // Build IgSurfaceLight // clear _IGSurfaceLight.clear(); if(retrieverGridMap) { //build _IGSurfaceLight.build(*retrieverGridMap, igSurfaceLightCellSize, plRemap); } }

void NL3D::CInstanceGroup::build (  const CVector &  vGlobalPos, const TInstanceArray &  array, const std::vector< CCluster > &  Clusters, const std::vector< CPortal > &  Portals )

Build the group Build with an empty list of light Definition at line 342 of file scene_group.cpp. References TInstanceArray. Referenced by NL3D::CInstanceLighter::light(). { // empty pointLightList std::vector<CPointLightNamed> pointLightList; build(vGlobalPos, array, Clusters, Portals, pointLightList); }

void NL3D::CInstanceGroup::buildPointLightList (  const std::vector< CPointLightNamed > &  pointLightList, std::vector< uint > &  plRemap )  [private]

Build the list of light. NB: sort by LightGroupName the array, and return index remap. Definition at line 1165 of file scene_group.cpp. References _InstancesInfos, _PointLightArray, NL3D::CPointLightNamedArray::build(), NL3D::CPointLightNamedArray::getPointLights(), NL3D::CInstanceGroup::CInstance::Light, NL3D::CInstanceGroup::CInstance::LocalAmbientId, nlassert, NL3D::CInstanceGroup::CInstance::StaticLightEnabled, and uint. Referenced by build(). { // build. _PointLightArray.build(pointLightList, plRemap); // remap Instance precalc lighted. for(uint i=0; i<_InstancesInfos.size(); i++) { CInstance &inst= _InstancesInfos[i]; // If the instance has no precomputed lighting, skip if(!inst.StaticLightEnabled) continue; // remap pointlights for(uint l=0; l<CInstanceGroup::NumStaticLightPerInstance; l++) { // If NULL light, break and continue to next instance if(inst.Light[l]== 0xFF) break; else { // Check good index. nlassert(inst.Light[l] < _PointLightArray.getPointLights().size()); // Remap index, because of light sorting. inst.Light[l]= plRemap[inst.Light[l]]; } } // remap ambient light if(inst.LocalAmbientId!=0xFF) { nlassert(inst.LocalAmbientId < _PointLightArray.getPointLights().size()); inst.LocalAmbientId= plRemap[inst.LocalAmbientId]; } } }

void NL3D::CInstanceGroup::createRoot (  CScene &  scene  )

Add all the instances to the scene. Definition at line 476 of file scene_group.cpp. References NL3D::CScene::createModel(), NL3D::CTransform::setDontUnfreezeChildren(), setPos(), and NL3D::TransformId. Referenced by addToSceneWhenAllShapesLoaded(), and NL3D::CInstanceGroupUser::createRoot(). { _Root = (CTransform*)scene.createModel (TransformId); _Root->setDontUnfreezeChildren (true); setPos (CVector(0,0,0)); }

void NL3D::CInstanceGroup::displayDebugClusters (  IDriver *  drv, class CTextContext *  txtCtx )

For Debug Display of clusters. The view matrix and frustum should have been setuped NB: the ModelMatrix is modified by this method Definition at line 1224 of file scene_group.cpp. References NL3D::CCluster::_BBox, _ClusterInstances, NL3D::CCluster::_Portals, NL3D::CCluster::_Volume, NL3D::IDriver::activeVertexBuffer(), NL3D::CPrimitiveBlock::addLine(), NL3D::CPrimitiveBlock::addTri(), NLMISC::CPolygon::clip(), NLMISC::CAABBox::getCenter(), NLMISC::CPlane::getNormal(), NLMISC::CAABBox::getRadius(), NL3D::IDriver::getViewMatrix(), NL3D::CMaterial::initUnlit(), NLMISC::CMatrix::inverted(), NL3D::CCluster::Name, NLMISC::CMatrix::normalize(), NLMISC::CPlane::normalize(), NLMISC::CPlane::project(), NL3D::IDriver::render(), NL3D::CComputedString::render3D(), NL3D::CPrimitiveBlock::reserveLine(), NL3D::CPrimitiveBlock::reserveTri(), s, NLMISC::CMatrix::scale(), NL3D::CMaterial::setBlend(), NL3D::CMaterial::setBlendFunc(), NL3D::CMaterial::setColor(), NL3D::CMaterial::setDoubleSided(), NL3D::CPrimitiveBlock::setNumLine(), NL3D::CPrimitiveBlock::setNumTri(), NL3D::CVertexBuffer::setNumVertices(), NLMISC::CMatrix::setPos(), NLMISC::CMatrix::setRot(), NL3D::IDriver::setupModelMatrix(), NL3D::CVertexBuffer::setVertexCoord(), NL3D::CVertexBuffer::setVertexFormat(), NL3D::CMaterial::setZFunc(), NL3D::CMaterial::setZWrite(), uint, NLMISC::CPolygon::Vertices, and NLMISC::CVector::y. Referenced by NL3D::CInstanceGroupUser::displayDebugClusters(). { uint opacity= 50; CRGBA colorCluster(255, 128, 255, opacity); // portals are drawn twice CRGBA colorPortal(128, 255, 128, opacity/2); CMaterial clusterMat; CMaterial portalMat; CMaterial lineMat; clusterMat.initUnlit(); clusterMat.setBlend(true); clusterMat.setBlendFunc(CMaterial::srcalpha, CMaterial::invsrcalpha); clusterMat.setZWrite(false); clusterMat.setDoubleSided(true); clusterMat.setColor(colorCluster); portalMat.initUnlit(); portalMat.setBlend(true); portalMat.setBlendFunc(CMaterial::srcalpha, CMaterial::invsrcalpha); portalMat.setZWrite(false); portalMat.setDoubleSided(true); portalMat.setColor(colorPortal); lineMat.initUnlit(); lineMat.setBlend(true); lineMat.setBlendFunc(CMaterial::srcalpha, CMaterial::invsrcalpha); lineMat.setZWrite(false); lineMat.setDoubleSided(true); lineMat.setColor(CRGBA(0,0,0,opacity)); // The geometry for each cluster CVertexBuffer vb; // too big cluster won't be rendered const uint maxVertices= 10000; vb.setVertexFormat(CVertexBuffer::PositionFlag); vb.setNumVertices(maxVertices); CPrimitiveBlock clusterTriangles; CPrimitiveBlock clusterLines; CPrimitiveBlock portalTriangles; CPrimitiveBlock portalLines; clusterTriangles.reserveTri(maxVertices); clusterLines.reserveLine(maxVertices); portalTriangles.reserveTri(maxVertices); portalLines.reserveLine(maxVertices); // setup identity matrix drv->setupModelMatrix(CMatrix::Identity); // For all clusters uint i; for(i=0;i<_ClusterInstances.size();i++) { CCluster *cluster= _ClusterInstances[i]; if(cluster) { uint numTotalVertices= 0; // **** Build a set of polys representing the volume (slow but debug!) static std::vector<CPolygon> polygons; polygons.clear(); polygons.resize(cluster->_Volume.size()); // for each plane, build the associated polygon uint j; for(j=0;j<polygons.size();j++) { // Start with a big quad centered on bbox center CPlane p= cluster->_Volume[j]; p.normalize(); CVector quadCenter= p.project(cluster->_BBox.getCenter()); // choose a basis on this plane CMatrix mat; if( fabs(p.getNormal().y)>0.9 ) mat.setRot(CVector::K, CVector::I, p.getNormal()); else mat.setRot(CVector::I, CVector::J, p.getNormal()); mat.normalize(CMatrix::ZYX); mat.setPos(quadCenter); // Build the initial Big quad CPolygon &poly= polygons[j]; poly.Vertices.resize(4); float s= 10 * cluster->_BBox.getRadius(); poly.Vertices[0]= mat * CVector(-s,-s,0); poly.Vertices[1]= mat * CVector(s,-s,0); poly.Vertices[2]= mat * CVector(s,s,0); poly.Vertices[3]= mat * CVector(-s,s,0); // clip this poly against all the other (ie not me) planes // This make this algo O(N2) but this is for debug.... for(uint k=0;k<cluster->_Volume.size();k++) { if(j!=k) { poly.clip(&cluster->_Volume[k], 1); } } // count the number of vertices / triangles / lines to add if(poly.Vertices.size()>=3) { numTotalVertices+= poly.Vertices.size(); } } // **** count the number of portals vertices for(j=0;j<cluster->_Portals.size();j++) { numTotalVertices+= cluster->_Portals[j]->_Poly.size(); } // **** Draw those cluster polygons, and portals // too big clusters won't be rendered if(numTotalVertices<=maxVertices) { uint iVert= 0; uint j; // build the cluster geometry clusterTriangles.setNumTri(0); clusterLines.setNumLine(0); for(j=0;j<polygons.size();j++) { CPolygon &poly= polygons[j]; if(poly.Vertices.size()>=3) { uint k; // add the vertices for(k=0;k<poly.Vertices.size();k++) vb.setVertexCoord(iVert+k, poly.Vertices[k]); // add the triangles for(k=0;k<poly.Vertices.size()-2;k++) clusterTriangles.addTri(iVert+0, iVert+k+1, iVert+k+2); // add the lines for(k=0;k<poly.Vertices.size();k++) clusterLines.addLine(iVert+k, iVert+ ((k+1)%poly.Vertices.size()) ); iVert+= poly.Vertices.size(); } } // build the portal geometry portalTriangles.setNumTri(0); portalLines.setNumLine(0); for(j=0;j<cluster->_Portals.size();j++) { std::vector<CVector> &portalVerts= cluster->_Portals[j]->_Poly; if(portalVerts.size()>=3) { uint k; // add the vertices for(k=0;k<portalVerts.size();k++) vb.setVertexCoord(iVert+k, portalVerts[k]); // add the triangles for(k=0;k<portalVerts.size()-2;k++) portalTriangles.addTri(iVert+0, iVert+k+1, iVert+k+2); // add the lines for(k=0;k<portalVerts.size();k++) portalLines.addLine(iVert+k, iVert+ ((k+1)%portalVerts.size()) ); iVert+= portalVerts.size(); } } // render 2 pass with or without ZBuffer (for clearness) for(uint pass=0;pass<2;pass++) { if(pass==0) { clusterMat.setZFunc(CMaterial::always); portalMat.setZFunc(CMaterial::always); lineMat.setZFunc(CMaterial::always); } else { clusterMat.setZFunc(CMaterial::lessequal); portalMat.setZFunc(CMaterial::lessequal); lineMat.setZFunc(CMaterial::lessequal); } drv->activeVertexBuffer(vb); drv->render(clusterTriangles, clusterMat); drv->render(clusterLines, lineMat); drv->render(portalTriangles, portalMat); drv->render(portalLines, lineMat); } } } } // **** For all clusters, Draw the cluster name at center of the cluster if(txtCtx) { CComputedString computedStr; // bkup fontSize uint bkFontSize; CMatrix fontMatrix; bkFontSize= txtCtx->getFontSize(); // to be readable txtCtx->setFontSize(24); // the font matrix fontMatrix.setRot(drv->getViewMatrix().inverted()); fontMatrix.normalize(CMatrix::YZX); fontMatrix.scale(10); // parse all clusters for(i=0;i<_ClusterInstances.size();i++) { CCluster *cluster= _ClusterInstances[i]; if(cluster) { fontMatrix.setPos(cluster->_BBox.getCenter()); txtCtx->computeString(cluster->Name, computedStr); computedStr.render3D(*drv, fontMatrix); } } // restore fontsize txtCtx->setFontSize(bkFontSize); } }

void NL3D::CInstanceGroup::enableRealTimeSunContribution (  bool  enable  )

Setuped at export, tells if the ig is touched by the sun. true by default. Definition at line 1212 of file scene_group.cpp. References _RealTimeSunContribution. { _RealTimeSunContribution= enable; }

void NL3D::CInstanceGroup::freezeHRC (   )

see CTransform::freezeHRC(). Do it for all instances (not clusters), and for the root of the IG. Definition at line 1132 of file scene_group.cpp. References NL3D::CTransform::freezeHRC(), and uint. Referenced by addToSceneWhenAllShapesLoaded(), and NL3D::CInstanceGroupUser::freezeHRC(). { // For all instances. for (uint i=0; i < _Instances.size(); i++) { if(_Instances[i]) _Instances[i]->freezeHRC(); } // and for root. _Root->freezeHRC(); }

CInstanceGroup::TState NL3D::CInstanceGroup::getAddToSceneState (   )

Definition at line 868 of file scene_group.cpp. References _AddToSceneSignal, _AddToSceneTempSelectTexture, addToScene(), and StateAdding. Referenced by NL3D::CInstanceGroupUser::getAddToSceneState(). { // If we are adding but we have finished loading shapes (all shapes are here) if (_AddToSceneState == StateAdding) { if (_AddToSceneSignal) { addToScene (*_AddToSceneTempScene, _AddToSceneTempDriver, _AddToSceneTempSelectTexture); } } return _AddToSceneState; }

void NL3D::CInstanceGroup::getBlendShapes (  std::set< std::string > &  BlendShapeNames  )

Get all the blendshapes from an instance group. BlendShape part Definition at line 1015 of file scene_group.cpp. References NL3D::CMeshBaseInstance::getBlendShapeName(), NL3D::CMeshBaseInstance::getNbBlendShape(), and uint32. { BlendShapeNames.clear(); for( uint32 i = 0; i < _Instances.size(); ++i ) { CMeshBaseInstance *pMBI = dynamic_cast<CMeshBaseInstance*>(_Instances[i]); if (pMBI != NULL) { uint32 nNbBS = pMBI->getNbBlendShape(); for( uint32 j = 0; j < nNbBS; ++j ) { string sTmp; pMBI->getBlendShapeName( j, sTmp ); set<string>::iterator itSet = BlendShapeNames.find(sTmp); if( itSet == BlendShapeNames.end() ) BlendShapeNames.insert( sTmp ); } } } }

bool NL3D::CInstanceGroup::getDynamicPortal (  std::string &  name  )

Get the state of a dynamic portal (true=opened, false=closed). Definition at line 1081 of file scene_group.cpp. References uint32. Referenced by NL3D::CInstanceGroupUser::getDynamicPortal(). { for (uint32 i = 0; i < _Portals.size(); ++i) if (_Portals[i].getName() == name) return _Portals[i].isOpened (); return false; }

void NL3D::CInstanceGroup::getDynamicPortals (  std::vector< std::string > &  names  )

Get all dynamic portals of an instance group. Definition at line 1065 of file scene_group.cpp. References getName(), and uint32. Referenced by NL3D::CInstanceGroupUser::getDynamicPortals(). { for (uint32 i = 0; i < _Portals.size(); ++i) if (_Portals[i].getName() != "") names.push_back (_Portals[i].getName()); }

const NLMISC::CVector& NL3D::CInstanceGroup::getGlobalPos (   )  const [inline]

Definition at line 175 of file scene_group.h. References _GlobalPos. { return _GlobalPos; }

const CIGSurfaceLight& NL3D::CInstanceGroup::getIGSurfaceLight (   )  const [inline]

Get the SurfaceLight info, for debug purposes. Definition at line 361 of file scene_group.h. References _IGSurfaceLight. Referenced by NL3D::CIGSurfaceLightBuild::buildPLDebugMesh(). {return _IGSurfaceLight;}

CInstanceGroup::CInstance & NL3D::CInstanceGroup::getInstance (  uint  instanceNb  )

Definition at line 231 of file scene_group.cpp. References _InstancesInfos, and uint. { return _InstancesInfos[instanceNb]; }

const CInstanceGroup::CInstance & NL3D::CInstanceGroup::getInstance (  uint  instanceNb  )  const

Definition at line 225 of file scene_group.cpp. References _InstancesInfos, and uint. Referenced by NL3D::CInstanceLighter::lightIgSimple(). { return _InstancesInfos[instanceNb]; }

void NL3D::CInstanceGroup::getInstanceMatrix (  uint  instanceNb, NLMISC::CMatrix &  dest )  const

Definition at line 205 of file scene_group.cpp. References getInstancePos(), getInstanceRot(), getInstanceScale(), NLMISC::CMatrix::identity(), NLMISC::CMatrix::rotate(), NLMISC::CMatrix::scale(), NLMISC::CMatrix::translate(), and uint. Referenced by NL3D::CInstanceGroupUser::getInstanceMatrix(). { dest.identity(); dest.translate(getInstancePos(instanceNb)); dest.rotate(getInstanceRot(instanceNb)); dest.scale(getInstanceScale(instanceNb)); }

const string & NL3D::CInstanceGroup::getInstanceName (  uint  instanceNb  )  const

Get the instance name. Definition at line 173 of file scene_group.cpp. References _InstancesInfos, and uint. Referenced by NL3D::CInstanceGroupUser::addToScene(), NL3D::CInstanceGroupUser::getAddToSceneState(), and NL3D::CInstanceGroupUser::getInstanceName(). { // Return the name of the n-th instance return _InstancesInfos[instanceNb].InstanceName; }

const sint32 NL3D::CInstanceGroup::getInstanceParent (  uint  instanceNb  )  const

Definition at line 217 of file scene_group.cpp. References _InstancesInfos, sint32, and uint. { // Return the scale vector of the n-th instance return _InstancesInfos[instanceNb].nParent; }

const CVector & NL3D::CInstanceGroup::getInstancePos (  uint  instanceNb  )  const

Get an instance position. Definition at line 181 of file scene_group.cpp. References _InstancesInfos, and uint. Referenced by getInstanceMatrix(), NL3D::CInstanceGroupUser::getInstancePos(), and NL3D::CInstanceLighter::lightIgSimple(). { // Return the position vector of the n-th instance return _InstancesInfos[instanceNb].Pos; }

const CQuat & NL3D::CInstanceGroup::getInstanceRot (  uint  instanceNb  )  const

Get an instance rotation. Definition at line 189 of file scene_group.cpp. References _InstancesInfos, and uint. Referenced by getInstanceMatrix(), NL3D::CInstanceGroupUser::getInstanceRot(), and NL3D::CInstanceLighter::lightIgSimple(). { // Return the rotation vector of the n-th instance return _InstancesInfos[instanceNb].Rot; }

const CVector & NL3D::CInstanceGroup::getInstanceScale (  uint  instanceNb  )  const

Definition at line 197 of file scene_group.cpp. References _InstancesInfos, and uint. Referenced by getInstanceMatrix(), NL3D::CInstanceGroupUser::getInstanceScale(), and NL3D::CInstanceLighter::lightIgSimple(). { // Return the scale vector of the n-th instance return _InstancesInfos[instanceNb].Scale; }

void NL3D::CInstanceGroup::getLights (  std::set< std::string > &  LightNames  )

Get all lights (lightmaps) from an instance group. LightMap part Definition at line 993 of file scene_group.cpp. References NL3D::CMeshBaseInstance::getLightMapName(), NL3D::CMeshBaseInstance::getNbLightMap(), and uint32. { LightNames.clear(); for( uint32 i = 0; i < _Instances.size(); ++i ) { CMeshInstance *pMI = dynamic_cast<CMeshInstance*>(_Instances[i]); if( pMI != NULL ) { uint32 nNbLM = pMI->getNbLightMap(); for( uint32 j = 0; j < nNbLM; ++j ) { string sTmp; pMI->getLightMapName( j, sTmp ); set<string>::iterator itSet = LightNames.find(sTmp); if( itSet == LightNames.end() ) LightNames.insert( sTmp ); } } } }

uint NL3D::CInstanceGroup::getNumInstance (   )  const

Get number of instance in this group. Todo: remove all of these methods. For the moment DO NOT USE THEM !!! Definition at line 158 of file scene_group.cpp. References _InstancesInfos, and uint. Referenced by NL3D::CInstanceGroupUser::getCoarseMeshDist(), NL3D::CInstanceGroupUser::getDistMax(), NL3D::CInstanceGroupUser::getInstanceName(), NL3D::CInstanceGroupUser::getInstancePos(), NL3D::CInstanceGroupUser::getInstanceRot(), NL3D::CInstanceGroupUser::getInstanceScale(), NL3D::CInstanceGroupUser::getNumInstance(), NL3D::CInstanceGroupUser::getShapeName(), NL3D::CInstanceLighter::lightIgSimple(), NL3D::CInstanceGroupUser::setCoarseMeshDist(), and NL3D::CInstanceGroupUser::setDistMax(). { return _InstancesInfos.size(); }

uint NL3D::CInstanceGroup::getNumPointLights (   )  const [inline]

Get the number of point lights. Definition at line 341 of file scene_group.h. References _PointLightArray, NL3D::CPointLightNamedArray::getPointLights(), and uint. { return _PointLightArray.getPointLights().size(); }

CInstanceGroup* NL3D::CInstanceGroup::getParentClusterSystem (   )  const [inline]

Get the parent ClusterSystem Definition at line 376 of file scene_group.h. References _ParentClusterSystem. Referenced by NL3D::CScene::findCameraClusterSystemFromRay(), and NL3D::CInstanceGroupUser::getParentCluster(). {return _ParentClusterSystem;}

const std::vector<CPointLightNamed>& NL3D::CInstanceGroup::getPointLightList (   )  const [inline]

get the list of light. NB: the array is sorted by LightGroupName. Definition at line 338 of file scene_group.h. References _PointLightArray, and NL3D::CPointLightNamedArray::getPointLights(). Referenced by NL3D::CIGSurfaceLightBuild::buildPLDebugMesh(), NL3D::CSurfaceLightGrid::getStaticLightSetup(), NL3D::CInstanceLighter::lightIgSimple(), and retrieve(). {return _PointLightArray.getPointLights();}

CPointLightNamed& NL3D::CInstanceGroup::getPointLightNamed (  uint  index  )  [inline]

Get a mutable ref on a point light named. Definition at line 344 of file scene_group.h. References _PointLightArray, NL3D::CPointLightNamedArray::getPointLights(), index, and uint. { return _PointLightArray.getPointLights()[index]; }

CVector NL3D::CInstanceGroup::getPos (   )

Get the position of the IG. Definition at line 1105 of file scene_group.cpp. References NL3D::ITransformable::getPos(). Referenced by NL3D::CInstanceGroupUser::getPos(). { if (_Root != NULL) return _Root->getPos (); else return CVector(0.0f, 0.0f, 0.0f); }

bool NL3D::CInstanceGroup::getRealTimeSunContribution (   )  const [inline]

Setuped at export, tells if the ig is touched by the sun. true by default. Definition at line 365 of file scene_group.h. References _RealTimeSunContribution. {return _RealTimeSunContribution;}

CQuat NL3D::CInstanceGroup::getRotQuat (   )

Get the rotation of the IG. Definition at line 1114 of file scene_group.cpp. References NL3D::ITransformable::getRotQuat(). Referenced by NL3D::CInstanceGroupUser::getRotQuat(). { if (_Root != NULL) return _Root->getRotQuat (); else return CQuat(); }

void NL3D::CInstanceGroup::getShapeName (  uint  instanceIndex, std::string &  shapeName )  const

Get the instance name to create as written in the instance group. Definition at line 552 of file scene_group.cpp. References _InstancesInfos, _TransformName, NL3D::CInstanceGroup::CInstance::InstanceName, NL3D::CInstanceGroup::CInstance::Name, NLMISC::strlwr(), NL3D::ITransformName::transformName(), and uint. { const CInstance &rInstanceInfo = _InstancesInfos[instanceIndex]; shapeName = rInstanceInfo.Name; // If there is a callback added to this instance group then transform // the name of the shape to load. if (_TransformName != NULL && !rInstanceInfo.InstanceName.empty()) { shapeName = _TransformName->transformName (instanceIndex, rInstanceInfo.InstanceName, rInstanceInfo.Name); } shapeName = strlwr (shapeName); if (!shapeName.empty() && shapeName.find('.') == std::string::npos) shapeName += ".shape"; }

const string & NL3D::CInstanceGroup::getShapeName (  uint  instanceNb  )  const

Get the name of the mesh referenced. Definition at line 165 of file scene_group.cpp. References _InstancesInfos, and uint. Referenced by addToScene(), NL3D::CInstanceGroupUser::getShapeName(), and NL3D::CInstanceLighter::lightIgSimple(). { // Return the name of the n-th instance return _InstancesInfos[instanceNb].Name; }

bool NL3D::CInstanceGroup::getStaticLightSetup (  uint  retrieverIdentifier, sint  surfaceId, const CVector &  localPos, std::vector< CPointLightInfluence > &  pointLightList, uint8 &  sunContribution, NLMISC::CRGBA &  localAmbient )  [inline]

See CIGSurfaceLight::getStaticLightSetup(). Definition at line 353 of file scene_group.h. References _IGSurfaceLight, NL3D::CIGSurfaceLight::getStaticLightSetup(), sint, uint, and uint8. Referenced by NL3D::CInstanceGroupUser::getStaticLightSetup(). { return _IGSurfaceLight.getStaticLightSetup(retrieverIdentifier, surfaceId, localPos, pointLightList, sunContribution, localAmbient); }

CTransformShape * NL3D::CInstanceGroup::getTransformShape (  uint  instanceNb  )  const

Get the instance added to the scene. NULL if instanceNb too big, if addToScene not called, or if instance is DontAddToScene Definition at line 237 of file scene_group.cpp. References uint. { if(instanceNb>_Instances.size()) return NULL; return _Instances[instanceNb]; }

class UInstanceGroup* NL3D::CInstanceGroup::getUserInterface (   )  const [inline]

Definition at line 251 of file scene_group.h. References _UserIg. Referenced by NL3D::CInstanceGroupUser::getParentCluster(). {return _UserIg;}

void NL3D::CInstanceGroup::linkRoot (  CScene &  scene, CTransform *  father )

link the root of the ig to a node. No-op if not added to scene. Pass NULL to reset by default Transformation part Definition at line 1123 of file scene_group.cpp. References NL3D::CTransform::hrcLinkSon(). { if(_Root) { father->hrcLinkSon( _Root ); } }

bool NL3D::CInstanceGroup::linkToParent (  CInstanceGroup *  pFather  )

Look through all hierarchy our clusters that must be linked to our parent Definition at line 884 of file scene_group.cpp. References _ClusterInstances, _ParentClusterSystem, and uint32. Referenced by addToSceneWhenAllShapesLoaded(), and NL3D::CInstanceGroupUser::linkToParentCluster(). { uint32 i, j; bool ret; /* for (i = 0; i < pFather->_ClusterInstances.size(); ++i) { for(j = 0; j < pFather->_ClusterInstances[i]->Children.size(); ++j) { if (linkToParent(pFather->_ClusterInstances[i]->Children[j]->Group)) return true; } } */ ret = false; if (this != pFather) { for (j = 0; j < this->_ClusterInstances.size(); ++j) { if ((this->_ClusterInstances[j]->FatherVisible) || (this->_ClusterInstances[j]->VisibleFromFather)) { for (i = 0; i < pFather->_ClusterInstances .size(); ++i) { // If my cluster j is in the cluster i of the father if (pFather->_ClusterInstances[i]->isIn(this->_ClusterInstances[j]->getBBox())) { if (this->_ClusterInstances[j]->Father != pFather->_ClusterInstances[i]) // and not already son of the father cluster ? { // unlink from parent this->_ClusterInstances[j]->unlinkFromParent(); // relink to the new father found pFather->_ClusterInstances[i]->Children.push_back(this->_ClusterInstances[j]); this->_ClusterInstances[j]->Father = pFather->_ClusterInstances[i]; } ret = true; } } } } } // store new parent if(ret) _ParentClusterSystem= pFather; return ret; }

bool NL3D::CInstanceGroup::removeFromScene (  CScene &  scene  )

Remove all the instances from the scene. Definition at line 935 of file scene_group.cpp. References _AddRemoveInstance, _ClusterInfos, _ClusterInstances, _PointLightArray, NL3D::CScene::deleteInstance(), NL3D::CScene::deleteModel(), NL3D::CScene::getClipTrav(), NL3D::CPointLightNamedArray::getPointLights(), NL3D::IAddRemoveInstance::instanceGroupRemoved(), nlassert, NL3D::CScene::removeInstanceGroupForLightAnimation(), uint32, NL3D::CTransform::unfreezeStaticLightSetup(), and NL3D::CClipTrav::unregisterCluster(). Referenced by NL3D::CInstanceGroupUser::removeFromScene(). { uint32 i, j, k; // Remove shapes for (i = 0; i < _Instances.size(); ++i) { CTransformShape *pTShape = _Instances[i]; if(pTShape) { // For security, unfreeze any StaticLightSetup setuped. pTShape->unfreezeStaticLightSetup(); // delete the instance scene.deleteInstance (pTShape); _Instances[i] = NULL; } } // Relink portals with old clusters for (i = 0; i < _Portals.size(); ++i) for (k = 0; k < 2; ++k) { if (_Portals[i]._Clusters[k]) { for (j = 0; j < _ClusterInstances.size(); ++j) if( _Portals[i]._Clusters[k] == _ClusterInstances[j] ) break; nlassert (j!=_ClusterInstances.size()); _Portals[i]._Clusters[k] = &_ClusterInfos[j]; } } // Remove clusters CClipTrav *pClipTrav = &scene.getClipTrav(); for (i = 0; i < _ClusterInstances.size(); ++i) { pClipTrav->unregisterCluster (_ClusterInstances[i]); scene.deleteModel (_ClusterInstances[i]); } scene.deleteModel (_Root); _Root = NULL; // UnRegister the instanceGroup for light animation // ----------------- // If some PointLight to animate if(_PointLightArray.getPointLights().size() > 0) scene.removeInstanceGroupForLightAnimation(this); if (_AddRemoveInstance) _AddRemoveInstance->instanceGroupRemoved(); return true; }

void NL3D::CInstanceGroup::retrieve (  CVector &  vGlobalPos, TInstanceArray &  array, std::vector< CCluster > &  Clusters, std::vector< CPortal > &  Portals, std::vector< CPointLightNamed > &  pointLightList )  const

Retreive group information. NB: data may have changed, eg: order of lights. Definition at line 354 of file scene_group.cpp. References _ClusterInfos, _GlobalPos, _InstancesInfos, getPointLightList(), TInstanceArray, and uint. Referenced by NL3D::CInstanceLighter::light(). { // Just copy infos. NB: light information order have change but is still valid vGlobalPos= _GlobalPos; array= _InstancesInfos; Portals= _Portals; Clusters= _ClusterInfos; // Must reset links to all portals and clusters. uint i; for(i=0; i<Portals.size(); i++) Portals[i].resetClusterLinks(); for(i=0; i<Clusters.size(); i++) Clusters[i].resetPortalLinks(); pointLightList= getPointLightList(); }

void NL3D::CInstanceGroup::serial (  NLMISC::IStream &  f  )

Serial the group. Definition at line 379 of file scene_group.cpp. References _ClusterInfos, _GlobalPos, _IGSurfaceLight, _InstancesInfos, _PointLightArray, _RealTimeSunContribution, NL3D::CPointLightNamedArray::clear(), NL3D::CIGSurfaceLight::clear(), NLMISC::IStream::isReading(), NLMISC::IStream::serial(), NLMISC::IStream::serialCheck(), NLMISC::IStream::serialCont(), NLMISC::IStream::serialVersion(), sint, sint32, and uint32. Referenced by NL3D::CInstanceGroupUser::init(), and NL3D::CAsyncFileManager3D::CIGLoad::run(). { // Serial a header f.serialCheck ((uint32)'TPRG'); /* Version 5: _ _RealTimeSunContribution Version 4: _ IGSurfaceLight Version 3: - PointLights */ // Serial a version number sint version=f.serialVersion (5); // _RealTimeSunContribution if (version >= 5) { f.serial(_RealTimeSunContribution); } else if(f.isReading()) { _RealTimeSunContribution= true; } // Serial the IGSurfaceLight if (version >= 4) { f.serial(_IGSurfaceLight); } else if(f.isReading()) { _IGSurfaceLight.clear(); } // Serial the PointLights info if (version >= 3) { f.serial(_PointLightArray); } else if(f.isReading()) { _PointLightArray.clear(); } if (version >= 2) f.serial(_GlobalPos); if (version >= 1) { f.serialCont (_ClusterInfos); f.serialCont (_Portals); // Links if (f.isReading()) { uint32 i, j; for (i = 0; i < _ClusterInfos.size(); ++i) { uint32 nNbPortals; f.serial (nNbPortals); _ClusterInfos[i]._Portals.resize (nNbPortals); // Recreate clusters to portals links for (j = 0; j < nNbPortals; ++j) { sint32 nPortalNb; f.serial (nPortalNb); _ClusterInfos[i]._Portals[j] = &_Portals[nPortalNb]; _Portals[nPortalNb].setCluster (&_ClusterInfos[i]); } } } else // We are writing to the stream { uint32 i, j; for (i = 0; i < _ClusterInfos.size(); ++i) { uint32 nNbPortals = _ClusterInfos[i]._Portals.size(); f.serial (nNbPortals); for (j = 0; j < nNbPortals; ++j) { sint32 nPortalNb = (_ClusterInfos[i]._Portals[j] - &_Portals[0]); f.serial (nPortalNb); } } } } // Serial the array f.serialCont (_InstancesInfos); }

void NL3D::CInstanceGroup::setAddRemoveInstanceCallback (  IAddRemoveInstance *  callback  )

Set a callback to know when an instance has been added / removed. Definition at line 491 of file scene_group.cpp. References _AddRemoveInstance. Referenced by NL3D::CInstanceGroupUser::setAddRemoveInstanceCallback(). { _AddRemoveInstance = callback; }

void NL3D::CInstanceGroup::setBlendShapeFactor (  const std::string &  BlendShapeName, float  rFactor )

Set the blendshape factor for the whole instance group (-100 -> 100). Definition at line 1037 of file scene_group.cpp. References NL3D::CMeshBaseInstance::setBlendShapeFactor(), and uint32. Referenced by NL3D::CInstanceGroupUser::setBlendShapeFactor(). { for( uint32 i = 0; i < _Instances.size(); ++i ) { CMeshBaseInstance *pMI = dynamic_cast<CMeshBaseInstance*>(_Instances[i]); if( pMI != NULL ) { pMI->setBlendShapeFactor( BlendShapeName, rFactor ); } } }

void NL3D::CInstanceGroup::setClusterSystemForInstances (  CInstanceGroup *  pIG  )

Set the cluster system to test for instances that are not in a cluster of this IG. Definition at line 1056 of file scene_group.cpp. References _ClusterSystemForInstances, _InstancesInfos, and uint32. Referenced by NL3D::CInstanceGroupUser::setClusterSystemForInstances(), and NL3D::CSceneUser::setToGlobalInstanceGroup(). { _ClusterSystemForInstances = pIG; for (uint32 i = 0; i < _Instances.size(); ++i) if (_Instances[i] && _InstancesInfos[i].Clusters.size() == 0) _Instances[i]->setClusterSystem (_ClusterSystemForInstances); }

void NL3D::CInstanceGroup::setDynamicPortal (  std::string &  name, bool  opened )

Set the state of a dynamic portal (true=opened, false=closed). Definition at line 1073 of file scene_group.cpp. References uint32. Referenced by NL3D::CInstanceGroupUser::setDynamicPortal(). { for (uint32 i = 0; i < _Portals.size(); ++i) if (_Portals[i].getName() == name) _Portals[i].open (opened); }

void NL3D::CInstanceGroup::setIGAddBeginCallback (  IIGAddBegin *  callback  )

Set a callback to know when an instance group is being created, and how many instances it contains. Definition at line 497 of file scene_group.cpp. References _IGAddBeginCallback. Referenced by NL3D::CInstanceGroupUser::setIGAddBeginCallback(). { _IGAddBeginCallback = callback; }

void NL3D::CInstanceGroup::setPointLightFactor (  const CScene &  scene  )

set the Light factor for all pointLights "lightGroupName". Definition at line 1205 of file scene_group.cpp. References _PointLightArray, and NL3D::CPointLightNamedArray::setPointLightFactor(). Referenced by NL3D::CScene::animate(). { _PointLightArray.setPointLightFactor(scene); }

void NL3D::CInstanceGroup::setPos (  const CVector &  pos  )

Set the position of the IG. Todo: Make this work (precision): _Root->setPos (_GlobalPos+pos); Definition at line 1090 of file scene_group.cpp. References NL3D::ITransformable::setPos(). Referenced by createRoot(), and NL3D::CInstanceGroupUser::setPos(). { if (_Root != NULL) _Root->setPos (pos); }

void NL3D::CInstanceGroup::setRotQuat (  const CQuat &  quat  )

Set the rotation of the IG. Definition at line 1098 of file scene_group.cpp. References NL3D::ITransformable::setRotQuat(). Referenced by NL3D::CInstanceGroupUser::setRotQuat(). { if (_Root != NULL) _Root->setRotQuat (quat); }

void NL3D::CInstanceGroup::setTransformNameCallback (  ITransformName *  pTN  )

Setup the callback in charge of changing name at the addToScene moment. Definition at line 484 of file scene_group.cpp. References _TransformName. Referenced by NL3D::CInstanceGroupUser::setTransformNameCallback(). { _TransformName = pTN; }

void NL3D::CInstanceGroup::setUserInterface (  class UInstanceGroup *  uig  )  [inline]

User Interface related: yes it is ugly.... Definition at line 250 of file scene_group.h. References _UserIg. Referenced by NL3D::CInstanceGroupUser::CInstanceGroupUser(). {_UserIg= uig;}

void NL3D::CInstanceGroup::stopAddToSceneAsync (   )

Definition at line 828 of file scene_group.cpp. References _AddToSceneSignal, _InstancesInfos, _TransformName, NL3D::CShapeBank::cancelLoadAsync(), NL3D::CInstanceGroup::CInstance::DontAddToScene, NL3D::CScene::getShapeBank(), NL3D::CInstanceGroup::CInstance::InstanceName, NL3D::CInstanceGroup::CInstance::Name, StateAdding, StateNotAdded, NLMISC::strlwr(), NL3D::ITransformName::transformName(), and uint32. Referenced by NL3D::CInstanceGroupUser::stopAddToSceneAsync(). { if (_AddToSceneState != StateAdding) return; vector<CInstance>::iterator it = _InstancesInfos.begin(); CAsyncFileManager::getInstance().cancelSignal (&_AddToSceneSignal); for (uint32 i = 0; i < _InstancesInfos.size(); ++i, ++it) { CInstance &rInstanceInfo = *it; if (!rInstanceInfo.DontAddToScene) { string shapeName; bool getShapeName = true; if (_TransformName != NULL && !rInstanceInfo.InstanceName.empty()) { shapeName = _TransformName->transformName (i, rInstanceInfo.InstanceName, rInstanceInfo.Name); if (shapeName != rInstanceInfo.Name) getShapeName = false; } if (getShapeName) { if (rInstanceInfo.Name.find('.') == std::string::npos) shapeName = rInstanceInfo.Name + ".shape"; else // extension has already been added shapeName = rInstanceInfo.Name; } shapeName = strlwr (shapeName); _AddToSceneTempScene->getShapeBank()->cancelLoadAsync (shapeName); } } _AddToSceneState = StateNotAdded; }

void NL3D::CInstanceGroup::unfreezeHRC (   )

see CTransform::unfreezeHRC(). Do it for all instances (not clusters), and for the root of the IG. Definition at line 1146 of file scene_group.cpp. References uint, and NL3D::CTransform::unfreezeHRC(). Referenced by NL3D::CInstanceGroupUser::unfreezeHRC(). { // For all instances. for (uint i=0; i < _Instances.size(); i++) { if(_Instances[i]) _Instances[i]->unfreezeHRC(); } // and for root. _Root->unfreezeHRC(); }

---

Field Documentation

IAddRemoveInstance* NL3D::CInstanceGroup::_AddRemoveInstance [private]

Definition at line 427 of file scene_group.h. Referenced by addToSceneWhenAllShapesLoaded(), CInstanceGroup(), removeFromScene(), and setAddRemoveInstanceCallback().

bool NL3D::CInstanceGroup::_AddToSceneSignal [private]

Definition at line 419 of file scene_group.h. Referenced by addToSceneAsync(), getAddToSceneState(), and stopAddToSceneAsync().

TState NL3D::CInstanceGroup::_AddToSceneState [private]

Definition at line 420 of file scene_group.h.

IDriver* NL3D::CInstanceGroup::_AddToSceneTempDriver [private]

Definition at line 422 of file scene_group.h.

CScene* NL3D::CInstanceGroup::_AddToSceneTempScene [private]

Definition at line 421 of file scene_group.h.

uint NL3D::CInstanceGroup::_AddToSceneTempSelectTexture [private]

Definition at line 423 of file scene_group.h. Referenced by addToSceneAsync(), and getAddToSceneState().

CClipTrav* NL3D::CInstanceGroup::_ClipTrav

Definition at line 389 of file scene_group.h. Referenced by addToSceneWhenAllShapesLoaded(), and NL3D::CCluster::traverseHrc().

std::vector<CCluster> NL3D::CInstanceGroup::_ClusterInfos

Definition at line 384 of file scene_group.h. Referenced by addToSceneWhenAllShapesLoaded(), build(), removeFromScene(), retrieve(), and serial().

std::vector<CCluster*> NL3D::CInstanceGroup::_ClusterInstances

Definition at line 385 of file scene_group.h. Referenced by addCluster(), addToSceneWhenAllShapesLoaded(), displayDebugClusters(), NL3D::CClipTrav::fullSearch(), linkToParent(), and removeFromScene().

CInstanceGroup* NL3D::CInstanceGroup::_ClusterSystemForInstances

Definition at line 391 of file scene_group.h. Referenced by addToSceneWhenAllShapesLoaded(), CInstanceGroup(), and setClusterSystemForInstances().

NLMISC::CVector NL3D::CInstanceGroup::_GlobalPos

Definition at line 395 of file scene_group.h. Referenced by build(), CInstanceGroup(), getGlobalPos(), retrieve(), and serial().

IIGAddBegin* NL3D::CInstanceGroup::_IGAddBeginCallback [private]

Definition at line 428 of file scene_group.h. Referenced by addToScene(), addToSceneAsync(), CInstanceGroup(), and setIGAddBeginCallback().

CIGSurfaceLight NL3D::CInstanceGroup::_IGSurfaceLight [private]

The object used to light dynamic models in town and buildings. Definition at line 413 of file scene_group.h. Referenced by build(), CInstanceGroup(), getIGSurfaceLight(), getStaticLightSetup(), and serial().

std::vector<CTransformShape*> NL3D::CInstanceGroup::_Instances

Definition at line 381 of file scene_group.h. Referenced by NL3D::CInstanceGroupUser::addToScene(), NL3D::CInstanceGroupUser::getAddToSceneState(), NL3D::CInstanceGroupUser::getCoarseMeshDist(), NL3D::CInstanceGroupUser::getDistMax(), NL3D::CInstanceGroupUser::setCoarseMeshDist(), and NL3D::CInstanceGroupUser::setDistMax().

TInstanceArray NL3D::CInstanceGroup::_InstancesInfos

Definition at line 380 of file scene_group.h. Referenced by addToScene(), addToSceneAsync(), addToSceneWhenAllShapesLoaded(), build(), buildPointLightList(), getInstance(), getInstanceName(), getInstanceParent(), getInstancePos(), getInstanceRot(), getInstanceScale(), getNumInstance(), getShapeName(), retrieve(), serial(), setClusterSystemForInstances(), and stopAddToSceneAsync().

CInstanceGroup* NL3D::CInstanceGroup::_ParentClusterSystem

Definition at line 393 of file scene_group.h. Referenced by CInstanceGroup(), getParentClusterSystem(), and linkToParent().

CPointLightNamedArray NL3D::CInstanceGroup::_PointLightArray [private]

Array of pointLights. Definition at line 406 of file scene_group.h. Referenced by addToScene(), addToSceneAsync(), addToSceneWhenAllShapesLoaded(), buildPointLightList(), getNumPointLights(), getPointLightList(), getPointLightNamed(), removeFromScene(), serial(), and setPointLightFactor().

std::vector<CPortal> NL3D::CInstanceGroup::_Portals

Definition at line 383 of file scene_group.h.

bool NL3D::CInstanceGroup::_RealTimeSunContribution [private]

RealTimeSunContribution. Used for ig_lighter and zone_ig_lighter. Definition at line 403 of file scene_group.h. Referenced by CInstanceGroup(), enableRealTimeSunContribution(), getRealTimeSunContribution(), and serial().

CTransform* NL3D::CInstanceGroup::_Root

Definition at line 387 of file scene_group.h.

ITransformName* NL3D::CInstanceGroup::_TransformName [private]

Definition at line 426 of file scene_group.h. Referenced by addToSceneAsync(), CInstanceGroup(), getShapeName(), setTransformNameCallback(), and stopAddToSceneAsync().

UInstanceGroup* NL3D::CInstanceGroup::_UserIg [private]

Definition at line 431 of file scene_group.h. Referenced by CInstanceGroup(), getUserInterface(), and setUserInterface().

---

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

• scene_group.h
• scene_group.cpp

---