APEX NvParameterized Schemas: EmitterEffect Struct Reference

NVIDIA APEX

EmitterEffect Struct Reference

Describes the NxParameterized::Interface for 'EmitterEffect' : An emitter 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
Bool EmitterVelocityChanges.AdjustLifetime.AdjustEnabled
 'EmitterVelocityChanges.AdjustLifetime.AdjustEnabled' : True if adjusting emitter properties based on velocity
F32 EmitterVelocityChanges.AdjustLifetime.VelocityLow
 'EmitterVelocityChanges.AdjustLifetime.VelocityLow' : Low velocity range to match the low
F32 EmitterVelocityChanges.AdjustLifetime.VelocityHigh
 'EmitterVelocityChanges.AdjustLifetime.VelocityHigh' : High velocity range to match the high value
F32 EmitterVelocityChanges.AdjustLifetime.LowValue
 'EmitterVelocityChanges.AdjustLifetime.LowValue' : The multiplier when the velocity equals VelocityLow
F32 EmitterVelocityChanges.AdjustLifetime.HighValue
 'EmitterVelocityChanges.AdjustLifetime.HighValue' : The multiplier when the velocity equals VelocityHigh
Bool EmitterVelocityChanges.AdjustEmitterRate.AdjustEnabled
 'EmitterVelocityChanges.AdjustEmitterRate.AdjustEnabled' : True if adjusting emitter properties based on velocity
F32 EmitterVelocityChanges.AdjustEmitterRate.VelocityLow
 'EmitterVelocityChanges.AdjustEmitterRate.VelocityLow' : Low velocity range to match the low
F32 EmitterVelocityChanges.AdjustEmitterRate.VelocityHigh
 'EmitterVelocityChanges.AdjustEmitterRate.VelocityHigh' : High velocity range to match the high value
F32 EmitterVelocityChanges.AdjustEmitterRate.LowValue
 'EmitterVelocityChanges.AdjustEmitterRate.LowValue' : The multiplier when the velocity equals VelocityLow
F32 EmitterVelocityChanges.AdjustEmitterRate.HighValue
 'EmitterVelocityChanges.AdjustEmitterRate.HighValue' : The multiplier when the velocity equals VelocityHigh
Ref Emitter
 'Emitter' : Emitter Asset

Detailed Description

Describes the NxParameterized::Interface for 'EmitterEffect' : An emitter effect.

EmitterEffect contains 35 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 : Bool           EmitterVelocityChanges.AdjustLifetime.AdjustEnabled     
 26 : F32            EmitterVelocityChanges.AdjustLifetime.VelocityLow       
 27 : F32            EmitterVelocityChanges.AdjustLifetime.VelocityHigh      
 28 : F32            EmitterVelocityChanges.AdjustLifetime.LowValue          
 29 : F32            EmitterVelocityChanges.AdjustLifetime.HighValue         
 30 : Bool           EmitterVelocityChanges.AdjustEmitterRate.AdjustEnabled  
 31 : F32            EmitterVelocityChanges.AdjustEmitterRate.VelocityLow    
 32 : F32            EmitterVelocityChanges.AdjustEmitterRate.VelocityHigh   
 33 : F32            EmitterVelocityChanges.AdjustEmitterRate.LowValue       
 34 : F32            EmitterVelocityChanges.AdjustEmitterRate.HighValue      
 35 : Ref            Emitter                                                 

Member Data Documentation

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

'Emitter' : Emitter Asset

'EmitterVelocityChanges.AdjustEmitterRate.AdjustEnabled' : True if adjusting emitter properties based on velocity

'EmitterVelocityChanges.AdjustEmitterRate.HighValue' : The multiplier when the velocity equals VelocityHigh

'EmitterVelocityChanges.AdjustEmitterRate.LowValue' : The multiplier when the velocity equals VelocityLow

'EmitterVelocityChanges.AdjustEmitterRate.VelocityHigh' : High velocity range to match the high value

'EmitterVelocityChanges.AdjustEmitterRate.VelocityLow' : Low velocity range to match the low

'EmitterVelocityChanges.AdjustLifetime.AdjustEnabled' : True if adjusting emitter properties based on velocity

'EmitterVelocityChanges.AdjustLifetime.HighValue' : The multiplier when the velocity equals VelocityHigh

'EmitterVelocityChanges.AdjustLifetime.LowValue' : The multiplier when the velocity equals VelocityLow

'EmitterVelocityChanges.AdjustLifetime.VelocityHigh' : High velocity range to match the high value

'EmitterVelocityChanges.AdjustLifetime.VelocityLow' : Low velocity range to match the low


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

Generated on Fri Dec 15 2017 13:59:11

Copyright © 2012-2017 NVIDIA Corporation, 2701 San Tomas Expressway, Santa Clara, CA 95050 U.S.A. All rights reserved.