Brunot
Loading...
Searching...
No Matches
sys::ParticleManager Class Reference

system to store, render, and manage particles. More...

#include <ParticleManager.h>

Inheritance diagram for sys::ParticleManager:
[legend]
Collaboration diagram for sys::ParticleManager:
[legend]

Public Member Functions

 ParticleManager ()
 ~ParticleManager () override=default
 ParticleManager (const ParticleManager &other)=default
 ParticleManager (ParticleManager &&other) noexcept
auto operator= (const ParticleManager &other) -> ParticleManager &
auto operator= (ParticleManager &&other) noexcept -> ParticleManager &=default
auto clone () const -> std::unique_ptr< GameObject > override
 makes a copy a GameObject even if it's held polymorphically
auto onUpdate (float dt) -> void override
 called once every frame.
auto endWindow () -> void override
 currently unused, but intended to but was assumed to be necessary for a proper ImGui editor
auto onRender () -> void override
 called every frame after update has been called for every object.
auto load (const Stream &stream) -> void override
 Implementations will load the state of a GameObject from a th::Json Object.
auto save (Stream &stream) const -> void override
 Implementations will load the state of a GameObject to a th::Json object.
auto addBlock (std::shared_ptr< ParticleBlock > newBlock) -> void
 gives ParticleManager a new particleBlock to keep track of
auto showParticleSpreadsheet () -> void
 draw the particle spreadsheet menu
Public Member Functions inherited from System
auto showMenu () -> void override
 Called before update each frame, for calling ImGui editor code relevant to the gameObject.
auto getKey () const -> Key override
 Generates a unique Key that corresponds to the GameObject.
auto getParent () const -> GameObject *override
 Gets the parent of a GameObject.
Public Member Functions inherited from GameObject
 GameObject (std::string typeName, gobj::Type parentType, gobj::Type type)
 constructor for gameobject.
virtual ~GameObject ()
 destructor for GameObject.
 GameObject (const GameObject &other)
 Copy Constructor.
auto operator= (const GameObject &other) -> GameObject &
 copy assignment operator
 GameObject (GameObject &&other) noexcept
 Move constructor.
auto operator= (GameObject &&other) noexcept -> GameObject &
 Move assignment operator.
virtual auto update (float dt) -> void
 called once every frame.
virtual auto render () -> void
 called every frame after update has been called for every object.
virtual auto destroy () -> void
 Marks an GameObject to be destroyed.
virtual auto onEnterEngine () -> void
 hook that is called when a GameObject enters the Engine tree.
virtual auto onSceneStart (const std::string &sceneName) -> void
 Hook that is called before the first frame a scene is run, but after the entire scene is loaded into the engine To receive the hook, simply override the function in your class.
virtual auto onSceneExit (const std::string &sceneName) -> void
 Hook that is called right before a scene is unloaded To receive the hook, simply override the function in your class.
virtual auto for_each (std::function< void(GameObject &)> func) -> void
 applies a function to every child.
virtual auto for_each (std::function< void(const GameObject &)> func) const -> void
 applies a const function to every child.
virtual auto parentTo (GameObject *newParent) -> bool
 Sets the GameObject as a child of another GameObject.
auto getInternalParent () const -> GameObject *
 returns the actual owning parent of the GameObject
virtual auto addChild (std::unique_ptr< GameObject > newChild) -> bool
 Adds a child to a GameObject.
auto destroyed () const -> bool
auto getUUID () const -> gobj::UUID
auto isUUID (gobj::UUID compareUUID) const -> bool
auto getName () const -> const std::string &
 Gets the type of the object as a string.
auto getNickname () const -> const std::string &
 Gets the nickname (custom, writable name) of a GameObject.
auto getFormattedName () const -> const std::string &
 combines a GameObjects Type, Nickname, and UUID into one string, for use with logging.
auto nameEquals (const std::string &compareString) const -> bool
 check whether a GameObjects typeName is equivilent to a given string.
auto isType (gobj::Type otherType) const -> bool
 check whether the GameObject is the same as a given type.
auto getObjectType () const -> gobj::Type
 gets the internal type of the GameObject, as an enum
auto setNickname (const std::string &newNickname) -> void
 sets the GameObjects nickname.
auto updates () const -> bool
auto renders () const -> bool
auto receivesMessages () const -> bool
auto isActive () const -> bool
virtual auto setShouldUpdate (bool _shouldUpdate) -> void
 set whether the GameObject should update every frame, and whether all of it's children should update every frame
virtual auto setShouldRender (bool _shouldRender) -> void
 set whether the GameObject should render every frame, and whether all of it's children should render every frame
virtual auto setShouldReceiveMessages (bool _shouldReceiveMessages) -> void
 set whether the GameObject should Receive Messags, and whether all of it's children should receive messages
auto setActive (bool shouldBeActive) -> void
 set the GameObject should update, render, and receive messages

Static Public Member Functions

static auto getEnum () -> Type
 function required by all systems

Protected Member Functions

auto systemShowMenu () -> void override
 Specific systems should override this function to show their specific menu for the system.
Protected Member Functions inherited from System
 System (const std::string &typeName, Type systemType)
Protected Member Functions inherited from GameObject
auto setInternalParent (GameObject *parent) -> bool
 sets the internal parent of a GameObject directly, avoiding abstractions provided by ParentTo().
auto getGameObjectJson () const -> json
 Used for serializing GameObjects.
auto setGameObjectJson (const json &stream) -> void
 used for deserializing GameObjects
virtual auto getChildren () const -> std::shared_ptr< std::vector< GameObject * > >
 gets a vector of a GameObjects public (i.e.
auto checkAddToSceneHook () -> void
 Determine if the GameObject was recently added to the engine, and if it was, call onEngineEnter.

Private Attributes

std::vector< std::shared_ptr< ParticleBlock > > blocks

Additional Inherited Members

Public Types inherited from System
enum class  Type : unsigned short {
  system_error_type = 0 , newSystemStub = 100 , OpenGL = 200 , Input = 300 ,
  Editor = 400 , Messaging = 500 , Camera = 600 , Logging = 700 ,
  AudioSystem = 750 , Scoring = 800 , HandSystem = 900 , PlayerTurn = 950 ,
  Table = 960 , SceneManager = 1000 , Particles = 1050 , ActionList = 1100 ,
  DebugDraw = 1150 , ColliderSystem = 1300 , Options = 1400 , TestRunner = 64'000
}
Public Attributes inherited from GameObject
friend Entity
friend Node
friend ChildrenHandeler
friend Engine

Detailed Description

system to store, render, and manage particles.

Realistically just holds on to particleBlocks and calls update on them

The core of a Particle 's life is spent a ParticleBlock. These ParticleBlocks are updated by ParticleManager, but owned by ParticleEmitter. ParticleEmitter uses a ParticleGenerator to create Particle s to be put into the ParticleBlock. ParticleEmitters exist on Entities by putting a ParticleGenerator component on them

Constructor & Destructor Documentation

◆ ParticleManager() [1/3]

sys::ParticleManager::ParticleManager ( )
Here is the call graph for this function:
Here is the caller graph for this function:

◆ ~ParticleManager()

sys::ParticleManager::~ParticleManager ( )
overridedefault

◆ ParticleManager() [2/3]

sys::ParticleManager::ParticleManager ( const ParticleManager & other)
default
Here is the call graph for this function:

◆ ParticleManager() [3/3]

sys::ParticleManager::ParticleManager ( ParticleManager && other)
noexcept
Here is the call graph for this function:

Member Function Documentation

◆ addBlock()

auto sys::ParticleManager::addBlock ( std::shared_ptr< ParticleBlock > newBlock) ->void

gives ParticleManager a new particleBlock to keep track of

Parameters
newBlockblock to start keeping track of and updating

◆ clone()

auto sys::ParticleManager::clone ( ) const->std::unique_ptr< GameObject >
inlineoverridevirtual

makes a copy a GameObject even if it's held polymorphically

Warning
When overriding this function, make sure to set the parents object to this
Returns
a unique_ptr to a new stack allocated object that is a copy of the object

Implements GameObject.

Here is the call graph for this function:

◆ endWindow()

auto sys::ParticleManager::endWindow ( ) ->void
inlineoverridevirtual

currently unused, but intended to but was assumed to be necessary for a proper ImGui editor

Implements GameObject.

◆ getEnum()

auto sys::ParticleManager::getEnum ( ) ->Type
inlinestatic

function required by all systems

◆ load()

auto sys::ParticleManager::load ( const Stream & stream) ->void
overridevirtual

Implementations will load the state of a GameObject from a th::Json Object.

Unimplemented in GameObject

Parameters
streamth::Json Object

Implements GameObject.

◆ onRender()

auto sys::ParticleManager::onRender ( ) ->void
overridevirtual

called every frame after update has been called for every object.

Generally used for rendering an object to the screen, when applicable. Unimplemented in GameObject

Implements GameObject.

◆ onUpdate()

auto sys::ParticleManager::onUpdate ( float dt) ->void
overridevirtual

called once every frame.

Generally used for timers, movement, condition checks, etc. Unimplemented in GameObject

Parameters
dtthe time in seconds that has elapsed

Implements GameObject.

◆ operator=() [1/2]

auto sys::ParticleManager::operator= ( const ParticleManager & other) ->ParticleManager &
Here is the call graph for this function:

◆ operator=() [2/2]

auto sys::ParticleManager::operator= ( ParticleManager && other) ->ParticleManager &=default
defaultnoexcept
Here is the call graph for this function:

◆ save()

auto sys::ParticleManager::save ( Stream & stream) const->void
overridevirtual

Implementations will load the state of a GameObject to a th::Json object.

Unimplemented in GameObject

Parameters
streamth::Json Object

Implements GameObject.

◆ showParticleSpreadsheet()

auto sys::ParticleManager::showParticleSpreadsheet ( ) ->void

draw the particle spreadsheet menu

◆ systemShowMenu()

auto sys::ParticleManager::systemShowMenu ( ) ->void
overrideprotectedvirtual

Specific systems should override this function to show their specific menu for the system.

Reimplemented from System.

Member Data Documentation

◆ blocks

std::vector<std::shared_ptr<ParticleBlock> > sys::ParticleManager::blocks
private

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