Tutorial 1: Simumatik logo
In this tutorial you will:
- Understand the basics of the datamodel
- Learn about the Component Editor
- Create a basic decoration component
The Simumatik datamodel is an abstraction based on URDF and SDF that declare the elements, properties and structure that give life to a component. It provides the users with simple blocks to create any component and it defines the rules that make a component valid, making sure it is compatible with the platform.
Simumatik components are defined in XML files by using the generic blocks of the datamodel. They follow a tree-structure, where different elements will have as children the related properties. Manually edit this file requires a really good knowledge of the datamodel. Therefore, the Component Editor is a huge help.
The component editor is a fully replacement for the XML editor, so don't feel overwhelmed by this screenshot. It will generate the entire XML for you!
The component editor allows users with a paid subscription to easily create new components. It allows defining the component metadata (such as name, description, etc), assets (3d-models, scripts, etc) and structure (visuals, collisions, joints, etc).
It's main goal is to ease the components creation by helping the user to define everything needed in a visual way, without any code involved. For that purpose, the component structure is defined as a tree, where you can modify any properly and add/remove new elements directly from there.
Let's start by creating a new component in the Library page. If you don't know how to do it, please take a look to Creating a new component.
Once the Component Editor is shown, switch to the 3D tab. As you can see, a component has by default just a base_link element, which you can think of as a body. Any body will need to have defined at least the way it looks like (visual). At the same time, the visual will need a position in the space (origin) and a geometry.
In the following tutorials we will be adding more elements to our body (base_link), such as multiple visuals, inertia, a surface, etc. Moreover, we will also add multiple bodies to a component, connecting them together with joints.
We are going to use a 3D model of the Simumatik logo, that you can download by clicking here. In Simumatik, 3D imported models are called mesh, and currently the only supported standard is the glb file format. They could be as simple as a box, or as complex as a car.
Let's start by moving back to the Component Information tab for uploading the Simumatik logo to assets. Take a look to Uploading assets to learn how to do it.
Next, switch again to the 3D tab. Expand everything in the tree until the geometry is visible, as in the above picture, then right-click it to get the available options. Let's select now the mesh.
The mesh element has as children a model element, which will link an asset to the visual, and a scale, in order to change the visual size. Let's select the model element and then click on the Value field below to modify it.
A modal will be shown. Pick the asset that we upload before and then click OK.
Your Simumatik logo is now finished! Let's take a screenshot of your newest component and save it.
You can now add it to a library and start using it. You can see an example below.