 |
cocos2d-iphone
1.0.1
Improved Cocos2D API Reference (iOS version) for Kobold2D developers
|
|
cocos2d-iphone
1.0.1
Improved Cocos2D API Reference (iOS version) for Kobold2D developers
|
#include <CCDirector.h>
Inheritance diagram for CCDirector: Collaboration diagram for CCDirector:Public Member Functions | |
| CGSize | winSize () |
| CGSize | winSizeInPixels () |
| CGSize | displaySizeInPixels () |
| void | reshapeProjection: (CGSize newWindowSize) |
| CGPoint | convertToGL: (CGPoint p) |
| CGPoint | convertToUI: (CGPoint p) |
| float | getZEye () |
| XXX: missing description. | |
| void | runWithScene: (CCScene *scene) |
| void | pushScene: (CCScene *scene) |
| void | popScene () |
| void | replaceScene: (CCScene *scene) |
| void | end () |
| void | pause () |
| void | resume () |
| void | stopAnimation () |
| void | startAnimation () |
| void | drawScene () |
| void | purgeCachedData () |
| void | setGLDefaultValues () |
| void | setAlphaBlending: (BOOL on) |
| void | setDepthTest: (BOOL on) |
| void | showProfilers () |
| void | applyOrientation () |
| void | setDeviceOrientation: (ccDeviceOrientation orientation) |
| ccDeviceOrientation | deviceOrientation () |
| void | setContentScaleFactor: (CGFloat scaleFactor) |
| BOOL | enableRetinaDisplay: (BOOL yes) |
| CGFloat | contentScaleFactor () |
Static Public Member Functions | |
| CCDirector * | sharedDirector () |
| BOOL | setDirectorType: (ccDirectorType directorType) |
Protected Attributes | |
| CC_GLVIEW * | openGLView_ |
| NSTimeInterval | animationInterval_ |
| NSTimeInterval | oldAnimationInterval_ |
| BOOL | displayFPS_ |
| NSUInteger | frames_ |
| NSUInteger | totalFrames_ |
| ccTime | accumDt_ |
| ccTime | frameRate_ |
| CCLabelAtlas * | FPSLabel_ |
| BOOL | isPaused_ |
| CCScene * | runningScene_ |
| id | notificationNode_ |
| CCScene * | nextScene_ |
| BOOL | sendCleanupToScene_ |
| NSMutableArray * | scenesStack_ |
| struct timeval | lastUpdate_ |
| ccTime | dt |
| BOOL | nextDeltaTimeZero_ |
| ccDirectorProjection | projection_ |
| id< CCProjectionProtocol > | projectionDelegate_ |
| CGSize | winSizeInPoints_ |
| CGSize | winSizeInPixels_ |
| NSThread * | runningThread_ |
Properties | |
| NSThread * | runningThread |
| CCScene * | runningScene |
| NSTimeInterval | animationInterval |
| BOOL | displayFPS |
| CC_GLVIEW * | openGLView |
| BOOL | nextDeltaTimeZero |
| BOOL | isPaused |
| ccDirectorProjection | projection |
| NSUInteger | totalFrames |
| BOOL | sendCleanupToScene |
| id | notificationNode |
| id< CCProjectionProtocol > | projectionDelegate |
Class that creates and handle the main Window and manages how and when to execute the Scenes.
The CCDirector is also resposible for:
Since the CCDirector is a singleton, the standard way to use it is by calling:
The CCDirector also sets the default OpenGL context:
| CGFloat CCDirector(iOSExtension)::contentScaleFactor | ( | ) | [virtual] |
returns the content scale factor
| CGPoint CCDirector::convertToGL: | ( | CGPoint | p | ) | [virtual] |
converts a UIKit coordinate to an OpenGL coordinate Useful to convert (multi) touchs coordinates to the current layout (portrait or landscape)
| CGPoint CCDirector::convertToUI: | ( | CGPoint | p | ) | [virtual] |
converts an OpenGL coordinate to a UIKit coordinate Useful to convert node points to window points for calls such as glScissor
| ccDeviceOrientation CCDirector(iOSExtension)::deviceOrientation | ( | ) | [virtual] |
returns the device orientation
| CGSize CCDirector::displaySizeInPixels | ( | ) | [virtual] |
returns the display size of the OpenGL view in pixels. It doesn't take into account any possible rotation of the window.
| void CCDirector::drawScene | ( | ) | [virtual] |
Draw the scene. This method is called every frame. Don't call it manually.
| BOOL CCDirector(iOSExtension)::enableRetinaDisplay: | ( | BOOL | yes | ) | [virtual] |
Will enable Retina Display on devices that supports it. It will enable Retina Display on iPhone4 and iPod Touch 4. It will return YES, if it could enabled it, otherwise it will return NO.
This is the recommened way to enable Retina Display.
| void CCDirector::end | ( | ) | [virtual] |
Ends the execution, releases the running scene. It doesn't remove the OpenGL view from its parent. You have to do it manually.
| float CCDirector::getZEye | ( | ) | [virtual] |
XXX: missing description.
| void CCDirector::pause | ( | ) | [virtual] |
Pauses the running scene. The running scene will be _drawed_ but all scheduled timers will be paused While paused, the draw rate will be 4 FPS to reduce CPU consuption
| void CCDirector::popScene | ( | ) | [virtual] |
Pops out a scene from the queue. This scene will replace the running one. The running scene will be deleted. If there are no more scenes in the stack the execution is terminated. ONLY call it if there is a running scene.
| void CCDirector::purgeCachedData | ( | ) | [virtual] |
Removes all the cocos2d data that was cached automatically. It will purge the CCTextureCache, CCLabelBMFont cache. IMPORTANT: The CCSpriteFrameCache won't be purged. If you want to purge it, you have to purge it manually.
| void CCDirector::pushScene: | ( | CCScene * | scene | ) | [virtual] |
Suspends the execution of the running scene, pushing it on the stack of suspended scenes. The new scene will be executed. Try to avoid big stacks of pushed scenes to reduce memory allocation. ONLY call it if there is a running scene.
| void CCDirector::replaceScene: | ( | CCScene * | scene | ) | [virtual] |
Replaces the running scene with a new one. The running scene is terminated. ONLY call it if there is a running scene.
| void CCDirector::reshapeProjection: | ( | CGSize | newWindowSize | ) | [virtual] |
changes the projection size
| void CCDirector::resume | ( | ) | [virtual] |
Resumes the paused scene The scheduled timers will be activated again. The "delta time" will be 0 (as if the game wasn't paused)
| void CCDirector::runWithScene: | ( | CCScene * | scene | ) | [virtual] |
Enters the Director's main loop with the given Scene. Call it to run only your FIRST scene. Don't call it if there is already a running scene.
| void CCDirector::setAlphaBlending: | ( | BOOL | on | ) | [virtual] |
enables/disables OpenGL alpha blending
| void CCDirector(iOSExtension)::setContentScaleFactor: | ( | CGFloat | scaleFactor | ) | [virtual] |
The size in pixels of the surface. It could be different than the screen size. High-res devices might have a higher surface size than the screen size. In non High-res device the contentScale will be emulated.
The recommend way to enable Retina Display is by using the "enableRetinaDisplay:(BOOL)enabled" method.
| void CCDirector::setDepthTest: | ( | BOOL | on | ) | [virtual] |
enables/disables OpenGL depth test
| void CCDirector(iOSExtension)::setDeviceOrientation: | ( | ccDeviceOrientation | orientation | ) | [virtual] |
Sets the device orientation. If the orientation is going to be controlled by an UIViewController, then the orientation should be Portrait
| BOOL CCDirector(iOSExtensionClassMethods)::setDirectorType: | ( | ccDirectorType | directorType | ) | [static, virtual] |
There are 4 types of Director.
Each Director has it's own benefits, limitations. If you are using SDK 3.1 or newer it is recommed to use the DisplayLink director
This method should be called before any other call to the director.
It will return NO if the director type is kCCDirectorTypeDisplayLink and the running SDK is < 3.1. Otherwise it will return YES.
| void CCDirector::setGLDefaultValues | ( | ) | [virtual] |
sets the OpenGL default values
| CCDirector * CCDirector::sharedDirector | ( | ) | [static, virtual] |
returns a shared instance of the director
| void CCDirector::startAnimation | ( | ) | [virtual] |
The main loop is triggered again. Call this function only if [stopAnimation] was called earlier
| void CCDirector::stopAnimation | ( | ) | [virtual] |
Stops the animation. Nothing will be drawn. The main loop won't be triggered anymore. If you wan't to pause your animation call [pause] instead.
| CGSize CCDirector::winSize | ( | ) | [virtual] |
returns the size of the OpenGL view in points. It takes into account any possible rotation (device orientation) of the window
| CGSize CCDirector::winSizeInPixels | ( | ) | [virtual] |
returns the size of the OpenGL view in pixels. It takes into account any possible rotation (device orientation) of the window. On Mac winSize and winSizeInPixels return the same value.
NSTimeInterval CCDirector::animationInterval [read, write, assign] |
The FPS value
BOOL CCDirector::displayFPS [read, write, assign] |
Whether or not to display the FPS on the bottom-left corner
BOOL CCDirector::isPaused [read, assign] |
Whether or not the Director is paused
BOOL CCDirector::nextDeltaTimeZero [read, write, assign] |
whether or not the next delta time will be zero
id CCDirector::notificationNode [read, write, retain] |
This object will be visited after the main scene is visited. This object MUST implement the "visit" selector. Useful to hook a notification object, like CCNotifications (http://github.com/manucorporat/CCNotifications)
CC_GLVIEW* CCDirector::openGLView [read, write, retain] |
The OpenGLView, where everything is rendered
ccDirectorProjection CCDirector::projection [read, write, assign] |
Sets an OpenGL projection
id<CCProjectionProtocol> CCDirector::projectionDelegate [read, write, retain] |
This object will be called when the OpenGL projection is udpated and only when the kCCDirectorProjectionCustom projection is used.
CCScene* CCDirector::runningScene [read, assign] |
The current running Scene. Director can only run one Scene at the time
NSThread* CCDirector::runningThread [read, assign] |
returns the cocos2d thread. If you want to run any cocos2d task, run it in this thread. On iOS usually it is the main thread.
BOOL CCDirector::sendCleanupToScene [read, assign] |
Whether or not the replaced scene will receive the cleanup message. If the new scene is pushed, then the old scene won't receive the "cleanup" message. If the new scene replaces the old one, the it will receive the "cleanup" message.
NSUInteger CCDirector::totalFrames [read, assign] |
How many frames were called since the director started
