|
Regular API function
simRemovePointsFromPointCloud / sim.removePointsFromPointCloud
|
Description
|
Removes points from a point cloud. When a point cloud doesn't use an OC tree calculation structure, then individual points cannot be removed, only all points can be removed in that case. See also sim.insertPointsIntoPointCloud, sim.setPointCloudOptions and the other point cloud related functions. |
C/C++
synopsis
|
simInt simRemovePointsFromPointCloud(simInt pointCloudHandle,simInt options,const simFloat* pts,simInt ptCnt,simFloat tolerance,simVoid* reserved) |
C/C++
parameters |
pointCloudHandle: the handle of the point cloud. See also sim.getObjectoptions: bit-coded:
bit0 set (1): specified points are relative to the point cloud reference frame, otherwise they are relative to the world reference frame
pts: a pointer to the point positions specified as X/Y/Z coordinates. Set to nullptr to remove all points
ptCnt: the number of point coordinates contained in pts
tolerance: a distance used as a tolerance value
reserved: reserved for future extensions. Set to nullptr
|
C/C++
return value
|
-1 if operation was not successful, otherwise the total number of points in the point cloud
|
Lua
synopsis
|
int totalPointCnt=sim.removePointsFromPointCloud(int pointCloudHandle,int options,float[] points,float tolerance) |
Lua
parameters |
Similar to the C-function counterpart
|
Lua
return values
|
Similar to the C-function counterpart
|
Python
synopsis |
int totalPointCnt=sim.removePointsFromPointCloud(int pointCloudHandle,int options,list points,float tolerance) |
|