Director Class Reference

Class that creates and handles the main Window and manages how and when to execute the Scenes. More...

#include <CCDirector.h>

Inheritance diagram for Director:

Public Types
enum	Projection { _2D, _3D, CUSTOM, DEFAULT = _3D }
	Possible OpenGL projections used by director. More...

Public Member Functions
	Director ()
	ctor ()
	Director ()
virtual	~Director ()
virtual bool	init ()
var	init ()
local	init ()
Scene *	getRunningScene ()
	Gets current running Scene. More...
var	getRunningScene ()
	Gets current running Scene. More...
local	getRunningScene ()
	Gets current running Scene. More...
double	getAnimationInterval ()
	Gets the FPS value. More...
var	getAnimationInterval ()
	Gets the FPS value. More...
local	getAnimationInterval ()
	Gets the FPS value. More...
virtual void	setAnimationInterval (double interval)=0
	Sets the FPS value. More...
local	setAnimationInterval ( local interval)
	Sets the FPS value. More...
bool	isDisplayStats ()
	Whether or not to display the FPS on the bottom-left corner. More...
var	isDisplayStats ()
	Whether or not to display the FPS on the bottom-left corner. More...
local	isDisplayStats ()
	Whether or not to display the FPS on the bottom-left corner. More...
void	setDisplayStats (bool displayStats)
	Display the FPS on the bottom-left corner. More...
var	setDisplayStats ( var displayStats)
	Display the FPS on the bottom-left corner. More...
local	setDisplayStats ( local displayStats)
	Display the FPS on the bottom-left corner. More...
float	getSecondsPerFrame ()
	Get seconds per frame. More...
var	getSecondsPerFrame ()
	Get seconds per frame. More...
local	getSecondsPerFrame ()
	Get seconds per frame. More...
GLView *	getOpenGLView ()
	Get the GLView. More...
var	getOpenGLView ()
	Get the GLView. More...
void	setOpenGLView (GLView *openGLView)
	Sets the GLView. More...
var	setOpenGLView ( var openGLView)
	Sets the GLView. More...
TextureCache *	getTextureCache () const
bool	isNextDeltaTimeZero ()
	Whether or not _nextDeltaTimeZero is set to 0. More...
var	isNextDeltaTimeZero ()
	Whether or not _nextDeltaTimeZero is set to 0. More...
local	isNextDeltaTimeZero ()
	Whether or not _nextDeltaTimeZero is set to 0. More...
void	setNextDeltaTimeZero (bool nextDeltaTimeZero)
	Sets the detal time between current frame and next frame is 0. More...
bool	isPaused ()
	Whether or not the Director is paused. More...
unsigned int	getTotalFrames ()
	How many frames were called since the director started. More...
local	getTotalFrames ()
	How many frames were called since the director started. More...
Projection	getProjection ()
	Gets an OpenGL projection. More...
var	getProjection ()
	Gets an OpenGL projection. More...
void	setProjection (Projection projection)
	Sets OpenGL projection. More...
void	setViewport ()
	Sets the glViewport. More...
var	setViewport ()
	Sets the glViewport. More...
local	setViewport ()
	Sets the glViewport. More...
bool	isSendCleanupToScene ()
	How many frames were called since the director started. More...
local	isSendCleanupToScene ()
	How many frames were called since the director started. More...
Node *	getNotificationNode () const
	This object will be visited after the main scene is visited. More...
var	getNotificationNode ()
	This object will be visited after the main scene is visited. More...
local	getNotificationNode ()
	This object will be visited after the main scene is visited. More...
void	setNotificationNode (Node *node)
	Sets the notification node. More...
const Size &	getWinSize () const
	Returns the size of the OpenGL view in points. More...
var	getWinSize ()
	Returns the size of the OpenGL view in points. More...
local	getWinSize ()
	Returns the size of the OpenGL view in points. More...
Size	getWinSizeInPixels () const
	Returns the size of the OpenGL view in pixels. More...
var	getWinSizeInPixels ()
	Returns the size of the OpenGL view in pixels. More...
local	getWinSizeInPixels ()
	Returns the size of the OpenGL view in pixels. More...
Size	getVisibleSize () const
	Returns visible size of the OpenGL view in points. More...
var	getVisibleSize ()
	Returns visible size of the OpenGL view in points. More...
local	getVisibleSize ()
	Returns visible size of the OpenGL view in points. More...
Vec2	getVisibleOrigin () const
	Returns visible origin coordinate of the OpenGL view in points. More...
Vec2	convertToGL (const Vec2 &point)
	Converts a screen coordinate to an OpenGL coordinate. More...
Vec2	convertToUI (const Vec2 &point)
	Converts an OpenGL coordinate to a screen coordinate. More...
float	getZEye () const
	Gets the distance between camera and near clipping frane. More...
void	runWithScene (Scene *scene)
	Enters the Director's main loop with the given Scene. More...
local	runWithScene ( local scene)
	Enters the Director's main loop with the given Scene. More...
void	pushScene (Scene *scene)
	Suspends the execution of the running scene, pushing it on the stack of suspended scenes. More...
void	popScene ()
	Pops out a scene from the stack. More...
void	popToRootScene ()
	Pops out all scenes from the stack until the root scene in the queue. More...
void	popToSceneStackLevel (int level)
	Pops out all scenes from the stack until it reaches level. More...
var	popToSceneStackLevel ( var level)
	Pops out all scenes from the stack until it reaches level. More...
local	popToSceneStackLevel ( local level)
	Pops out all scenes from the stack until it reaches level. More...
void	replaceScene (Scene *scene)
	Replaces the running scene with a new one. More...
void	end ()
	Ends the execution, releases the running scene. More...
void	pause ()
	Pauses the running scene. More...
var	pause ()
	Pauses the running scene. More...
local	pause ()
	Pauses the running scene. More...
void	resume ()
	Resumes the paused scene. More...
void	restart ()
virtual void	stopAnimation ()=0
	Stops the animation. More...
local	stopAnimation ()
	Stops the animation. More...
virtual void	startAnimation ()=0
	The main loop is triggered again. More...
var	startAnimation ()
	The main loop is triggered again. More...
local	startAnimation ()
	The main loop is triggered again. More...
void	drawScene ()
	Draw the scene. More...
var	drawScene ()
	Draw the scene. More...
local	drawScene ()
	Draw the scene. More...
void	purgeCachedData ()
	Removes all cocos2d cached data. More...
void	setDefaultValues ()
	Sets the default values based on the Configuration info. More...
var	setDefaultValues ()
	Sets the default values based on the Configuration info. More...
local	setDefaultValues ()
	Sets the default values based on the Configuration info. More...
void	setGLDefaultValues ()
	Sets the OpenGL default values. More...
local	setGLDefaultValues ()
	Sets the OpenGL default values. More...
void	setAlphaBlending (bool on)
	Enables/disables OpenGL alpha blending. More...
var	setAlphaBlending ( var on)
	Enables/disables OpenGL alpha blending. More...
local	setAlphaBlending ( local on)
	Enables/disables OpenGL alpha blending. More...
void	setClearColor (const Color4F &clearColor)
	Sets clear values for the color buffers, value range of each element is [0.0, 1.0]. More...
local	setClearColor ( local clearColor)
	Sets clear values for the color buffers, value range of each element is [0.0, 1.0]. More...
void	setDepthTest (bool on)
	Enables/disables OpenGL depth test. More...
virtual void	mainLoop ()=0
void	setContentScaleFactor (float scaleFactor)
	The size in pixels of the surface. More...
var	setContentScaleFactor ( var scaleFactor)
	The size in pixels of the surface. More...
local	setContentScaleFactor ( local scaleFactor)
	The size in pixels of the surface. More...
float	getContentScaleFactor () const
	Gets content scale factor. More...
var	getContentScaleFactor ()
	Gets content scale factor. More...
local	getContentScaleFactor ()
	Gets content scale factor. More...
Scheduler *	getScheduler () const
	Gets the Scheduler associated with this director. More...
local	getScheduler ()
	Gets the Scheduler associated with this director. More...
void	setScheduler (Scheduler *scheduler)
	Sets the Scheduler associated with this director. More...
var	setScheduler ( var scheduler)
	Sets the Scheduler associated with this director. More...
local	setScheduler ( local scheduler)
	Sets the Scheduler associated with this director. More...
ActionManager *	getActionManager () const
	Gets the ActionManager associated with this director. More...
var	getActionManager ()
	Gets the ActionManager associated with this director. More...
local	getActionManager ()
	Gets the ActionManager associated with this director. More...
void	setActionManager (ActionManager *actionManager)
	Sets the ActionManager associated with this director. More...
var	setActionManager ( var actionManager)
	Sets the ActionManager associated with this director. More...
local	setActionManager ( local actionManager)
	Sets the ActionManager associated with this director. More...
EventDispatcher *	getEventDispatcher () const
	Gets the EventDispatcher associated with this director. More...
local	getEventDispatcher ()
	Gets the EventDispatcher associated with this director. More...
void	setEventDispatcher (EventDispatcher *dispatcher)
	Sets the EventDispatcher associated with this director. More...
local	setEventDispatcher ( local dispatcher)
	Sets the EventDispatcher associated with this director. More...
Renderer *	getRenderer () const
	Returns the Renderer associated with this director. More...
var	getRenderer ()
	Returns the Renderer associated with this director. More...
local	getRenderer ()
	Returns the Renderer associated with this director. More...
Console *	getConsole () const
	Returns the Console associated with this director. More...
local	getConsole ()
	Returns the Console associated with this director. More...
float	getDeltaTime () const
var	getDeltaTime ()
local	getDeltaTime ()
float	getFrameRate () const
	Gets Frame Rate. More...
local	getFrameRate ()
	Gets Frame Rate. More...
void	pushMatrix (MATRIX_STACK_TYPE type)
	Clones a specified type matrix and put it to the top of specified type of matrix stack. More...
local	pushMatrix ( local type)
	Clones a specified type matrix and put it to the top of specified type of matrix stack. More...
void	popMatrix (MATRIX_STACK_TYPE type)
	Pops the top matrix of the specified type of matrix stack. More...
void	loadIdentityMatrix (MATRIX_STACK_TYPE type)
	Adds an identity matrix to the top of specified type of matrxi stack. More...
void	loadMatrix (MATRIX_STACK_TYPE type, const Mat4 &mat)
	Adds a matrix to the top of specified type of matrix stack. More...
local	loadMatrix ( local type, local mat)
	Adds a matrix to the top of specified type of matrix stack. More...
void	multiplyMatrix (MATRIX_STACK_TYPE type, const Mat4 &mat)
	Multipies a matrix to the top of specified type of matrix stack. More...
const Mat4 &	getMatrix (MATRIX_STACK_TYPE type)
	Gets the top matrix of specified type of matrix stack. More...
void	resetMatrixStack ()
	Cleras all types of matrix stack, and add indentity matrix to these matrix stacks. More...
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership. More...
void	release ()
	Releases the ownership immediately. More...
Ref *	autorelease ()
	Releases the ownership sometime soon automatically. More...
unsigned int	getReferenceCount () const
	Returns the Ref's current reference count. More...
virtual	~Ref ()
	Destructor. More...

Static Public Member Functions
static Director *	getInstance ()
	Returns a shared instance of the director. More...
var	_getInstance ()
	Returns a shared instance of the director. More...
local	getInstance ()
	Returns a shared instance of the director. More...
static Director *	sharedDirector ()
local	sharedDirector ()

Static Public Attributes
static const char *	EVENT_PROJECTION_CHANGED
	Director will trigger an event when projection type is changed. More...
static const char *	EVENT_AFTER_UPDATE
	Director will trigger an event after Schedule::update() is invoked. More...
var	EVENT_AFTER_UPDATE
	Director will trigger an event after Schedule::update() is invoked. More...
local	EVENT_AFTER_UPDATE
	Director will trigger an event after Schedule::update() is invoked. More...
static const char *	EVENT_AFTER_VISIT
	Director will trigger an event after Scene::render() is invoked. More...
var	EVENT_AFTER_VISIT
	Director will trigger an event after Scene::render() is invoked. More...
local	EVENT_AFTER_VISIT
	Director will trigger an event after Scene::render() is invoked. More...
static const char *	EVENT_AFTER_DRAW
	Director will trigger an event after a scene is drawn, the data is sent to GPU. More...
var	EVENT_AFTER_DRAW
	Director will trigger an event after a scene is drawn, the data is sent to GPU. More...
local	EVENT_AFTER_DRAW
	Director will trigger an event after a scene is drawn, the data is sent to GPU. More...

Protected Member Functions
void	reset ()
var	reset ()
local	reset ()
void	purgeDirector ()
var	purgeDirector ()
local	purgeDirector ()
void	restartDirector ()
var	restartDirector ()
local	restartDirector ()
void	setNextScene ()
var	setNextScene ()
local	setNextScene ()
void	showStats ()
var	showStats ()
local	showStats ()
void	createStatsLabel ()
var	createStatsLabel ()
local	createStatsLabel ()
void	calculateMPF ()
var	calculateMPF ()
local	calculateMPF ()
void	getFPSImageData (unsigned char **datapointer, ssize_t *length)
var	getFPSImageData ( var datapointer, var length)
local	getFPSImageData ( local datapointer, local length)
void	calculateDeltaTime ()
	calculates delta time since last time it was called More...
var	calculateDeltaTime ()
	calculates delta time since last time it was called More...
local	calculateDeltaTime ()
	calculates delta time since last time it was called More...
void	initTextureCache ()
void	destroyTextureCache ()
var	destroyTextureCache ()
local	destroyTextureCache ()
void	initMatrixStack ()
var	initMatrixStack ()
local	initMatrixStack ()
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...
	Ref ()
	Constructor. More...

Protected Attributes
bool	_purgeDirectorInNextLoop
var	_purgeDirectorInNextLoop
local	_purgeDirectorInNextLoop
bool	_restartDirectorInNextLoop
var	_restartDirectorInNextLoop
local	_restartDirectorInNextLoop
std::stack< Mat4 >	_modelViewMatrixStack
var	_modelViewMatrixStack
local	_modelViewMatrixStack
std::stack< Mat4 >	_projectionMatrixStack
var	_projectionMatrixStack
local	_projectionMatrixStack
std::stack< Mat4 >	_textureMatrixStack
var	_textureMatrixStack
local	_textureMatrixStack
Scheduler *	_scheduler
	Scheduler associated with this director. More...
var	_scheduler
	Scheduler associated with this director. More...
local	_scheduler
	Scheduler associated with this director. More...
ActionManager *	_actionManager
	ActionManager associated with this director. More...
var	_actionManager
	ActionManager associated with this director. More...
local	_actionManager
	ActionManager associated with this director. More...
EventDispatcher *	_eventDispatcher
	EventDispatcher associated with this director. More...
var	_eventDispatcher
	EventDispatcher associated with this director. More...
local	_eventDispatcher
	EventDispatcher associated with this director. More...
EventCustom *	_eventProjectionChanged
var	_eventProjectionChanged
local	_eventProjectionChanged
EventCustom *	_eventAfterDraw
var	_eventAfterDraw
local	_eventAfterDraw
EventCustom *	_eventAfterVisit
var	_eventAfterVisit
local	_eventAfterVisit
EventCustom *	_eventAfterUpdate
var	_eventAfterUpdate
local	_eventAfterUpdate
float	_deltaTime
var	_deltaTime
local	_deltaTime
GLView *	_openGLView
var	_openGLView
local	_openGLView
TextureCache *	_textureCache
var	_textureCache
local	_textureCache
double	_animationInterval
var	_animationInterval
local	_animationInterval
double	_oldAnimationInterval
var	_oldAnimationInterval
local	_oldAnimationInterval
bool	_landscape
var	_landscape
local	_landscape
bool	_displayStats
var	_displayStats
local	_displayStats
float	_accumDt
var	_accumDt
local	_accumDt
float	_frameRate
var	_frameRate
local	_frameRate
LabelAtlas *	_FPSLabel
var	_FPSLabel
local	_FPSLabel
LabelAtlas *	_drawnBatchesLabel
var	_drawnBatchesLabel
local	_drawnBatchesLabel
LabelAtlas *	_drawnVerticesLabel
var	_drawnVerticesLabel
local	_drawnVerticesLabel
bool	_paused
	Whether or not the Director is paused. More...
var	_paused
	Whether or not the Director is paused. More...
local	_paused
	Whether or not the Director is paused. More...
unsigned int	_totalFrames
var	_totalFrames
local	_totalFrames
float	_secondsPerFrame
var	_secondsPerFrame
local	_secondsPerFrame
Scene *	_runningScene
var	_runningScene
local	_runningScene
Scene *	_nextScene
var	_nextScene
local	_nextScene
bool	_sendCleanupToScene
var	_sendCleanupToScene
local	_sendCleanupToScene
Vector< Scene * >	_scenesStack
var	_scenesStack
local	_scenesStack
struct timeval *	_lastUpdate
var	_lastUpdate
local	_lastUpdate
bool	_nextDeltaTimeZero
var	_nextDeltaTimeZero
local	_nextDeltaTimeZero
Projection	_projection
var	_projection
local	_projection
Size	_winSizeInPoints
var	_winSizeInPoints
local	_winSizeInPoints
float	_contentScaleFactor
var	_contentScaleFactor
local	_contentScaleFactor
Node *	_notificationNode
var	_notificationNode
local	_notificationNode
Renderer *	_renderer
var	_renderer
local	_renderer
Console *	_console
var	_console
local	_console
Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...
local	_referenceCount
	count of references More...

Friends
class	GLView

Detailed Description

Class that creates and handles the main Window and manages how and when to execute the Scenes.

The Director is also responsible for:

• initializing the OpenGL context
• setting the OpenGL buffer depth (default one is 0-bit)
• setting the projection (default one is 3D)

Since the Director is a singleton, the standard way to use it is by calling: _ Director::getInstance()->methodName();

Constructor & Destructor Documentation

Director

(

)

var ctor

(

)

local Director

(

)

virtual ~Director ( )

virtual

Member Function Documentation

void calculateDeltaTime ( )

protected

calculates delta time since last time it was called

var calculateDeltaTime ( )

protected

calculates delta time since last time it was called

local calculateDeltaTime ( )

protected

calculates delta time since last time it was called

void calculateMPF ( )

protected

var calculateMPF ( )

protected

local calculateMPF ( )

protected

Vec2 convertToGL

(

const Vec2 &

point

)

Converts a screen coordinate to an OpenGL coordinate.

Useful to convert (multi) touch coordinates to the current layout (portrait or landscape).

var convertToGL

(

var

point

)

Converts a screen coordinate to an OpenGL coordinate.

Useful to convert (multi) touch coordinates to the current layout (portrait or landscape).

local convertToGL

(

local

point

)

Converts a screen coordinate to an OpenGL coordinate.

Useful to convert (multi) touch coordinates to the current layout (portrait or landscape).

Vec2 convertToUI

(

const Vec2 &

point

)

Converts an OpenGL coordinate to a screen coordinate.

Useful to convert node points to window points for calls such as glScissor.

var convertToUI

(

var

point

)

Converts an OpenGL coordinate to a screen coordinate.

Useful to convert node points to window points for calls such as glScissor.

local convertToUI

(

local

point

)

Converts an OpenGL coordinate to a screen coordinate.

Useful to convert node points to window points for calls such as glScissor.

void createStatsLabel ( )

protected

var createStatsLabel ( )

protected

local createStatsLabel ( )

protected

void destroyTextureCache ( )

protected

var destroyTextureCache ( )

protected

local destroyTextureCache ( )

protected

void drawScene

(

)

Draw the scene.

This method is called every frame. Don't call it manually.

var drawScene

(

)

Draw the scene.

This method is called every frame. Don't call it manually.

local drawScene

(

)

Draw the scene.

This method is called every frame. Don't call it manually.

void end

(

)

Ends the execution, releases the running scene.

var end

(

)

Ends the execution, releases the running scene.

local endToLua

(

)

Ends the execution, releases the running scene.

ActionManager* getActionManager ( ) const

inline

Gets the ActionManager associated with this director.

Since

v2.0

var getActionManager ( )

inline

Gets the ActionManager associated with this director.

Since

v2.0

local getActionManager ( )

inline

Gets the ActionManager associated with this director.

Since

v2.0

double getAnimationInterval ( )

inline

Gets the FPS value.

var getAnimationInterval ( )

inline

Gets the FPS value.

local getAnimationInterval ( )

inline

Gets the FPS value.

Console* getConsole ( ) const

inline

Returns the Console associated with this director.

Since

v3.0

local getConsole ( )

inline

Returns the Console associated with this director.

Since

v3.0

float getContentScaleFactor ( ) const

inline

Gets content scale factor.

See also

Director::setContentScaleFactor()

var getContentScaleFactor ( )

inline

Gets content scale factor.

See also

Director::setContentScaleFactor()

local getContentScaleFactor ( )

inline

Gets content scale factor.

See also

Director::setContentScaleFactor()

float getDeltaTime

(

)

const

var getDeltaTime

(

)

local getDeltaTime

(

)

EventDispatcher* getEventDispatcher ( ) const

inline

Gets the EventDispatcher associated with this director.

Since

v3.0

local getEventDispatcher ( )

inline

Gets the EventDispatcher associated with this director.

Since

v3.0

void getFPSImageData ( unsigned char **  datapointer, ssize_t *  length  )

protected

var getFPSImageData ( var  datapointer, var  length  )

protected

local getFPSImageData ( local  datapointer, local  length  )

protected

float getFrameRate ( ) const

inline

Gets Frame Rate.

local getFrameRate ( )

inline

Gets Frame Rate.

static Director* getInstance ( )

static

Returns a shared instance of the director.

var _getInstance ( )

static

Returns a shared instance of the director.

local getInstance ( )

static

Returns a shared instance of the director.

const Mat4& getMatrix

(

MATRIX_STACK_TYPE

type

)

Gets the top matrix of specified type of matrix stack.

local getMatrix

(

local

type

)

Gets the top matrix of specified type of matrix stack.

Node* getNotificationNode ( ) const

inline

This object will be visited after the main scene is visited.

This object MUST implement the "visit" function. Useful to hook a notification object, like Notifications (http://github.com/manucorporat/CCNotifications)

Since

v0.99.5

var getNotificationNode ( )

inline

This object will be visited after the main scene is visited.

This object MUST implement the "visit" function. Useful to hook a notification object, like Notifications (http://github.com/manucorporat/CCNotifications)

Since

v0.99.5

local getNotificationNode ( )

inline

This object will be visited after the main scene is visited.

This object MUST implement the "visit" function. Useful to hook a notification object, like Notifications (http://github.com/manucorporat/CCNotifications)

Since

v0.99.5

GLView* getOpenGLView ( )

inline

Get the GLView.

var getOpenGLView ( )

inline

Get the GLView.

Projection getProjection ( )

inline

Gets an OpenGL projection.

Since

v0.8.2

var getProjection ( )

inline

Gets an OpenGL projection.

Since

v0.8.2

Renderer* getRenderer ( ) const

inline

Returns the Renderer associated with this director.

Since

v3.0

var getRenderer ( )

inline

Returns the Renderer associated with this director.

Since

v3.0

local getRenderer ( )

inline

Returns the Renderer associated with this director.

Since

v3.0

Scene* getRunningScene ( )

inline

Gets current running Scene.

Director can only run one Scene at a time.

var getRunningScene ( )

inline

Gets current running Scene.

Director can only run one Scene at a time.

local getRunningScene ( )

inline

Gets current running Scene.

Director can only run one Scene at a time.

Scheduler* getScheduler ( ) const

inline

Gets the Scheduler associated with this director.

Since

v2.0

var getScheduler ( )

inline

Gets the Scheduler associated with this director.

Since

v2.0

local getScheduler ( )

inline

Gets the Scheduler associated with this director.

Since

v2.0

float getSecondsPerFrame ( )

inline

Get seconds per frame.

var getSecondsPerFrame ( )

inline

Get seconds per frame.

local getSecondsPerFrame ( )

inline

Get seconds per frame.

TextureCache* getTextureCache

(

)

const

var getTextureCache

(

)

local getTextureCache

(

)

unsigned int getTotalFrames ( )

inline

How many frames were called since the director started.

var getTotalFrames ( )

inline

How many frames were called since the director started.

local getTotalFrames ( )

inline

How many frames were called since the director started.

Vec2 getVisibleOrigin

(

)

const

Returns visible origin coordinate of the OpenGL view in points.

var getVisibleOrigin

(

)

Returns visible origin coordinate of the OpenGL view in points.

local getVisibleOrigin

(

)

Returns visible origin coordinate of the OpenGL view in points.

Size getVisibleSize

(

)

const

Returns visible size of the OpenGL view in points.

The value is equal to Director::getWinSize() if don't invoke GLView::setDesignResolutionSize().

var getVisibleSize

(

)

Returns visible size of the OpenGL view in points.

The value is equal to Director::getWinSize() if don't invoke GLView::setDesignResolutionSize().

local getVisibleSize

(

)

Returns visible size of the OpenGL view in points.

The value is equal to Director::getWinSize() if don't invoke GLView::setDesignResolutionSize().

const Size& getWinSize

(

)

const

Returns the size of the OpenGL view in points.

var getWinSize

(

)

Returns the size of the OpenGL view in points.

local getWinSize

(

)

Returns the size of the OpenGL view in points.

Size getWinSizeInPixels

(

)

const

Returns the size of the OpenGL view in pixels.

var getWinSizeInPixels

(

)

Returns the size of the OpenGL view in pixels.

local getWinSizeInPixels

(

)

Returns the size of the OpenGL view in pixels.

float getZEye

(

)

const

Gets the distance between camera and near clipping frane.

It is correct for default camera that near clipping frane is the same as screen.

var getZEye

(

)

Gets the distance between camera and near clipping frane.

It is correct for default camera that near clipping frane is the same as screen.

local getZEye

(

)

Gets the distance between camera and near clipping frane.

It is correct for default camera that near clipping frane is the same as screen.

virtual bool init ( )

virtual

var init ( )

virtual

local init ( )

virtual

void initMatrixStack ( )

protected

var initMatrixStack ( )

protected

local initMatrixStack ( )

protected

void initTextureCache ( )

protected

var initTextureCache ( )

protected

local initTextureCache ( )

protected

bool isDisplayStats ( )

inline

Whether or not to display the FPS on the bottom-left corner.

var isDisplayStats ( )

inline

Whether or not to display the FPS on the bottom-left corner.

local isDisplayStats ( )

inline

Whether or not to display the FPS on the bottom-left corner.

bool isNextDeltaTimeZero ( )

inline

Whether or not _nextDeltaTimeZero is set to 0.

var isNextDeltaTimeZero ( )

inline

Whether or not _nextDeltaTimeZero is set to 0.

local isNextDeltaTimeZero ( )

inline

Whether or not _nextDeltaTimeZero is set to 0.

bool isPaused ( )

inline

Whether or not the Director is paused.

var isPaused ( )

inline

Whether or not the Director is paused.

local isPaused ( )

inline

Whether or not the Director is paused.

bool isSendCleanupToScene ( )

inline

How many frames were called since the director started.

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.

Since

v0.99.0

var isSendCleanupToScene ( )

inline

How many frames were called since the director started.

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.

Since

v0.99.0

local isSendCleanupToScene ( )

inline

How many frames were called since the director started.

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.

Since

v0.99.0

void loadIdentityMatrix

(

MATRIX_STACK_TYPE

type

)

Adds an identity matrix to the top of specified type of matrxi stack.

local loadIdentityMatrix

(

local

type

)

Adds an identity matrix to the top of specified type of matrxi stack.

void loadMatrix	(	MATRIX_STACK_TYPE	type,
		const Mat4 &	mat
	)

Adds a matrix to the top of specified type of matrix stack.

Parameters

type	Matrix type.
mat	The matrix that to be added.

local loadMatrix	(	local	type,
		local	mat
	)

Adds a matrix to the top of specified type of matrix stack.

Parameters

type	Matrix type.
mat	The matrix that to be added.

virtual void mainLoop ( )

pure virtual

Implemented in DisplayLinkDirector.

var mainLoop ( )

pure virtual

Implemented in DisplayLinkDirector.

local mainLoop ( )

pure virtual

Implemented in DisplayLinkDirector.

void multiplyMatrix	(	MATRIX_STACK_TYPE	type,
		const Mat4 &	mat
	)

Multipies a matrix to the top of specified type of matrix stack.

Parameters

type	Matrix type.
mat	The matrix that to be multipied.

local multiplyMatrix	(	local	type,
		local	mat
	)

Multipies a matrix to the top of specified type of matrix stack.

Parameters

type	Matrix type.
mat	The matrix that to be multipied.

void pause

(

)

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 consumption.

var pause

(

)

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 consumption.

local pause

(

)

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 consumption.

void popMatrix

(

MATRIX_STACK_TYPE

type

)

Pops the top matrix of the specified type of matrix stack.

local popMatrix

(

local

type

)

Pops the top matrix of the specified type of matrix stack.

void popScene

(

)

Pops out a scene from the stack.

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.

var popScene

(

)

Pops out a scene from the stack.

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.

local popScene

(

)

Pops out a scene from the stack.

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 popToRootScene

(

)

Pops out all scenes from the stack until the root scene in the queue.

This scene will replace the running one. Internally it will call popToSceneStackLevel(1).

var popToRootScene

(

)

Pops out all scenes from the stack until the root scene in the queue.

This scene will replace the running one. Internally it will call popToSceneStackLevel(1).

local popToRootScene

(

)

Pops out all scenes from the stack until the root scene in the queue.

This scene will replace the running one. Internally it will call popToSceneStackLevel(1).

void popToSceneStackLevel

(

int

level

)

Pops out all scenes from the stack until it reaches level.

If level is 0, it will end the director. If level is 1, it will pop all scenes until it reaches to root scene. If level is <= than the current stack level, it won't do anything.

var popToSceneStackLevel

(

var

level

)

Pops out all scenes from the stack until it reaches level.

If level is 0, it will end the director. If level is 1, it will pop all scenes until it reaches to root scene. If level is <= than the current stack level, it won't do anything.

local popToSceneStackLevel

(

local

level

)

Pops out all scenes from the stack until it reaches level.

If level is 0, it will end the director. If level is 1, it will pop all scenes until it reaches to root scene. If level is <= than the current stack level, it won't do anything.

void purgeCachedData

(

)

Removes all cocos2d cached data.

It will purge the TextureCache, SpriteFrameCache, LabelBMFont cache

Since

v0.99.3

var purgeCachedData

(

)

Removes all cocos2d cached data.

It will purge the TextureCache, SpriteFrameCache, LabelBMFont cache

Since

v0.99.3

local purgeCachedData

(

)

Removes all cocos2d cached data.

It will purge the TextureCache, SpriteFrameCache, LabelBMFont cache

Since

v0.99.3

void purgeDirector ( )

protected

var purgeDirector ( )

protected

local purgeDirector ( )

protected

void pushMatrix

(

MATRIX_STACK_TYPE

type

)

Clones a specified type matrix and put it to the top of specified type of matrix stack.

local pushMatrix

(

local

type

)

Clones a specified type matrix and put it to the top of specified type of matrix stack.

void pushScene

(

Scene *

scene

)

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.

var pushScene

(

var

scene

)

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.

local pushScene

(

local

scene

)

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 replaceScene

(

Scene *

scene

)

Replaces the running scene with a new one.

The running scene is terminated. ONLY call it if there is a running scene.

local replaceScene

(

local

scene

)

Replaces the running scene with a new one.

The running scene is terminated. ONLY call it if there is a running scene.

void reset ( )

protected

var reset ( )

protected

local reset ( )

protected

void resetMatrixStack

(

)

Cleras all types of matrix stack, and add indentity matrix to these matrix stacks.

local resetMatrixStack

(

)

Cleras all types of matrix stack, and add indentity matrix to these matrix stacks.

void restart

(

)

var restart

(

)

local restart

(

)

void restartDirector ( )

protected

var restartDirector ( )

protected

local restartDirector ( )

protected

void resume

(

)

Resumes the paused scene.

The scheduled timers will be activated again. The "delta time" will be 0 (as if the game wasn't paused).

var resume

(

)

Resumes the paused scene.

The scheduled timers will be activated again. The "delta time" will be 0 (as if the game wasn't paused).

local resume

(

)

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 runWithScene

(

Scene *

scene

)

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.

It will call pushScene: and then it will call startAnimation

local runWithScene

(

local

scene

)

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.

It will call pushScene: and then it will call startAnimation

void setActionManager

(

ActionManager *

actionManager

)

Sets the ActionManager associated with this director.

Since

v2.0

var setActionManager

(

var

actionManager

)

Sets the ActionManager associated with this director.

Since

v2.0

local setActionManager

(

local

actionManager

)

Sets the ActionManager associated with this director.

Since

v2.0

void setAlphaBlending

(

bool

on

)

Enables/disables OpenGL alpha blending.

var setAlphaBlending

(

var

on

)

Enables/disables OpenGL alpha blending.

local setAlphaBlending

(

local

on

)

Enables/disables OpenGL alpha blending.

virtual void setAnimationInterval ( double  interval )

pure virtual

Sets the FPS value.

FPS = 1/internal.

Implemented in DisplayLinkDirector.

var setAnimationInterval ( var  interval )

pure virtual

Sets the FPS value.

FPS = 1/internal.

Implemented in DisplayLinkDirector.

local setAnimationInterval ( local  interval )

pure virtual

Sets the FPS value.

FPS = 1/internal.

Implemented in DisplayLinkDirector.

void setClearColor

(

const Color4F &

clearColor

)

Sets clear values for the color buffers, value range of each element is [0.0, 1.0].

local setClearColor

(

local

clearColor

)

Sets clear values for the color buffers, value range of each element is [0.0, 1.0].

void setContentScaleFactor

(

float

scaleFactor

)

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. Only available when compiled using SDK >= 4.0.

Since

v0.99.4

var setContentScaleFactor

(

var

scaleFactor

)

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. Only available when compiled using SDK >= 4.0.

Since

v0.99.4

local setContentScaleFactor

(

local

scaleFactor

)

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. Only available when compiled using SDK >= 4.0.

Since

v0.99.4

void setDefaultValues

(

)

Sets the default values based on the Configuration info.

var setDefaultValues

(

)

Sets the default values based on the Configuration info.

local setDefaultValues

(

)

Sets the default values based on the Configuration info.

void setDepthTest

(

bool

on

)

Enables/disables OpenGL depth test.

var setDepthTest

(

var

on

)

Enables/disables OpenGL depth test.

local setDepthTest

(

local

on

)

Enables/disables OpenGL depth test.

void setDisplayStats ( bool  displayStats )

inline

Display the FPS on the bottom-left corner.

var setDisplayStats ( var  displayStats )

inline

Display the FPS on the bottom-left corner.

local setDisplayStats ( local  displayStats )

inline

Display the FPS on the bottom-left corner.

void setEventDispatcher

(

EventDispatcher *

dispatcher

)

Sets the EventDispatcher associated with this director.

Since

v3.0

local setEventDispatcher

(

local

dispatcher

)

Sets the EventDispatcher associated with this director.

Since

v3.0

void setGLDefaultValues

(

)

Sets the OpenGL default values.

It will enable alpha blending, disable depth test.

local setGLDefaultValues

(

)

Sets the OpenGL default values.

It will enable alpha blending, disable depth test.

void setNextDeltaTimeZero

(

bool

nextDeltaTimeZero

)

Sets the detal time between current frame and next frame is 0.

This value will be used in Schedule, and will affect all functions that are using frame detal time, such as Actions. This value will take effect only one time.

var setNextDeltaTimeZero

(

var

nextDeltaTimeZero

)

Sets the detal time between current frame and next frame is 0.

This value will be used in Schedule, and will affect all functions that are using frame detal time, such as Actions. This value will take effect only one time.

local setNextDeltaTimeZero

(

local

nextDeltaTimeZero

)

Sets the detal time between current frame and next frame is 0.

This value will be used in Schedule, and will affect all functions that are using frame detal time, such as Actions. This value will take effect only one time.

void setNextScene ( )

protected

var setNextScene ( )

protected

local setNextScene ( )

protected

void setNotificationNode

(

Node *

node

)

Sets the notification node.

See also

Director::getNotificationNode()

var setNotificationNode

(

var

node

)

Sets the notification node.

See also

Director::getNotificationNode()

local setNotificationNode

(

local

node

)

Sets the notification node.

See also

Director::getNotificationNode()

void setOpenGLView

(

GLView *

openGLView

)

Sets the GLView.

var setOpenGLView

(

var

openGLView

)

Sets the GLView.

void setProjection

(

Projection

projection

)

Sets OpenGL projection.

var setProjection

(

var

projection

)

Sets OpenGL projection.

local setProjection

(

local

projection

)

Sets OpenGL projection.

void setScheduler

(

Scheduler *

scheduler

)

Sets the Scheduler associated with this director.

Since

v2.0

var setScheduler

(

var

scheduler

)

Sets the Scheduler associated with this director.

Since

v2.0

local setScheduler

(

local

scheduler

)

Sets the Scheduler associated with this director.

Since

v2.0

void setViewport

(

)

Sets the glViewport.

var setViewport

(

)

Sets the glViewport.

local setViewport

(

)

Sets the glViewport.

static Director* sharedDirector ( )

inlinestatic

Deprecated:

Use getInstance() instead.

local sharedDirector ( )

inlinestatic

Deprecated:

Use getInstance() instead.

void showStats ( )

protected

var showStats ( )

protected

local showStats ( )

protected

virtual void startAnimation ( )

pure virtual

The main loop is triggered again.

Call this function only if [stopAnimation] was called earlier.

Warning

Don't call this function to start the main loop. To run the main loop call runWithScene.

Implemented in DisplayLinkDirector.

var startAnimation ( )

pure virtual

The main loop is triggered again.

Call this function only if [stopAnimation] was called earlier.

Warning

Don't call this function to start the main loop. To run the main loop call runWithScene.

Implemented in DisplayLinkDirector.

local startAnimation ( )

pure virtual

The main loop is triggered again.

Call this function only if [stopAnimation] was called earlier.

Warning

Don't call this function to start the main loop. To run the main loop call runWithScene.

Implemented in DisplayLinkDirector.

virtual void stopAnimation ( )

pure virtual

Stops the animation.

Nothing will be drawn. The main loop won't be triggered anymore. If you don't want to pause your animation call [pause] instead.

Implemented in DisplayLinkDirector.

var stopAnimation ( )

pure virtual

Stops the animation.

Nothing will be drawn. The main loop won't be triggered anymore. If you don't want to pause your animation call [pause] instead.

Implemented in DisplayLinkDirector.

local stopAnimation ( )

pure virtual

Stops the animation.

Nothing will be drawn. The main loop won't be triggered anymore. If you don't want to pause your animation call [pause] instead.

Implemented in DisplayLinkDirector.

Friends And Related Function Documentation

friend class GLView

friend

var GLView

friend

local GLView

friend

Member Data Documentation

float _accumDt

protected

var _accumDt

protected

local _accumDt

protected

ActionManager* _actionManager

protected

ActionManager associated with this director.

Since

v2.0

var _actionManager

protected

ActionManager associated with this director.

Since

v2.0

local _actionManager

protected

ActionManager associated with this director.

Since

v2.0

double _animationInterval

protected

var _animationInterval

protected

local _animationInterval

protected

Console* _console

protected

var _console

protected

local _console

protected

float _contentScaleFactor

protected

var _contentScaleFactor

protected

local _contentScaleFactor

protected

float _deltaTime

protected

var _deltaTime

protected

local _deltaTime

protected

bool _displayStats

protected

var _displayStats

protected

local _displayStats

protected

LabelAtlas* _drawnBatchesLabel

protected

var _drawnBatchesLabel

protected

local _drawnBatchesLabel

protected

LabelAtlas* _drawnVerticesLabel

protected

var _drawnVerticesLabel

protected

local _drawnVerticesLabel

protected

EventCustom * _eventAfterDraw

protected

var _eventAfterDraw

protected

local _eventAfterDraw

protected

EventCustom * _eventAfterUpdate

protected

var _eventAfterUpdate

protected

local _eventAfterUpdate

protected

EventCustom * _eventAfterVisit

protected

var _eventAfterVisit

protected

local _eventAfterVisit

protected

EventDispatcher* _eventDispatcher

protected

EventDispatcher associated with this director.

Since

v3.0

var _eventDispatcher

protected

EventDispatcher associated with this director.

Since

v3.0

local _eventDispatcher

protected

EventDispatcher associated with this director.

Since

v3.0

EventCustom* _eventProjectionChanged

protected

var _eventProjectionChanged

protected

local _eventProjectionChanged

protected

LabelAtlas* _FPSLabel

protected

var _FPSLabel

protected

local _FPSLabel

protected

float _frameRate

protected

var _frameRate

protected

local _frameRate

protected

bool _landscape

protected

var _landscape

protected

local _landscape

protected

struct timeval* _lastUpdate

protected

var _lastUpdate

protected

local _lastUpdate

protected

std::stack<Mat4> _modelViewMatrixStack

protected

var _modelViewMatrixStack

protected

local _modelViewMatrixStack

protected

bool _nextDeltaTimeZero

protected

var _nextDeltaTimeZero

protected

local _nextDeltaTimeZero

protected

Scene* _nextScene

protected

var _nextScene

protected

local _nextScene

protected

Node* _notificationNode

protected

var _notificationNode

protected

local _notificationNode

protected

double _oldAnimationInterval

protected

var _oldAnimationInterval

protected

local _oldAnimationInterval

protected

GLView* _openGLView

protected

var _openGLView

protected

local _openGLView

protected

bool _paused

protected

Whether or not the Director is paused.

var _paused

protected

Whether or not the Director is paused.

local _paused

protected

Whether or not the Director is paused.

Projection _projection

protected

var _projection

protected

local _projection

protected

std::stack<Mat4> _projectionMatrixStack

protected

var _projectionMatrixStack

protected

local _projectionMatrixStack

protected

bool _purgeDirectorInNextLoop

protected

var _purgeDirectorInNextLoop

protected

local _purgeDirectorInNextLoop

protected

Renderer* _renderer

protected

var _renderer

protected

local _renderer

protected

bool _restartDirectorInNextLoop

protected

var _restartDirectorInNextLoop

protected

local _restartDirectorInNextLoop

protected

Scene* _runningScene

protected

var _runningScene

protected

local _runningScene

protected

Vector<Scene*> _scenesStack

protected

var _scenesStack

protected

local _scenesStack

protected

Scheduler* _scheduler

protected

Scheduler associated with this director.

Since

v2.0

var _scheduler

protected

Scheduler associated with this director.

Since

v2.0

local _scheduler

protected

Scheduler associated with this director.

Since

v2.0

float _secondsPerFrame

protected

var _secondsPerFrame

protected

local _secondsPerFrame

protected

bool _sendCleanupToScene

protected

var _sendCleanupToScene

protected

local _sendCleanupToScene

protected

TextureCache* _textureCache

protected

var _textureCache

protected

local _textureCache

protected

std::stack<Mat4> _textureMatrixStack

protected

var _textureMatrixStack

protected

local _textureMatrixStack

protected

unsigned int _totalFrames

protected

var _totalFrames

protected

local _totalFrames

protected

Size _winSizeInPoints

protected

var _winSizeInPoints

protected

local _winSizeInPoints

protected

const char* EVENT_AFTER_DRAW

static

Director will trigger an event after a scene is drawn, the data is sent to GPU.

var EVENT_AFTER_DRAW

static

Director will trigger an event after a scene is drawn, the data is sent to GPU.

local EVENT_AFTER_DRAW

static

Director will trigger an event after a scene is drawn, the data is sent to GPU.

const char* EVENT_AFTER_UPDATE

static

Director will trigger an event after Schedule::update() is invoked.

var EVENT_AFTER_UPDATE

static

Director will trigger an event after Schedule::update() is invoked.

local EVENT_AFTER_UPDATE

static

Director will trigger an event after Schedule::update() is invoked.

const char* EVENT_AFTER_VISIT

static

Director will trigger an event after Scene::render() is invoked.

var EVENT_AFTER_VISIT

static

Director will trigger an event after Scene::render() is invoked.

local EVENT_AFTER_VISIT

static

Director will trigger an event after Scene::render() is invoked.

const char* EVENT_PROJECTION_CHANGED

static

Director will trigger an event when projection type is changed.

var EVENT_PROJECTION_CHANGED

static

Director will trigger an event when projection type is changed.

local EVENT_PROJECTION_CHANGED

static

Director will trigger an event when projection type is changed.

---

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

• /Users/minggo/SourceCode/cocos2d-x/cocos/base/CCDirector.h