nvidia::apex::ModuleTurbulenceFS Class Reference

Class for TurbulenceFS module. More...

#include <ModuleTurbulenceFS.h>

List of all members.

Public Member Functions
virtual bool	setCustomTimestep (const Scene &apexScene, float timestep, int numIterations)=0
	Set custom timestep parameters for the specified scene (only for one simulation call)
virtual bool	setMultiSolveEnabled (const Scene &apexScene, bool enabled)=0
	Enable/disable multi-solve feature for the specified scene (disable by default)
virtual void	enableOutputVelocityField ()=0
	Enable output velocity field to UserRenderSurfaceBuffer.
virtual void	enableOutputDensityField ()=0
	Enable output density field to UserRenderSurfaceBuffer.
virtual void	enableOutputFlameField ()=0
	Enable output flame field to UserRenderSurfaceBuffer.
virtual void	setCustomFilterShader (physx::PxSimulationFilterShader shader, const void *shaderData, uint32_t shaderDataSize)=0
	Set custum filter shader to filter collision shapes interacting with Turbulence grids.
virtual const TestBase *	getTestBase (Scene *apexScene) const =0
	Returns pointer to TestBase. Internal feature, return NULL for distribution builds.
virtual int32_t	getGridSizePow () const =0
	get grid size power. Grid size of all actors will be multiplied by 2^(grid size power). But final grid size restricted by defined values
virtual void	setGridSizePow (int32_t power)=0
	set grid size power. Grid size of all actors will be multiplied by 2^(grid size power). But final grid size restricted by defined values
virtual void	prepareRenderables (const Scene &)=0
	Prepare renderables for rendering, should be called each frame before using renderables to update them with the most recent data.
virtual bool	setTurbulenceRenderCallback (const Scene &apexScene, TurbulenceRenderCallback *)=0
	Set TurbulenceRenderCallback.
virtual TurbulenceRenderCallback *	getTurbulenceRenderCallback (const Scene &apexScene) const =0
	Get TurbulenceRenderCallback.
Protected Member Functions
virtual	~ModuleTurbulenceFS ()

---

Detailed Description

Class for TurbulenceFS module.

---

Constructor & Destructor Documentation

virtual nvidia::apex::ModuleTurbulenceFS::~ModuleTurbulenceFS

(

)

[inline, protected, virtual]

---

Member Function Documentation

virtual void nvidia::apex::ModuleTurbulenceFS::enableOutputDensityField

(

)

[pure virtual]

Enable output density field to UserRenderSurfaceBuffer.

virtual void nvidia::apex::ModuleTurbulenceFS::enableOutputFlameField

(

)

[pure virtual]

Enable output flame field to UserRenderSurfaceBuffer.

virtual void nvidia::apex::ModuleTurbulenceFS::enableOutputVelocityField

(

)

[pure virtual]

Enable output velocity field to UserRenderSurfaceBuffer.

virtual int32_t nvidia::apex::ModuleTurbulenceFS::getGridSizePow

(

)

const [pure virtual]

get grid size power. Grid size of all actors will be multiplied by 2^(grid size power). But final grid size restricted by defined values

virtual const TestBase* nvidia::apex::ModuleTurbulenceFS::getTestBase

(

Scene *

apexScene

)

const [pure virtual]

Returns pointer to TestBase. Internal feature, return NULL for distribution builds.

virtual TurbulenceRenderCallback* nvidia::apex::ModuleTurbulenceFS::getTurbulenceRenderCallback

(

const Scene &

apexScene

)

const [pure virtual]

Get TurbulenceRenderCallback.

See also:

TurbulenceRenderCallback

virtual void nvidia::apex::ModuleTurbulenceFS::prepareRenderables

(

const Scene &

)

[pure virtual]

Prepare renderables for rendering, should be called each frame before using renderables to update them with the most recent data.

virtual void nvidia::apex::ModuleTurbulenceFS::setCustomFilterShader	(	physx::PxSimulationFilterShader	shader,
		const void *	shaderData,
		uint32_t	shaderDataSize
	)		[pure virtual]

Set custum filter shader to filter collision shapes interacting with Turbulence grids.

virtual bool nvidia::apex::ModuleTurbulenceFS::setCustomTimestep	(	const Scene &	apexScene,
		float	timestep,
		int	numIterations
	)		[pure virtual]

Set custom timestep parameters for the specified scene (only for one simulation call)

virtual void nvidia::apex::ModuleTurbulenceFS::setGridSizePow

(

int32_t

power

)

[pure virtual]

set grid size power. Grid size of all actors will be multiplied by 2^(grid size power). But final grid size restricted by defined values

virtual bool nvidia::apex::ModuleTurbulenceFS::setMultiSolveEnabled	(	const Scene &	apexScene,
		bool	enabled
	)		[pure virtual]

Enable/disable multi-solve feature for the specified scene (disable by default)

virtual bool nvidia::apex::ModuleTurbulenceFS::setTurbulenceRenderCallback	(	const Scene &	apexScene,
		TurbulenceRenderCallback *
	)		[pure virtual]

Set TurbulenceRenderCallback.

See also:

TurbulenceRenderCallback

---

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

• ModuleTurbulenceFS.h