Fairmotion Character Positioning via MOTION MouseMode

[JuanTheEngineer]

Motivation and Context

Goal

With this PR merged, the Fairmotion viewer will have an additional mouse interaction mode called "MOTION".

Functionality

This mode allows users to select a loaded Fairmotion character and click to a desired location for the character and its motion. It also allows users to set rotation around the floor-normal axis by scrolling the mouse wheel with fine-grain rotating using the Shift key. These are useful features for positioning the character in the scene.

It is works in parallel with the Key Frame and Trajectory Object Previews, which gives the user the ability to foresee scene collision throughout the timeline of the motion for improved character placement choice.

Currently the Fairmotion viewer supports one character at a time and this PR feature is lightly coupled to that fact. In a future PR multiple character loading will be supported and this MOTION mode with expand to the same degree.

UI Mouse Commands

Here is a snippet of the Command Help Text to describe the utilities of this PR

In MOTION mode (with 'enable-physics'):
    LEFT:
        Click a Fairmotion character to set it as selected or clcik anywhere else to deselect.
    RIGHT (With selected Fairmotion character):
        Click anywhere on the scene to translate a selected Fairmotion character to the clicked location.
    WHEEL (with selected Fairmotion character):
        Rotate the orientation of a selected Fairmotion character along an axis normal to the floor of the scene.
        (+ SHIFT): for fine-grained control

Preview

Here is a preview of the feature in action where the feature is used to place the character's dribbling motion in the tight hallway:

Demo_Motion_Mouse_Postioning.mp4

How Has This Been Tested

The majority of this feature lives in the Fairmotion viewer application and was tested by running that application.

Types of changes

• Docs change / refactoring / dependency upgrade
• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have completed my CLA (see CONTRIBUTING)
• I have added tests to cover my changes.
• All new and existing tests passed.

[Skylion007]

FYI, just updated the Magnum color bindings to make things a bit easier for you: mosra/magnum-bindings@c50a2f6 . Will need to bump the submodule to see the new bindings.

Resolved current change requests

[aclegg3]

Great video in description. Let's improve the UI description also. Be clear about which click and keys to use. Maybe use a bullet list similar to the help text.

When you re-defined the help text for this application you dropped the mouse legend. Let's add that back here and document the MOTION mode there.