RenderCommand Class Reference

Base class of the RenderCommand hierarchy. More...

Inherited by BatchCommand, CustomCommand, GroupCommand, MeshCommand, PrimitiveCommand, and TrianglesCommand.

Public Types
enum	Type {   UNKNOWN_COMMAND, QUAD_COMMAND, CUSTOM_COMMAND, BATCH_COMMAND,   GROUP_COMMAND, MESH_COMMAND, PRIMITIVE_COMMAND, TRIANGLES_COMMAND }
	Enum the type of render command. More...

Public Member Functions
void	init (float globalZOrder, const Mat4 &modelViewTransform, uint32_t flags)
	Init function, will be called by all the render commands. More...
var	init ( var globalZOrder, var modelViewTransform, var flags)
	Init function, will be called by all the render commands. More...
local	init ( local globalZOrder, local modelViewTransform, local flags)
	Init function, will be called by all the render commands. More...
float	getGlobalOrder () const
	Get global Z order. More...
local	getGlobalOrder ()
	Get global Z order. More...
Type	getType () const
	Returns the Command type. More...
local	getType ()
	Returns the Command type. More...
bool	isTransparent () const
	Returns whether is transparent. More...
local	isTransparent ()
	Returns whether is transparent. More...
void	setTransparent (bool isTransparent)
	Set transparent flag. More...
var	setTransparent ( var isTransparent)
	Set transparent flag. More...
local	setTransparent ( local isTransparent)
	Set transparent flag. More...
bool	isSkipBatching () const
	Get skip batching status, if a rendering is skip batching, it will be forced to be rendering separately.
void	setSkipBatching (bool value)
	Set skip batching. More...
local	setSkipBatching ( local value)
	Set skip batching. More...
bool	is3D () const
	Whether the command should be rendered at 3D mode. More...
var	is3D ()
	Whether the command should be rendered at 3D mode. More...
local	is3D ()
	Whether the command should be rendered at 3D mode. More...
void	set3D (bool value)
	Set the command rendered in 3D mode or not. More...
var	set3D ( var value)
	Set the command rendered in 3D mode or not. More...
local	set3D ( local value)
	Set the command rendered in 3D mode or not. More...
float	getDepth () const
	Get the depth by current model view matrix. More...
local	getDepth ()
	Get the depth by current model view matrix. More...

Detailed Description

Base class of the RenderCommand hierarchy.

The Renderer knows how to render RenderCommands objects.

Member Function Documentation

void init	(	float	globalZOrder,
		const Mat4 &	modelViewTransform,
		uint32_t	flags
	)

Init function, will be called by all the render commands.

Parameters

globalZOrder	The global order of command, used for rendercommand sorting.
modelViewTransform	Modelview matrix when submitting the render command.
flags	Flag used to indicate whether the command should be draw at 3D mode or not.

var init	(	var	globalZOrder,
		var	modelViewTransform,
		var	flags
	)

Init function, will be called by all the render commands.

Parameters

globalZOrder	The global order of command, used for rendercommand sorting.
modelViewTransform	Modelview matrix when submitting the render command.
flags	Flag used to indicate whether the command should be draw at 3D mode or not.

local init	(	local	globalZOrder,
		local	modelViewTransform,
		local	flags
	)

Init function, will be called by all the render commands.

Parameters

globalZOrder	The global order of command, used for rendercommand sorting.
modelViewTransform	Modelview matrix when submitting the render command.
flags	Flag used to indicate whether the command should be draw at 3D mode or not.

float getGlobalOrder ( ) const

inline

Get global Z order.

var getGlobalOrder ( )

inline

Get global Z order.

local getGlobalOrder ( )

inline

Get global Z order.

Type getType ( ) const

inline

Returns the Command type.

var getType ( )

inline

Returns the Command type.

local getType ( )

inline

Returns the Command type.

bool isTransparent ( ) const

inline

Returns whether is transparent.

var isTransparent ( )

inline

Returns whether is transparent.

local isTransparent ( )

inline

Returns whether is transparent.

void setTransparent ( bool  isTransparent )

inline

Set transparent flag.

var setTransparent ( var  isTransparent )

inline

Set transparent flag.

local setTransparent ( local  isTransparent )

inline

Set transparent flag.

void setSkipBatching ( bool  value )

inline

Set skip batching.

var setSkipBatching ( var  value )

inline

Set skip batching.

local setSkipBatching ( local  value )

inline

Set skip batching.

bool is3D ( ) const

inline

Whether the command should be rendered at 3D mode.

var is3D ( )

inline

Whether the command should be rendered at 3D mode.

local is3D ( )

inline

Whether the command should be rendered at 3D mode.

void set3D ( bool  value )

inline

Set the command rendered in 3D mode or not.

var set3D ( var  value )

inline

Set the command rendered in 3D mode or not.

local set3D ( local  value )

inline

Set the command rendered in 3D mode or not.

float getDepth ( ) const

inline

Get the depth by current model view matrix.

var getDepth ( )

inline

Get the depth by current model view matrix.

local getDepth ( )

inline

Get the depth by current model view matrix.

---

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

• CCRenderCommand.h