Regular API function

simGroupShapes / sim.groupShapes

Description Groups (or merges) several shapes into a compound shape (or simple shape). See also sim.ungroupShape.
C/C++
synopsis
simInt simGroupShapes(const simInt* shapeHandles,simInt shapeCount)
C/C++
parameters
shapeHandles: the handles of the shapes to be grouped or merged. The last handle represents the shape that will accept the other shapes.
shapeCount: the size of the shapeHandles array. A negative number indicates that we want to merge the shapes instead of grouping them.
C/C++
return value
-1 if operation was not successful. Otherwise the handle of the resulting compound shape, which is the last shape in shapeHandles.
Lua synopsis int shapeHandle=sim.groupShapes(table[] shapeHandles, bool merge=false)
Lua parameters
shapeHandles: the handles of the shapes to be grouped or merged. The last handle represents the shape that will accept the other shapes.
merge: whether the shapes should be merged or grouped
Lua return values
Similar to the C-function counterpart
Python synopsis int shapeHandle=sim.groupShapes(list shapeHandles,bool merge=False)