A CC3Billboard node customized to display and manage a cocos2d 2D CCParticleSystem. More...
#import <CC3Billboard.h>
Properties | |
| CC3AttenuationCoefficients | particleSizeAttenuationCoefficients |
| BOOL | shouldTransformUnseenParticles |
Detailed Description
A CC3Billboard node customized to display and manage a cocos2d 2D CCParticleSystem.
This specialized subclass adds some specific features to aid with drawing particle systems, including:
- Setting the particle size attenuation before drawing.
- If the CCParticleSystem has a finite duration and its autoRemoveOnFinish property is set to YES, the CC3ParticleSystemBillboard node is automatically removed from its parent once the particle system has finished emitting.
- In cocos2d, particle systems draw all particles at the same Z-distance. When undergoing transforms in the 3D scene, the result is that the Z-distances are very close but not equal, resulting in Z-fighting between the particles. To avoid this, if the shouldDisableDepthMask property is set to YES, the GL depth mask is temporarily disabled during drawing so that particles will not update the depth buffer, meaning that the Z-distance of each particle will be compared against previously drawn objects, but not against each other. For CC3Billboard, the default value of the shouldDisableDepthMask is YES, indicating that the GL depth mask will be disabled during the drawing of the particles.
Property Documentation
- (CC3AttenuationCoefficients) particleSizeAttenuationCoefficients [read, write, assign] |
The coefficients of the attenuation function that affects the size of a particle based on its distance from the camera.
The sizes of the particles are attenuated according to the formula 1/sqrt(a + b * r + c * r * r), where r is the radial distance from the particle to the camera, and a, b and c are the coefficients from this property.
The initial value of this property is kCC3ParticleSizeAttenuationNone, indicating no attenuation with distance.
- (BOOL) shouldTransformUnseenParticles [read, write, assign] |
Indicates whether scheduled updates of the contained 2D billboard should continue when this node is outside the camera's view frustum.
This property is simply an alias for the parent shouldUpdateUnseenBillboard property, and exists for compatibility with the same property on the CC3MeshParticleEmitter class.
The initial value of this property is YES. You can set this property to NO to pause unnecessary update activity when the billboard is not in view.
The property does not affect any CCAction activities that might be running on the contained 2D billboard.
The documentation for this class was generated from the following file:
