Tap to Place MRTK

[CDiaz-MS]

Overview

The MRTK version of HoloToolkit's Tap to Place.

Tracked Target Type: Head	Tracked Target Type: Controller Ray

Tap to Place enables easy placement of an object on a surface. The default behavior for Tap to Place MRTK mirrors HoloToolkit's Tap to Place, but has some new additions. Tap to Place is a derivation of the Solver class.

To test, open the example scene TapToPlaceExample located in MixedRealityToolkit.Examples/Demos/Solvers/Scenes/.

How to use:

1. Create a new unity scene and add MRTK by selecting the Mixed Reality Toolkit menu -> Add to Scene and Configure
2. Attach TapToPlace to a game object with a Collider
   • A Solver Handler component will also get added with Tap to Place
3. Press play, with the game object in focus, air tap/click the object.
   • The object will begin to follow the TrackedTargetType, which is the Head by default. The object placement is based on whether or not the raycast hits a surface, this could be the spatial mesh or any object with a collider. If there is a surface hit, place the object on the surface, if not, place at an adjustable default distance.
4. To place the object, air tap/click again. The placement click does not require the object to be in focus.

Changes from HoloToolkit to MRTK's Tap to Place:

• Added OnPlacingStarted and OnPlacingStopped events
• Removed spatial awareness dependency
• Added RotateAccordingToSurface and KeepOrientationVertical
  • Enables object orientation adaption based on the normal of the surface hit

This work is based on @Troy-Ferrell's tap to place branch found here.

Images/Gifs

Tap to Place Inspector

Tap to Place Example Scene without walls (Default)	Tap to Place Example Scene with walls

VR Behavior:

Changes

• Fixes: Port over Tap-to-Place feature from HoloToolkit #4515 , TapToPlace #7190

TO DO

• Update PR Description, add gifs
• Add Documentation (Different PR)
• Add Tests (Different PR)

Verification

As a reviewer, it is possible to check out this change locally by using the following
commands (substituting {PR_ID} with the ID of this pull request):

git fetch origin pull/{PR_ID}/head:name_of_local_branch

git checkout name_of_local_branch

[Troy-Ferrell]

Cool stuff! I know you are only in draft mode but left some initial comments to review before creating pull request

[wiwei]

Looking good!

[julenka]

Good progress. I have several smaller comments but have a must-have request: please make it possible to start and stop placement from code. Would also recommend removing the custom inspector

[julenka]

Why do we need to disable editing this component if in play mode?

[CDiaz-MS]

If the user tries to toggle AutoStart while in play mode, the change will not get registered because the action associated with AutoStart is called only in Start(). I disabled it to remove the potential confusion if someone tried to toggle AutoStart while in play mode through the inspector only to see nothing happen.

[julenka]

Not sure this is worth building an entire custom inspector for. Asking @Troy-Ferrell for his opinion. I would vote to not make a custom inspector just t support this.

[CDiaz-MS]

The custom inspector has been removed. This is what the inspector looks like now:

I added a space between the inherited solver properties and the tap to place properties.

[julenka]

Looking better, a couple more comments.

[julenka]

Would be good to add tests to verify that StartPlacement() and StopPlacement() work when called from code. Good candidate for tests.

[CDiaz-MS]

Tests will be added in another PR, but there will be a test with code configurability in mind.

[julenka]

Looks good!

[CDiaz-MS]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).

[CDiaz-MS]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 2 pipeline(s).

[keveleigh]

Sorry I'm super late to the review party, but just a few comments.