C4ParticleSystem Class Reference

#include <C4Particles.h>

Collaboration diagram for C4ParticleSystem:

Public Member Functions
	C4ParticleSystem ()
	~C4ParticleSystem ()
void	CalculateNextStep ()
void	Clear ()
void	DrawGlobalParticles (C4TargetFacet cgo)
C4ParticleList *	GetGlobalParticles ()
C4ParticleList *	GetNewParticleList (C4Object *forTarget=nullptr)
void	ReleaseParticleList (C4ParticleList *first, C4ParticleList *second=nullptr)
GLuint	GetIBO (size_t forParticleAmount)
void	Create (C4ParticleDef *of_def, C4ParticleValueProvider &x, C4ParticleValueProvider &y, C4ParticleValueProvider &speedX, C4ParticleValueProvider &speedY, C4ParticleValueProvider &lifetime, C4PropList *properties, int amount=1, C4Object *object=nullptr)
void	ClearAllParticles ()

Public Attributes
C4ParticleSystemDefinitionList	definitions

Friends
class	CalculationThread
class	C4ParticleList

Detailed Description

Definition at line 444 of file C4Particles.h.

Constructor & Destructor Documentation

C4ParticleSystem()

C4ParticleSystem::C4ParticleSystem

(

)

Definition at line 1259 of file C4Particles.cpp.

                                   : frameCounterAdvancedEvent(false)
{
    currentSimulationTime = 0;
    globalParticles = 0;
    ibo = 0;
    ibo_size = 0;
}

~C4ParticleSystem()

C4ParticleSystem::~C4ParticleSystem

(

)

Definition at line 1267 of file C4Particles.cpp.

{
    Clear();
 
    calculationThread.SignalStop();
    CalculateNextStep();
}

References CalculateNextStep(), and Clear().

Here is the call graph for this function:

Member Function Documentation

CalculateNextStep()

void C4ParticleSystem::CalculateNextStep ( )

inline

Definition at line 481 of file C4Particles.h.

    {
#ifndef USE_CONSOLE
        frameCounterAdvancedEvent.Set();
#endif
    }

References CStdEvent::Set().

Referenced by C4Game::Execute(), and ~C4ParticleSystem().

Here is the call graph for this function:

Here is the caller graph for this function:

Clear()

void C4ParticleSystem::Clear

(

)

Definition at line 1477 of file C4Particles.cpp.

{
#ifndef USE_CONSOLE
    if (ibo != 0) glDeleteBuffers(1, &ibo);
    ibo = 0; ibo_size = 0;
 
    currentSimulationTime = 0;
    ClearAllParticles();
#endif
    // clear definitions even in console mode
    definitions.Clear();
}

References C4ParticleSystemDefinitionList::Clear(), ClearAllParticles(), and definitions.

Referenced by C4Game::Clear(), and ~C4ParticleSystem().

Here is the call graph for this function:

Here is the caller graph for this function:

ClearAllParticles()

void C4ParticleSystem::ClearAllParticles

(

)

Definition at line 1490 of file C4Particles.cpp.

{
#ifndef USE_CONSOLE
    particleListAccessMutex.Enter();
    particleLists.clear();
    particleListAccessMutex.Leave();
#endif
}

References CStdCSec::Enter(), and CStdCSec::Leave().

Referenced by Clear(), C4Game::LoadScenarioSection(), and C4Game::ReloadParticle().

Here is the call graph for this function:

Here is the caller graph for this function:

Create()

void C4ParticleSystem::Create	(	C4ParticleDef *	of_def,
		C4ParticleValueProvider &	x,
		C4ParticleValueProvider &	y,
		C4ParticleValueProvider &	speedX,
		C4ParticleValueProvider &	speedY,
		C4ParticleValueProvider &	lifetime,
		C4PropList *	properties,
		int	amount = 1,
		C4Object *	object = nullptr
	)

Definition at line 1339 of file C4Particles.cpp.

{
    // todo: check amount etc
 
    C4ParticleList * pxList(0);
 
 
    // initialize the particle properties
    // this is done here, because it would also be the right place to implement caching
    C4ParticleProperties particleProperties;
    particleProperties.Set(properties);
 
    speedX.Floatify(10.f);
    speedY.Floatify(10.f);
 
    // position offset that will be added to the particle
    float xoff(0.f), yoff(0.f);
    
    // offset only for the drawing position - this is needed so that particles relative to an object work correctly
    float drawingOffsetX(0.f), drawingOffsetY(0.f);
 
    if (object != 0)
    {
        // for all types of particles add object's offset (mainly for collision etc.)
        xoff = object->GetX();
        yoff = object->GetY();
 
        if (particleProperties.attachment & C4ATTACH_MoveRelative)
        {
            drawingOffsetX = -xoff;
            drawingOffsetY = -yoff;
 
            // move relative implies that the particle needs to be in the object's particle list (back OR front)
            // just select the front particles here - will be overwritten below if necessary
            if (!(particleProperties.attachment & C4ATTACH_Front) && !(particleProperties.attachment & C4ATTACH_Back))
                particleProperties.attachment |= C4ATTACH_Front;
        }
 
        // figure out particle list to use
        if (particleProperties.attachment & C4ATTACH_Front) 
        {
            if (!object->FrontParticles) object->FrontParticles = GetNewParticleList(object);
            pxList = object->FrontParticles;
        }
        else if (particleProperties.attachment & C4ATTACH_Back)
        {
            if (!object->BackParticles) object->BackParticles = GetNewParticleList(object);
            pxList = object->BackParticles;
        }
    }
 
    // no assigned list implies that we are going to use the global particles
    if (!pxList)
    {
        if (!globalParticles) globalParticles = GetNewParticleList();
        pxList = globalParticles;
    }
 
    // It is necessary to lock the particle list, because we will have it create a particle first that we are going to modify.
    // Inbetween creation of the particle and modification, the particle list's calculations should not be executed
    // (this could f.e. lead to the particle being removed before it was fully instantiated).
    pxList->Lock();
 
    // retrieve the fitting chunk for the particle (note that we tell the particle list, we already locked it)
    C4ParticleChunk *chunk = pxList->GetFittingParticleChunk(of_def, particleProperties.blitMode, particleProperties.attachment, true);
    
    // set up chunk to be able to contain enough particles
    chunk->ReserveSpace(static_cast<uint32_t>(amount));
 
    while (amount--)
    {   
        // create a particle in the fitting chunk (note that we tell the particle list, we already locked it)
        C4Particle *particle = chunk->AddNewParticle();
 
        // initialize some more properties
        particle->properties = particleProperties;
        // this will adjust the initial values of the (possibly cached) particle properties
        particle->properties.Floatify();
 
        // setup some more non-property attributes of the particle
        // The particle having lifetime == startingLifetime will force all random values to alway-reevaluate.
        // Thus we need to guarantee that even before setting the lifetime (to allow a PV_Random for the lifetime).
        particle->lifetime = particle->startingLifetime = 0.0f;
        const float lifetime_value = lifetime.GetValue(particle);
        // Negative values are not allowed (would crash later); using a value of 0 is most likely visible to the scripter.
        if (lifetime_value >= 0.0f)
            particle->lifetime = particle->startingLifetime = lifetime_value;
 
        particle->currentSpeedX = speedX.GetValue(particle);
        particle->currentSpeedY = speedY.GetValue(particle);
        particle->drawingData.aspect = of_def->Aspect;
        particle->drawingData.SetOffset(drawingOffsetX, drawingOffsetY);
        particle->SetPosition(x.GetValue(particle) + xoff, y.GetValue(particle) + yoff);
        particle->drawingData.SetColor(particle->properties.colorR.GetValue(particle), particle->properties.colorG.GetValue(particle), particle->properties.colorB.GetValue(particle), particle->properties.colorAlpha.GetValue(particle));
        particle->drawingData.SetPhase((int)(particle->properties.phase.GetValue(particle) + 0.5f), of_def);
    }
 
    pxList->Unlock();
}

References C4ParticleChunk::AddNewParticle(), C4ParticleDef::Aspect, C4Particle::DrawingData::aspect, C4ParticleProperties::attachment, C4Object::BackParticles, C4ParticleProperties::blitMode, C4ATTACH_Back, C4ATTACH_Front, C4ATTACH_MoveRelative, C4ParticleProperties::colorAlpha, C4ParticleProperties::colorB, C4ParticleProperties::colorG, C4ParticleProperties::colorR, C4Particle::currentSpeedX, C4Particle::currentSpeedY, C4Particle::drawingData, C4ParticleProperties::Floatify(), C4ParticleValueProvider::Floatify(), C4Object::FrontParticles, C4ParticleList::GetFittingParticleChunk(), GetNewParticleList(), C4ParticleValueProvider::GetValue(), C4Particle::lifetime, C4ParticleList::Lock(), C4ParticleProperties::phase, C4Particle::properties, C4ParticleChunk::ReserveSpace(), C4ParticleProperties::Set(), C4Particle::DrawingData::SetColor(), C4Particle::DrawingData::SetOffset(), C4Particle::DrawingData::SetPhase(), C4Particle::SetPosition(), C4Particle::startingLifetime, and C4ParticleList::Unlock().

Here is the call graph for this function:

DrawGlobalParticles()

void C4ParticleSystem::DrawGlobalParticles ( C4TargetFacet  cgo )

inline

Definition at line 489 of file C4Particles.h.

    {
#ifndef USE_CONSOLE
        if (globalParticles) globalParticles->Draw(cgo, nullptr);
#endif
    } 

References C4ParticleList::Draw().

Referenced by C4Viewport::Draw().

Here is the call graph for this function:

Here is the caller graph for this function:

GetGlobalParticles()

C4ParticleList* C4ParticleSystem::GetGlobalParticles ( )

inline

Definition at line 496 of file C4Particles.h.

    {
#ifndef USE_CONSOLE
        return globalParticles;
#else
        return nullptr;
#endif
    }

GetIBO()

GLuint C4ParticleSystem::GetIBO

(

size_t

forParticleAmount

)

Definition at line 1439 of file C4Particles.cpp.

{
    PreparePrimitiveRestartIndices(forParticleAmount);
    return ibo;
}

Referenced by C4ParticleChunk::Draw().

Here is the caller graph for this function:

GetNewParticleList()

C4ParticleList * C4ParticleSystem::GetNewParticleList

(

C4Object *

forTarget = nullptr

)

Definition at line 1300 of file C4Particles.cpp.

{
#ifdef USE_CONSOLE
    return 0;
#else
    C4ParticleList *newList = 0;
 
    particleListAccessMutex.Enter();
    particleLists.emplace_back(forObject);
    newList = &particleLists.back();
    particleListAccessMutex.Leave();
 
    return newList;
#endif
}

References CStdCSec::Enter(), and CStdCSec::Leave().

Referenced by Create().

Here is the call graph for this function:

Here is the caller graph for this function:

ReleaseParticleList()

void C4ParticleSystem::ReleaseParticleList	(	C4ParticleList *	first,
		C4ParticleList *	second = nullptr
	)

Definition at line 1316 of file C4Particles.cpp.

{
#ifndef USE_CONSOLE
    particleListAccessMutex.Enter();
 
    for(std::list<C4ParticleList>::iterator iter = particleLists.begin(); iter != particleLists.end();)
    {
        C4ParticleList *list = &(*iter);
        if (list == first || list == second)
        {
            iter = particleLists.erase(iter);
        }
        else
        {
            ++iter;
        }
    }
 
    particleListAccessMutex.Leave();
#endif
}

References CStdCSec::Enter(), and CStdCSec::Leave().

Referenced by C4Object::ClearParticleLists().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

C4ParticleList

friend class C4ParticleList

friend

Definition at line 525 of file C4Particles.h.

CalculationThread

friend class CalculationThread

friend

Definition at line 454 of file C4Particles.h.

Member Data Documentation

definitions

C4ParticleSystemDefinitionList C4ParticleSystem::definitions

Definition at line 510 of file C4Particles.h.

Referenced by C4ParticleDef::C4ParticleDef(), Clear(), C4ParticleDef::Load(), C4Game::ReloadParticle(), and C4ParticleDef::~C4ParticleDef().

---

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

• C4Particles.h
• C4Particles.cpp