cyberbotics / robot-designer Goto Github PK

Here is a new iteration on the module and class design:
https://github.com/omichel/robot-designer/wiki/Design

Since the last version and according the Olivier:

• The view3D and the partView have been separated into 2 modules.
• Classes and modules are listed in a more exhaustive way.
• A top module has been introduced.

Moreover:

• I renamed "View3D" to "RobotView"
• I dropped the UIControl classes which could be implicitly added the main class of each module (RobotView, etc.)
• I added a PartBrowser module.
• I didn't show all the interactions with the data blocks (DOM, ThreeJS), because they are implicit in most of the cases.

This document needs to be validated and improved with the implementation.

After clicking on a translation gizmo and dragging the part the mouse over part highlight continues to change based on the position of the mouse.
Given that in any case the selection cannot be changes during the drag it seems better to disable the highlight changes based on the mouse position.

Currently for some faces of the TInkerbots cubies, like the up face, only one slot is defined even if multiple "holes" are available in the slot.
This could be fine for users but in this case we need to support adding multiple parts per slots which is not the case now.

It would also be possible to specify a maximum number of parts per slot.

I think it would be good to rename view/view3d.js to view/robot_viewer.js (and the related class) to be consistent with view/part_browser.js and view/part_viewer.js

Steps to reproduce:

1. add tinkerbots root part
2. add a cubie (A)
3. add a cubie (B) to the cubie (A)
4. delete cubie (A) -> cubie (B) is deleted as well
5. undo last deletion action

-> everything seems to work correctly but this error is displayed in the console

Uncaught TypeError: Cannot read property 'traverse' of undefined
    at PartMediator.onPartAdded (part_mediator.js:23)
    at PartMediator.model.addObserver (part_mediator.js:13)
    at observers.forEach (Observable.js:18)
    at Array.forEach (<anonymous>)
    at Part.notify (Observable.js:17)
    at part.js:43
    at Part._applyFooRecursively (part.js:92)
    at Part.addPart (part.js:42)
    at commands.js:95
    at UndoStack.undo (UndoStack.js:39)

It could be more user-friendly if a translation/rotation using the handles (from mouse down till mouse up) is considered as a single operation.
Otherwise, undoing this change would need many undo actions.

In the part browser it would be good to show the name of the part when the mouse pointer is over it.

The current version of the robot designer is very close to allow to build all the default models.
But there are a couple of issues with the slots that prevents it:

• missing slots definition for cubie_box_with_round_slots
• translation step is too big for the front face of the cubie_box_with_round_slots and cubie_box_with_cross_slots -> it is not possible to move the attached part precisely to the wanted position

Additionally:

• it should be possible to define multiple slot type for round female slots: they can be connect with both cross and round male parts

For now the position constraints are hard-coded here:

https://github.com/omichel/robot-designer/blob/master/app/view/handle.js#L109

It would be good to migrate them to asset/assets.json.

For now, the customizable parameters are TinkerbotsAxle.length (actually not implemented), TinkerbotsCubiePyramid.color and TinkerbotsCubieTriangle.color. In Webots, they are all string enumerations, and affects the Shape (color or shape).

In the contrary of translation or rotation where the THREEjs <-> Webots link is direct, this kind of links should be coded somewhere. For now it's hard-coded here: https://github.com/omichel/robot-designer/blob/master/app/view/mediator/part_mediator.js#L78

To solve this, we should either provide a generic way to write these links, or to have several x3d files (e.g. one x3d file per parameter set).

Sometimes it happens that there is a gap between selection in the 3D view and the mouse pointer position on the screen.
This is not systematical but i can reproduce it quite often on Chrome especially after working with other applications and returning the robot designer web page.

I had similar issues with webots.js that were due to faulty mouse position initialization.

robot-designer is not working on Edge and IE

To reproduce:

• Add a Tinkerbots base
• Add 2 Tinkerbots cube and a cubie on the base
• Remove one Tinkerbots cube
• Change mode to "move"
• Select the cubie
  => the handle is not displayed

It will be user-friendly to enable some keyboard shortcuts, for example:

• Delete: delete selected
• Ctrl + Z: Undo
• Ctrl + Y: Redo
• Ctrl + S: save
• M - Toggle between selection and translation and rotation gizmo (as in mecabricks or any other keyboard shortcuts)

And to add copy/paste buttons and shortcuts

In https://github.com/omichel/webots/pull/552, the Tinkerbots type name has changed to use the Slot gender mechanism.

Updating https://github.com/omichel/robot-designer/blob/master/assets/assets.json would be good for consistency.

For now, the THREEjs view is refreshed at 60fps systematically. Now that the design become more stable it would be good to have a finer control on the refresh, by refreshing only when some event occurs. These events are certainly the command updates, x3d load, textures load, direct GUI modifications (mouse move?).

As already reported in #11, there are some issues undoing operations with meshes for which the color has been changed.

For example:

1. undoing a color change (yellow -> blue)
   -> the mesh remains blue

2. undoing a delete of a blue part
   -> the mesh appears as yellow, in the part viewer the color is set to yellow, but it seems that internally the blue is stored because changing manually back the color to blue doesn't work the first time. It works if set it to blue, then to yellow (visible color matches internal color?) and then again to blue.

The Tinkerbots root node cannot be deleted using the delete button.