Regular API function

simSubtractObjectFromOctree / sim.subtractObjectFromOctree

Description Removes an object from an OC tree, as voxel subtractions. See also sim.insertObjectIntoOctree, sim.removeVoxelsFromOctree and the other OC tree related functions.
C/C++
synopsis
simInt simSubtractObjectFromOctree(simInt octreeHandle,simInt objectHandle,simInt options,simVoid* reserved)
C/C++
parameters
octreeHandle: the handle of the OC tree. See also sim.getObject
objectHandle: the handle of the object to subtract. Only potentially collidable objects are supported
options: reserved. Set to 0
reserved: reserved for future extensions. Set to nullptr
C/C++
return value
-1 if operation was not successful, otherwise the total number of voxels in the OC tree
Lua
synopsis
int totalVoxelCnt=sim.subtractObjectFromOctree(int octreeHandle,int objectHandle,int options)
Lua
parameters
Similar to the C-function counterpart
Lua
return values
Similar to the C-function counterpart
Python
synopsis
int totalVoxelCnt=sim.subtractObjectFromOctree(int octreeHandle,int objectHandle,int options)