Partio Namespace Reference

Classes

class  ParticlesInfo
 Particle Collection Interface. More...
class  ParticlesData
 Particle Data Interface. More...
class  ParticlesDataMutable
 Particle Mutable Data Interface. More...
struct  ETYPE_TO_TYPE
struct  ETYPE_TO_TYPE< VECTOR >
struct  ETYPE_TO_TYPE< FLOAT >
struct  ETYPE_TO_TYPE< INT >
struct  IS_SAME
struct  IS_SAME< T, T >
class  ParticleAttribute
 Particle Collection Interface. More...
struct  Data
 Data. More...
struct  Provider
struct  PROVIDER
struct  PROVIDER< true >
struct  ParticleAccessor
class  ParticleIterator

Typedefs

typedef uint64_t ParticleIndex
 Opaque random access method to a single particle. No number is implied or guaranteed.
typedef Data< int, 1 > DataI
typedef Data< float, 1 > DataF
typedef Data< float, 3 > DataV

Enumerations

enum  ParticleAttributeType { NONE = 0, VECTOR = 1, FLOAT = 2, INT = 3 }

Functions

ParticlesDataMutablecreate ()
 Provides an empty particle instance, freed with p->release().
ParticlesDataMutableread (const char *filename)
ParticlesInforeadHeaders (const char *filename)
void write (const char *filename, const ParticlesData &, const bool forceCompressed=false)
ParticlesDatareadCached (const char *filename, const bool sort)
 Cached (only one copy) read only way to read a particle file.
void beginCachedAccess (ParticlesData *particles)
 Begin accessing data in a cached file.
void endCachedAccess (ParticlesData *particles)
 End accessing data in a cached file.
void print (const ParticlesData *particles)
 Prints a subset of particle data in a textual form.
template<class T >
bool typeCheck (const ParticleAttributeType &type)
int TypeSize (ParticleAttributeType attrType)
std::string TypeName (ParticleAttributeType attrType)
template<class T , int d>
std::ostream & operator<< (std::ostream &output, const Data< T, d > &v)

Detailed Description

The interface of the particle API (Partio) what type the primitive is, how many instances of the primitive there, name of the attribute and an index which speeds lookups of data


Typedef Documentation

typedef Data<float,1> Partio::DataF
typedef Data<int,1> Partio::DataI
typedef Data<float,3> Partio::DataV
typedef uint64_t Partio::ParticleIndex

Opaque random access method to a single particle. No number is implied or guaranteed.


Enumeration Type Documentation

Enumerator:
NONE 
VECTOR 
FLOAT 
INT 

Function Documentation

void Partio::beginCachedAccess ( ParticlesData *  particles  ) 

Begin accessing data in a cached file.

Indicates to Partio that data access from a cached particle set will start. The sent in particles pointer must be from a readCached() call, not from read() or create(). Attributes can be read before this call.

ParticlesDataMutable* Partio::create (  ) 

Provides an empty particle instance, freed with p->release().

void Partio::endCachedAccess ( ParticlesData *  particles  ) 

End accessing data in a cached file.

Indicates to Partio that data from a cached particle read will end. The sent in particles pointer must be from a readCached() call, not from read() or create(). This allows the particle API to free all data pages, if they are needed.

template<class T , int d>
std::ostream& Partio::operator<< ( std::ostream &  output,
const Data< T, d > &  v 
) [inline]
void Partio::print ( const ParticlesData *  particles  ) 

Prints a subset of particle data in a textual form.

ParticlesDataMutable* Partio::read ( const char *  filename  ) 

Provides read/write access to a particle set stored in a file freed with p->release()

ParticlesData* Partio::readCached ( const char *  filename,
const bool  sort 
)

Cached (only one copy) read only way to read a particle file.

Loads a file read-only if not already in memory, otherwise returns already loaded item. Pointer is owned by Partio and must be releasedwith p->release(); (will not be deleted if others are also holding). If you want to do finding neighbors give true to sort

ParticlesInfo* Partio::readHeaders ( const char *  filename  ) 

Provides read access to a particle headers (number of particles and attribute information, much cheapeer

template<class T >
bool Partio::typeCheck ( const ParticleAttributeType &  type  )  [inline]

References FLOAT, INT, and VECTOR.

std::string Partio::TypeName ( ParticleAttributeType  attrType  ) 
int Partio::TypeSize ( ParticleAttributeType  attrType  ) 
void Partio::write ( const char *  filename,
const ParticlesData &  ,
const bool  forceCompressed = false 
)

Provides access to a particle set stored in a file if filename ends with .gz or forceCompressed is true, the file is compressed.


Generated on 5 Apr 2011 for Partio by  doxygen 1.6.1