Properties

<CC3CommonVertexArrayParticleProtocol> Protocol Reference

CC3CommonVertexArrayParticleProtocol defines the requirements for particles that are emitted and managed by the CC3CommonVertexArrayParticleEmitter class. More...

#import <CC3Particles.h>

Inheritance diagram for <CC3CommonVertexArrayParticleProtocol>:
Inheritance graph
[legend]
Collaboration diagram for <CC3CommonVertexArrayParticleProtocol>:
Collaboration graph
[legend]

List of all members.

Properties

BOOL hasVertexIndices
GLuint vertexCount
GLuint vertexIndexCount
NSRange vertexIndexRange
NSRange vertexRange

Detailed Description

CC3CommonVertexArrayParticleProtocol defines the requirements for particles that are emitted and managed by the CC3CommonVertexArrayParticleEmitter class.

A CC3CommonVertexArrayParticleEmitter maintains the vertices of all particles in common vertex arrays.


Property Documentation

- (BOOL) hasVertexIndices [read, assign]

Returns whether this particle uses indexed vertices.

- (GLuint) vertexCount [read, assign]

Returns the number of vertices in this particle.

- (GLuint) vertexIndexCount [read, assign]

Returns the number of vertex indices required for the mesh of this particle.

Not all meshes use vertex indices. If indexed drawing is used by this particle, this method returns the number of vertex indices in the particle. If indexed drawing is not used by this particle, this property returns the same value as the vertexCount property, indicating, in effect, the number of indices that would be required if this particle was converted to using indexed drawing.

This behaviour allows a particle that does not use indexed drawing to be added to an emitter that does use indexed drawing. When this happens, the missing vertex indices are automatically synthesized.

- (NSRange) vertexIndexRange [read, assign]

Returns the range of vertex indices in the underlying mesh that are managed by this particle.

The location element of the returned range structure contains the index to the first vertex index of this particle, and the length element contains the same value as the vertexIndexCount property.

Not all meshes use vertex indices. If indexed drawing is used by this particle, this method returns the range of vertex indices in the particle. If indexed drawing is not used by this particle, this property returns the same value as the vertexRange property, indicating, in effect, the range of indices that would be required if this particle was converted to using indexed drawing.

This behaviour allows a particle that does not use indexed drawing to be added to an emitter that does use indexed drawing. When this happens, the missing vertex indices are automatically synthesized.

- (NSRange) vertexRange [read, assign]

Returns the range of vertices in the underlying mesh that are managed by this particle.

The location element of the returned range structure contains the index to the first vertex of this particle, and the length element contains the same value as the vertexCount property.


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