 |
XNACS1Lib Library Documentation
XNACS1ParticleEmitter Members |
|
|
XNACS1Lib Library Documentation
XNACS1ParticleEmitter Members |
XNACS1ParticleEmitter overview
XNACS1ParticleEmitter Constructor
|
Constructs a particle Emitter. |
 AttachedPrimitive | Gets or Sets the primitive that this emitter is attached to. The emitter's center will be automatically updated each tick to match the attached primitive's center. |
| AutoEmitEnabled | Gets or Sets whether or not particles should automatically be emitted every EmitFrequency ticks. |
| AutoRemoveDeadParticles | Gets or sets whether or not particles with zero life remaining will be automatically deleted from the particle emitter set. Setting a particle's life to negative will ensure it is never deleted via this functionality. |
| Center (inherited from XNACS1Particle) | Center of the primitive. |
| CenterX (inherited from XNACS1Primitive) | X coordinate of the center position of the primitive. |
| CenterY (inherited from XNACS1Primitive) | Y coordinate of the center position of the primitive. |
| Color (inherited from XNACS1Primitive) | Color of the primitive. (undefined for PrimitiveSet). |
| CurrentSpriteSheetFrameX (inherited from XNACS1Primitive) | Gets or Sets the zero-based current sprite column for sprite sheet drawing. |
| CurrentSpriteSheetFrameY (inherited from XNACS1Primitive) | Gets or Sets the zero-based current sprite row for sprite sheet drawing. |
| DefaultColor | Gets or Sets The default color of emitted particles. |
| DefaultTexture | Gets or Sets The default texture of emitted particles. |
| DisplacementAmplitude (inherited from XNACS1Particle) | The amplitude of the Particle TravelMode displacement. For example, the amplitude of the Sine Wave. |
| DisplacementFrequency (inherited from XNACS1Particle) | The frequency of the Particle TravelMode displacement. The default is 1, values between 0..1 would stretch a sine wave while values >1 would compress it. |
| EmitFrequency | Gets or Sets how many ticks between calls of EmitParticle if AutoEmitEnable = True. |
| FrontDirection (inherited from XNACS1Primitive) | Sets the front direction of the primitive. Setting FrontDireciton will cause the RotateAngle and NormalDirection of the primitive to be updated accordingly. y default, when RotateAngle is 0, FrontDireciton points towards (1,0) [positive X-direction]. E.g., if we set RotateAngle to 90-degrees, FrontDireciton will be updated accordinlgy to (0,1) [positive y-direciton], or rotated 90-degress in the anit-clockwise direction |
| InitialLife | Gets or Sets the default life in ticks for emitted particles. |
| InitialSize | Gets or Sets The default size of emitted particles. |
| Label (inherited from XNACS1Primitive) | Annotated text label to be associated with the primitive. |
| LabelColor (inherited from XNACS1Primitive) | Color of the anontated text label. |
| Life (inherited from XNACS1Particle) | Gets or sets the life parameter of a particle. |
| MaxBound (inherited from XNACS1Primitive) | Upper left corner of the primitive. |
| MinBound (inherited from XNACS1Primitive) | Lower left corner of the Primitive. |
| NormalDirection (inherited from XNACS1Primitive) | Get or Set the normal direction of the primitive. Setting NormalDirection will update RotateAngle and FrontDirection accordingly. |
| ParticlesPerEmit | Gets or Sets the number of particles to be emitted per emit cycle if AutoEmitEnabled = true. |
| Radius (inherited from XNACS1Circle) | Radius of the circle. |
| RotateAngle (inherited from XNACS1Primitive) | Rotate the primitive by the Angle specified (in degree). After the rotation, the FrontDirection of the primitive will be udpated accordingly. By default, when RotateAngle is 0, FrontDireciton points towards (1,0) [positive X-direction]. E.g., if we set RotateAngle to 90-degrees, FrontDireciton will be updated accordinlgy to (0,1) [positive y-direciton], or rotated 90-degress in the anit-clockwise direction |
| ShouldTravel (inherited from XNACS1Particle) | Defines if the primitive should move by its current velocity. Defaults to false. |
| Speed (inherited from XNACS1Primitive) | Get/Set the speed (magnitude of the Velocity vector) for the velocity. |
| Texture (inherited from XNACS1Primitive) | Texture file name (without the "." or the extension) to cover the primitive. |
| TextureTintColor (inherited from XNACS1Primitive) | If a primitive has a texture assigned, this will change the tint and or opacity of the texture when drawn, Color.White is no tint or opacity. |
| TravelMode (inherited from XNACS1Particle) | Gets or Sets the primitive's TravelMode if ShouldTravel = True. Used in conjunction with DisplacementAmplitude and DisplacementFrequecy. |
| UseSpriteSheet (inherited from XNACS1Primitive) | Allow the primitive to draw as a sprite sheet. |
| UseSpriteSheetAnimation (inherited from XNACS1Primitive) | Allow the primitive to follow a specified sprite sheet animation sequence. |
| Velocity (inherited from XNACS1Primitive) | Velocity of a primitive. This is a true velocity: with magnitude (speed) and direction for tavel. |
| VelocityDirection (inherited from XNACS1Primitive) | Get/Set the direction of the velocity. |
| VelocityX (inherited from XNACS1Primitive) | Get/Set the x-component of the primitive velocity. |
| VelocityY (inherited from XNACS1Primitive) | Get/Set the y-component of the primitive velocity. |
| Visible (inherited from XNACS1Primitive) | Whether the primitive is visible. |
| Above (inherited from XNACS1Primitive) | Returns if the center of this primitive is "above" (in y) in relation to the center of otherPrimitive. |
| AddEmitterToUpdateSet | Adds the emitter to the emitter update list. This will cause the emitter's UpdateEmitter function to be called once per tick and it to emit particles as defined. Newly created emitters are automatically in the update set. |
| AddToAutoDrawSet (inherited from XNACS1Primitive) | Add this primitive to the AutoDrawSet. If this primitive already exists in the draw set, this function call is ignored. By default, all primitive are added into the AutoDrawSet. |
| Below (inherited from XNACS1Primitive) | Returns if the center of this primitive is "below" (in y) in relation to the center of otherPrimitive. |
| Collided (inherited from XNACS1Primitive) | Overloaded. Determines if this primitive collides with the otherPrimitive. If true, pos is the colliding position. |
| Draw (inherited from XNACS1Primitive) | If visible, draws the primitive with the associated text label. |
| HasNonZeroVelocity (inherited from XNACS1Primitive) | Retruns if the current velocity is non-zero. |
| IsInAutoDrawSet (inherited from XNACS1Primitive) | Determines if this primitive is in the AutoDrawSet. |
| LeftOf (inherited from XNACS1Primitive) | Returns if the center of this primitive is "to the left" (in x) in relation to the center of otherPrimtive |
| RemoveEmitterFromUpdateSet | Removes the emitter from the emitter update list. To be called before removing all references to the emitter so that garbage collection can collect it. |
| RemoveFromAutoDrawSet (inherited from XNACS1Primitive) | Remove this primitive from the AutoDrawSet. After this function call, this primitive will not be drawn in the application window. |
| RightOf (inherited from XNACS1Primitive) | Returns if the center of this primitive is "to the right" (in x) in relation to the center of otherPrimitive |
| SetTextureSpriteAnimationFrames (inherited from XNACS1Primitive) | Sets animation parameters for a sprite sheet primitive. Zero-based first frame column for the beginning sprite in the animation sequence.
Zero-based first frame row for the beginning sprite in the animation sequence.
Zero-based first frame column for the ending sprite in the animation sequence.
Zero-based first frame row for the ending sprite in the animation sequence.
How many ticks the animation will pause for on each frame.
The behavior of the animation loop.
|
| SetTextureSpriteSheet (inherited from XNACS1Primitive) | Defines a texture specified for a primitive to behave like a sprite sheet with the specified number of sprites. The default sprite to be drawn is the top left sprite in the sheet. Example: The texture for a given primitive has 16 sprites in it, arranged in a 4 by 4 pattern. By default, all 16 sprites will be displayed, stretched to fit the primitive. Calling this method allows you to specify the number of sprites in the texture. The texture of the sprite sheet to be used.
The number of columns in the sprite sheet (number of sprites in a single row).
Number of rows in the sprite sheet.
The padding between sprites and on the top and left edge.
|
| TopOfAutoDrawSet (inherited from XNACS1Primitive) | Make sure this primitive is drawn on top of all other primitives. |
| TravelPrimitive (inherited from XNACS1Particle) | Overloaded TravelPrimitive for Particles. Moves the particle during each update cycle. This function is automacially called for all visible particle. Default behavior is to move the particle if: . Primitive is visible (invivislble primitive is not updated) . ShouldTravel is true . HasNonZeroVelocity() is true This method moves the particle in the direction of its velocity and also displaces it according to the ParticleTravelMode chosen. |
 DrawPrimitive | Draws all the particles in the emitter |
| Emit | When this method is called a new particle will be added to the emitter set and NewParticle() will be called to change the initial parameters of the particle if needed. |
| KillParticle | Overloaded. Removes a particle from the emitter list. |
| NewParticle | This method is called by the Emit method whenever a particle is created. By default particles are created at the Center location of the emitter with InitialLife, InitialSize, DefaultTexture, and DefaultColor. Newly created particles also have shouldtravel set to false and velocity = 0. By overloading this method you can change these properties to make particles emit in different ways. Particle that has just been created and added to the set.
|
| Update | Controls updates for AttachedPrimitive, AutoRemoveDead, and AutoEmit. Overload at your own risk! |
| UpdateParticle | This is where you define the behavior of particles in the emitter. This method will be called once a tick for each particle if the emitter is in the Emitter Update Set. This is an abstract method and must be overloaded. |
 Size (inherited from XNACS1Primitive) | Get/Set width/height of the primitive. |
| SizeX (inherited from XNACS1Primitive) | Width of the primitive. |
| SizeY (inherited from XNACS1Primitive) | Height of the primitive. For PrimitiveCircle (diameter), PrimitiveRectangle (height), PrimitiveSet (undefined). |
XNACS1ParticleEmitter Class | XNACS1Lib Namespace
|
This work is supported in part by a grant from Microsoft Research under the Computer Gaming Curriculum in Computer Science RFP, Award Number 15871 and 16531. |