Partio::ParticlesDataMutable Class Reference

Particle Mutable Data Interface. More...

#include <Partio.h>

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

List of all members.

Public Types

typedef ParticleIterator< false > iterator

Public Member Functions

template<class T >
T * dataWrite (const ParticleAttribute &attribute, const ParticleIndex particleIndex) const
virtual void sort ()=0
virtual ParticleAttribute addAttribute (const char *attribute, ParticleAttributeType type, const int count)=0
 Adds an attribute to the particle with the provided name, type and count.
virtual ParticleIndex addParticle ()=0
 Add a particle to the particle set. Returns the offset to the particle.
virtual iterator addParticles (const int count)=0
iterator begin ()
 Produce a beginning iterator for the particles.
iterator end ()
 Produce a ending iterator for the particles.
virtual iterator setupIterator ()=0
 Produce a const iterator.

Protected Member Functions

virtual ~ParticlesDataMutable ()

Private Member Functions

virtual void * dataInternal (const ParticleAttribute &attribute, const ParticleIndex particleIndex) const =0

Detailed Description

Particle Mutable Data Interface.

This interface provides the ability to write data attributes, add attributes, add particles, etc.


Member Typedef Documentation


Constructor & Destructor Documentation

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

Member Function Documentation

virtual ParticleAttribute Partio::ParticlesDataMutable::addAttribute ( const char *  attribute,
ParticleAttributeType  type,
const int  count 
) [pure virtual]

Adds an attribute to the particle with the provided name, type and count.

virtual ParticleIndex Partio::ParticlesDataMutable::addParticle (  )  [pure virtual]

Add a particle to the particle set. Returns the offset to the particle.

virtual iterator Partio::ParticlesDataMutable::addParticles ( const int  count  )  [pure virtual]

Add a set of particles to the particle set. Returns the offset to the first particle

iterator Partio::ParticlesDataMutable::begin (  )  [inline]

Produce a beginning iterator for the particles.

References setupIterator().

virtual void* Partio::ParticlesDataMutable::dataInternal ( const ParticleAttribute attribute,
const ParticleIndex  particleIndex 
) const [private, pure virtual]

Implements Partio::ParticlesData.

Referenced by dataWrite().

template<class T >
T* Partio::ParticlesDataMutable::dataWrite ( const ParticleAttribute attribute,
const ParticleIndex  particleIndex 
) const [inline]

Get a pointer to the data corresponding to the given particleIndex and attribute given by the attribute handle.

References dataInternal().

iterator Partio::ParticlesDataMutable::end (  )  [inline]

Produce a ending iterator for the particles.

virtual iterator Partio::ParticlesDataMutable::setupIterator (  )  [pure virtual]

Produce a const iterator.

Referenced by begin().

virtual void Partio::ParticlesDataMutable::sort (  )  [pure virtual]

Preprocess the data for finding nearest neighbors by sorting into a KD-Tree. Note: all particle pointers are invalid after this call.


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

Generated on 5 Apr 2011 for Partio by  doxygen 1.6.1