WindFSAssetParams Struct Reference

Describes the NxParameterized::Interface for 'WindFSAssetParams' : Contains the asset properties for this Wind Field Sampler. More...

#include <params.h>

List of all members.

Public Attributes
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	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 WindFS vs Field Boundaries interaction.
String	fieldSamplerFilterDataName
	'fieldSamplerFilterDataName' : The filter data name for WindFS vs other Field Samplers interaction.

---

Detailed Description

Describes the NxParameterized::Interface for 'WindFSAssetParams' : Contains the asset properties for this Wind Field Sampler.

WindFSAssetParams contains 10 fully qualified names
---------------------------------------------
  1 : Vec3    fieldDirection                    
  2 : F32     fieldDirectionDeviationAngle      
  3 : F32     fieldDirectionOscillationPeriod   
  4 : F32     fieldStrength                     
  5 : F32     fieldStrengthDeviationPercentage  
  6 : F32     fieldStrengthOscillationPeriod    
  7 : F32     fieldDragCoeff                    
  8 : F32     fieldWeight                       
  9 : String  fieldBoundaryFilterDataName       
 10 : String  fieldSamplerFilterDataName        

---

Member Data Documentation

String WindFSAssetParams::fieldBoundaryFilterDataName

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

Vec3 WindFSAssetParams::fieldDirection

'fieldDirection' : field direction.

F32 WindFSAssetParams::fieldDirectionDeviationAngle

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

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

F32 WindFSAssetParams::fieldDirectionOscillationPeriod

'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.

F32 WindFSAssetParams::fieldDragCoeff

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

String WindFSAssetParams::fieldSamplerFilterDataName

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

F32 WindFSAssetParams::fieldStrength

'fieldStrength' : field strength.

F32 WindFSAssetParams::fieldStrengthDeviationPercentage

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

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

F32 WindFSAssetParams::fieldStrengthOscillationPeriod

'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.

F32 WindFSAssetParams::fieldWeight

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

---

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

• params.h