VelocitySourceEffect Struct Reference

Describes the NxParameterized::Interface for 'VelocitySourceEffect' : A velocity source effect. More...

#include <params.h>

List of all members.

Public Attributes
String	EffectProperties.UserString
	'EffectProperties.UserString' : An aribtrary user string that can be set by an artist/designer/programmer
Bool	EffectProperties.Enable
	'EffectProperties.Enable' : Whether or not this effect is to be initially enabled on startup
F32	EffectProperties.Position.TranslateX
	'EffectProperties.Position.TranslateX' : Nudge up to +/- one meter in each direction
F32	EffectProperties.Position.TranslateY
	'EffectProperties.Position.TranslateY' : Nudge up to +/- one meter in each direction
F32	EffectProperties.Position.TranslateZ
	'EffectProperties.Position.TranslateZ' : Nudge up to +/- one meter in each direction
F32	EffectProperties.Orientation.RotateX
	'EffectProperties.Orientation.RotateX' : Rotate on the X axis (0-360 degrees)
F32	EffectProperties.Orientation.RotateY
	'EffectProperties.Orientation.RotateY' : Rotate on the Y axis (0-360 degrees)
F32	EffectProperties.Orientation.RotateZ
	'EffectProperties.Orientation.RotateZ' : Rotate on the Z axis (0-360 degrees)
F32	EffectProperties.InitialDelayTime
	'EffectProperties.InitialDelayTime' : Initial time to delay before spawning this effect
F32	EffectProperties.Duration
	'EffectProperties.Duration' : The duration of the effect in secontds
U32	EffectProperties.RepeatCount
	'EffectProperties.RepeatCount' : The number of times to repeat the effect; 9999 means repeate forever
F32	EffectProperties.RepeatDelay
	'EffectProperties.RepeatDelay' : The time to delay activation each time the effect repeats in seconds; this can be different than the initial delay time
F32	EffectProperties.RandomizeRepeatTime
	'EffectProperties.RandomizeRepeatTime' : Amount of randomization to the repeat cycle; a value of zero (default) means no random and a value of one means completely random.
PlaybackMode	EffectProperties.Path.PlaybackMode
	'EffectProperties.Path.PlaybackMode' : The mode to play back the path
F32	EffectProperties.Path.PathDuration
	'EffectProperties.Path.PathDuration' : The duration of the path if one is not otherwise provided
U32	EffectProperties.Path.LoopIndex
	'EffectProperties.Path.LoopIndex' : The array index to loop back to
Transform	EffectProperties.Path.ControlPoints[]
	'EffectProperties.Path.ControlPoints[]' : The array of control points to fit the curve to
F32	EffectProperties.Path.Scale[].x
	'EffectProperties.Path.Scale[].x' : The x-axis value for this vector
F32	EffectProperties.Path.Scale[].y
	'EffectProperties.Path.Scale[].y' : The y-axis value for this vector
F32	EffectProperties.Path.Speed[].x
	'EffectProperties.Path.Speed[].x' : The x-axis value for this vector
F32	EffectProperties.Path.Speed[].y
	'EffectProperties.Path.Speed[].y' : The y-axis value for this vector
Ref	VelocitySource
	'VelocitySource' : Velocity Source Asset

---

Detailed Description

Describes the NxParameterized::Interface for 'VelocitySourceEffect' : A velocity source effect.

VelocitySourceEffect contains 25 fully qualified names
---------------------------------------------
  1 : String         EffectProperties.UserString            
  2 : Bool           EffectProperties.Enable                
  3 : F32            EffectProperties.Position.TranslateX   
  4 : F32            EffectProperties.Position.TranslateY   
  5 : F32            EffectProperties.Position.TranslateZ   
  6 : F32            EffectProperties.Orientation.RotateX   
  7 : F32            EffectProperties.Orientation.RotateY   
  8 : F32            EffectProperties.Orientation.RotateZ   
  9 : F32            EffectProperties.InitialDelayTime      
 10 : F32            EffectProperties.Duration              
 11 : U32            EffectProperties.RepeatCount           
 12 : F32            EffectProperties.RepeatDelay           
 13 : F32            EffectProperties.RandomizeRepeatTime   
 14 : PlaybackMode   EffectProperties.Path.PlaybackMode     
 15 : F32            EffectProperties.Path.PathDuration     
 16 : U32            EffectProperties.Path.LoopIndex        
 17 : ArraySizeName  ControlPoints                          
 18 : Transform      EffectProperties.Path.ControlPoints[]  
 19 : ArraySizeName  Scale                                  
 20 : F32            EffectProperties.Path.Scale[].x        
 21 : F32            EffectProperties.Path.Scale[].y        
 22 : ArraySizeName  Speed                                  
 23 : F32            EffectProperties.Path.Speed[].x        
 24 : F32            EffectProperties.Path.Speed[].y        
 25 : Ref            VelocitySource                         

---

Member Data Documentation

F32 VelocitySourceEffect::EffectProperties.Duration

'EffectProperties.Duration' : The duration of the effect in secontds

Bool VelocitySourceEffect::EffectProperties.Enable

'EffectProperties.Enable' : Whether or not this effect is to be initially enabled on startup

F32 VelocitySourceEffect::EffectProperties.InitialDelayTime

'EffectProperties.InitialDelayTime' : Initial time to delay before spawning this effect

F32 VelocitySourceEffect::EffectProperties.Orientation.RotateX

'EffectProperties.Orientation.RotateX' : Rotate on the X axis (0-360 degrees)

F32 VelocitySourceEffect::EffectProperties.Orientation.RotateY

'EffectProperties.Orientation.RotateY' : Rotate on the Y axis (0-360 degrees)

F32 VelocitySourceEffect::EffectProperties.Orientation.RotateZ

'EffectProperties.Orientation.RotateZ' : Rotate on the Z axis (0-360 degrees)

Transform VelocitySourceEffect::EffectProperties.Path.ControlPoints[]

'EffectProperties.Path.ControlPoints[]' : The array of control points to fit the curve to

U32 VelocitySourceEffect::EffectProperties.Path.LoopIndex

'EffectProperties.Path.LoopIndex' : The array index to loop back to

F32 VelocitySourceEffect::EffectProperties.Path.PathDuration

'EffectProperties.Path.PathDuration' : The duration of the path if one is not otherwise provided

PlaybackMode VelocitySourceEffect::EffectProperties.Path.PlaybackMode

'EffectProperties.Path.PlaybackMode' : The mode to play back the path

F32 VelocitySourceEffect::EffectProperties.Path.Scale[].x

'EffectProperties.Path.Scale[].x' : The x-axis value for this vector

F32 VelocitySourceEffect::EffectProperties.Path.Scale[].y

'EffectProperties.Path.Scale[].y' : The y-axis value for this vector

F32 VelocitySourceEffect::EffectProperties.Path.Speed[].x

'EffectProperties.Path.Speed[].x' : The x-axis value for this vector

F32 VelocitySourceEffect::EffectProperties.Path.Speed[].y

'EffectProperties.Path.Speed[].y' : The y-axis value for this vector

F32 VelocitySourceEffect::EffectProperties.Position.TranslateX

'EffectProperties.Position.TranslateX' : Nudge up to +/- one meter in each direction

F32 VelocitySourceEffect::EffectProperties.Position.TranslateY

'EffectProperties.Position.TranslateY' : Nudge up to +/- one meter in each direction

F32 VelocitySourceEffect::EffectProperties.Position.TranslateZ

'EffectProperties.Position.TranslateZ' : Nudge up to +/- one meter in each direction

F32 VelocitySourceEffect::EffectProperties.RandomizeRepeatTime

'EffectProperties.RandomizeRepeatTime' : Amount of randomization to the repeat cycle; a value of zero (default) means no random and a value of one means completely random.

U32 VelocitySourceEffect::EffectProperties.RepeatCount

'EffectProperties.RepeatCount' : The number of times to repeat the effect; 9999 means repeate forever

F32 VelocitySourceEffect::EffectProperties.RepeatDelay

'EffectProperties.RepeatDelay' : The time to delay activation each time the effect repeats in seconds; this can be different than the initial delay time

String VelocitySourceEffect::EffectProperties.UserString

'EffectProperties.UserString' : An aribtrary user string that can be set by an artist/designer/programmer

Ref VelocitySourceEffect::VelocitySource

'VelocitySource' : Velocity Source Asset

---

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

• params.h