Operators

Operators are constructs in Blender that can be called from the GUI, thus whenever you click a button or menu item, you execute an operator. While you can use lots of Phobos' functions when scripting in Blender, most of the time you will work with the set of operators it provides.

Model editing

Robot Model

Update Robot Model

This operator is deprecated and will be deleted soon. Please do not use it anymore. TODO already deleted?

Name Robot

assign a name to a robot. You have to select at least one object parented to the robots root link.

Define kinematic chain

define a kinematic chain containing all selected objects. The active object will be the end of the chain.

Toggle Namespaces

toggle the selected objects namespaces. If complete is checked the whole selected robot will be toggled. TODO what does it mean to toggle the namespace?

Inspect Robot

Measure distance

measure the distance between TODO between what and what?

X-Ray view

enable or disable the X-Ray view for a specified set of objects. With X-Ray view you can investigate the inner structure of the robot without hiding objects.

Check robot dictionary

check a robot against a set of rules and saves all suspicious objects into a list. TODO is this validating?

Select error containing objects

select objects with errors (detected by the TODOLCheck robot dictionary operator)

Selection(s)

Select Root

select the root link of the corresponding robot for each selected object.

Select by phobostype

select all objects of a specified phobostype.

Select Robot

select all objects (including links, visuals, collisions, inertials, sensors and controllers) which are part of the robot the currently selected object is part of.

Object editing

Set phobostype

set a specific phobostype for all selected objects.

Partial Rename

perform a find and replace operation on object names. Be careful using it, because it doesn't respect namespaces and other naming conventions.

Set Objects to Layers

sorts the selected TODO selected true? objects to their corresponding layer (determined by phobostype). See Editing a model for more information about layers in phobos.

Edit Custom Property

edit the specified custom property for all selected objects. If the new value is empty the property is deleted. Otherwise the new value is set accordingly (and the property added if not existent).

Share meshes

shares the mesh of the active object with the selected objects. Be careful with this operator, as the overwritten meshes will be lost forever. You can specify a name for the shared mesh.

Context Requirements

• The active object must not have an already shared mesh
• The active object has to be a visual or collision object
• The number of selected visual/collision objects has to be >= 2 TODO is this true and needed?

Copy Custom Property

takes the active objects properties and copies it to all other selected objects. You can choose to purge all other custom properties.

Undo Share meshes

breaks the bond between the shared meshes. The objects will not get their old meshes back, but the meshes can be edited and exported individually again. If you undo a sharing on a source object without undoing it on its adherents you may have problems with the mesh export later on.

Rename Custom Property

takes all selected objects and renames a given custom property. You can choose whether you want to override existing properties or not.

Smoothen Surface

takes all selected objects and applies smooth shading to them.

Edit Object Dictionary

edit the active objects custom properties in the blender text editor. You can change the values and even add or delete key-value pairs. If you hit the run script button the custom properties of the currently active object will be overwritten. So make sure you have selected the right one.

Kinematics

Create Link(s)

creates links at the 3D cursors location or at the selected objects positions. You can choose to parent the newly created links with the selected objects and parent links. TODO better detail

Define Joint Constraints

takes all selected links and applies the defined joint constraints to them. All URDF joint types are supported.

Create Inertial Object(s)

takes all selected links and creates their inertial objects. You can choose to calculate them automatically or manually.

Attach Motor

attaches the specified motor to all selected links.

Create Collision Object(s)

creates collision objects for all selected visuals. You can choose from a set of different primitives or use visuals mesh. If you use the mesh option you can either copy the mesh for further editing or use the shared mesh.

Set Geometry Type(s)

takes all selected objects and sets their geometry types. All objects that are no visual or collision objects are omitted.

Set Origin to COM

sets all selected objects origins to their centre of mass. Does this result in errors with the parenting?

Set Collision Group

sets the collision groups for all selected collision objects. You can change the groups by just changing the bitmask visible in the operators properties menu.

Mimic Joint

TODO what is this? remove it?

Masses & Inertia

Show Mass

shows the mass of your selected objects.

Sync Masses

TODO missing?

Set Mass

sets the specified mass for all selected objects.

Edit Inertia

takes all selected objects and sets their inertia data. Non inertial objects are omitted.

Sensors & Controllers

Add/Edit Sensor

TODO Empty?

Add Controller

TODO Empty?

Export & Import

Model Export Settings

path

The directory in which the model will be saved. By checking the respective box in the selection dialog it is possible to use a relative path.

decimals

This value sets the number of decimal digits used for representing floating point values inside the export files.

export textures

Check this to export the texture data of the meshes.

selected only

Check this to limit exporting to selected objects.

Models export

Checking one or multiple of the model boxes will result in an export in the respective file format.

Mesh export

Selecting one or multiple of the mesh boxes will export the visual meshes in the respective file format.

mesh link

The model or scene export will use this mesh type to link to mesh data.

Scene export

Select the appropriate scene format that will be exported.

Robot data export

Export Model

Exports the selected robot to the specified path using the export settings.

Import Robot Model

allows browsing of either a MARS scene or a URDF file and importing the model specified inside it. TODO which imports are available right now?

For a description of individual operators please refer to our source documentation.