Regular API function


Description Retrieves object handles in a given hierarchy tree. See also simGetObjects.
C synopsis simInt* simGetObjectsInTree(simInt treeBaseHandle,simInt objectType,simInt options,simInt* objectCount)
C parameters
treeBaseHandle: the handle of the object that describes the hierarchy tree, or sim_handle_scene for all objects in the scene.
objectType: the object type to retrieve or sim_handle_all for any type of object in the tree
options: bit-coded:
bit0 set (1): exclude the tree base from the returned array
bit1 set (2): include in the returned array only the object's first children. If treeBaseHandle is sim_handle_scene, then only parentless objects will be included.
objectCount (out value): the number of returned object handles
C return value
a pointer to an array containing object handles, or NULL in case of an error. The user is in charge of releasing the returned buffer with simReleaseBuffer.
Lua synopsis table objects=simGetObjectsInTree(number treeBaseHandle,number objectType=sim_handle_all, number options=0)
Lua parameters
Same as C-function
Lua return values
Similar as C-function

All regular API functions on one page