RenderCommand Class Reference

Base class of the RenderCommand hierarchy. More...

Inherited by BatchCommand, CustomCommand, GroupCommand, MeshCommand, PrimitiveCommand, QuadCommand, 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...
float	getGlobalOrder () const
	Get global Z order. More...
Type	getType () const
	Returns the Command type. More...
bool	isTransparent () const
	Retruns whether is transparent. More...
void	setTransparent (bool 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. More...
void	setSkipBatching (bool value)
	Set skip batching. More...
bool	is3D () const
	Whether the command should be rendered at 3D mode. More...
void	set3D (bool value)
	Set the command rendered in 3D mode or not. More...
float	getDepth () const
	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.

The global order of command, used for rendercommand sorting. Modelview matrix when submitting the render command. 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.

The global order of command, used for rendercommand sorting. Modelview matrix when submitting the render command. 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.

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

float getGlobalOrder ( ) const

inline

Get global Z order.

the global Z of render command.

var getGlobalOrder ( )

inline

Get global Z order.

the global Z of render command.

local getGlobalOrder ( )

inline

Get global Z order.

the global Z of render command.

Type getType ( ) const

inline

Returns the Command type.

The type of render command.

var getType ( )

inline

Returns the Command type.

The type of render command.

local getType ( )

inline

Returns the Command type.

The type of render command.

bool isTransparent ( ) const

inline

Retruns whether is transparent.

The transparent status.

var isTransparent ( )

inline

Retruns whether is transparent.

The transparent status.

local isTransparent ( )

inline

Retruns whether is transparent.

The transparent status.

void setTransparent ( bool  isTransparent )

inline

Set transparent flag.

The transparent status.

var setTransparent ( var  isTransparent )

inline

Set transparent flag.

The transparent status.

local setTransparent ( local  isTransparent )

inline

Set transparent flag.

The transparent status.

bool isSkipBatching ( ) const

inline

Get skip batching status, if a rendering is skip batching, it will be forced to be rendering separately.

the Skip Batching status.

var isSkipBatching ( )

inline

Get skip batching status, if a rendering is skip batching, it will be forced to be rendering separately.

the Skip Batching status.

local isSkipBatching ( )

inline

Get skip batching status, if a rendering is skip batching, it will be forced to be rendering separately.

the Skip Batching status.

void setSkipBatching ( bool  value )

inline

Set skip batching.

the skip batching status.

var setSkipBatching ( var  value )

inline

Set skip batching.

the skip batching status.

local setSkipBatching ( local  value )

inline

Set skip batching.

the skip batching status.

bool is3D ( ) const

inline

Whether the command should be rendered at 3D mode.

the 3D mode status.

var is3D ( )

inline

Whether the command should be rendered at 3D mode.

the 3D mode status.

local is3D ( )

inline

Whether the command should be rendered at 3D mode.

the 3D mode status.

void set3D ( bool  value )

inline

Set the command rendered in 3D mode or not.

the 3D model status.

var set3D ( var  value )

inline

Set the command rendered in 3D mode or not.

the 3D model status.

local set3D ( local  value )

inline

Set the command rendered in 3D mode or not.

the 3D model status.

float getDepth ( ) const

inline

Get the depth by current model view matrix.

the depth value.

var getDepth ( )

inline

Get the depth by current model view matrix.

the depth value.

local getDepth ( )

inline

Get the depth by current model view matrix.

the depth value.

---

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

• CCRenderCommand.h