GridBase Class Reference

Base class for Other grid. More...

#include <CCGrid.h>

Inheritance diagram for GridBase:

Public Member Functions
virtual	~GridBase (void)
	Destructor. More...
int	getReuseGrid (void) const
	Get number of times that the grid will be reused. More...
var	getReuseGrid ()
	Get number of times that the grid will be reused. More...
local	getReuseGrid ()
	Get number of times that the grid will be reused. More...
void	setReuseGrid (int reuseGrid)
	Set number of times that the grid will be reused. More...
var	setReuseGrid ( var reuseGrid)
	Set number of times that the grid will be reused. More...
local	setReuseGrid ( local reuseGrid)
	Set number of times that the grid will be reused. More...
const Size &	getGridSize (void) const
	Size of the grid. More...
var	getGridSize ()
	Size of the grid. More...
local	getGridSize ()
	Size of the grid. More...
void	setGridSize (const Size &gridSize)
	Set the size of the grid. More...
var	setGridSize ( var gridSize)
	Set the size of the grid. More...
local	setGridSize ( local gridSize)
	Set the size of the grid. More...
const Vec2 &	getStep (void) const
	Pixels between the grids. More...
local	getStep ()
	Pixels between the grids. More...
void	setStep (const Vec2 &step)
	Get the pixels between the grids. More...
var	setStep ( var step)
	Get the pixels between the grids. More...
local	setStep ( local step)
	Get the pixels between the grids. More...
bool	isTextureFlipped (void) const
	is texture flipped. More...
var	isTextureFlipped ()
	is texture flipped. More...
local	isTextureFlipped ()
	is texture flipped. More...
void	setTextureFlipped (bool flipped)
	Set the texture flipped or not. More...
var	setTextureFlipped ( var flipped)
	Set the texture flipped or not. More...
local	setTextureFlipped ( local flipped)
	Set the texture flipped or not. More...
virtual void	blit (void)
	Interface used to blit the texture with grid to screen. More...
virtual void	reuse (void)
	Interface, Reuse the grid vertices. More...
var	reuse ()
	Interface, Reuse the grid vertices. More...
local	reuse ()
	Interface, Reuse the grid vertices. More...
virtual void	calculateVertexPoints (void)
	Interface, Calculate the vertices used for the blit. More...
local	calculateVertexPoints ()
	Interface, Calculate the vertices used for the blit. More...
void	set2DProjection (void)
	Change projection to 2D for grabbing. More...
bool	initWithSize (const Size &gridSize, Texture2D *texture, bool flipped)
local	initWithSize ( local gridSize, local texture, local flipped)
bool	initWithSize (const Size &gridSize)
bool	isActive (void) const
var	isActive ()
local	isActive ()
void	setActive (bool active)
var	setActive ( var active)
local	setActive ( local active)
void	beforeDraw (void)
void	afterDraw (Node *target)
virtual void	beforeBlit ()
local	beforeBlit ()
virtual void	afterBlit ()
var	afterBlit ()
local	afterBlit ()
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 GridBase *	create (const Size &gridSize, Texture2D *texture, bool flipped)
	create one Grid More...
var	create ( var gridSize, var texture, var flipped)
	create one Grid More...
local	create ( local gridSize, local texture, local flipped)
	create one Grid More...
static GridBase *	create (const Size &gridSize)
	create one Grid More...
local	create ( local gridSize)
	create one Grid More...

Protected Attributes
bool	_active
int	_reuseGrid
var	_reuseGrid
local	_reuseGrid
Size	_gridSize
var	_gridSize
local	_gridSize
Texture2D *	_texture
var	_texture
local	_texture
Vec2	_step
var	_step
local	_step
Grabber *	_grabber
var	_grabber
local	_grabber
bool	_isTextureFlipped
var	_isTextureFlipped
local	_isTextureFlipped
GLProgram *	_shaderProgram
var	_shaderProgram
local	_shaderProgram
Director::Projection	_directorProjection
var	_directorProjection
local	_directorProjection
Protected Attributes inherited from Ref
unsigned int	_referenceCount
	count of references More...
local	_referenceCount
	count of references More...

Additional Inherited Members
Protected Member Functions inherited from Ref
	Ref ()
	Constructor. More...
	Ref ()
	Constructor. More...

Detailed Description

Base class for Other grid.

Constructor & Destructor Documentation

virtual ~GridBase ( void  )

virtual

Destructor.

Member Function Documentation

virtual void afterBlit ( )

inlinevirtual

Reimplemented in Grid3D.

var afterBlit ( )

inlinevirtual

Reimplemented in Grid3D.

local afterBlit ( )

inlinevirtual

Reimplemented in Grid3D.

void afterDraw

(

Node *

target

)

var afterDraw

(

var

target

)

local afterDraw

(

local

target

)

virtual void beforeBlit ( )

inlinevirtual

Interface for custom action when before or after draw.

Reimplemented in Grid3D.

var beforeBlit ( )

inlinevirtual

Interface for custom action when before or after draw.

Reimplemented in Grid3D.

local beforeBlit ( )

inlinevirtual

Interface for custom action when before or after draw.

Reimplemented in Grid3D.

void beforeDraw

(

void

)

Init and reset the status when render effects by using the grid.

var beforeDraw

(

)

Init and reset the status when render effects by using the grid.

local beforeDraw

(

)

Init and reset the status when render effects by using the grid.

virtual void blit ( void  )

virtual

Interface used to blit the texture with grid to screen.

Reimplemented in TiledGrid3D, and Grid3D.

var blit (   )

virtual

Interface used to blit the texture with grid to screen.

Reimplemented in TiledGrid3D, and Grid3D.

local blit (   )

virtual

Interface used to blit the texture with grid to screen.

Reimplemented in TiledGrid3D, and Grid3D.

virtual void calculateVertexPoints ( void  )

virtual

Interface, Calculate the vertices used for the blit.

Reimplemented in TiledGrid3D, and Grid3D.

var calculateVertexPoints (   )

virtual

Interface, Calculate the vertices used for the blit.

Reimplemented in TiledGrid3D, and Grid3D.

local calculateVertexPoints (   )

virtual

Interface, Calculate the vertices used for the blit.

Reimplemented in TiledGrid3D, and Grid3D.

static GridBase* create ( const Size &  gridSize, Texture2D *  texture, bool  flipped  )

static

create one Grid

var create ( var  gridSize, var  texture, var  flipped  )

static

create one Grid

local create ( local  gridSize, local  texture, local  flipped  )

static

create one Grid

static GridBase* create ( const Size &  gridSize )

static

create one Grid

var create ( var  gridSize )

static

create one Grid

local create ( local  gridSize )

static

create one Grid

const Size& getGridSize ( void  ) const

inline

Size of the grid.

var getGridSize (   )

inline

Size of the grid.

local getGridSize (   )

inline

Size of the grid.

int getReuseGrid ( void  ) const

inline

Get number of times that the grid will be reused.

var getReuseGrid (   )

inline

Get number of times that the grid will be reused.

local getReuseGrid (   )

inline

Get number of times that the grid will be reused.

const Vec2& getStep ( void  ) const

inline

Pixels between the grids.

var getStep (   )

inline

Pixels between the grids.

local getStep (   )

inline

Pixels between the grids.

bool initWithSize	(	const Size &	gridSize,
		Texture2D *	texture,
		bool	flipped
	)

Init the Grid base.

Parameters

gridSize	the size of the grid.
texture	The texture used for grab.
flipped	whether or not the grab texture should be flip by Y or not.

var initWithSize	(	var	gridSize,
		var	texture,
		var	flipped
	)

Init the Grid base.

Parameters

gridSize	the size of the grid.
texture	The texture used for grab.
flipped	whether or not the grab texture should be flip by Y or not.

local initWithSize	(	local	gridSize,
		local	texture,
		local	flipped
	)

Init the Grid base.

Parameters

gridSize	the size of the grid.
texture	The texture used for grab.
flipped	whether or not the grab texture should be flip by Y or not.

bool initWithSize

(

const Size &

gridSize

)

var initWithSize

(

var

gridSize

)

local initWithSize

(

local

gridSize

)

bool isActive ( void  ) const

inline

Getter and setter of the active state of the grid.

var isActive (   )

inline

Getter and setter of the active state of the grid.

local isActive (   )

inline

Getter and setter of the active state of the grid.

bool isTextureFlipped ( void  ) const

inline

is texture flipped.

var isTextureFlipped (   )

inline

is texture flipped.

local isTextureFlipped (   )

inline

is texture flipped.

virtual void reuse ( void  )

virtual

Interface, Reuse the grid vertices.

Reimplemented in TiledGrid3D, and Grid3D.

var reuse (   )

virtual

Interface, Reuse the grid vertices.

Reimplemented in TiledGrid3D, and Grid3D.

local reuse (   )

virtual

Interface, Reuse the grid vertices.

Reimplemented in TiledGrid3D, and Grid3D.

void set2DProjection

(

void

)

Change projection to 2D for grabbing.

var set2DProjection

(

)

Change projection to 2D for grabbing.

local set2DProjection

(

)

Change projection to 2D for grabbing.

void setActive

(

bool

active

)

var setActive

(

var

active

)

local setActive

(

local

active

)

void setGridSize ( const Size &  gridSize )

inline

Set the size of the grid.

var setGridSize ( var  gridSize )

inline

Set the size of the grid.

local setGridSize ( local  gridSize )

inline

Set the size of the grid.

void setReuseGrid ( int  reuseGrid )

inline

Set number of times that the grid will be reused.

var setReuseGrid ( var  reuseGrid )

inline

Set number of times that the grid will be reused.

local setReuseGrid ( local  reuseGrid )

inline

Set number of times that the grid will be reused.

void setStep ( const Vec2 &  step )

inline

Get the pixels between the grids.

var setStep ( var  step )

inline

Get the pixels between the grids.

local setStep ( local  step )

inline

Get the pixels between the grids.

void setTextureFlipped

(

bool

flipped

)

Set the texture flipped or not.

var setTextureFlipped

(

var

flipped

)

Set the texture flipped or not.

local setTextureFlipped

(

local

flipped

)

Set the texture flipped or not.

Member Data Documentation

bool _active

protected

var _active

protected

local _active

protected

Director::Projection _directorProjection

protected

var _directorProjection

protected

local _directorProjection

protected

Grabber* _grabber

protected

var _grabber

protected

local _grabber

protected

Size _gridSize

protected

var _gridSize

protected

local _gridSize

protected

bool _isTextureFlipped

protected

var _isTextureFlipped

protected

local _isTextureFlipped

protected

int _reuseGrid

protected

var _reuseGrid

protected

local _reuseGrid

protected

GLProgram* _shaderProgram

protected

var _shaderProgram

protected

local _shaderProgram

protected

Vec2 _step

protected

var _step

protected

local _step

protected

Texture2D* _texture

protected

var _texture

protected

local _texture

protected

---

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

• /Users/minggo/SourceCode/cocos2d-x/cocos/2d/CCGrid.h