NoiseFSAssetParams Struct Reference

Describes the NxParameterized::Interface for 'NoiseFSAssetParams' : Contains the asset properties for this Noise Field Sampler. More...

#include <params.h>

List of all members.

Public Attributes
F32	defaultScale
	'defaultScale' : The default scale factor of the boundary shape.
Vec3	boundarySize
	'boundarySize' : Size of the boundary box.
F32	boundaryFadePercentage
	'boundaryFadePercentage' : Percentage of distance from boundary to center where fade out starts.
FieldType	fieldType
	'fieldType' : Type of field.
F32	fieldDragCoeff
	'fieldDragCoeff' : Field drag coefficient (only for VELOCITY_DRAG field type).
F32	fieldWeight
	'fieldWeight' : A weight for the field, it controls how strongly the field affects particles
NoiseType	noiseType
	'noiseType' : Type of noise (simplex, curl and etc.).
U32	noiseSeed
	'noiseSeed' : Seed for the noise random generator.
F32	noiseStrength
	'noiseStrength' : Noise strength.
Vec3	noiseSpacePeriod
	'noiseSpacePeriod' : Noise period in space.
F32	noiseTimePeriod
	'noiseTimePeriod' : Noise period in time.
U32	noiseOctaves
	'noiseOctaves' : Number of the noise octaves (more octaves give more turbulent noise, but increase computational time).
F32	noiseStrengthOctaveMultiplier
	'noiseStrengthOctaveMultiplier' : Noise strength multiplier from one octave to the next.
Vec3	noiseSpacePeriodOctaveMultiplier
	'noiseSpacePeriodOctaveMultiplier' : Noise period in space multiplier from one octave to the next.
F32	noiseTimePeriodOctaveMultiplier
	'noiseTimePeriodOctaveMultiplier' : Noise period in time multiplier from one octave to the next.
String	fieldBoundaryFilterDataName
	'fieldBoundaryFilterDataName' : The filter data name for NoiseFS vs Field Boundaries interaction.
String	fieldSamplerFilterDataName
	'fieldSamplerFilterDataName' : The filter data name for NoiseFS vs other Field Samplers interaction.
Bool	useLocalSpace
	'useLocalSpace' : when enabled, noise calculation is done in the local space.

---

Detailed Description

Describes the NxParameterized::Interface for 'NoiseFSAssetParams' : Contains the asset properties for this Noise Field Sampler.

NoiseFSAssetParams contains 18 fully qualified names
---------------------------------------------
  1 : F32        defaultScale                      
  2 : Vec3       boundarySize                      
  3 : F32        boundaryFadePercentage            
  4 : FieldType  fieldType                         
  5 : F32        fieldDragCoeff                    
  6 : F32        fieldWeight                       
  7 : NoiseType  noiseType                         
  8 : U32        noiseSeed                         
  9 : F32        noiseStrength                     
 10 : Vec3       noiseSpacePeriod                  
 11 : F32        noiseTimePeriod                   
 12 : U32        noiseOctaves                      
 13 : F32        noiseStrengthOctaveMultiplier     
 14 : Vec3       noiseSpacePeriodOctaveMultiplier  
 15 : F32        noiseTimePeriodOctaveMultiplier   
 16 : String     fieldBoundaryFilterDataName       
 17 : String     fieldSamplerFilterDataName        
 18 : Bool       useLocalSpace                     

---

Member Data Documentation

F32 NoiseFSAssetParams::boundaryFadePercentage

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

Vec3 NoiseFSAssetParams::boundarySize

'boundarySize' : Size of the boundary box.

F32 NoiseFSAssetParams::defaultScale

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

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

String NoiseFSAssetParams::fieldBoundaryFilterDataName

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

F32 NoiseFSAssetParams::fieldDragCoeff

'fieldDragCoeff' : Field drag coefficient (only for VELOCITY_DRAG field type).

String NoiseFSAssetParams::fieldSamplerFilterDataName

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

FieldType NoiseFSAssetParams::fieldType

'fieldType' : Type of field.

F32 NoiseFSAssetParams::fieldWeight

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

U32 NoiseFSAssetParams::noiseOctaves

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

U32 NoiseFSAssetParams::noiseSeed

'noiseSeed' : Seed for the noise random generator.

Vec3 NoiseFSAssetParams::noiseSpacePeriod

'noiseSpacePeriod' : Noise period in space.

Vec3 NoiseFSAssetParams::noiseSpacePeriodOctaveMultiplier

'noiseSpacePeriodOctaveMultiplier' : Noise period in space multiplier from one octave to the next.

F32 NoiseFSAssetParams::noiseStrength

'noiseStrength' : Noise strength.

F32 NoiseFSAssetParams::noiseStrengthOctaveMultiplier

'noiseStrengthOctaveMultiplier' : Noise strength multiplier from one octave to the next.

F32 NoiseFSAssetParams::noiseTimePeriod

'noiseTimePeriod' : Noise period in time.

F32 NoiseFSAssetParams::noiseTimePeriodOctaveMultiplier

'noiseTimePeriodOctaveMultiplier' : Noise period in time multiplier from one octave to the next.

NoiseType NoiseFSAssetParams::noiseType

'noiseType' : Type of noise (simplex, curl and etc.).

Bool NoiseFSAssetParams::useLocalSpace

'useLocalSpace' : when enabled, noise calculation is done in the local space.

---

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

• params.h