castor3d::Particle Class Reference

#include <Particle.hpp>

Public Member Functions
C3D_API	Particle (ParticleDeclaration const &description, castor::StrStrMap const &defaultValues)
	Constructor. More...
C3D_API	Particle (ParticleDeclaration const &description)
	Constructor. More...
C3D_API	Particle (Particle const &rhs)
	Copy constructor. More...
C3D_API	Particle (Particle &&rhs) noexcept
	Move constructor. More...
C3D_API Particle &	operator= (Particle const &rhs)
	Copy assignment operator. More...
C3D_API Particle &	operator= (Particle &&rhs) noexcept
	Move assignment operator. More...
template<ParticleFormat Type>
void	setValue (uint32_t index, typename ElementTyper< Type >::Type const &value)
	Sets the particle variable's value at given index. More...
template<ParticleFormat Type>
ElementTyper< Type >::Type	getValue (uint32_t index) const
	Sets the particle variable's value at given index. More...
uint8_t const *	getData () const
uint8_t *	getData ()

Constructor & Destructor Documentation

Particle() [1/4]

C3D_API castor3d::Particle::Particle	(	ParticleDeclaration const &	description,
		castor::StrStrMap const &	defaultValues
	)

Constructor.

Parameters

[in]	description	The particle's elements description.
[in]	defaultValues	The default values for the particle's elements.

Particle() [2/4]

C3D_API castor3d::Particle::Particle ( ParticleDeclaration const &  description )

explicit

Constructor.

Parameters

[in]

description

The particle's elements description.

Particle() [3/4]

C3D_API castor3d::Particle::Particle

(

Particle const &

rhs

)

Copy constructor.

Parameters

[in]

rhs

The object to copy.

Particle() [4/4]

C3D_API castor3d::Particle::Particle ( Particle &&  rhs )

noexcept

Move constructor.

Parameters

[in]

rhs

The object to move.

Member Function Documentation

getData() [1/2]

uint8_t * castor3d::Particle::getData ( )

inline

Returns

The particle data.

getData() [2/2]

uint8_t const * castor3d::Particle::getData ( ) const

inline

Returns

The particle data.

getValue()

template<ParticleFormat Type>

ElementTyper< Type >::Type castor3d::Particle::getValue ( uint32_t  index ) const

inline

Sets the particle variable's value at given index.

Parameters

[in]

index

The variable index.

Returns

The variable value.

operator=() [1/2]

C3D_API Particle & castor3d::Particle::operator= ( Particle &&  rhs )

noexcept

Move assignment operator.

Parameters

[in]

rhs

The object to move.

operator=() [2/2]

C3D_API Particle & castor3d::Particle::operator=

(

Particle const &

rhs

)

Copy assignment operator.

Parameters

[in]

rhs

The object to copy.

setValue()

template<ParticleFormat Type>

void castor3d::Particle::setValue ( uint32_t  index, typename ElementTyper< Type >::Type const &  value  )

inline

Sets the particle variable's value at given index.

Parameters

[in]	index	The variable index.
[in]	value	The variable value.

---

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

• Scene/ParticleSystem/Particle.hpp