VortexFSAssetParams Struct Reference

Describes the NxParameterized::Interface for 'VortexFSAssetParams' : Contains the asset properties for this Vortex Field Sampler. More...

#include <params.h>

List of all members.

Public Attributes
F32	boundaryFadePercentage
	'boundaryFadePercentage' : Percentage of distance from boundary to center where fade out starts.
Vec3	axis
	'axis' : The primary axis of the vortex around which the particles will rotate.
Bool	bottomSphericalForce
	'bottomSphericalForce' : If this parameter true, radial forces in bottom sphere of the capsule will point to the center of sphere.
Bool	topSphericalForce
	'topSphericalForce' : If this parameter true, radial forces in top sphere of the capsule will point to the center of sphere.
F32	height
	'height' : The height of the capsule volume of the vortex.
F32	bottomRadius
	'bottomRadius' : The radius of the bottom sphere of the capsule.
F32	topRadius
	'topRadius' : The radius of the top sphere of the capsule.
F32	rotationalStrength
	'rotationalStrength' : Coefficient that sets strength of the rotational part of force.
F32	radialStrength
	'radialStrength' : Coefficient that sets strength of the radial part of force.
F32	liftStrength
	'liftStrength' : Coefficient that sets strength of the lifting part of force.
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 AttractorFS vs Field Boundaries interaction.
String	fieldSamplerFilterDataName
	'fieldSamplerFilterDataName' : The filter data name for AttractorFS vs other Field Samplers interaction.

---

Detailed Description

Describes the NxParameterized::Interface for 'VortexFSAssetParams' : Contains the asset properties for this Vortex Field Sampler.

VortexFSAssetParams contains 14 fully qualified names
---------------------------------------------
  1 : F32     boundaryFadePercentage       
  2 : Vec3    axis                         
  3 : Bool    bottomSphericalForce         
  4 : Bool    topSphericalForce            
  5 : F32     height                       
  6 : F32     bottomRadius                 
  7 : F32     topRadius                    
  8 : F32     rotationalStrength           
  9 : F32     radialStrength               
 10 : F32     liftStrength                 
 11 : F32     fieldDragCoeff               
 12 : F32     fieldWeight                  
 13 : String  fieldBoundaryFilterDataName  
 14 : String  fieldSamplerFilterDataName   

---

Member Data Documentation

Vec3 VortexFSAssetParams::axis

'axis' : The primary axis of the vortex around which the particles will rotate.

F32 VortexFSAssetParams::bottomRadius

'bottomRadius' : The radius of the bottom sphere of the capsule.

Bool VortexFSAssetParams::bottomSphericalForce

'bottomSphericalForce' : If this parameter true, radial forces in bottom sphere of the capsule will point to the center of sphere.

F32 VortexFSAssetParams::boundaryFadePercentage

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

String VortexFSAssetParams::fieldBoundaryFilterDataName

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

F32 VortexFSAssetParams::fieldDragCoeff

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

String VortexFSAssetParams::fieldSamplerFilterDataName

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

F32 VortexFSAssetParams::fieldWeight

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

F32 VortexFSAssetParams::height

'height' : The height of the capsule volume of the vortex.

F32 VortexFSAssetParams::liftStrength

'liftStrength' : Coefficient that sets strength of the lifting part of force.

F32 VortexFSAssetParams::radialStrength

'radialStrength' : Coefficient that sets strength of the radial part of force.

F32 VortexFSAssetParams::rotationalStrength

'rotationalStrength' : Coefficient that sets strength of the rotational part of force.

F32 VortexFSAssetParams::topRadius

'topRadius' : The radius of the top sphere of the capsule.

Bool VortexFSAssetParams::topSphericalForce

'topSphericalForce' : If this parameter true, radial forces in top sphere of the capsule will point to the center of sphere.

---

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

• params.h