Regular API function

simSubtractObjectFromPointCloud / sim.subtractObjectFromPointCloud

Description Removes an object from a point cloud, as a subtraction. See also sim.insertPointsIntoPointCloud, sim.insertObjectIntoPointCloud, sim.removePointsFromPointCloud and the other point cloud related functions.
C synopsis simInt simSubtractObjectFromPointCloud(simInt pointCloudHandle,simInt objectHandle,simInt options,simFloat tolerance,simVoid* reserved)
C parameters
pointCloudHandle: the handle of the point cloud. See also simGetObjectHandle
objectHandle: the handle of the object to subtract. Only potentially measurable objects are supported.
options: reserved. Set to 0
tolerance: a distance used as a tolerance value
reserved: reserved for future extensions. Set to nullptr
C return value
-1 if operation was not successful, otherwise the total number of points in the point cloud
Lua synopsis int totalPointCnt=sim.subtractObjectFromPointCloud(int pointCloudHandle,int objectHandle,int options,float tolerance)
Lua parameters
Similar to the C-function counterpart
Lua return values
Similar to the C-function counterpart