Inherits from CC3NodeAnimation : NSObject
Declared in CC3NodeAnimation.h

Overview

A concrete CC3NodeAnimation that holds animation data in simple arrays. The arrays can be allocated and managed either by the instance, or externally.

There are three properties that hold the animated content: – animatedLocations – location animation content – animatedQuaternions – rotation quaternion animation content – animatedScales – scale animation content

You do not need to use all of these properties. You can choose to animate any subset of these animation data properties, and leave the remaining animation data properties set to NULL (the default). If you do not set an animation data property, the corresponding property on the node will not be animated, and will retain its originally set value.

For example, if you set only the animatedLocations property, and run a CC3ActionAnimate on the node, only the location of the node will move around during the animation. The remaining node properties (quaternion & scale) will remain unchanged by the animation. The effect will be that the node moves around, but remains at a fixed size, and oriented in a fixed rotation.

This animation can be configured so that time interval between frames can vary from frame to frame, or that the time interval between frames is constant. To configure for variable frame timing, use the frameTimes property to assign a specific time to each frame. To configure for equally-spaced frames, set the frameTimes property to NULL.

You can work with these animation content properties in one of two ways: – Allocate the arrays outside this class and simply assign them to this instance using the property accessors. In this case, it is up to you to allocate and deallocate the memory used by the arrays. – Invoke one or more of the methods allocateFrameTimes, allocateLocations, allocateQuaternions, and allocateScales to instruct this instance to allocate and manage the memory for the content array. You can then access the associated array via the frameTimes, animatedLocations, animatedQuaternions, and animatedScales properties respectively. This instance will take care of releasing the arrays when appropriate.

Tasks

Properties

animatedLocations

An array of animated location content. Each CC3Vector in the array holds the location content for one frame of animation. The array must have at least frameCount elements.

@property (nonatomic, assign) CC3Vector *animatedLocations

Discussion

This property can be set to NULL to indicate that the location is not animated.

The isAnimatingLocation property will return YES if this property is not NULL, and NO otherwise.

Setting this property will safely free any memory allocated by the allocateLocations method.

The initial value of this property is NULL.

Declared In

CC3NodeAnimation.h

animatedQuaternions

An array of animated rotation quaternion content. Each CC3Quaternion in the array holds the rotation content for one frame of animation. The array must have at least frameCount elements.

@property (nonatomic, assign) CC3Quaternion *animatedQuaternions

Discussion

This property can be set to NULL to indicate that the rotation is not animated.

The isAnimatingQuaternion property will return YES if this property is not NULL, and NO otherwise.

Setting this property will safely free any memory allocated by the allocateQuaternions method.

The initial value of this property is NULL.

Declared In

CC3NodeAnimation.h

animatedScales

An array of animated scale content. Each CC3Vector in the array holds the scale content for one frame of animation. The array must have at least frameCount elements.

@property (nonatomic, assign) CC3Vector *animatedScales

Discussion

This property can be set to NULL to indicate that the scale is not animated.

The isAnimatingScale property will return YES if this property is not NULL, and NO otherwise.

Setting this property will safely free any memory allocated by the allocateScales method.

The initial value of this property is NULL.

Declared In

CC3NodeAnimation.h

frameTimes

An array of frame times. Each CCTime in the array indicates the time for one frame. All values must be within the range from zero and one inclusive. For accurate animation, the value of the first element of this array should be zero, and the value of the last element should be one. The array must have at least frameCount elements.

@property (nonatomic, assign) CCTime *frameTimes

Discussion

This property can be set to NULL to indicate that the duration of all of the frames is the same.

The hasVariableFrameTiming property will return YES if this property is not NULL, and NO otherwise.

Setting this property will safely free any memory allocated by the allocateFrameTimes method.

The initial value of this property is NULL, indicating that the frames are equally spaced.

Declared In

CC3NodeAnimation.h

Instance Methods

allocateFrameTimes

Allocates underlying memory for an array of frame times. All elements of the array are initialized to zero. The amount of memory allocated will be (frameCount * sizeof(CCTime)) bytes.

- (CCTime *)allocateFrameTimes

Discussion

It is safe to invoke this method more than once, but understand that any previously allocated memory will be safely freed prior to the allocation of the new memory. The memory allocated earlier will therefore be lost and should not be referenced.

Declared In

CC3NodeAnimation.h

allocateLocations

Allocates underlying memory for an array of location vectors. All elements of the array are initialized to zero location. The amount of memory allocated will be (frameCount * sizeof(CC3Vector)) bytes.

- (CC3Vector *)allocateLocations

Discussion

It is safe to invoke this method more than once, but understand that any previously allocated memory will be safely freed prior to the allocation of the new memory. The memory allocated earlier will therefore be lost and should not be referenced.

Declared In

CC3NodeAnimation.h

allocateQuaternions

Allocates underlying memory for an array of quaternions vectors. All elements of the array are initialized to the identity quaternion. The amount of memory allocated will be (frameCount * sizeof(CC3Quaternion)) bytes.

- (CC3Quaternion *)allocateQuaternions

Discussion

It is safe to invoke this method more than once, but understand that any previously allocated memory will be safely freed prior to the allocation of the new memory. The memory allocated earlier will therefore be lost and should not be referenced.

Declared In

CC3NodeAnimation.h

allocateScales

Allocates underlying memory for an array of scale vectors. All elements of the array are initialized to unity scale. The amount of memory allocated will be (frameCount * sizeof(CC3Vector)) bytes.

- (CC3Vector *)allocateScales

Discussion

It is safe to invoke this method more than once, but understand that any previously allocated memory will be safely freed prior to the allocation of the new memory. The memory allocated earlier will therefore be lost and should not be referenced.

Declared In

CC3NodeAnimation.h

deallocateFrameTimes

Deallocates the underlying frame times array allocated with the allocateFrameTimes method. It is safe to invoke this method more than once, or even if allocateFrameTimes was not previously invoked.

- (void)deallocateFrameTimes

Discussion

This method is invoked automatically when this instance is deallocated.

Declared In

CC3NodeAnimation.h

deallocateLocations

Deallocates the underlying location array allocated with the allocateLocations method. It is safe to invoke this method more than once, or even if allocateLocations was not previously invoked.

- (void)deallocateLocations

Discussion

This method is invoked automatically when this instance is deallocated.

Declared In

CC3NodeAnimation.h

deallocateQuaternions

Deallocates the underlying quaternion array allocated with the allocateQuaternions method. It is safe to invoke this method more than once, or even if allocateQuaternions was not previously invoked.

- (void)deallocateQuaternions

Discussion

This method is invoked automatically when this instance is deallocated.

Declared In

CC3NodeAnimation.h

deallocateScales

Deallocates the underlying scale array allocated with the allocateScales method. It is safe to invoke this method more than once, or even if allocateScales was not previously invoked.

- (void)deallocateScales

Discussion

This method is invoked automatically when this instance is deallocated.

Declared In

CC3NodeAnimation.h