CC3PointParticle Class Reference

#import <CC3PointParticles.h>

Inheritance diagram for CC3PointParticle:

Instance Methods
(id)	- initFromEmitter:
(void)	- update:
Instance Methods inherited from CC3ParticleBase
(id)	- init
(void)	- populateFrom:
(void)	- remove
Instance Methods inherited from <CC3PointParticleProtocol>
(void)	- pointNormalAt:

Class Methods
(id)	+ particleFromEmitter:
Class Methods inherited from CC3ParticleBase
(id)	+ particle

Properties
GLuint index	__deprecated
CC3PointParticleEmitter *	emitter
BOOL	hasNormal
BOOL	hasSize
CC3Vector	normal
GLfloat	size
Properties inherited from CC3ParticleBase
CCColorRef	color
ccColor4B	color4B
ccColor4F	color4F
CC3Vector	globalLocation
BOOL	hasColor
CC3Vector	location
CCOpacity	opacity
Properties inherited from <CC3PointParticleProtocol>
GLuint	particleIndex
Properties inherited from <CC3CommonVertexArrayParticleProtocol>
BOOL	hasVertexIndices
GLuint	vertexCount
GLuint	vertexIndexCount
NSRange	vertexIndexRange
NSRange	vertexRange

Detailed Description

CC3PointParticle is a standard base implementation of the CC3PointParticleProtocol.

CC3PointParticle provides accessors for the particle normal and size.

Method Documentation

- (id) initFromEmitter:

(CC3PointParticleEmitter *)

anEmitter

Deprecated:

Use the init method instead, and set emitter property directly.

+ (id) particleFromEmitter:

(CC3PointParticleEmitter *)

anEmitter

Deprecated:

Use the particle method instead, and set emitter property directly.

- (void) update:

(CCTime)

__deprecated

Deprecated:

Replaced by the updateBeforeTransform: method.

Property Documentation

- (GLuint index) __deprecated

readwritenonatomicassign

Deprecated:

Replaced by the particleIndex property.

- (CC3PointParticleEmitter*) emitter

readwritenonatomicunsafe_unretained

The emitter that emitted this particle.

For CC3PointParticle, the emitter must be of type CC3PointParticleEmitter.

- (BOOL) hasNormal

readnonatomicassign

Indicates whether this particle has vertex normal content, as determined by the vertexContentTypes property of the emitter.

Within an emitter, either all particles have normal content, or none do.

When this property returns YES, each particle will have a normal vector and will interact with light sources. When this property returns NO, each particle will ignore lighting conditions.

- (BOOL) hasSize

readnonatomicassign

Indicates whether this particle has vertex size content, as determined by the vertexContentTypes property of the emitter.

Within an emitter, either all particles have size content, or none do.

When this property returns YES, each particle can be set to a different size. When this property returns NO, all particles will have the size specified by the particleSize property of the emitter.

- (CC3Vector) normal

readwritenonatomicassign

If this particle has vertex normal content, (which can be checked with the hasNormal property), this property indicates the vertex normal that the particle uses to interact with light sources.

This property is automatically and dynamically adjusted by the emitter, based on the particle's orientation with respect to the camera. Unless you have specific reason to change this property, and know what you are doing, you should leave the value of this property alone.

If this particle does not have vertex normal content, this property will always return kCC3VectorZero. In this condition, it is safe to set this property, but changes will have no effect.

- (GLfloat) size

readwritenonatomicassign

If this particle has individual size content, (which can be checked with the hasSize property), this property indicates the size at which this particle will appear.

If this particle has individual size content, you can set this property at any time to define the size of the particle.

If this particle does not have individual size content, this property will always return the value of the particleSize property of the emitter. In this condition, it is safe to set this property, but changes will have no effect.

---

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

• CC3PointParticles.h