Regular API function

simRemoveVoxelsFromOctree / sim.removeVoxelsFromOctree

Description Removes voxels from an OC tree. See also sim.insertVoxelsIntoOctree and the other OC tree related functions.
C/C++
synopsis
simInt simRemoveVoxelsFromOctree(simInt octreeHandle,simInt options,const simFloat* pts,simInt ptCnt,simVoid* reserved)
C/C++
parameters
octreeHandle: the handle of the OC tree. See also sim.getObject
options: bit-coded:
bit0 set (1): specified points are relative to the OC tree reference frame, otherwise they are relative to the world reference frame
pts: a pointer to the voxel positions specified as X/Y/Z coordinates. Set to nullptr to remove all voxels
ptCnt: the number of point coordinates contained in pts
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.removeVoxelsFromOctree(int octreeHandle,int options,float[] points)
Lua
parameters
Similar to the C-function counterpart
Lua
return values
Similar to the C-function counterpart
Python
synopsis
int totalVoxelCnt=sim.removeVoxelsFromOctree(int octreeHandle,int options,list points)