Public Attributes
TurbulenceFSAssetParams Struct Reference

Describes the NxParameterized::Interface for 'TurbulenceFSAssetParams' : Contains the asset properties for this Turbulence field sampler. More...

#include <params.h>

List of all members.

Public Attributes

Min gridXRange.min
 'gridXRange.min' : Turbulence resolution. The higher resolution, the higher precision, but the simulation time is also longer. This is the lower bound of possible turbulence grid resolution, depending on the LOD settings
Max gridXRange.max
 'gridXRange.max' : Turbulence resolution. The higher resolution, the higher precision, but the simulation time is also longer. This is the higher bound of possible turbulence grid resolution, depending on the LOD settings
Min gridYRange.min
 'gridYRange.min' : Turbulence resolution. The higher resolution, the higher precision, but the simulation time is also longer. This is the lower bound of possible turbulence grid resolution, depending on the LOD settings
Max gridYRange.max
 'gridYRange.max' : Turbulence resolution. The higher resolution, the higher precision, but the simulation time is also longer. This is the higher bound of possible turbulence grid resolution, depending on the LOD settings
Min gridZRange.min
 'gridZRange.min' : Turbulence resolution. The higher resolution, the higher precision, but the simulation time is also longer. This is the lower bound of possible turbulence grid resolution, depending on the LOD settings
Max gridZRange.max
 'gridZRange.max' : Turbulence resolution. The higher resolution, the higher precision, but the simulation time is also longer. This is the higher bound of possible turbulence grid resolution, depending on the LOD settings
Vec3 gridSizeWorld
 'gridSizeWorld' : Size of the grid in world space.
F32 updatesPerFrameRange.min
 'updatesPerFrameRange.min' : Minimum value
F32 updatesPerFrameRange.max
 'updatesPerFrameRange.max' : Maximum value
F32 angularVelocityMultiplier
 'angularVelocityMultiplier' : a multiplier for the angular velocity set by the user.
F32 angularVelocityClamp
 'angularVelocityClamp' : a clamp for the angular velocity set by the user.
F32 linearVelocityMultiplier
 'linearVelocityMultiplier' : a multiplier for the linear velocity set by the user.
F32 linearVelocityClamp
 'linearVelocityClamp' : a clamp for the linear velocity set by the user.
F32 velocityFieldFadeTime
 'velocityFieldFadeTime' : Time of velocity field cleaning process [sec]. Cleaning disabled by default.
F32 velocityFieldFadeDelay
 'velocityFieldFadeDelay' : Time without activity before velocity field cleaning process starts [sec].
F32 velocityFieldFadeIntensity
 'velocityFieldFadeIntensity' : This parameter sets how much each velocity vector should be damped, so (1 - velocityFieldFadeIntensity) of original velocity vector magnitude will be left after the fade process finishes.
F32 boundaryFadePercentage
 'boundaryFadePercentage' : Percentage of distance from boundary to center where fade out starts.
F32 boundarySizePercentage
 'boundarySizePercentage' : Boundary size as the percentage of grid size.
String collisionFilterDataName
 'collisionFilterDataName' : The filter data (group/groupsMask) name for TurbulenceFS vs PhysX interaction.
String fieldBoundaryFilterDataName
 'fieldBoundaryFilterDataName' : The filter data name for TurbulenceFS vs Field Boundaries interaction.
String fieldSamplerFilterDataName
 'fieldSamplerFilterDataName' : The filter data name for TurbulenceFS vs other Field Samplers interaction.
U32 maxCollidingObjects
 'maxCollidingObjects' : The maximum number of colliding objects.
U32 maxVelocitySources
 'maxVelocitySources' : The maximum number of velocity source.
U32 maxHeatSources
 'maxHeatSources' : The maximum number of heat source.
U32 maxSubstanceSources
 'maxSubstanceSources' : The maximum number of substance source (computed if density enabled).
F32 dragCoeff
 'dragCoeff' : Coefficient for deriving drag force from velocity (if equals to zero, direct grid velocity is used).
Vec3 externalVelocity
 'externalVelocity' : Adds a single directional velocity to the grid.
F32 fieldVelocityMultiplier
 'fieldVelocityMultiplier' : A multiplier for the field velocity.
F32 fieldVelocityWeight
 'fieldVelocityWeight' : The effect of the field velocity on objects. A value of 1 causes objects to only be affected by the grid, a value of 0 allows objects to be controlled by other field samplers.
Bool useHeat
 'useHeat' : Enable whether or not to use heat in the simulation.
F32 heatParams.temperatureBasedForceMultiplier
 'heatParams.temperatureBasedForceMultiplier' : Multiplier for force induced by heat source.
F32 heatParams.ambientTemperature
 'heatParams.ambientTemperature' : Environment temperature.
Vec3 heatParams.heatForceDirection
 'heatParams.heatForceDirection' : Direction of the force induced by heat source.
F32 heatParams.thermalConductivity
 'heatParams.thermalConductivity' : Thermal conductivity. Default value is set for air.
Bool useDensity
 'useDensity' : Enable whether or not to use density in the simulation.
F32 densityParams.diffusionCoef
 'densityParams.diffusionCoef' : Diffusion coefficient for density (analog for viscosity in velocity equation.
F32 densityParams.densityFieldFade
 'densityParams.densityFieldFade' : Each cell in density field are multiplied by (1 - densityFieldFade) every frame.
U32 densityParams.densityGridMultiplier
 'densityParams.densityGridMultiplier' : Density grid resolution multiplier.
Bool isEnabledOptimizedLOD
 'isEnabledOptimizedLOD' : Enable more aggressive LOD.
F32 customLOD
 'customLOD' : Force the current LOD to a particular value, range is 0-1: 1.0f is maximum, 0.0f is minimum simulation quality.
F32 lodWeights.maxDistance
 'lodWeights.maxDistance' : Objects greater than this distance from the player will be culled more aggressively
F32 lodWeights.distanceWeight
 'lodWeights.distanceWeight' : Weight given to distance parameter in LOD function
F32 lodWeights.bias
 'lodWeights.bias' : benefit = ((distanceWeight * distanceFactor + bias) * SimulationCost + benefitBias) * benefitWeight
F32 lodWeights.benefitBias
 'lodWeights.benefitBias' : benefit = ((distanceWeight * distanceFactor + bias) * SimulationCost + benefitBias) * benefitWeight
F32 lodWeights.benefitWeight
 'lodWeights.benefitWeight' : benefit = ((distanceWeight * distanceFactor + bias) * SimulationCost + benefitBias) * benefitWeight
F32 noiseParams.noiseStrength
 'noiseParams.noiseStrength' : The strength of the noise added to the simulation.
Vec3 noiseParams.noiseSpacePeriod
 'noiseParams.noiseSpacePeriod' : Noise period in space.
F32 noiseParams.noiseTimePeriod
 'noiseParams.noiseTimePeriod' : Noise time period.
U32 noiseParams.noiseOctaves
 'noiseParams.noiseOctaves' : Number of the noise octaves (more octaves give more turbulent noise, but increase computational time).
F32 dragCoeffForRigidBody
 'dragCoeffForRigidBody' : It is not true drag coef just mixing coefficient for slip and no-slip boundary condition. If set to zero supposed slip boundary condition on rigid bodies. If set to 1 supposed no-slip boundary condition else mixed (partly slip)
F32 fluidViscosity
 'fluidViscosity' : Viscosity is the coefficient for velocity diffusion. If 0. there is no diffusion.
Ref volumeRenderMaterialName
 'volumeRenderMaterialName' : The optional volume render material name

Detailed Description

Describes the NxParameterized::Interface for 'TurbulenceFSAssetParams' : Contains the asset properties for this Turbulence field sampler.

TurbulenceFSAssetParams contains 52 fully qualified names
---------------------------------------------
  1 : Min     gridXRange.min                              
  2 : Max     gridXRange.max                              
  3 : Min     gridYRange.min                              
  4 : Max     gridYRange.max                              
  5 : Min     gridZRange.min                              
  6 : Max     gridZRange.max                              
  7 : Vec3    gridSizeWorld                               
  8 : F32     updatesPerFrameRange.min                    
  9 : F32     updatesPerFrameRange.max                    
 10 : F32     angularVelocityMultiplier                   
 11 : F32     angularVelocityClamp                        
 12 : F32     linearVelocityMultiplier                    
 13 : F32     linearVelocityClamp                         
 14 : F32     velocityFieldFadeTime                       
 15 : F32     velocityFieldFadeDelay                      
 16 : F32     velocityFieldFadeIntensity                  
 17 : F32     boundaryFadePercentage                      
 18 : F32     boundarySizePercentage                      
 19 : String  collisionFilterDataName                     
 20 : String  fieldBoundaryFilterDataName                 
 21 : String  fieldSamplerFilterDataName                  
 22 : U32     maxCollidingObjects                         
 23 : U32     maxVelocitySources                          
 24 : U32     maxHeatSources                              
 25 : U32     maxSubstanceSources                         
 26 : F32     dragCoeff                                   
 27 : Vec3    externalVelocity                            
 28 : F32     fieldVelocityMultiplier                     
 29 : F32     fieldVelocityWeight                         
 30 : Bool    useHeat                                     
 31 : F32     heatParams.temperatureBasedForceMultiplier  
 32 : F32     heatParams.ambientTemperature               
 33 : Vec3    heatParams.heatForceDirection               
 34 : F32     heatParams.thermalConductivity              
 35 : Bool    useDensity                                  
 36 : F32     densityParams.diffusionCoef                 
 37 : F32     densityParams.densityFieldFade              
 38 : U32     densityParams.densityGridMultiplier         
 39 : Bool    isEnabledOptimizedLOD                       
 40 : F32     customLOD                                   
 41 : F32     lodWeights.maxDistance                      
 42 : F32     lodWeights.distanceWeight                   
 43 : F32     lodWeights.bias                             
 44 : F32     lodWeights.benefitBias                      
 45 : F32     lodWeights.benefitWeight                    
 46 : F32     noiseParams.noiseStrength                   
 47 : Vec3    noiseParams.noiseSpacePeriod                
 48 : F32     noiseParams.noiseTimePeriod                 
 49 : U32     noiseParams.noiseOctaves                    
 50 : F32     dragCoeffForRigidBody                       
 51 : F32     fluidViscosity                              
 52 : Ref     volumeRenderMaterialName                    

Member Data Documentation

'angularVelocityClamp' : a clamp for the angular velocity set by the user.

'angularVelocityMultiplier' : a multiplier for the angular velocity set by the user.

'boundaryFadePercentage' : Percentage of distance from boundary to center where fade out starts.

'boundarySizePercentage' : Boundary size as the percentage of grid size.

'collisionFilterDataName' : The filter data (group/groupsMask) name for TurbulenceFS vs PhysX interaction.

'customLOD' : Force the current LOD to a particular value, range is 0-1: 1.0f is maximum, 0.0f is minimum simulation quality.

'densityParams.densityFieldFade' : Each cell in density field are multiplied by (1 - densityFieldFade) every frame.

'densityParams.densityGridMultiplier' : Density grid resolution multiplier.

'densityParams.diffusionCoef' : Diffusion coefficient for density (analog for viscosity in velocity equation.

'dragCoeff' : Coefficient for deriving drag force from velocity (if equals to zero, direct grid velocity is used).

'dragCoeffForRigidBody' : It is not true drag coef just mixing coefficient for slip and no-slip boundary condition. If set to zero supposed slip boundary condition on rigid bodies. If set to 1 supposed no-slip boundary condition else mixed (partly slip)

'externalVelocity' : Adds a single directional velocity to the grid.

'fieldBoundaryFilterDataName' : The filter data name for TurbulenceFS vs Field Boundaries interaction.

'fieldSamplerFilterDataName' : The filter data name for TurbulenceFS vs other Field Samplers interaction.

'fieldVelocityMultiplier' : A multiplier for the field velocity.

'fieldVelocityWeight' : The effect of the field velocity on objects. A value of 1 causes objects to only be affected by the grid, a value of 0 allows objects to be controlled by other field samplers.

'fluidViscosity' : Viscosity is the coefficient for velocity diffusion. If 0. there is no diffusion.

'gridSizeWorld' : Size of the grid in world space.

'gridXRange.max' : Turbulence resolution. The higher resolution, the higher precision, but the simulation time is also longer. This is the higher bound of possible turbulence grid resolution, depending on the LOD settings

'gridXRange.min' : Turbulence resolution. The higher resolution, the higher precision, but the simulation time is also longer. This is the lower bound of possible turbulence grid resolution, depending on the LOD settings

'gridYRange.max' : Turbulence resolution. The higher resolution, the higher precision, but the simulation time is also longer. This is the higher bound of possible turbulence grid resolution, depending on the LOD settings

'gridYRange.min' : Turbulence resolution. The higher resolution, the higher precision, but the simulation time is also longer. This is the lower bound of possible turbulence grid resolution, depending on the LOD settings

'gridZRange.max' : Turbulence resolution. The higher resolution, the higher precision, but the simulation time is also longer. This is the higher bound of possible turbulence grid resolution, depending on the LOD settings

'gridZRange.min' : Turbulence resolution. The higher resolution, the higher precision, but the simulation time is also longer. This is the lower bound of possible turbulence grid resolution, depending on the LOD settings

'heatParams.ambientTemperature' : Environment temperature.

'heatParams.heatForceDirection' : Direction of the force induced by heat source.

'heatParams.temperatureBasedForceMultiplier' : Multiplier for force induced by heat source.

'heatParams.thermalConductivity' : Thermal conductivity. Default value is set for air.

'isEnabledOptimizedLOD' : Enable more aggressive LOD.

'linearVelocityClamp' : a clamp for the linear velocity set by the user.

'linearVelocityMultiplier' : a multiplier for the linear velocity set by the user.

'lodWeights.benefitBias' : benefit = ((distanceWeight * distanceFactor + bias) * SimulationCost + benefitBias) * benefitWeight

'lodWeights.benefitWeight' : benefit = ((distanceWeight * distanceFactor + bias) * SimulationCost + benefitBias) * benefitWeight

'lodWeights.bias' : benefit = ((distanceWeight * distanceFactor + bias) * SimulationCost + benefitBias) * benefitWeight

'lodWeights.distanceWeight' : Weight given to distance parameter in LOD function

'lodWeights.maxDistance' : Objects greater than this distance from the player will be culled more aggressively

'maxCollidingObjects' : The maximum number of colliding objects.

'maxHeatSources' : The maximum number of heat source.

'maxSubstanceSources' : The maximum number of substance source (computed if density enabled).

'maxVelocitySources' : The maximum number of velocity source.

'noiseParams.noiseOctaves' : Number of the noise octaves (more octaves give more turbulent noise, but increase computational time).

'noiseParams.noiseSpacePeriod' : Noise period in space.

'noiseParams.noiseStrength' : The strength of the noise added to the simulation.

'noiseParams.noiseTimePeriod' : Noise time period.

'updatesPerFrameRange.max' : Maximum value

'updatesPerFrameRange.min' : Minimum value

'useDensity' : Enable whether or not to use density in the simulation.

'useHeat' : Enable whether or not to use heat in the simulation.

'velocityFieldFadeDelay' : Time without activity before velocity field cleaning process starts [sec].

'velocityFieldFadeIntensity' : This parameter sets how much each velocity vector should be damped, so (1 - velocityFieldFadeIntensity) of original velocity vector magnitude will be left after the fade process finishes.

'velocityFieldFadeTime' : Time of velocity field cleaning process [sec]. Cleaning disabled by default.

'volumeRenderMaterialName' : The optional volume render material name


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

Generated on Sat Dec 1 2018 15:52:44

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