Public Member Functions | Public Attributes | List of all members
PxParticleFluidReadData Class Reference

Data layout descriptor for reading fluid particle data from the SDK. More...

#include <PxParticleFluidReadData.h>

Inheritance diagram for PxParticleFluidReadData:
Inheritance graph
[legend]
Collaboration diagram for PxParticleFluidReadData:
Collaboration graph
[legend]

Public Member Functions

virtual ~PxParticleFluidReadData ()
 virtual destructor More...
 
- Public Member Functions inherited from PxParticleReadData
virtual PxDataAccessFlags getDataAccessFlags ()=0
 Returns PxDataAccessFlag::eREADABLE, since PxParticleReadData is read only data. More...
 
virtual void unlock ()=0
 Unlocks the data. More...
 
virtual ~PxParticleReadData ()
 virtual destructor More...
 
- Public Member Functions inherited from PxLockedData
virtual ~PxLockedData ()
 virtual destructor More...
 

Public Attributes

PxStrideIterator< const PxF32densityBuffer
 Particle density data. More...
 
- Public Attributes inherited from PxParticleReadData
PxU32 nbValidParticles
 Number of particles (only including particles with PxParticleFlag.eVALID set). More...
 
PxU32 validParticleRange
 Index after the last valid particle (PxParticleFlag.eVALID set). Its 0 if there are no valid particles. More...
 
const PxU32validParticleBitmap
 Bitmap marking valid particle indices. The bitmap is defined between [0, (PxParticleReadData.validParticleRange-1) >> 5]. More...
 
PxStrideIterator< const PxVec3positionBuffer
 Particle position data. More...
 
PxStrideIterator< const PxVec3velocityBuffer
 Particle velocity data. More...
 
PxStrideIterator< const PxF32restOffsetBuffer
 Particle rest offset data. More...
 
PxStrideIterator< const
PxParticleFlags
flagsBuffer
 Particle flags. More...
 
PxStrideIterator< const PxVec3collisionNormalBuffer
 Collision normals of colliding particles. The collision normal buffer is only guaranteed to be valid after the particle system has been simulated. Otherwise collisionNormalBuffer.ptr() is NULL. This also applies to particle systems that are not assigned to a scene. More...
 
PxStrideIterator< const PxVec3collisionVelocityBuffer
 Velocities of particles relative to shapes they collide with. The collision velocity buffer is only guaranteed to be valid after the particle system has been simulated. Otherwise collisionVelocityBuffer.ptr() is NULL. This also applies to particle systems that are not assigned to a scene. The collision velocity is identical to the particle velocity if the particle is not colliding. More...
 

Detailed Description

Data layout descriptor for reading fluid particle data from the SDK.

Additionally to PxParticleReadData, the density can be read from the SDK.

See Also
PxParticleReadData PxParticleFluid.lockParticleFluidReadData()

Constructor & Destructor Documentation

virtual PxParticleFluidReadData::~PxParticleFluidReadData ( )
inlinevirtual

virtual destructor

Member Data Documentation

PxStrideIterator<const PxF32> PxParticleFluidReadData::densityBuffer

Particle density data.

The density depends on how close particles are to each other. The density values are normalized such that:

  1. Particles which have no neighbors (no particles closer than restParticleDistance * 2) will have a density of zero.
  2. Particles which are at rest density (distances corresponding to restParticleDistance in the mean) will have a density of one.

The density buffer is only guaranteed to be valid after the particle fluid has been simulated. Otherwise densityBuffer.ptr() is NULL. This also applies to particle fluids that are not assigned to a scene.


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


Copyright © 2008-2015 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved. www.nvidia.com