Cocos2d-x  v3.17
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Groups Pages
GroupCommand Class Reference

GroupCommand is used to group several command together, and more, it can be nested. More...

Inherits RenderCommand.

Public Member Functions

void init (float globalOrder)
 Init function for group command.
 
var init ( var globalOrder)
 Init function for group command.
 
local init ( local globalOrder)
 Init function for group command.
 
int getRenderQueueID () const
 called by renderer, get the group ID. More...
 
var getRenderQueueID ()
 called by renderer, get the group ID. More...
 
local getRenderQueueID ()
 called by renderer, get the group ID. More...
 
 GroupCommand ()
 GroupCommand ()
- Public Member Functions inherited from RenderCommand
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...
 

Additional Inherited Members

- Public Types inherited from RenderCommand
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...
 

Detailed Description

GroupCommand is used to group several command together, and more, it can be nested.

So it is used to generate the hierarchy for the rendcommands. Every group command will be assigned by a group ID.

Constructor & Destructor Documentation

Constructor and Destructor.

var GroupCommand ( )

Constructor and Destructor.

local GroupCommand ( )

Constructor and Destructor.

Member Function Documentation

int getRenderQueueID ( ) const
inline

called by renderer, get the group ID.

var getRenderQueueID ( )
inline

called by renderer, get the group ID.

local getRenderQueueID ( )
inline

called by renderer, get the group ID.


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