Skylicht::Particle::CParticleBufferData Class Reference

ECS data structure holding particle groups for an entity. More...

#include <ParticleSystem/CParticleBufferData.h>

Inheritance diagram for Skylicht::Particle::CParticleBufferData:

Public Member Functions
void	clear ()
	Clears all groups and sub-groups.
CGroup *	createGroup ()
	Creates a new top-level particle group.
CGroup *	getGroupByName (const wchar_t *name)
	Finds a group by its name.
CSubGroup *	createSubGroup (CGroup *group)
	Creates a new sub-group attached to a parent group.
std::vector< CSubGroup * >	getSubGroup (CGroup *parent)
	Gets all sub-groups belonging to a specific parent.
void	removeGroup (CGroup *group)
	Removes and deletes a top-level group and its sub-groups.
void	removeSubGroup (CSubGroup *group)
	Removes and deletes a specific sub-group.
void	bringToNext (CGroup *group, CGroup *target, bool behind)
	Reorders a group within the Groups list.
void	updateListGroup ()
	Rebuilds the AllGroups flat list from Groups and SubGroups.
Public Member Functions inherited from Skylicht::IEntityData
virtual bool	serializable (CMemoryStream *stream)
virtual bool	deserializable (CMemoryStream *stream, int version)
virtual const char *	getTypeName ()
Public Member Functions inherited from Skylicht::IActivatorObject
virtual	~IActivatorObject ()
	Virtual destructor for polymorphic activator objects.

Public Attributes
core::array< CGroup * >	Groups
	List of top-level particle groups.
core::array< CSubGroup * >	SubGroups
	List of sub-particle groups (attached to parent groups).
core::array< CGroup * >	AllGroups
	Flat list of all particle groups (Groups + SubGroups).
Public Attributes inherited from Skylicht::IEntityData
int	EntityIndex
CEntity *	Entity

Detailed Description

ECS data structure holding particle groups for an entity.

This data is managed by CParticleComponent and processed by CParticleGroupSystem and CParticleRenderer.

Member Function Documentation

bringToNext()

void Skylicht::Particle::CParticleBufferData::bringToNext	(	CGroup *	group,
		CGroup *	target,
		bool	behind )

Reorders a group within the Groups list.

Parameters

group	The group to move.
target	The target group for positioning.
behind	If true, places it after the target; otherwise before.

createGroup()

CGroup * Skylicht::Particle::CParticleBufferData::createGroup

(

)

Creates a new top-level particle group.

Returns

Pointer to the new CGroup.

createSubGroup()

CSubGroup * Skylicht::Particle::CParticleBufferData::createSubGroup

(

CGroup *

group

)

Creates a new sub-group attached to a parent group.

Parameters

group

The parent group.

Returns

Pointer to the new CSubGroup.

getGroupByName()

CGroup * Skylicht::Particle::CParticleBufferData::getGroupByName

(

const wchar_t *

name

)

Finds a group by its name.

Parameters

name	The name of the group.

Returns

Pointer to CGroup if found, NULL otherwise.

getSubGroup()

std::vector< CSubGroup * > Skylicht::Particle::CParticleBufferData::getSubGroup

(

CGroup *

parent

)

Gets all sub-groups belonging to a specific parent.

Parameters

parent

The parent group.

Returns

Vector of CSubGroup pointers.

removeGroup()

void Skylicht::Particle::CParticleBufferData::removeGroup

(

CGroup *

group

)

Removes and deletes a top-level group and its sub-groups.

Parameters

group

The group to remove.

removeSubGroup()

void Skylicht::Particle::CParticleBufferData::removeSubGroup

(

CSubGroup *

group

)

Removes and deletes a specific sub-group.

Parameters

group

The sub-group to remove.

---

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

• ParticleSystem/CParticleBufferData.h