Regular API function


Description Removes an object from the selection. See also simAddObjectToSelection, simIsObjectInSelection and simGetObjectSelection.
C synopsis simInt simRemoveObjectFromSelection(simInt what,simInt objectHandle)
C parameters
What: indicates what we wish to remove from the selection. Valid values are sim_handle_single (removes one object from the selection), sim_handle_all (removes all objects from the selection), sim_handle_tree (removes the tree with base objectHandle (inclusive) from the selection, sim_handle_chain (removes the chain with tip objectHandle (inclusive) from the selection.
objectHandle: handle of the object to remove from the selection. If sim_handle_all is specifies in "what", then objectHandle is ignored
C return value
-1 if operation was not successful. In a future release, a more differentiated return value might be available
Lua synopsis
(1) number result=simRemoveObjectFromSelection(number what,number objectHandle)
(2) number result=simRemoveObjectFromSelection(table objectHandles)
Lua parameters
(1) Same as C-function. The second argument can be omitted if "what" is sim_handle_all
(2) objectHandles: table containing the handles of objects to remove. Can be nil, in which case nothing happens
Lua return values
Same as C-function

All regular API functions on one page