GridBase Class Reference

Base class for Other grid. More...

Inherits Ref.

Inherited by Grid3D, and TiledGrid3D.

Public Member Functions
virtual	~GridBase ()
	Destructor.
virtual void	blit ()=0
	Interface used to blit the texture with grid to screen.
virtual void	reuse ()=0
	Interface, Reuse the grid vertices.
virtual void	calculateVertexPoints ()=0
	Interface, Calculate the vertices used for the blit.
int	getReuseGrid () const
	Get number of times that the grid will be reused.
void	setReuseGrid (int reuseGrid)
	Set number of times that the grid will be reused.
const Size &	getGridSize () const
	Size of the grid.
void	setGridSize (const Size &gridSize)
	Set the size of the grid.
const Vec2 &	getStep () const
	Pixels between the grids.
void	setStep (const Vec2 &step)
	Get the pixels between the grids.
bool	isTextureFlipped () const
	is texture flipped.
void	setTextureFlipped (bool flipped)
	Set the texture flipped or not.
void	set2DProjection ()
	Change projection to 2D for grabbing.
void	setGridRect (const Rect &rect)
	Set the effect grid rect.
const Rect &	getGridRect () const
	Get the effect grid rect.
virtual void	beforeBlit ()
bool	initWithSize (const Size &gridSize)
bool	isActive () const
void	beforeDraw ()
Public Member Functions inherited from Ref
void	retain ()
	Retains the ownership.
void	release ()
	Releases the ownership immediately.
Ref *	autorelease ()
	Releases the ownership sometime soon automatically.
unsigned int	getReferenceCount () const
	Returns the Ref's current reference count.
virtual	~Ref ()
	Destructor.

Additional Inherited Members
Public Attributes inherited from Ref
unsigned int	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.
void *	_scriptObject
	scriptObject, support for swift
bool	_rooted
	When true, it means that the object was already rooted.

Detailed Description

Base class for Other grid.

Constructor & Destructor Documentation

virtual ~GridBase ( )

virtual

Destructor.

NA NA

Member Function Documentation

virtual void beforeBlit ( )

inlinevirtual

Interface for custom action when before or after draw. NA

Reimplemented in Grid3D.

virtual void blit ( )

pure virtual

Interface used to blit the texture with grid to screen.

Implemented in TiledGrid3D, and Grid3D.

virtual void reuse ( )

pure virtual

Interface, Reuse the grid vertices.

Implemented in TiledGrid3D, and Grid3D.

virtual void calculateVertexPoints ( )

pure virtual

Interface, Calculate the vertices used for the blit.

Implemented in TiledGrid3D, and Grid3D.

bool initWithSize

(

const Size &

gridSize

)

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.
rect	The effective grid rect.

bool isActive ( ) const

inline

Getter and setter of the active state of the grid.

int getReuseGrid ( ) const

inline

Get number of times that the grid will be reused.

void setReuseGrid ( int  reuseGrid )

inline

Set number of times that the grid will be reused.

const Size& getGridSize ( ) const

inline

Size of the grid.

void setGridSize ( const Size &  gridSize )

inline

Set the size of the grid.

const Vec2& getStep ( ) const

inline

Pixels between the grids.

void setStep ( const Vec2 &  step )

inline

Get the pixels between the grids.

bool isTextureFlipped ( ) const

inline

is texture flipped.

void setTextureFlipped

(

bool

flipped

)

Set the texture flipped or not.

void beforeDraw

(

)

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

void set2DProjection

(

)

Change projection to 2D for grabbing.

void setGridRect

(

const Rect &

rect

)

Set the effect grid rect.

Parameters

rect	The effect grid rect.

const Rect& getGridRect ( ) const

inline

Get the effect grid rect.

Returns

Return the effect grid rect.

---

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

• CCGrid.h