ForceFieldAssetParams Struct Reference

Describes the NxParameterized::Interface for 'ForceFieldAssetParams' : Contains the asset properties for ForceField. More...

#include <params.h>

List of all members.

Classes
union	ForceFieldKernelType
Public Attributes
ForceFieldKernelType	forceFieldKernelType
F32	defScale
	'defScale' : Default scale of the force field
F32	strength
	'strength' : Constant part of force field function
F32	lifetime
	'lifetime' : Lifetime of force field
Shape	includeShapeParameters.shape
	'includeShapeParameters.shape' : Include shape type for force field
Mat44	includeShapeParameters.forceFieldToShape
	'includeShapeParameters.forceFieldToShape' : Transform to convert force field to local shape coordinates
Vec3	includeShapeParameters.dimensions
	'includeShapeParameters.dimensions' : x,y,z values dependent on shape type
String	fieldBoundaryFilterDataName
	'fieldBoundaryFilterDataName' : The filter data name for ForceField vs Field Boundaries interaction. Overrides asset's value.
String	fieldSamplerFilterDataName
	'fieldSamplerFilterDataName' : The filter data name for ForceField vs other Field Samplers interaction. Overrides asset's value.

---

Detailed Description

Describes the NxParameterized::Interface for 'ForceFieldAssetParams' : Contains the asset properties for ForceField.

ForceFieldAssetParams contains 27 fully qualified names
---------------------------------------------
  1 : Type    forceFieldKernelType.coordinateSystemParameters.type         RefVariant[GenericForceFieldKernelParams]
  2 : F32     forceFieldKernelType.coordinateSystemParameters.torusRadius  RefVariant[GenericForceFieldKernelParams]
  3 : Vec3    forceFieldKernelType.constant                                RefVariant[GenericForceFieldKernelParams]
  4 : Mat33   forceFieldKernelType.positionMultiplier                      RefVariant[GenericForceFieldKernelParams]
  5 : Vec3    forceFieldKernelType.positionTarget                          RefVariant[GenericForceFieldKernelParams]
  6 : Mat33   forceFieldKernelType.velocityMultiplier                      RefVariant[GenericForceFieldKernelParams]
  7 : Vec3    forceFieldKernelType.velocityTarget                          RefVariant[GenericForceFieldKernelParams]
  8 : Vec3    forceFieldKernelType.noise                                   RefVariant[GenericForceFieldKernelParams]
  9 : Vec3    forceFieldKernelType.falloffLinear                           RefVariant[GenericForceFieldKernelParams]
 10 : Vec3    forceFieldKernelType.falloffQuadratic                        RefVariant[GenericForceFieldKernelParams]
 11 : Type    forceFieldKernelType.falloffParameters.type                  RefVariant[ForceFieldFalloffParams]
 12 : F32     forceFieldKernelType.falloffParameters.multiplier            RefVariant[ForceFieldFalloffParams]
 13 : F32     forceFieldKernelType.falloffParameters.start                 RefVariant[ForceFieldFalloffParams]
 14 : F32     forceFieldKernelType.falloffParameters.end                   RefVariant[ForceFieldFalloffParams]
 15 : F32     forceFieldKernelType.noiseParameters.strength                RefVariant[ForceFieldNoiseParams]
 16 : F32     forceFieldKernelType.noiseParameters.spaceScale              RefVariant[ForceFieldNoiseParams]
 17 : F32     forceFieldKernelType.noiseParameters.timeScale               RefVariant[ForceFieldNoiseParams]
 18 : U32     forceFieldKernelType.noiseParameters.octaves                 RefVariant[ForceFieldNoiseParams]
 19 : F32     forceFieldKernelType.radius                                  RefVariant[RadialForceFieldKernelParams]
 20 : F32     defScale                                                     
 21 : F32     strength                                                     
 22 : F32     lifetime                                                     
 23 : Shape   includeShapeParameters.shape                                 
 24 : Mat44   includeShapeParameters.forceFieldToShape                     
 25 : Vec3    includeShapeParameters.dimensions                            
 26 : String  fieldBoundaryFilterDataName                                  
 27 : String  fieldSamplerFilterDataName                                   

---

Member Data Documentation

F32 ForceFieldAssetParams::defScale

'defScale' : Default scale of the force field

String ForceFieldAssetParams::fieldBoundaryFilterDataName

'fieldBoundaryFilterDataName' : The filter data name for ForceField vs Field Boundaries interaction. Overrides asset's value.

String ForceFieldAssetParams::fieldSamplerFilterDataName

'fieldSamplerFilterDataName' : The filter data name for ForceField vs other Field Samplers interaction. Overrides asset's value.

ForceFieldKernelType ForceFieldAssetParams::forceFieldKernelType

Vec3 ForceFieldAssetParams::includeShapeParameters.dimensions

'includeShapeParameters.dimensions' : x,y,z values dependent on shape type

Mat44 ForceFieldAssetParams::includeShapeParameters.forceFieldToShape

'includeShapeParameters.forceFieldToShape' : Transform to convert force field to local shape coordinates

Shape ForceFieldAssetParams::includeShapeParameters.shape

'includeShapeParameters.shape' : Include shape type for force field

F32 ForceFieldAssetParams::lifetime

'lifetime' : Lifetime of force field

F32 ForceFieldAssetParams::strength

'strength' : Constant part of force field function

---

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

• params.h