Ndk::ParticleGroupComponent Class Reference

NDK class that represents the component for a group of particles. More...

Inherits Ndk::Component< ComponentType >, Nz::ParticleGroup, and Nz::HandledObject< T >.

Public Member Functions
	ParticleGroupComponent (unsigned int maxParticleCount, Nz::ParticleLayout layout)
	Constructs a ParticleGroupComponent object with a maximal number of particles and a layout. More...
	ParticleGroupComponent (unsigned int maxParticleCount, Nz::ParticleDeclarationConstRef declaration)
	Constructs a ParticleGroupComponent object with a maximal number of particles and a particle declaration. More...
	ParticleGroupComponent (const ParticleGroupComponent &)=default
void	AddEmitter (Entity *emitter)
	Adds an emitter to the particles. More...
void	RemoveEmitter (Entity *emitter)
	Removes an emitter to the particles. More...

Static Public Attributes
static ComponentIndex	componentIndex

Detailed Description

NDK class that represents the component for a group of particles.

Constructor & Destructor Documentation

ParticleGroupComponent() [1/2]

Ndk::ParticleGroupComponent::ParticleGroupComponent ( unsigned int  maxParticleCount, Nz::ParticleLayout  layout  )

inline

Constructs a ParticleGroupComponent object with a maximal number of particles and a layout.

Parameters

maxParticleCount	Maximum number of particles to generate
layout	Enumeration for the layout of data information for the particles

ParticleGroupComponent() [2/2]

Ndk::ParticleGroupComponent::ParticleGroupComponent ( unsigned int  maxParticleCount, Nz::ParticleDeclarationConstRef  declaration  )

inline

Constructs a ParticleGroupComponent object with a maximal number of particles and a particle declaration.

Parameters

maxParticleCount	Maximum number of particles to generate
declaration	Data information for the particles

Member Function Documentation

AddEmitter()

void Ndk::ParticleGroupComponent::AddEmitter ( Entity *  emitter )

inline

Adds an emitter to the particles.

Parameters

emitter

Emitter for the particles

Remarks

Produces a NazaraAssert if emitter is invalid

Produces a NazaraAssert if entity has no component of type ParticleEmitterComponent

RemoveEmitter()

void Ndk::ParticleGroupComponent::RemoveEmitter ( Entity *  emitter )

inline

Removes an emitter to the particles.

Parameters

emitter

Emitter for the particles to remove

Remarks

Produces a NazaraAssert if emitter is invalid

Produces a NazaraAssert if entity has no component of type ParticleEmitterComponent

---

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

• SDK/include/NDK/Components/ParticleGroupComponent.hpp
• SDK/include/NDK/Components/ParticleGroupComponent.inl
• SDK/src/NDK/Components/ParticleGroupComponent.cpp