Main Page | Namespace List | Class Hierarchy | Alphabetical List | Data Structures | File List | Namespace Members | Data Fields | Globals | Related Pages | Search for 

NL3D::CPSTargetLocatedBindable Class Reference

#include <ps_located.h>

Inheritance diagram for NL3D::CPSTargetLocatedBindable:

NL3D::CPSLocatedBindable NLMISC::IStreamable NLMISC::IClassable NL3D::CPSForce NL3D::CPSZone NL3D::CIsotropicForceT< T > NL3D::CIsotropicForceT< CPSFluidFrictionFunctor > NL3D::CIsotropicForceT< CPSTurbulForceFunc > NL3D::CPSForceIntensityHelper NL3D::CPSZoneCylinder NL3D::CPSZoneDisc NL3D::CPSZonePlane NL3D::CPSZoneRectangle NL3D::CPSZoneSphere

Detailed Description

This class is a located bindable that can focus on several target Can be inherited by bindable like forces or collision zones

Definition at line 1064 of file ps_located.h.

Public Member Functions

virtual void attachTarget (CPSLocated *ptr)
 ***************************************************************************************

virtual void basisChanged (TPSMatrixMode systemBasis)
virtual bool completeBBox (NLMISC::CAABBox &box) const
NLMISC::CVector computeI (void) const
NLMISC::CVector computeJ (void) const
NLMISC::CVector computeK (void) const
void detachTarget (CPSLocated *ptr)
virtual bool doesProduceBBox (void) const
virtual void enumTexs (std::vector< NLMISC::CSmartPtr< ITexture > > &dest, IDriver &drv)
virtual void finalize (void)
 ***************************************************************************************

virtual std::string getClassName ()=0
IDriver * getDriver () const
 shortcut to get an instance of the driver

uint32 getExternID (void) const
 get the extern ID of this located bindable

const CFontGenerator * getFontGenerator (void) const
 Shortcut to get the font generator if one was set (const version).

CFontGenerator * getFontGenerator (void)
 Shortcut to get the font generator if one was set.

const CFontManager * getFontManager (void) const
 Shortcut to get the font manager if one was set (const version).

CFontManager * getFontManager (void)
 ***************************************************************************************

const NLMISC::CMatrix & getInvertedSysMat (void) const
 shortcut to get the inverted matrix of the system

const NLMISC::CMatrix & getInvertedViewMat (void) const
 shortcut to get the inverted view matrix

const NLMISC::CMatrix & getLocalToWorldMatrix () const
 Shortcut to get the local to world matrix.

TPSLod getLOD (void) const
 get the valid lods for that object

std::string getName (void) const
 get the located bindable name (edition purpose)

uint32 getNbTargets (void) const
 return the number of targets

const CPSLocated * getOwner (void) const
 get the located that owns this bindable (const version)

CPSLocated * getOwner (void)
 get the located that owns this bindable

virtual uint32 getPriority (void) const=0
const NLMISC::CMatrix & getSysMat (void) const
 ***************************************************************************************

const CPSLocated * getTarget (uint32 index) const
 Return a const ptr on a target. Invalid range -> nlassert.

CPSLocated * getTarget (uint32 index)
 Return a ptr on a target. Invalid range -> nlassert.

virtual uint32 getType (void) const=0
virtual bool getUserMatrixUsageCount () const
const NLMISC::CMatrix & getViewMat (void) const
 shortcut to get the view matrix

virtual bool hasEmitters (void) const
 tells wether there are alive emitters

virtual bool hasParticles (void) const
 tells wether there are alive entities / particles

bool isActive () const
virtual void motionTypeChanged (bool parametric)
 called when a located has switch between incrmental / parametric motion. The default does nothing

virtual void releaseAllRef ()
 ***************************************************************************************

virtual void releaseRefTo (const CParticleSystemProcess *other)
 ***************************************************************************************

virtual void releaseTargetRsc (CPSLocated *target)
void serial (NLMISC::IStream &f) throw (NLMISC::EStream)
 ***************************************************************************************

void setActive (bool active)
 Activate / Deactivate this object. When not active, the owning system won't try to call the 'step' method.

void setExternID (uint32 id)
 ***************************************************************************************

void setLOD (TPSLod lod)
void setName (const std::string &name)
 set the located bindable name (edition purpose)

void setupDriverModelMatrix (void)
 shortcut to setup the model matrix (system basis or world basis)

virtual void setZBias (float value)
virtual void step (TPSProcessPass pass, TAnimationTime ellapsedTime, TAnimationTime realEt)=0
 process one pass for this bindable

virtual void systemDateChanged ()
virtual ~CPSTargetLocatedBindable ()
 ***************************************************************************************


Protected Types

typedef CPSVector< CPSLocated
* >::V 		TTargetCont

Protected Member Functions

virtual void bounceOccured (uint32 index)
virtual void deleteElement (uint32 index)=0
void displayIcon2d (const NLMISC::CVector tab[], uint nbSegs, float scale)
 ***************************************************************************************

virtual void newElement (CPSLocated *emitterLocated, uint32 emitterIndex)=0
virtual void notifyTargetRemoved (CPSLocated *ptr)
 ***************************************************************************************

virtual void resize (uint32 size)=0
virtual void setOwner (CPSLocated *psl)
 ***************************************************************************************


Protected Attributes

bool _Active
uint32 _ExternID
TPSLod _LOD
 tells when this object must be dealt with

std::string _Name
CPSLocated * _Owner
TTargetCont _Targets

Friends

class CPSLocated

Member Typedef Documentation

typedef CPSVector<CPSLocated *>::V NL3D::CPSTargetLocatedBindable::TTargetCont [protected]
 

Definition at line 1122 of file ps_located.h.

Constructor & Destructor Documentation

NL3D::CPSTargetLocatedBindable::~CPSTargetLocatedBindable (   )  [virtual]
 

***************************************************************************************

Definition at line 2251 of file ps_located.cpp.

References _Targets. 

02252 {       
02253         // we unregister to all the targets
02254         for (TTargetCont::iterator it = _Targets.begin(); it != _Targets.end(); ++it)
02255         {               
02256                 (*it)->unregisterDtorObserver(this);
02257         }
02258 }

Member Function Documentation

void NL3D::CPSTargetLocatedBindable::attachTarget (  CPSLocated *  ptr  )  [virtual]
 

***************************************************************************************

Add a new type of located for this to apply on. nlassert if already present. You should only call this if this object and the target are already inserted in a system. By overriding this and calling the CPSTargetLocatedBindable version, you can also send some notificiation to the object that's being attached.

Reimplemented in NL3D::CPSForce, and NL3D::CPSZone.

Definition at line 2202 of file ps_located.cpp.

References _Targets, NL3D::CParticleSystemProcess::getOwner(), nlassert, and NL3D::CPSLocated::registerDtorObserver(). 

02203 {
02204 
02205         // a target can't be shared between different particle systems
02206         #ifdef NL_DEBUG
02207         if (_Owner)
02208         {
02209                 nlassert(_Owner->getOwner() == ptr->getOwner());
02210         }
02211         #endif
02212 
02213         // see wether this target has not been registered before 
02214         nlassert(std::find(_Targets.begin(), _Targets.end(), ptr) == _Targets.end());
02215         _Targets.push_back(ptr);
02216 
02217         // we register us to be notified when the target disappear
02218         ptr->registerDtorObserver(this);
02219 }

virtual void NL3D::CPSLocatedBindable::basisChanged (  TPSMatrixMode  systemBasis  )  [inline, virtual, inherited]
 

Called when the basis of the owner changed. the default behaviour does nothing

Parameters:
newBasis : True if in the system basis, false for the world basis.

Reimplemented in NL3D::CPSForce.

Definition at line 968 of file ps_located.h. 

00968 {}

virtual void NL3D::CPSLocatedBindable::bounceOccured (  uint32  index  )  [inline, protected, virtual, inherited]
 

a bounce occured, so some action could be done. The default behaviour does nothing

Parameters:
index the index of the element that bounced

Reimplemented in NL3D::CPSEmitter.

Definition at line 1011 of file ps_located.h.

References index, and uint32. 

01011 {}

virtual bool NL3D::CPSLocatedBindable::completeBBox (  NLMISC::CAABBox &  box  )  const [inline, virtual, inherited]
 

Reimplemented in NL3D::CPSFanLight, NL3D::CPSQuad, and NL3D::CPSShockWave.

Definition at line 884 of file ps_located.h. 

00884 { return false ;}

NLMISC::CVector NL3D::CPSLocatedBindable::computeI (  void   )  const [inline, inherited]
 

Compute a vector that will map to (1 0 0) after view and model transform. This allow to have object that always faces the user, whatever basis they are in

Definition at line 931 of file ps_located.h.

References NL3D::CPSLocated::computeI().

Referenced by NL3D::CPSLocatedBindable::displayIcon2d(), NL3D::CPSFanLightHelper::drawFanLight(), NL3D::CPSFaceLookAtHelper::drawLookAt(), NL3D::CPSFaceLookAtHelper::drawLookAtAlignOnMotion(), NL3D::CPSGravity::show(), and NL3D::CPSEmitter::showTool(). 

00931 { return _Owner->computeI(); }

NLMISC::CVector NL3D::CPSLocatedBindable::computeJ (  void   )  const [inline, inherited]
 

Compute a vector that will map to (0 1 0) after view and model transform. This allow to have object that always faces the user, whatever basis they are in

Definition at line 936 of file ps_located.h.

References NL3D::CPSLocated::computeJ().

Referenced by NL3D::CPSFaceLookAtHelper::drawLookAt(). 

00936 { return _Owner->computeJ(); }

NLMISC::CVector NL3D::CPSLocatedBindable::computeK (  void   )  const [inline, inherited]
 

Compute a vector that will map to (0 0 1) after view and model transform. This allow to have object that always faces the user, whatever basis they are in

Definition at line 940 of file ps_located.h.

References NL3D::CPSLocated::computeK().

Referenced by NL3D::CPSLocatedBindable::displayIcon2d(), NL3D::CPSFanLightHelper::drawFanLight(), NL3D::CPSFaceLookAtHelper::drawLookAt(), NL3D::CPSFaceLookAtHelper::drawLookAtAlignOnMotion(), and NL3D::CPSEmitter::showTool(). 

00940 { return _Owner->computeK(); }

virtual void NL3D::CPSLocatedBindable::deleteElement (  uint32  index  )  [protected, pure virtual, inherited]
 

Delete an element given its index Attributes of the located that hold this bindable (pos etc...) are still accessible for the given index. index out of range -> nl_assert

Implemented in NL3D::CPSDot, NL3D::CPSEmitter, NL3D::CPSEmitterDirectionnal, NL3D::CPSEmitterOmni, NL3D::CPSEmitterRectangle, NL3D::CPSSphericalEmitter, NL3D::CPSFace, NL3D::CPSFaceLookAt, NL3D::CPSFanLight, NL3D::CPSForce, NL3D::CPSForceIntensityHelper, NL3D::CIsotropicForceT< T >, NL3D::CPSFluidFriction, NL3D::CPSBrownianForce, NL3D::CPSTurbul, NL3D::CPSCylindricVortex, NL3D::CPSLight, NL3D::CPSMesh, NL3D::CPSConstraintMesh, NL3D::CPSParticle, NL3D::CPSQuad, NL3D::CPSRibbon, NL3D::CPSRibbonBase, NL3D::CPSRibbonLookAt, NL3D::CPSShockWave, NL3D::CPSSound, NL3D::CPSTailDot, NL3D::CPSZonePlane, NL3D::CPSZoneSphere, NL3D::CPSZoneDisc, NL3D::CPSZoneCylinder, NL3D::CPSZoneRectangle, NL3D::CIsotropicForceT< CPSTurbulForceFunc >, and NL3D::CIsotropicForceT< CPSFluidFrictionFunctor >.

Referenced by NL3D::CPSLocatedBindable::setOwner().

void NL3D::CPSTargetLocatedBindable::detachTarget (  CPSLocated *  ptr  )  [inline]
 

remove a target

See also:
attachTarget

Definition at line 1076 of file ps_located.h.

References notifyTargetRemoved(). 

01077         {
01078                 notifyTargetRemoved(ptr);
01079         }

void NL3D::CPSLocatedBindable::displayIcon2d (  const NLMISC::CVector  tab[],
uint  nbSegs,
float  scale
)  [protected, inherited]
 

***************************************************************************************

show an drawing to represent the object, and in red if it is selected

Parameters:
tab : a table of 2 * nbSeg vector. only the x and y coordinates are used
nbSeg : the number of segment
scale : the scale to use for drawing

Definition at line 2038 of file ps_located.cpp.

References NL3D::CPSLocatedBindable::computeI(), NL3D::CPSLocatedBindable::computeK(), NL3D::CParticleSystem::getCurrentEditedElement(), NL3D::CPSLocatedBindable::getDriver(), NL3D::CParticleSystemProcess::getOwner(), NL3D::CPSLocated::getPos(), NL3D::CPSLocated::getSize(), index, NL3D::CMaterial::setBlend(), NL3D::CMaterial::setBlendFunc(), NL3D::CMaterial::setColor(), NL3D::CMaterial::setLighting(), NL3D::CPSLocatedBindable::setupDriverModelMatrix(), NL3D::CMaterial::setZFunc(), NL3D::CMaterial::setZWrite(), size, uint, uint32, NLMISC::CLine::V0, NLMISC::CLine::V1, NLMISC::CVector::x, and NLMISC::CVector::y.

Referenced by NL3D::CPSSpring::show(), NL3D::CPSCentralGravity::show(), and NL3D::CPSParticle::showTool(). 

02039 {
02040         uint32 size = _Owner->getSize();
02041         if (!size) return;              
02042         setupDriverModelMatrix();       
02043 
02044         const CVector I = computeI();
02045         const CVector K = computeK();
02046 
02047         static std::vector<NLMISC::CLine> lines;
02048         
02049         lines.clear();
02050 
02051         // ugly slow code, but not for runtime
02052         for (uint  k = 0; k < size; ++k)
02053         {
02054                 // center of the current particle
02055                 const CVector p = _Owner->getPos()[k];
02056                 
02057                 
02058 
02059                 for (uint l = 0; l < nbSegs; ++l)
02060                 {
02061                         NLMISC::CLine li;
02062                         li.V0 = p + scale * (tab[l << 1].x * I + tab[l << 1].y * K);
02063                         li.V1 = p + scale * (tab[(l << 1) + 1].x * I + tab[(l << 1) + 1].y * K);
02064                         lines.push_back(li);
02065                 }
02066         
02067                 CMaterial mat;
02068 
02069                 mat.setBlendFunc(CMaterial::one, CMaterial::one);
02070                 mat.setZWrite(false);
02071                 mat.setLighting(false);
02072                 mat.setBlend(true);
02073                 mat.setZFunc(CMaterial::less);
02074                 
02075         
02076 
02077                 CPSLocated *loc;
02078                 uint32 index;           
02079                 CPSLocatedBindable *lb;
02080                 _Owner->getOwner()->getCurrentEditedElement(loc, index, lb);
02081         
02082                 mat.setColor((lb == NULL || this == lb) && loc == _Owner && index == k  ? CRGBA::Red : CRGBA(127, 127, 127));
02083                 
02084 
02085                 CDRU::drawLinesUnlit(lines, mat, *getDriver() );
02086         }
02087 
02088 }

virtual bool NL3D::CPSLocatedBindable::doesProduceBBox (  void   )  const [inline, virtual, inherited]
 

Reimplemented in NL3D::CPSForce.

Definition at line 888 of file ps_located.h. 

00888 { return true; }

virtual void NL3D::CPSLocatedBindable::enumTexs (  std::vector< NLMISC::CSmartPtr< ITexture > > &  dest,
IDriver &  drv
)  [inline, virtual, inherited]
 

Reimplemented in NL3D::CPSFanLight, NL3D::CPSQuad, NL3D::CPSRibbon, NL3D::CPSRibbonLookAt, and NL3D::CPSShockWave.

Definition at line 977 of file ps_located.h. 

00977 {}

void NL3D::CPSTargetLocatedBindable::finalize (  void   )  [virtual]
 

***************************************************************************************

Release the collisionInfos we've querried. We can't do it in the dtor, as calls to releaseTargetRsc wouldn't be polymorphics for derived class! And the behaviour of releaseTergetRsc is implemented in derived class

Reimplemented from NL3D::CPSLocatedBindable.

Definition at line 2238 of file ps_located.cpp.

References _Targets, and releaseTargetRsc(). 

02239 {       
02243         for (TTargetCont::iterator it = _Targets.begin(); it != _Targets.end(); ++it)
02244         {               
02245                 releaseTargetRsc(*it);
02246         }
02247         CPSLocatedBindable::finalize(); 
02248 }

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().

IDriver* NL3D::CPSLocatedBindable::getDriver (  void   )  const [inline, inherited]
 

shortcut to get an instance of the driver

Definition at line 890 of file ps_located.h.

References NL3D::CPSLocated::getDriver(), and nlassert.

Referenced by NL3D::CPSLocatedBindable::displayIcon2d(), NL3D::CPSTailDot::displayRibbons(), NL3D::CPSRibbonLookAt::displayRibbons(), NL3D::CPSRibbon::displayRibbons(), NL3D::CPSDot::draw(), NL3D::CPSFaceHelper::drawFaces(), NL3D::CPSFanLightHelper::drawFanLight(), NL3D::CPSFaceLookAtHelper::drawLookAt(), NL3D::CPSFaceLookAtHelper::drawLookAtAlignOnMotion(), NL3D::CPSConstraintMeshHelper::drawMeshs(), NL3D::CPSConstraintMeshHelper::drawPrerotatedMeshs(), NL3D::CPSZoneRectangle::show(), NL3D::CPSZoneCylinder::show(), NL3D::CPSZoneDisc::show(), NL3D::CPSZoneSphere::show(), NL3D::CPSZonePlane::show(), NL3D::CPSLight::show(), NL3D::CPSCylindricVortex::show(), NL3D::CPSGravity::show(), NL3D::CPSDirectionnalForce::show(), NL3D::CPSSphericalEmitter::showTool(), NL3D::CPSEmitterRectangle::showTool(), and NL3D::CPSEmitter::showTool(). 

00891          { 
00892                  nlassert(_Owner);
00893                  nlassert(_Owner->getDriver());
00894                  return _Owner->getDriver();
00895          }

uint32 NL3D::CPSLocatedBindable::getExternID (  void   )  const [inline, inherited]
 

get the extern ID of this located bindable

Definition at line 964 of file ps_located.h.

References NL3D::CPSLocatedBindable::_ExternID, and uint32.

Referenced by NL3D::CPSLocated::bind(), and NL3D::CParticleSystem::unregisterLocatedBindableExternID(). 

00964 { return _ExternID; }

const CFontGenerator* NL3D::CPSLocatedBindable::getFontGenerator (  void   )  const [inline, inherited]
 

Shortcut to get the font generator if one was set (const version).

Definition at line 904 of file ps_located.h.

References NL3D::CParticleSystemProcess::getFontGenerator(), and nlassert. 

00905          {
00906                 nlassert(_Owner);
00907                 return _Owner->getFontGenerator();
00908          }

CFontGenerator* NL3D::CPSLocatedBindable::getFontGenerator (  void   )  [inline, inherited]
 

Shortcut to get the font generator if one was set.

Definition at line 897 of file ps_located.h.

References NL3D::CParticleSystemProcess::getFontGenerator(), and nlassert.

Referenced by NL3D::CPSZoneRectangle::show(), NL3D::CPSZoneCylinder::show(), NL3D::CPSZoneDisc::show(), NL3D::CPSZonePlane::show(), NL3D::CPSCylindricVortex::show(), NL3D::CPSGravity::show(), and NL3D::CPSEmitterRectangle::showTool(). 

00898          {
00899                 nlassert(_Owner);
00900                 return _Owner->getFontGenerator();
00901          }

const CFontManager * NL3D::CPSLocatedBindable::getFontManager (  void   )  const [inherited]
 

Shortcut to get the font manager if one was set (const version).

Definition at line 2099 of file ps_located.cpp.

References NL3D::CParticleSystemProcess::getFontManager(), and nlassert. 

02100 {
02101         nlassert(_Owner);
02102         return _Owner->getFontManager();
02103 }

CFontManager * NL3D::CPSLocatedBindable::getFontManager (  void   )  [inherited]
 

***************************************************************************************

Definition at line 2091 of file ps_located.cpp.

References NL3D::CParticleSystemProcess::getFontManager(), and nlassert.

Referenced by NL3D::CPSZoneRectangle::show(), NL3D::CPSZoneCylinder::show(), NL3D::CPSZoneDisc::show(), NL3D::CPSZonePlane::show(), NL3D::CPSCylindricVortex::show(), NL3D::CPSGravity::show(), and NL3D::CPSEmitterRectangle::showTool(). 

02092 {
02093         nlassert(_Owner);
02094         return _Owner->getFontManager();
02095 }

const NLMISC::CMatrix & NL3D::CPSLocatedBindable::getInvertedSysMat (  void   )  const [inherited]
 

shortcut to get the inverted matrix of the system

Definition at line 2116 of file ps_located.cpp.

References NL3D::CParticleSystem::getInvertedSysMat(), NL3D::CParticleSystemProcess::getOwner(), and nlassert. 

02117 {
02118         nlassert(_Owner);
02119                 return _Owner->getOwner()->getInvertedSysMat();
02120 
02121 }

const NLMISC::CMatrix & NL3D::CPSLocatedBindable::getInvertedViewMat (  void   )  const [inherited]
 

shortcut to get the inverted view matrix

Definition at line 2134 of file ps_located.cpp.

References NL3D::CParticleSystem::getInvertedViewMat(), NL3D::CParticleSystemProcess::getOwner(), and nlassert. 

02135 {
02136         nlassert(_Owner);
02137         return _Owner->getOwner()->getInvertedViewMat();        
02138 }

const NLMISC::CMatrix & NL3D::CPSLocatedBindable::getLocalToWorldMatrix (   )  const [inline, inherited]
 

Shortcut to get the local to world matrix.

Definition at line 1144 of file ps_located.h.

References NL3D::CPSLocated::getLocalToWorldMatrix(), and nlassert.

Referenced by NL3D::CPSRibbonLookAt::displayRibbons(), NL3D::CPSSound::newElement(), NL3D::CPSZoneRectangle::show(), NL3D::CPSZoneCylinder::show(), NL3D::CPSZoneDisc::show(), NL3D::CPSZonePlane::show(), NL3D::CPSLight::show(), NL3D::CPSGravity::show(), NL3D::CPSEmitterRectangle::showTool(), NL3D::CPSLight::step(), and NL3D::CPSMesh::updatePos(). 

01145 {
01146         nlassert(_Owner);
01147         return _Owner->getLocalToWorldMatrix();
01148 }

TPSLod NL3D::CPSLocatedBindable::getLOD (  void   )  const [inline, inherited]
 

get the valid lods for that object

Definition at line 954 of file ps_located.h.

References NL3D::CPSLocatedBindable::_LOD, and NL3D::TPSLod. 

00954 { return _LOD; }

std::string NL3D::CPSLocatedBindable::getName (  void   )  const [inline, inherited]
 

get the located bindable name (edition purpose)

Definition at line 948 of file ps_located.h. 

00948 { return _Name; }

uint32 NL3D::CPSTargetLocatedBindable::getNbTargets (  void   )  const [inline]
 

return the number of targets

Definition at line 1091 of file ps_located.h.

References _Targets, and uint32.

Referenced by NL3D::CParticleSystem::getTargeters(). 

01091 { return _Targets.size(); }

const CPSLocated* NL3D::CPSLocatedBindable::getOwner (  void   )  const [inline, inherited]
 

get the located that owns this bindable (const version)

Definition at line 944 of file ps_located.h. 

00944 { return _Owner; }

CPSLocated* NL3D::CPSLocatedBindable::getOwner (  void   )  [inline, inherited]
 

get the located that owns this bindable

Definition at line 942 of file ps_located.h.

Referenced by NL3D::CPSLocated::deleteElement(), NL3D::CParticleSystemInstanceUser::emit(), NL3D::CPSFaceLookAt::CSecondSize::getSizeOwner(), NL3D::CPSSound::newElement(), NL3D::CPSLocated::registerIntegrableForce(), NL3D::CParticleSystem::registerLocatedBindableExternID(), NL3D::CParticleSystemInstanceUser::removeByID(), NL3D::CPSSound::resize(), NL3D::CPSLight::resize(), NL3D::CPSSound::step(), NL3D::CPSLocated::unregisterIntegrableForce(), and NL3D::CParticleSystem::unregisterLocatedBindableExternID(). 

00942 { return _Owner; }

virtual uint32 NL3D::CPSLocatedBindable::getPriority (  void   )  const [pure virtual, inherited]
 

Get the priority of the bindable The more high it is, the earlier it is dealt with

Implemented in NL3D::CPSEmitter, NL3D::CPSForce, NL3D::CPSLight, NL3D::CPSParticle, NL3D::CPSSound, and NL3D::CPSZone.

Referenced by NL3D::operator<().

const NLMISC::CMatrix & NL3D::CPSLocatedBindable::getSysMat (  void   )  const [inherited]
 

***************************************************************************************

Definition at line 2108 of file ps_located.cpp.

References NL3D::CParticleSystemProcess::getOwner(), NL3D::CParticleSystem::getSysMat(), and nlassert. 

02109 {
02110         nlassert(_Owner);               
02111         return _Owner->getOwner()->getSysMat();
02112 }

const CPSLocated* NL3D::CPSTargetLocatedBindable::getTarget (  uint32  index  )  const [inline]
 

Return a const ptr on a target. Invalid range -> nlassert.

Definition at line 1099 of file ps_located.h.

References _Targets, index, nlassert, and uint32. 

01100         {
01101                 nlassert(index < _Targets.size());
01102                 return _Targets[index];
01103         }

CPSLocated* NL3D::CPSTargetLocatedBindable::getTarget (  uint32  index  )  [inline]
 

Return a ptr on a target. Invalid range -> nlassert.

Definition at line 1093 of file ps_located.h.

References _Targets, index, nlassert, and uint32.

Referenced by NL3D::CParticleSystem::getTargeters(). 

01094         {
01095                 nlassert(index < _Targets.size());
01096                 return _Targets[index];
01097         }

virtual uint32 NL3D::CPSLocatedBindable::getType (  void   )  const [pure virtual, inherited]
 

Gives the type for this bindable. types are encoded as constant uint32

Implemented in NL3D::CPSEmitter, NL3D::CPSForce, NL3D::CPSLight, NL3D::CPSParticle, NL3D::CPSSound, and NL3D::CPSZone.

Referenced by NL3D::CParticleSystem::activateEmitters(), NL3D::CPSLocated::deleteElement(), NL3D::CParticleSystemInstanceUser::emit(), NL3D::CParticleSystem::evalDuration(), NL3D::CParticleSystem::getCurrNumParticles(), NL3D::CParticleSystem::getMaxNumParticles(), NL3D::CParticleSystem::hasActiveEmitters(), NL3D::CParticleSystem::hasEmittersTemplates(), NL3D::CParticleSystem::hasLightableObjects(), NL3D::CParticleSystem::hasOpaqueObjects(), NL3D::CParticleSystem::hasTransparentObjects(), NL3D::CParticleSystem::reactivateSound(), and NL3D::CParticleSystem::stopSound().

virtual bool NL3D::CPSLocatedBindable::getUserMatrixUsageCount (   )  const [inline, virtual, inherited]
 

Reimplemented in NL3D::CPSEmitter.

Definition at line 974 of file ps_located.h.

Referenced by NL3D::CPSLocatedBindable::finalize(), and NL3D::CPSLocatedBindable::setOwner(). 

00974 { return 0; }

const NLMISC::CMatrix & NL3D::CPSLocatedBindable::getViewMat (  void   )  const [inherited]
 

shortcut to get the view matrix

Definition at line 2125 of file ps_located.cpp.

References NL3D::CParticleSystemProcess::getOwner(), NL3D::CParticleSystem::getViewMat(), and nlassert.

Referenced by NL3D::CPSRibbonLookAt::displayRibbons(), and NL3D::CPSFaceLookAtHelper::drawLookAt(). 

02126 {
02127         nlassert(_Owner);
02128         return _Owner->getOwner()->getViewMat();        
02129 }

virtual bool NL3D::CPSLocatedBindable::hasEmitters (  void   )  const [inline, virtual, inherited]
 

tells wether there are alive emitters

Definition at line 958 of file ps_located.h. 

00958 { return false; }

virtual bool NL3D::CPSLocatedBindable::hasParticles (  void   )  const [inline, virtual, inherited]
 

tells wether there are alive entities / particles

Reimplemented in NL3D::CPSParticle.

Definition at line 956 of file ps_located.h. 

00956 { return false; }

bool NL3D::CPSLocatedBindable::isActive (   )  const [inline, inherited]
 

Definition at line 844 of file ps_located.h.

References NL3D::CPSLocatedBindable::_Active.

Referenced by NL3D::CParticleSystem::hasActiveEmitters(). 

00844 { return _Active; }

virtual void NL3D::CPSLocatedBindable::motionTypeChanged (  bool  parametric  )  [inline, virtual, inherited]
 

called when a located has switch between incrmental / parametric motion. The default does nothing

Reimplemented in NL3D::CPSRibbonBase.

Definition at line 971 of file ps_located.h.

Referenced by NL3D::CPSLocated::bind(). 

00971 {}

virtual void NL3D::CPSLocatedBindable::newElement (  CPSLocated *  emitterLocated,
uint32  emitterIndex
)  [protected, pure virtual, inherited]
 

Generate a new element for this bindable. They are generated according to the propertie of the class

Implemented in NL3D::CPSDot, NL3D::CPSEmitter, NL3D::CPSEmitterDirectionnal, NL3D::CPSEmitterOmni, NL3D::CPSEmitterRectangle, NL3D::CPSSphericalEmitter, NL3D::CPSFace, NL3D::CPSFaceLookAt, NL3D::CPSFanLight, NL3D::CPSForce, NL3D::CPSForceIntensityHelper, NL3D::CIsotropicForceT< T >, NL3D::CPSFluidFriction, NL3D::CPSBrownianForce, NL3D::CPSTurbul, NL3D::CPSCylindricVortex, NL3D::CPSLight, NL3D::CPSMesh, NL3D::CPSConstraintMesh, NL3D::CPSParticle, NL3D::CPSQuad, NL3D::CPSRibbon, NL3D::CPSRibbonBase, NL3D::CPSRibbonLookAt, NL3D::CPSShockWave, NL3D::CPSSound, NL3D::CPSTailDot, NL3D::CPSZonePlane, NL3D::CPSZoneSphere, NL3D::CPSZoneDisc, NL3D::CPSZoneCylinder, NL3D::CPSZoneRectangle, NL3D::CIsotropicForceT< CPSTurbulForceFunc >, and NL3D::CIsotropicForceT< CPSFluidFrictionFunctor >.

Referenced by NL3D::CPSLocated::bind().

void NL3D::CPSTargetLocatedBindable::notifyTargetRemoved (  CPSLocated *  ptr  )  [protected, virtual]
 

***************************************************************************************

Inherited from CPSLocatedBindable. A target has been remove If not present -> assert This also call releaseTargetRsc for clean up

Reimplemented from NL3D::CPSLocatedBindable.

Definition at line 2223 of file ps_located.cpp.

References _Targets, nlassert, and releaseTargetRsc().

Referenced by detachTarget(). 

02224 {       
02225         TTargetCont::iterator it = std::find(_Targets.begin(), _Targets.end(), ptr);
02226         nlassert(it != _Targets.end());
02227         releaseTargetRsc(*it);  
02228         _Targets.erase(it);
02229 
02230         CPSLocatedBindable::notifyTargetRemoved(ptr);   
02231 }

void NL3D::CPSTargetLocatedBindable::releaseAllRef (   )  [virtual]
 

***************************************************************************************

From CPSLocatedBindable Release any reference this obj may have to other process of the system For example, this is used when detaching a located bindable from a system.

Reimplemented from NL3D::CPSLocatedBindable.

Definition at line 2272 of file ps_located.cpp.

References _Targets, and releaseTargetRsc(). 

02273 {
02274         for (TTargetCont::iterator it = _Targets.begin(); it != _Targets.end(); ++it)
02275         {
02276                 releaseTargetRsc(*it);
02277                 (*it)->unregisterDtorObserver(this);            
02278         }
02279         _Targets.clear();
02280         CPSLocatedBindable::releaseAllRef();
02281 }

void NL3D::CPSTargetLocatedBindable::releaseRefTo (  const CParticleSystemProcess *  other  )  [virtual]
 

***************************************************************************************

From CPSLocatedBindable. Release any reference this obj may have on the given process. For example, this is used when detaching a located of a system.

Reimplemented from NL3D::CPSLocatedBindable.

Definition at line 2261 of file ps_located.cpp.

References _Targets, nlassert, and releaseTargetRsc(). 

02262 {
02263         TTargetCont::iterator it = std::find(_Targets.begin(), _Targets.end(), other);
02264         if (it == _Targets.end()) return;
02265         releaseTargetRsc(*it);
02266         (*it)->unregisterDtorObserver(this);
02267         _Targets.erase(it);
02268         nlassert(std::find(_Targets.begin(), _Targets.end(), other) == _Targets.end());
02269 }

virtual void NL3D::CPSTargetLocatedBindable::releaseTargetRsc (  CPSLocated *  target  )  [inline, virtual]
 

it is called when a target is destroyed or detached Override this if you allocated resources from the target (to release them) NOTE : as objects are no polymorphic while being destroyed, this class can't call your releaseTargetRsc override in its destructor, it does it in its finalize method, which is called by the particle system

Reimplemented in NL3D::CPSForce, and NL3D::CPSZone.

Definition at line 1110 of file ps_located.h.

Referenced by finalize(), notifyTargetRemoved(), releaseAllRef(), and releaseRefTo(). 

01110 {};

virtual void NL3D::CPSLocatedBindable::resize (  uint32  size  )  [protected, pure virtual, inherited]
 

Resize the bindable attributes containers should not be called directly. Call CPSLocated::resize instead

Implemented in NL3D::CPSDot, NL3D::CPSEmitter, NL3D::CPSEmitterDirectionnal, NL3D::CPSEmitterOmni, NL3D::CPSEmitterRectangle, NL3D::CPSSphericalEmitter, NL3D::CPSFace, NL3D::CPSFaceLookAt, NL3D::CPSFanLight, NL3D::CPSForce, NL3D::CPSForceIntensityHelper, NL3D::CIsotropicForceT< T >, NL3D::CPSFluidFriction, NL3D::CPSBrownianForce, NL3D::CPSTurbul, NL3D::CPSCylindricVortex, NL3D::CPSLight, NL3D::CPSMesh, NL3D::CPSConstraintMesh, NL3D::CPSParticle, NL3D::CPSQuad, NL3D::CPSRibbon, NL3D::CPSRibbonBase, NL3D::CPSRibbonLookAt, NL3D::CPSShockWave, NL3D::CPSSound, NL3D::CPSTailDot, NL3D::CPSZonePlane, NL3D::CPSZoneSphere, NL3D::CPSZoneDisc, NL3D::CPSZoneCylinder, NL3D::CPSZoneRectangle, NL3D::CIsotropicForceT< CPSTurbulForceFunc >, and NL3D::CIsotropicForceT< CPSFluidFrictionFunctor >.

Referenced by NL3D::CPSLocated::bind().

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

***************************************************************************************

Reimplemented from NL3D::CPSLocatedBindable.

Reimplemented in NL3D::CPSForce, NL3D::CPSForceIntensityHelper, NL3D::CIsotropicForceT< T >, NL3D::CPSDirectionnalForce, NL3D::CPSGravity, NL3D::CPSCentralGravity, NL3D::CPSSpring, NL3D::CPSCylindricVortex, NL3D::CPSMagneticForce, NL3D::CPSZone, NL3D::CPSZonePlane, NL3D::CPSZoneSphere, NL3D::CPSZoneDisc, NL3D::CPSZoneCylinder, NL3D::CPSZoneRectangle, NL3D::CIsotropicForceT< CPSTurbulForceFunc >, and NL3D::CIsotropicForceT< CPSFluidFrictionFunctor >.

Definition at line 2183 of file ps_located.cpp. 

02184 {
02185         (void)f.serialVersion(1);       
02186         f.serialPtr(_Owner);
02187         f.serial(_Name);
02188         if (f.isReading())
02189         {
02190                 // delete previous attached bindables...
02191                 for (TTargetCont::iterator it = _Targets.begin(); it != _Targets.end(); ++it)
02192                 {
02193                         delete (*it);
02194                 }
02195                 _Targets.clear();               
02196         }
02197         f.serialContPolyPtr(_Targets);  
02198 }

void NL3D::CPSLocatedBindable::setActive (  bool  active  )  [inline, inherited]
 

Activate / Deactivate this object. When not active, the owning system won't try to call the 'step' method.

Definition at line 843 of file ps_located.h.

References NL3D::CPSLocatedBindable::_Active.

Referenced by NL3D::CParticleSystem::activateEmitters(), and NL3D::CParticleSystemInstanceUser::setActive(). 

00843 { _Active = active; }

void NL3D::CPSLocatedBindable::setExternID (  uint32  id  )  [inherited]
 

***************************************************************************************

set the extern ID of this located bindable. 0 means no extern access. The map of ID-locatedBindable. Is in th particle system, so this located bindable must have been attached to a particle system, otherwise an assertion is raised

Definition at line 2149 of file ps_located.cpp.

References NL3D::CPSLocatedBindable::_ExternID, NL3D::CParticleSystemProcess::getOwner(), NL3D::CParticleSystem::registerLocatedBindableExternID(), uint32, and NL3D::CParticleSystem::unregisterLocatedBindableExternID(). 

02150 {
02151         if (id == _ExternID) return;
02152         CParticleSystem *ps = NULL;
02153         if (_Owner && _Owner->getOwner())
02154         {
02155                 ps = _Owner->getOwner();
02156         }       
02157         if (ps) 
02158         {
02159                 ps->unregisterLocatedBindableExternID(this);
02160                 _ExternID = 0;          
02161         }
02162         if (id != 0)
02163         {       
02164                 if (ps) ps->registerLocatedBindableExternID(id, this);
02165                 _ExternID = id;
02166         }       
02167 }

void NL3D::CPSLocatedBindable::setLOD (  TPSLod  lod  )  [inline, inherited]
 

set the LODs that apply to that object (warning : it is based on the position of the system, and don't act on a per instance basis ...) To have per instance precision, you must use an attribute maker that has LOD as its input

Definition at line 952 of file ps_located.h.

References NL3D::CPSLocatedBindable::_LOD. 

00952 { _LOD = lod; }

void NL3D::CPSLocatedBindable::setName (  const std::string &  name  )  [inline, inherited]
 

set the located bindable name (edition purpose)

Definition at line 946 of file ps_located.h. 

00946 { _Name = name; }

void NL3D::CPSLocatedBindable::setOwner (  CPSLocated *  psl  )  [protected, virtual, inherited]
 

***************************************************************************************

Reimplemented in NL3D::CPSEmitter.

Definition at line 1948 of file ps_located.cpp.

References NL3D::CParticleSystem::addRefForUserSysCoordInfo(), NL3D::CPSLocatedBindable::deleteElement(), NL3D::CParticleSystemProcess::getOwner(), NL3D::CPSLocated::getSize(), NL3D::CPSLocatedBindable::getUserMatrixUsageCount(), NL3D::CPSLocatedBindable::releaseAllRef(), NL3D::CParticleSystem::releaseRefForUserSysCoordInfo(), and uint.

Referenced by NL3D::CPSLocated::bind(), and NL3D::CPSLocated::unbind(). 

01949 { 
01950         if (psl == _Owner) return;
01951         if (psl == NULL)
01952         {
01953                 releaseAllRef();
01954                 if (_Owner)
01955                 {
01956                         // empty this located bindable. Need to be empty if it must be rebound to another located.
01957                         for (uint k = 0; k < _Owner->getSize(); ++k)
01958                         {
01959                                 deleteElement(0);
01960                         }
01961                 }                               
01962         }       
01963         if (_Owner && _Owner->getOwner())
01964         {
01965                 _Owner->getOwner()->releaseRefForUserSysCoordInfo(getUserMatrixUsageCount());
01966         }
01967         _Owner = psl;
01968         if (_Owner && _Owner->getOwner())
01969         {
01970                 _Owner->getOwner()->addRefForUserSysCoordInfo(getUserMatrixUsageCount());
01971         } 
01972 }

void NL3D::CPSLocatedBindable::setupDriverModelMatrix (  void   )  [inherited]
 

shortcut to setup the model matrix (system basis or world basis)

Definition at line 2142 of file ps_located.cpp.

References nlassert, and NL3D::CPSLocated::setupDriverModelMatrix().

Referenced by NL3D::CPSLocatedBindable::displayIcon2d(), NL3D::CPSTailDot::displayRibbons(), NL3D::CPSRibbonLookAt::displayRibbons(), NL3D::CPSRibbon::displayRibbons(), NL3D::CPSDot::draw(), NL3D::CPSFaceHelper::drawFaces(), NL3D::CPSFanLightHelper::drawFanLight(), NL3D::CPSFaceLookAtHelper::drawLookAt(), NL3D::CPSFaceLookAtHelper::drawLookAtAlignOnMotion(), NL3D::CPSConstraintMeshHelper::drawMeshs(), NL3D::CPSConstraintMeshHelper::drawPrerotatedMeshs(), NL3D::CPSZoneRectangle::show(), NL3D::CPSZoneCylinder::show(), NL3D::CPSZoneDisc::show(), NL3D::CPSZoneSphere::show(), NL3D::CPSZonePlane::show(), NL3D::CPSCylindricVortex::show(), NL3D::CPSDirectionnalForce::show(), NL3D::CPSSphericalEmitter::showTool(), NL3D::CPSEmitterRectangle::showTool(), and NL3D::CPSEmitter::showTool(). 

02143 {
02144         nlassert(_Owner);
02145         _Owner->setupDriverModelMatrix();
02146 }

virtual void NL3D::CPSLocatedBindable::setZBias (  float  value  )  [inline, virtual, inherited]
 

Reimplemented in NL3D::CPSDot, NL3D::CPSFanLight, NL3D::CPSMesh, NL3D::CPSConstraintMesh, NL3D::CPSParticle, NL3D::CPSQuad, NL3D::CPSRibbon, NL3D::CPSRibbonLookAt, NL3D::CPSShockWave, and NL3D::CPSTailDot.

Definition at line 980 of file ps_located.h.

References value. 

00980 {}

virtual void NL3D::CPSLocatedBindable::step (  TPSProcessPass  pass,
TAnimationTime  ellapsedTime,
TAnimationTime  realEt
)  [pure virtual, inherited]
 

process one pass for this bindable

Implemented in NL3D::CPSEmitter, NL3D::CPSFace, NL3D::CPSForce, NL3D::CPSLight, NL3D::CPSMesh, NL3D::CPSConstraintMesh, NL3D::CPSParticle, NL3D::CPSRibbon, NL3D::CPSRibbonLookAt, NL3D::CPSSound, NL3D::CPSTailDot, and NL3D::CPSZone.

virtual void NL3D::CPSLocatedBindable::systemDateChanged (   )  [inline, virtual, inherited]
 

PRIVATE USE : called by the system when its date has been manually changed. This his usually for object that expect time to be always increasing, so that they can reset their datas

Reimplemented in NL3D::CPSRibbonBase.

Definition at line 1038 of file ps_located.h. 

01038 {}

Friends And Related Function Documentation

friend class CPSLocated [friend, inherited]
 

Reimplemented in NL3D::CPSForce.

Definition at line 986 of file ps_located.h.

Field Documentation

bool NL3D::CPSLocatedBindable::_Active [protected, inherited]
 

Definition at line 1033 of file ps_located.h.

Referenced by NL3D::CPSLocatedBindable::isActive(), and NL3D::CPSLocatedBindable::setActive().

uint32 NL3D::CPSLocatedBindable::_ExternID [protected, inherited]
 

Definition at line 1027 of file ps_located.h.

Referenced by NL3D::CPSLocatedBindable::getExternID(), NL3D::CPSLocatedBindable::setExternID(), and NL3D::CPSLocatedBindable::~CPSLocatedBindable().

TPSLod NL3D::CPSLocatedBindable::_LOD [protected, inherited]
 

tells when this object must be dealt with

Definition at line 1029 of file ps_located.h.

Referenced by NL3D::CPSLocatedBindable::getLOD(), and NL3D::CPSLocatedBindable::setLOD().

std::string NL3D::CPSLocatedBindable::_Name [protected, inherited]
 

Definition at line 1031 of file ps_located.h.

CPSLocated* NL3D::CPSLocatedBindable::_Owner [protected, inherited]
 

Definition at line 1026 of file ps_located.h.

Referenced by NL3D::CPSFaceHelper::drawFaces(), NL3D::CPSFanLightHelper::drawFanLight(), NL3D::CPSFaceLookAtHelper::drawLookAt(), NL3D::CPSFaceLookAtHelper::drawLookAtAlignOnMotion(), NL3D::CPSConstraintMeshHelper::drawMeshs(), and NL3D::CPSConstraintMeshHelper::drawPrerotatedMeshs().

TTargetCont NL3D::CPSTargetLocatedBindable::_Targets [protected]
 

Definition at line 1123 of file ps_located.h.

Referenced by attachTarget(), finalize(), getNbTargets(), getTarget(), notifyTargetRemoved(), releaseAllRef(), releaseRefTo(), and ~CPSTargetLocatedBindable().

The documentation for this class was generated from the following files:
Generated on Tue Mar 16 07:28:21 2004 for NeL by doxygen 1.3.6