simSDF Plugin API reference

API functions for SDF input/output.

simSDF.dump
simSDF.import

simSDF.dump

Description Inspect the structure of a SDF file. Can be useful for tracking bugs.
Lua synopsis simSDF.dump(string fileName)
Lua parameters
fileName (string): SDF file path
Lua return values -
Python synopsis simSDF.dump(string fileName)

simSDF.import

Description Import a SDF file into the current scene.
Lua synopsis simSDF.import(string fileName, ImportOptions options={})
Lua parameters
fileName (string): SDF file path
options (ImportOptions, default: {})
Lua return values -
Python synopsis simSDF.import(string fileName, ImportOptions options={})



Data structures

Data structures are used to pass complex data around. Create data structures in Lua in the form of a map, e.g.: {line_size=3, add_to_legend=false, selectable=true}

ImportOptions

Description
Fields
fileName (string, default: nil):
ignoreMissingValues (bool, default: false):
hideCollisionLinks (bool, default: true):
hideJoints (bool, default: true):
convexDecompose (bool, default: true):
showConvexDecompositionDlg (bool, default: false):
createVisualIfNone (bool, default: true):
centerModel (bool, default: true):
prepareModel (bool, default: true):
noSelfCollision (bool, default: true):
positionCtrl (bool, default: true):
See also