ParticleData.h

Go to the documentation of this file.

/*
   Copyright (c) 2018 DIVIDE-Studio
   Copyright (c) 2009 Ionut Cava
 
   This file is part of DIVIDE Framework.
 
   Permission is hereby granted, free of charge, to any person obtaining a copy
   of this software
   and associated documentation files (the "Software"), to deal in the Software
   without restriction,
   including without limitation the rights to use, copy, modify, merge, publish,
   distribute, sublicense,
   and/or sell copies of the Software, and to permit persons to whom the
   Software is furnished to do so,
   subject to the following conditions:
 
   The above copyright notice and this permission notice shall be included in
   all copies or substantial portions of the Software.
 
   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
   IMPLIED,
   INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
   PARTICULAR PURPOSE AND NONINFRINGEMENT.
   IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
   DAMAGES OR OTHER LIABILITY,
   WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
   IN CONNECTION WITH THE SOFTWARE
   OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 */
 
#pragma once
#ifndef DVD_PARTICLE_DATA_H_
#define DVD_PARTICLE_DATA_H_
 
#include "Graphs/Headers/SceneNode.h"
 
namespace Divide {
 
class GFXDevice;
 
enum class ParticleDataProperties : U8
{
    PROPERTIES_POS = toBit(1),
    PROPERTIES_VEL = toBit(2),
    PROPERTIES_ACC = toBit(3),
    PROPERTIES_COLOR = toBit(4),
    PROPERTIES_COLOR_TRANS = toBit(5),
    COUNT = 5
};
 
namespace Names {
    static const char* particleDataProperties[] = {
          "Position", "Velocity", "Acceleration", "Colour", "Colour transform", "UNKNOWN"
    };
}
 
class ParticleData {
   public:
    static constexpr U32 g_threadPartitionSize = 256;
 
    vector<std::pair<U32, F32>> _indices;
    vector<vec4<F32>> _renderingPositions;
    vector<UColour4>  _renderingColours;
    vector<vec4<F32>> _position;
    vector<vec4<F32>> _velocity;
    vector<vec4<F32>> _acceleration;
    vector<vec4<F32>> _misc;
    vector<FColour4> _colour;
    vector<FColour4> _startColour;
    vector<FColour4> _endColour;
    string _textureFileName;
 
 
    void setParticleGeometry(const vector<vec3<F32>>& particleGeometryVertices,
                             const vector<U32>& particleGeometryIndices,
                             PrimitiveTopology particleGeometryType);
 
    void setBillboarded(bool state) noexcept;
 
    [[nodiscard]] PrimitiveTopology particleGeometryType() const noexcept {
        return _particleGeometryType;
    }
 
    [[nodiscard]] const vector<vec3<F32>>& particleGeometryVertices() const noexcept {
        return _particleGeometryVertices;
    }
 
    [[nodiscard]] const vector<U32>& particleGeometryIndices() const noexcept {
        return _particleGeometryIndices;
    }
 
    [[nodiscard]] bool isBillboarded() const noexcept {
        return _isBillboarded;
    }
 
    PROPERTY_RW(U32, optionsMask, 0u);
   public:
    explicit ParticleData(GFXDevice& context, U32 particleCount, U32 optionsMask);
    ~ParticleData();
 
    void generateParticles(U32 particleCount, U32 optionsMask);
    void kill(U32 index);
    void wake(U32 index);
    void swapData(U32 indexA, U32 indexB);
 
    [[nodiscard]] U32 aliveCount() const noexcept { return _aliveCount; }
    [[nodiscard]] U32 totalCount() const noexcept { return _totalCount; }
    
    void sort();
 
   protected:
    U32 _totalCount = 0u;
    U32 _aliveCount = 0u;
 
    bool _isBillboarded = true;
    vector<vec3<F32>> _particleGeometryVertices;
    vector<U32> _particleGeometryIndices;
    PrimitiveTopology _particleGeometryType = PrimitiveTopology::COUNT;
 
    GFXDevice& _context;
};
 
}  // namespace Divide
 
#endif //DVD_PARTICLE_DATA_H_