nvidia::apex::EmitterGeomExplicit Class Reference

Explicit geometry. Coordinates of each particle are given explicitly. More...

#include <EmitterGeoms.h>

Inheritance diagram for nvidia::apex::EmitterGeomExplicit:

List of all members.

Classes
struct	EllipsoidParams
	Ellipsoid parameters. More...
struct	PointListData
	Structure contains positions, velocities and user data for particles. More...
struct	PointParams
	Point parameters. More...
struct	SphereParams
	Sphere prameters. More...
Public Member Functions
virtual void	resetParticleList ()=0
	Remove all shapes.
virtual void	addParticleList (uint32_t count, const PointParams *params, const PxVec3 *velocities=0)=0
	Add particles to geometry to be emitted.
virtual void	addParticleList (uint32_t count, const PxVec3 *positions, const PxVec3 *velocities=0)=0
	Add particles to geometry to be emitted.
virtual void	addParticleList (uint32_t count, const PointListData &data)=0
	Add particles to geometry to be emitted.
virtual void	addSphereList (uint32_t count, const SphereParams *params, const PxVec3 *velocities=0)=0
	Add spheres to geometry to be emitted.
virtual void	addEllipsoidList (uint32_t count, const EllipsoidParams *params, const PxVec3 *velocities=0)=0
	Add ellipsoids to geometry to be emitted.
virtual void	getParticleList (const PointParams *&params, uint32_t &numPoints, const PxVec3 *&velocities, uint32_t &numVelocities) const =0
	Access particles list.
virtual void	getSphereList (const SphereParams *&params, uint32_t &numSpheres, const PxVec3 *&velocities, uint32_t &numVelocities) const =0
	Access spheres list.
virtual void	getEllipsoidList (const EllipsoidParams *&params, uint32_t &numEllipsoids, const PxVec3 *&velocities, uint32_t &numVelocities) const =0
	Access ellipsoids list.
virtual uint32_t	getParticleCount () const =0
	Get the number of points.
virtual PxVec3	getParticlePos (uint32_t index) const =0
	Get the position of point.
virtual uint32_t	getSphereCount () const =0
	Get the number of spheres.
virtual PxVec3	getSphereCenter (uint32_t index) const =0
	Get the center of the sphere.
virtual float	getSphereRadius (uint32_t index) const =0
	Get the radius of the sphere.
virtual uint32_t	getEllipsoidCount () const =0
	Get the number of ellipsoids.
virtual PxVec3	getEllipsoidCenter (uint32_t index) const =0
	Get the center of the ellipsoid.
virtual float	getEllipsoidRadius (uint32_t index) const =0
	Get the radius of the ellipsoid.
virtual PxVec3	getEllipsoidNormal (uint32_t index) const =0
	Get the normal of the ellipsoid.
virtual float	getEllipsoidPolarRadius (uint32_t index) const =0
	Get the polar radius of the ellipsoid.
virtual float	getDistance () const =0
	Get average distance between particles.

---

Detailed Description

Explicit geometry. Coordinates of each particle are given explicitly.

---

Member Function Documentation

virtual void nvidia::apex::EmitterGeomExplicit::addEllipsoidList	(	uint32_t	count,
		const EllipsoidParams *	params,
		const PxVec3 *	velocities = 0
	)		[pure virtual]

Add ellipsoids to geometry to be emitted.

Parameters:

[in]	count	- number of ellipsoids being added by this call
[in]	params	- ellipsoids parameters
[in]	velocities	if NULL, the geometry's velocity list will be padded with zero velocities and the asset's velocityRange will be used for velocity

See also:

EmitterGeomExplicit::EellipsoidParams

virtual void nvidia::apex::EmitterGeomExplicit::addParticleList	(	uint32_t	count,
		const PointListData &	data
	)		[pure virtual]

Add particles to geometry to be emitted.

Parameters:

[in]	count	- number of particles being added by this call
[in]	data	- particles data

See also:

EmitterGeomExplicit::PointListData

virtual void nvidia::apex::EmitterGeomExplicit::addParticleList	(	uint32_t	count,
		const PointParams *	params,
		const PxVec3 *	velocities = 0
	)		[pure virtual]

Add particles to geometry to be emitted.

Parameters:

[in]	count	- number of particles being added by this call
[in]	params	must be specified. When emitted, these relative positions are added to emitter actor position
[in]	velocities	if NULL, the geometry's velocity list will be padded with zero velocities and the asset's velocityRange will be used for velocity

virtual void nvidia::apex::EmitterGeomExplicit::addParticleList	(	uint32_t	count,
		const PxVec3 *	positions,
		const PxVec3 *	velocities = 0
	)		[pure virtual]

Add particles to geometry to be emitted.

Parameters:

[in]	count	- number of particles being added by this call
[in]	positions	must be specified. When emitted, these relative positions are added to emitter actor position
[in]	velocities	if NULL, the geometry's velocity list will be padded with zero velocities and the asset's velocityRange will be used for velocity

virtual void nvidia::apex::EmitterGeomExplicit::addSphereList	(	uint32_t	count,
		const SphereParams *	params,
		const PxVec3 *	velocities = 0
	)		[pure virtual]

Add spheres to geometry to be emitted.

Parameters:

[in]	count	- number of spheres being added by this call
[in]	params	- spheres parameters
[in]	velocities	if NULL, the geometry's velocity list will be padded with zero velocities and the asset's velocityRange will be used for velocity

See also:

EmitterGeomExplicit::SphereParams

virtual float nvidia::apex::EmitterGeomExplicit::getDistance

(

)

const [pure virtual]

Get average distance between particles.

virtual PxVec3 nvidia::apex::EmitterGeomExplicit::getEllipsoidCenter

(

uint32_t

index

)

const [pure virtual]

Get the center of the ellipsoid.

virtual uint32_t nvidia::apex::EmitterGeomExplicit::getEllipsoidCount

(

)

const [pure virtual]

Get the number of ellipsoids.

virtual void nvidia::apex::EmitterGeomExplicit::getEllipsoidList	(	const EllipsoidParams *&	params,
		uint32_t &	numEllipsoids,
		const PxVec3 *&	velocities,
		uint32_t &	numVelocities
	)		const [pure virtual]

Access ellipsoids list.

Parameters:

[out]	params	- ellipsoids parameters
[out]	numEllipsoids	- number of ellipsoids in list
[out]	velocities	- ellipsoids velocities
[out]	numVelocities	- number of ellipsoids velocities in list

See also:

EmitterGeomExplicit::EllipsoidParams

virtual PxVec3 nvidia::apex::EmitterGeomExplicit::getEllipsoidNormal

(

uint32_t

index

)

const [pure virtual]

Get the normal of the ellipsoid.

virtual float nvidia::apex::EmitterGeomExplicit::getEllipsoidPolarRadius

(

uint32_t

index

)

const [pure virtual]

Get the polar radius of the ellipsoid.

virtual float nvidia::apex::EmitterGeomExplicit::getEllipsoidRadius

(

uint32_t

index

)

const [pure virtual]

Get the radius of the ellipsoid.

virtual uint32_t nvidia::apex::EmitterGeomExplicit::getParticleCount

(

)

const [pure virtual]

Get the number of points.

virtual void nvidia::apex::EmitterGeomExplicit::getParticleList	(	const PointParams *&	params,
		uint32_t &	numPoints,
		const PxVec3 *&	velocities,
		uint32_t &	numVelocities
	)		const [pure virtual]

Access particles list.

Parameters:

[out]	params	- particles coordinates
[out]	numPoints	- number of particles in list
[out]	velocities	- particles velocities
[out]	numVelocities	- number of particles velocities in list

See also:

EmitterGeomExplicit::PointParams

virtual PxVec3 nvidia::apex::EmitterGeomExplicit::getParticlePos

(

uint32_t

index

)

const [pure virtual]

Get the position of point.

virtual PxVec3 nvidia::apex::EmitterGeomExplicit::getSphereCenter

(

uint32_t

index

)

const [pure virtual]

Get the center of the sphere.

virtual uint32_t nvidia::apex::EmitterGeomExplicit::getSphereCount

(

)

const [pure virtual]

Get the number of spheres.

virtual void nvidia::apex::EmitterGeomExplicit::getSphereList	(	const SphereParams *&	params,
		uint32_t &	numSpheres,
		const PxVec3 *&	velocities,
		uint32_t &	numVelocities
	)		const [pure virtual]

Access spheres list.

Parameters:

[out]	params	- spheres parameters
[out]	numSpheres	- number of spheres in list
[out]	velocities	- spheres velocities
[out]	numVelocities	- number of spheres velocities in list

See also:

EmitterGeomExplicit::SphereParams

virtual float nvidia::apex::EmitterGeomExplicit::getSphereRadius

(

uint32_t

index

)

const [pure virtual]

Get the radius of the sphere.

virtual void nvidia::apex::EmitterGeomExplicit::resetParticleList

(

)

[pure virtual]

Remove all shapes.

---

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

• EmitterGeoms.h