CC3VertexColors Class Reference

#import <CC3VertexArrays.h>

Inheritance diagram for CC3VertexColors:

Instance Methods
(ccColor4B)	- color4BAt:
(ccColor4F)	- color4FAt:
(void)	- setColor4B:at:
(void)	- setColor4F:at:
Instance Methods inherited from CC3VertexArray
(void)	- __deprecated
(NSString *)	- __deprecated
(void)	- __deprecated
(GLvoid *)	- addressOfElement:
(GLvoid *)	- allocateElements:
(void)	- bindContentToAttributeAt:withVisitor:
(void)	- copyVertices:from:to:
(void)	- copyVertices:from:toAddress:
(void)	- copyVertices:fromAddress:to:
(void)	- copyVertices:fromAddress:toAddress:
(void)	- createGLBuffer
(void)	- deleteGLBuffer
(NSString *)	- describeElements:
(NSString *)	- describeElements:startingAt:
(NSString *)	- describeVertices
(NSString *)	- describeVertices:
(NSString *)	- describeVertices:startingAt:
(BOOL)	- ensureCapacity:
(id)	- initFromCPODData:fromSPODMesh:
(GLvoid *)	- interleaveWith:
(GLvoid *)	- interleaveWith:usingOffset:
(GLvoid *)	- reallocateElements:
(void)	- releaseRedundantContent
(void)	- updateGLBuffer
(void)	- updateGLBufferStartingAt:forLength:
Instance Methods inherited from CC3Identifiable
(id)	- copy
(id)	- copyAsClass:
(void)	- copyUserDataFrom:
(id)	- copyWithName:
(id)	- copyWithName:asClass:
(id)	- copyWithZone:withName:
(id)	- copyWithZone:withName:asClass:
(BOOL)	- deriveNameFrom:
(BOOL)	- deriveNameFrom:usingSuffix:
(NSString *)	- fullDescription
(id)	- init
(id)	- initAtIndex:fromPODResource:
(void)	- initUserData
(id)	- initWithName:
(id)	- initWithTag:
(id)	- initWithTag:withName:
(GLuint)	- nextTag
(void)	- populateFrom:

Properties
CCColorRef	color
CCOpacity	opacity
Properties inherited from CC3VertexArray
GLvoid *elements	__deprecated
GLuint elementCount	__deprecated
GLuint elementStride	__deprecated
GLfloat capacityExpansionFactor	__deprecated
BOOL shouldReleaseRedundantData	__deprecated
GLuint	allocatedVertexCapacity
GLuint	bufferID
GLenum	bufferTarget
GLenum	bufferUsage
GLuint	elementLength
GLuint	elementOffset
GLint	elementSize
GLenum	elementType
BOOL	isUsingGLBuffer
GLenum	semantic
BOOL	shouldAllowVertexBuffering
BOOL	shouldNormalizeContent
BOOL	shouldReleaseRedundantContent
GLuint	vertexCount
GLuint	vertexStride
GLvoid *	vertices
Properties inherited from CC3Identifiable
NSObject *sharedUserData	__deprecated
NSString *	name
NSString *	nameSuffix
GLint	podIndex
BOOL	shouldIncludeInDeepCopy
GLuint	tag
NSObject *	userData
Properties inherited from <CC3Cacheable>
NSString *	name

Additional Inherited Members
Class Methods inherited from CC3VertexArray
(id)	+ arrayFromCPODData:fromSPODMesh:
(GLenum)	+ defaultSemantic
(id)	+ vertexArray
(id)	+ vertexArrayWithName:
(id)	+ vertexArrayWithTag:
(id)	+ vertexArrayWithTag:withName:

Detailed Description

A CC3VertexArray that manages the per-vertex color aspect of an array of vertices.

Method Documentation

- (ccColor4B) color4BAt:

(GLuint)

index

Returns the color element at the specified index in the underlying vertex content.

If the underlying vertex content is not of type GLubyte, the color components are converted to GLubyte before the color value is returned.

The index refers to vertices, not bytes. The implementation takes into consideration the vertexStride and elementOffset properties to access the correct element.

If the releaseRedundantContent method has been invoked and the underlying vertex content has been released, this method will raise an assertion exception.

- (ccColor4F) color4FAt:

(GLuint)

index

Returns the color element at the specified index in the underlying vertex content.

If the underlying vertex content is not of type GLfloat, the color components are converted to GLfloat before the color value is returned.

The index refers to vertices, not bytes. The implementation takes into consideration the vertexStride and elementOffset properties to access the correct element.

If the releaseRedundantContent method has been invoked and the underlying vertex content has been released, this method will raise an assertion exception.

- (void) setColor4B:		(ccColor4B)	aColor
at:		(GLuint)	index

Sets the color element at the specified index in the underlying vertex content to the specified color value.

If the underlying vertex content is not of type GLubyte, the color components are converted to the appropriate type (typically GLfloat) before being set in the vertex content.

The index refers to vertices, not bytes. The implementation takes into consideration the vertexStride and elementOffset properties to access the correct element.

If the releaseRedundantContent method has been invoked and the underlying vertex content has been released, this method will raise an assertion exception.

- (void) setColor4F:		(ccColor4F)	aColor
at:		(GLuint)	index

Sets the color element at the specified index in the underlying vertex content to the specified color value.

If the underlying vertex content is not of type GLfloat, the color components are converted to the appropriate type (typically GLubyte) before being set in the vertex content.

The index refers to vertices, not bytes. The implementation takes into consideration the vertexStride and elementOffset properties to access the correct element.

If the releaseRedundantContent method has been invoked and the underlying vertex content has been released, this method will raise an assertion exception.

Property Documentation

- (CCColorRef) color

readwritenonatomicassign

The color of the vertices of this mesh.

Querying this property returns the RGB components of the first vertex.

When setting this property, the RGB values of each vertex are set to the specified color, without affecting the opacity value of each individual vertex. If the content of this vertex array has been copied to a GL buffer, that buffer is automatically updated.

- (CCOpacity) opacity

readwritenonatomicassign

The opacity of the vertices in this mesh.

Querying this property returns the alpha component of the first vertex.

When setting this property, the alpha values of each vertex is set to the specified opacity, without affecting the RGB color value of each individual vertex. If the content of this vertex array has been copied to a GL buffer, that buffer is automatically updated.

---

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

• CC3VertexArrays.h