APEX NvParameterized Schemas: JetFSAssetParams Struct Reference

NVIDIA APEX

JetFSAssetParams Struct Reference

Describes the NxParameterized::Interface for 'JetFSAssetParams' : Contains the asset properties for this Jet Field Sampler. More...

#include <params.h>

List of all members.

Public Attributes

F32 defaultScale
 'defaultScale' : The default scale factor of the boundary shape.
F32 boundaryFadePercentage
 'boundaryFadePercentage' : Percentage of distance from boundary to center where fade out starts
Vec3 fieldDirection
 'fieldDirection' : field direction.
F32 fieldDirectionDeviationAngle
 'fieldDirectionDeviationAngle' : field direction deviation angle (in degrees).
F32 fieldDirectionOscillationPeriod
 'fieldDirectionOscillationPeriod' : field direction oscillation period in seconds.
F32 fieldStrength
 'fieldStrength' : field strength.
F32 fieldStrengthDeviationPercentage
 'fieldStrengthDeviationPercentage' : +/- field strength deviation percentage.
F32 fieldStrengthOscillationPeriod
 'fieldStrengthOscillationPeriod' : field strength oscillation period in seconds.
F32 gridShapeRadius
 'gridShapeRadius' : Radius of sphere or capsule shape inside of the grid
F32 gridShapeHeight
 'gridShapeHeight' : Height of capsule shape inside of the grid
F32 gridBoundaryFadePercentage
 'gridBoundaryFadePercentage' : Percentage of distance from boundary to center where fade out starts
F32 nearRadius
 'nearRadius' : near radius of the toroidal field. (inside this radius there's the strongest field)
F32 pivotRadius
 'pivotRadius' : pivot radiues of the toroidal field. (this is the center of the field where it reaches zero)
F32 farRadius
 'farRadius' : far radius of the toroidal field. (outside this radius the field is empty)
F32 directionalStretch
 'directionalStretch' : stretch of the field along the direction
F32 averageStartDistance
 'averageStartDistance' : start distance of blending between averaged & oscilating fields
F32 averageEndDistance
 'averageEndDistance' : end distance of blending between averaged & oscilating fields
F32 noisePercentage
 'noisePercentage' : noise level in percentage of field strength
F32 noiseSpaceScale
 'noiseSpaceScale' : space scale of the noise function
F32 noiseTimeScale
 'noiseTimeScale' : time scale of the noise function
U32 noiseOctaves
 'noiseOctaves' : number of the noise octaves (more octaves give more turbulent noise, but increase computational time)
F32 fieldDragCoeff
 'fieldDragCoeff' : Field drag coefficient. When it equals to 0, then the field is applied as a direct velocity.
F32 fieldWeight
 'fieldWeight' : A weight for the field, it controls how strongly the field affects particles
String fieldBoundaryFilterDataName
 'fieldBoundaryFilterDataName' : The filter data name for JetFS vs Field Boundaries interaction.
String fieldSamplerFilterDataName
 'fieldSamplerFilterDataName' : The filter data name for JetFS vs other Field Samplers interaction.

Detailed Description

Describes the NxParameterized::Interface for 'JetFSAssetParams' : Contains the asset properties for this Jet Field Sampler.

JetFSAssetParams contains 25 fully qualified names
---------------------------------------------
  1 : F32     defaultScale                      
  2 : F32     boundaryFadePercentage            
  3 : Vec3    fieldDirection                    
  4 : F32     fieldDirectionDeviationAngle      
  5 : F32     fieldDirectionOscillationPeriod   
  6 : F32     fieldStrength                     
  7 : F32     fieldStrengthDeviationPercentage  
  8 : F32     fieldStrengthOscillationPeriod    
  9 : F32     gridShapeRadius                   
 10 : F32     gridShapeHeight                   
 11 : F32     gridBoundaryFadePercentage        
 12 : F32     nearRadius                        
 13 : F32     pivotRadius                       
 14 : F32     farRadius                         
 15 : F32     directionalStretch                
 16 : F32     averageStartDistance              
 17 : F32     averageEndDistance                
 18 : F32     noisePercentage                   
 19 : F32     noiseSpaceScale                   
 20 : F32     noiseTimeScale                    
 21 : U32     noiseOctaves                      
 22 : F32     fieldDragCoeff                    
 23 : F32     fieldWeight                       
 24 : String  fieldBoundaryFilterDataName       
 25 : String  fieldSamplerFilterDataName        

Member Data Documentation

'averageEndDistance' : end distance of blending between averaged & oscilating fields

'averageStartDistance' : start distance of blending between averaged & oscilating fields

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

'defaultScale' : The default scale factor of the boundary shape.

The default scale factor of the boundary shape. The default value is 1.0.

'directionalStretch' : stretch of the field along the direction

'farRadius' : far radius of the toroidal field. (outside this radius the field is empty)

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

'fieldDirection' : field direction.

'fieldDirectionDeviationAngle' : field direction deviation angle (in degrees).

The fieldDirectionDeviationAngle parameter controls the deviation in angle of the field direction.

'fieldDirectionOscillationPeriod' : field direction oscillation period in seconds.

The fieldDirectionOscillationPeriod defines the period of the field direction oscillation. If the fieldDirectionDeviationAngle is non-zero the period of each sinusoidal cycle will be this parameter in seconds.

'fieldDragCoeff' : Field drag coefficient. When it equals to 0, then the field is applied as a direct velocity.

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

'fieldStrength' : field strength.

'fieldStrengthDeviationPercentage' : +/- field strength deviation percentage.

The fieldStrengthDeviationPercentage parameter controls the deviation in % of the field strength.

'fieldStrengthOscillationPeriod' : field strength oscillation period in seconds.

The fieldStrengthOscillationPeriod defines the period of the field strength oscillation. If the fieldStrengthDeviationPercentage is non-zero the period of each sinusoidal cycle will be this parameter in seconds.

'fieldWeight' : A weight for the field, it controls how strongly the field affects particles

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

'gridShapeHeight' : Height of capsule shape inside of the grid

'gridShapeRadius' : Radius of sphere or capsule shape inside of the grid

'nearRadius' : near radius of the toroidal field. (inside this radius there's the strongest field)

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

'noisePercentage' : noise level in percentage of field strength

'noiseSpaceScale' : space scale of the noise function

'noiseTimeScale' : time scale of the noise function

'pivotRadius' : pivot radiues of the toroidal field. (this is the center of the field where it reaches zero)


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

Generated on Fri Dec 15 2017 13:59:11

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