Partio::ParticlesInfo Class Reference

Particle Collection Interface. More...

#include <Partio.h>

Inheritance diagram for Partio::ParticlesInfo:
Partio::ParticlesData Partio::ParticlesDataMutable

List of all members.

Public Member Functions

virtual void release () const =0
virtual int numAttributes () const =0
 Number of particles in the structure.
virtual int numParticles () const =0
 Number of per-particle attributes.
virtual bool attributeInfo (const char *attributeName, ParticleAttribute &attribute) const =0
 Lookup an attribute by name and store a handle to the attribute.
virtual bool attributeInfo (const int attributeInfo, ParticleAttribute &attribute) const =0
 Lookup an attribute by index and store a handle to the attribute.

Protected Member Functions

virtual ~ParticlesInfo ()

Friends

void freeCached (ParticlesData *particles)

Detailed Description

Particle Collection Interface.

This class provides ways of accessing basic information about particles, the number in the set, the attribute names and types, etc. No actual data can be read or written.


Constructor & Destructor Documentation

virtual Partio::ParticlesInfo::~ParticlesInfo (  )  [inline, protected, virtual]

Member Function Documentation

virtual bool Partio::ParticlesInfo::attributeInfo ( const int  attributeInfo,
ParticleAttribute attribute 
) const [pure virtual]

Lookup an attribute by index and store a handle to the attribute.

virtual bool Partio::ParticlesInfo::attributeInfo ( const char *  attributeName,
ParticleAttribute attribute 
) const [pure virtual]

Lookup an attribute by name and store a handle to the attribute.

virtual int Partio::ParticlesInfo::numAttributes (  )  const [pure virtual]

Number of particles in the structure.

virtual int Partio::ParticlesInfo::numParticles (  )  const [pure virtual]

Number of per-particle attributes.

virtual void Partio::ParticlesInfo::release (  )  const [pure virtual]

Frees the memory if this particle set was created with create() or release() Reduces reference count if it was obtained with readCached() and if the ref count hits zero, frees the memory


Friends And Related Function Documentation

void freeCached ( ParticlesData particles  )  [friend]

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

Generated on 5 Apr 2011 for Partio by  doxygen 1.6.1