APEX Framework: nvidia::apex::ModuleFieldSampler Class Reference

NVIDIA APEX

nvidia::apex::ModuleFieldSampler Class Reference

FieldSampler module class. More...

#include <ModuleFieldSampler.h>

Inheritance diagram for nvidia::apex::ModuleFieldSampler:
nvidia::apex::Module nvidia::apex::ApexInterface nvidia::apex::RWLockable

List of all members.

Public Member Functions

virtual bool setFieldSamplerWeightedCollisionFilterCallback (const Scene &apexScene, FieldSamplerWeightedCollisionFilterCallback *callback)=0
 Sets the optional weighted collision filter callback for this scene. If not provided, it will use the default SimulationFilterShader on the current scene.
virtual void enablePhysXMonitor (const Scene &apexScene, bool enable)=0
virtual void setPhysXMonitorFilterData (const Scene &apexScene, physx::PxFilterData filterData)=0
 Add filter data (collision group) to PhysXMonitor.
virtual uint32_t createForceSampleBatch (const Scene &apexScene, uint32_t maxCount, const physx::PxFilterData filterData)=0
 Initialize a query for a batch of sampling points.
virtual void releaseForceSampleBatch (const Scene &apexScene, uint32_t batchId)=0
 Release a query for a batch of sampling points.
virtual void submitForceSampleBatch (const Scene &apexScene, uint32_t batchId, PxVec4 *forces, const uint32_t forcesStride, const PxVec3 *positions, const uint32_t positionsStride, const PxVec3 *velocities, const uint32_t velocitiesStride, const float *mass, const uint32_t massStride, const uint32_t *indices, const uint32_t numIndices)=0
 Submits a batch of sampling points to be evaluated during the simulation step.

Detailed Description

FieldSampler module class.


Member Function Documentation

virtual uint32_t nvidia::apex::ModuleFieldSampler::createForceSampleBatch ( const Scene apexScene,
uint32_t  maxCount,
const physx::PxFilterData  filterData 
) [pure virtual]

Initialize a query for a batch of sampling points.

Parameters:
apexScene[in] - Apex scene for which to create the force sample batch query.
maxCount[in] - Maximum number of indices (active samples)
filterData[in] - PhysX 3.0 collision mask for data
Returns:
the ID of created query
virtual void nvidia::apex::ModuleFieldSampler::enablePhysXMonitor ( const Scene apexScene,
bool  enable 
) [pure virtual]

Set flag to toggle PhysXMonitor for ForceFields.

virtual void nvidia::apex::ModuleFieldSampler::releaseForceSampleBatch ( const Scene apexScene,
uint32_t  batchId 
) [pure virtual]

Release a query for a batch of sampling points.

Parameters:
apexScene[in] - Apex scene for which to create the force sample batch.
batchId[in] - ID of query that should be released
virtual void nvidia::apex::ModuleFieldSampler::setPhysXMonitorFilterData ( const Scene apexScene,
physx::PxFilterData  filterData 
) [pure virtual]

Add filter data (collision group) to PhysXMonitor.

Parameters:
apexScene[in] - Apex scene for which to submit the force sample batch.
filterData[in] - PhysX 3.0 collision mask for PhysXMonitor
virtual void nvidia::apex::ModuleFieldSampler::submitForceSampleBatch ( const Scene apexScene,
uint32_t  batchId,
PxVec4 *  forces,
const uint32_t  forcesStride,
const PxVec3 *  positions,
const uint32_t  positionsStride,
const PxVec3 *  velocities,
const uint32_t  velocitiesStride,
const float *  mass,
const uint32_t  massStride,
const uint32_t *  indices,
const uint32_t  numIndices 
) [pure virtual]

Submits a batch of sampling points to be evaluated during the simulation step.

Parameters:
apexScene[in] - Apex scene for which to submit the force sample batch.
batchId[in] - ID of query for force sample batch.
forces[out] - Buffer to which computed forces are written to. The buffer needs to be persistent between calling this function and the next PxApexScene::fetchResults.
forcesStride[in] - Stride between consecutive force vectors within the forces output.
positions[in] - Buffer containing the positions of the input samples.
positionsStride[in] - Stride between consecutive position vectors within the positions input.
velocities[in] - Buffer containing the velocities of the input samples.
velocitiesStride[in] - Stride between consecutive velocity vectors within the velocities input.
mass[in] - Buffer containing the mass of the input samples.
massStride[in] - Stride between consecutive mass values within the mass input.
indices[in] - Buffer containing the indices of the active samples that are considered for the input and output buffers.
numIndices[in] - Number of indices (active samples).

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

Generated on Fri Dec 15 2017 13:58:39

Copyright © 2012-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved.