Regular API function

simSubtractObjectFromOctree / sim.subtractObjectFromOctree

Description Removes an object from an octree, as voxel subtractions. See also sim.insertObjectIntoOctree, sim.removeVoxelsFromOctree and the other octree related functions.
C synopsis simInt simSubtractObjectFromOctree(simInt octreeHandle,simInt objectHandle,simInt options,simVoid* reserved)
C parameters
octreeHandle: the handle of the octree. See also simGetObjectHandle
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 NULL
C return value
-1 if operation was not successful, otherwise the total number of voxels in the octree
Lua synopsis number totalVoxelCnt=sim.subtractObjectFromOctree(number octreeHandle,number objectHandle,number options)
Lua parameters
Same as C-function
Lua return values
Same as C-function

All regular API functions on one page