vNEXT - UX Lines feature port #2513

StephenHodgson · 2018-07-29T03:47:30Z

Overview

UX Lines feature port (required for pointer ray visualization)

The Mixed Reality Toolkit's built in lines are split into two components: Data and Renderers.

Line Data Providers

Line components that define all the characteristics of that line and all the data associated with it. This does not handle any aspect of rendering a line in the scene, and can be used for paths, interpolation, and more.

Simple Line – a line with two points
Parabola – parabolic arc between two points
Rectangle – a line that loops back on itself with 4 corners
Ellipse – a line that loops back on itself with no corners
Spline – a multi-point line with Bezier interpolation

Line Renderers

The components take the line data and render it in the scene.

MixedRealityLineRenderer – implements Unity's built in line renderer component, and applies the line data to it
ParticleSystemLineRenderer – attaches a set of particles to the line
MeshLineRenderer – creates insances of a mesh along the line
StripMeshLineRenderer – draws a strip of polygons along the line

Other changes outside of line additions

updated BodyLock.cs with Orbital changes from created an orbital solver as an improved replacement to body lock solver #2480

Some things to discuss

I'm using Text Mesh Pro assets in the example scene, and think they look better way better. I'd like to see us use the SDF text for all the example scenes.
Do we want to have the lines in the core?
- I initially put them there, so when people get the core, they don't have to get the SDK if they want teleportation and pointer lines out of the box.
Is there anything else that we want to add to the demo scene?

Known Issues

There's a known issue for the Lines that they don't listen to color/width offsets (Unity line does not respect color and width offsets. #2498)
- Should we just remove this feature for the Unity Line Renderer components?
Strip Mesh, Instanced Mesh, and Particle System Line Renderers do not properly apply colors (Strip Mesh, Instanced Mesh, and Particle System Line Renderers do not properly apply colors #2528)
- Should we just remove these renderer components?

Updated and cleaned up a a few more classe

…ine data providers

StephenHodgson · 2018-07-29T19:37:49Z

If you guys have any other summary or documentation changes, I'm happy to accept PRs

SimonDarksideJ · 2018-07-29T20:40:56Z

Document ALL the things :P

keveleigh · 2018-07-30T19:21:43Z

Assets/TextMesh Pro.meta

@@ -0,0 +1,8 @@
+fileFormatVersion: 2


Is Text Mesh Pro being checked in as an option (and all our components will also work with Unity text) or as the way the Toolkit does text? Seems like something not everybody needs, and would add dependencies to anybody who wants to use our UI/UX text components when Unity text would suffice. Not a huge fan of that being added.

I very much disagree. The quality different in TMP vs default unity text in VR/AR is quite astonishing. Using SDF should be the industry standard.

Seeing as TMP is supposed to replace the old text renderers, (It's been depreciated) and TMP is a default asset with Unity now, and its ease to put into projects via the package manager makes it ideal.

I'm not suggesting we put it in the SDK or Core components, but we should def be using it for our demo, tutorial, and example scenes.

We should definitely not be including it in the SDK / Core (we want those as light as possible).

I can see the value of using it in the examples.

@StephenHodgson, how is it being included? Are we checking it into the examples tree? If so, does their license allow that?

It's owned by Unity. Not sure if a license is required if you're using the editor to begin with.

Are we checking it into the examples tree?

As stated in #2513 (comment), I put them in the default download location that the package manager prompts you to place them.

I put them in the default download location that the package manager prompts you to place them.

Sorry, not sure if I am reading this right... does this mean the files are checked in? Or do they get automatically added somehow.

It's owned by Unity. Not sure if a license is required if you're using the editor to begin with.

I am concerned with the license to redist the package.

A relevant forum thread.

At some point the old Text component and Text Mesh will be deprecated but that will come after the new text system / components are available.

Here's another.

As per the title and assuming all goes well, a new version of TextMesh Pro will be included by default in Unity 2018.1.

Later on in the thread it's confirmed that 2018.2 has the TMP assets by default.

With Unity 2018.2, the TextMesh Pro UPM package is included by default. However, the TMP Essential Resources are not imported / added to a user project until first use and consent of the user. Alternatively, a user can manually import the TMP Essential Resources via the "Window - TextMeshPro - Import TMP Essential Resources" menu.

I am concerned with the license to redist the package.

This is a good point. I suppose it doesn't hurt to remove the TMP assets from the project itself and let users download on their own when prompted. Instead I'll just make the folder ignored in git. Sound good?

Agreed. Reference and even prompt people to download it, but don't actually include it.
In 2018.2, we can solve this better by adding it as a dependant package

In 2018.2, we can solve this better by adding it as a dependent package

It's already in the editor in 2018.2, and installed. So no worries there.

SimonDarksideJ · 2018-07-30T22:35:53Z

Can you update the description to list any remaining features @StephenHodgson

SimonDarksideJ

Almost there, just some more docs and some math functions required

SimonDarksideJ · 2018-07-30T22:37:21Z

Assets/MixedRealityToolkit-SDK/Features/UX/Materials/UIDarkGray.mat

@@ -0,0 +1,173 @@
+%YAML 1.1


Agreed, materials / textures for the SDK should be in the standard assets folder

SimonDarksideJ · 2018-07-30T22:39:07Z

...tyToolkit/_Core/Inspectors/Utilities/Lines/DataProviders/EllipseLineDataProviderInspector.cs

+namespace Microsoft.MixedReality.Toolkit.Inspectors.Utilities.Lines.DataProviders
+{
+    [CustomEditor(typeof(EllipseLineDataProvider))]
+    public class EllipseLineDataProviderInspector : BaseMixedRealityLineDataProviderInspector


SimonDarksideJ · 2018-07-30T22:39:41Z

.../_Core/Inspectors/Utilities/Lines/DataProviders/ParabolaPhysicalLineDataProviderInspector.cs

+namespace Microsoft.MixedReality.Toolkit.Inspectors.Utilities.Lines.DataProviders
+{
+    [CustomEditor(typeof(ParabolaPhysicalLineDataProvider))]
+    public class ParabolaPhysicalLineDataProviderInspector : BaseMixedRealityLineDataProviderInspector


Except for vNext, they should.

SimonDarksideJ · 2018-07-30T22:42:50Z

Assets/MixedRealityToolkit/_Core/Utilities/Lines/DataProviders/EllipseLineDataProvider.cs

+            get { return radius; }
+            set
+            {
+                if (value.x < 0)


Agreed, should use standard math functions for min and max values

SimonDarksideJ · 2018-07-30T22:45:04Z

Assets/MixedRealityToolkit/_Core/Utilities/Lines/Renderers/MeshLineRenderer.cs

+
+        protected void OnEnable()
+        {
+            if (lineMaterial == null)


It's just that we have "if null / Debug" repeated everywhere.

SimonDarksideJ · 2018-07-30T22:45:44Z

Assets/MixedRealityToolkit/_Core/Utilities/Physics/Distorters/Distorter.cs

+
+namespace Microsoft.MixedReality.Toolkit.Internal.Utilities.Physics.Distorters
+{
+    public abstract class Distorter : MonoBehaviour, IComparable<Distorter>


SimonDarksideJ · 2018-07-30T22:45:55Z

Assets/MixedRealityToolkit/_Core/Utilities/Physics/Distorters/DistorterBulge.cs

+
+namespace Microsoft.MixedReality.Toolkit.Internal.Utilities.Physics.Distorters
+{
+    public class DistorterBulge : Distorter


addressed CRs

keveleigh · 2018-07-31T18:34:54Z

ProjectSettings/QualitySettings.asset

@@ -4,7 +4,7 @@
 QualitySettings:
  m_ObjectHideFlags: 0
  serializedVersion: 5
-  m_CurrentQuality: 5
+  m_CurrentQuality: 0


What's this change?

Cause I was testing on HoloLens it might have changed the quality to the lowest.

StephenHodgson added 19 commits June 15, 2018 09:11

first pass at pointer viz

d20bdb8

Merge branch 'mrtk_development' into MRTK-vNEXT-PointerViz

fb68cf5

Added distorters to Utitlities.Physics

ec41057

updated icons and a bit of documentation

e253e83

Lines and a bit of cleanup... probably more to do...

a9c8822

moved enum types to definitions.

0263e61

Updated and cleaned up a a few more classe

A bit more reorg and final property passes

71aa4d8

Merge branch 'mrtk_development' into vNEXT-PointerRayVisualization

c5dea6c

cleaned up line follower a bit more and added icons

64513ae

More cleaning up and a bit of a start on the editor scripts for the l…

1e86856

…ine data providers

Merge branch 'mrtk_development' into vNEXT-PointerRayVisualization

8c3462a

reverted component extension changes

1528051

Merge branch 'MRTK-vNEXT-PointerViz' into vNEXT-PointerRayVisualization

db4bb92

required line data provider

bf8e7c3

Merge branch 'mrtk_development' into vNEXT-PointerRayVisualization

657124f

More work on line stuff.

94d20d9

added session state to line inspectors

8112d70

Merge branch 'mrtk_development' into vNEXT-PointerRayVisualization

ba440c4

Example scene and a bunch more work on feature pairity

dee199b

StephenHodgson added MRTK vNEXT labels Jul 29, 2018

StephenHodgson added this to the MRTK vNEXT milestone Jul 29, 2018

StephenHodgson requested review from SimonDarksideJ, keveleigh, Railboy and david-c-kline July 29, 2018 03:47

StephenHodgson added the UX Controls - General label Jul 29, 2018

updated example scene

afe8a64

StephenHodgson added 2 commits July 29, 2018 12:51

missing inherit doc tags

9b48520

Merge branch 'mrtk_development' into vNEXT-PointerRayVisualization

6302a28

StephenHodgson added 4 commits July 29, 2018 15:45

updated scene name

a9a0176

made vector3 range attribute class sealed.

da78a2a

updated serialization of base line data provider inspector

be5e04a

made sure the loop is overridden for ellipse

1609c75

StephenHodgson added the Ready for Review label Jul 30, 2018

keveleigh reviewed Jul 30, 2018

View reviewed changes

keveleigh mentioned this pull request Jul 30, 2018

vNext Asset Clean-up #2521

Merged

StephenHodgson added 3 commits July 30, 2018 13:06

Removed TMP assets

b415e86

ignored TMP default asset path.

39d655e

sorted config profiles in context menu

1f9f127

SimonDarksideJ previously requested changes Jul 30, 2018

View reviewed changes

StephenHodgson added 3 commits July 30, 2018 16:30

added range to ellipse resolution

c26aa47

CRs

9849f30

moved materials to standard assets folder

845dc82

a bit more cleanup

3619f4a

SimonDarksideJ previously approved these changes Jul 31, 2018

View reviewed changes

Scene updates. Added default cursor, and updated serialization

d267ef2

StephenHodgson dismissed SimonDarksideJ’s stale review via d267ef2 July 31, 2018 15:38

SimonDarksideJ approved these changes Jul 31, 2018

View reviewed changes

david-c-kline approved these changes Jul 31, 2018

View reviewed changes

david-c-kline merged commit c05ad6f into microsoft:mrtk_development Jul 31, 2018

keveleigh reviewed Jul 31, 2018

View reviewed changes

StephenHodgson deleted the vNEXT-PointerRayVisualization branch July 31, 2018 18:39

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

vNEXT - UX Lines feature port #2513

vNEXT - UX Lines feature port #2513

StephenHodgson commented Jul 29, 2018 •

edited

Loading

StephenHodgson commented Jul 29, 2018

SimonDarksideJ commented Jul 29, 2018

keveleigh Jul 30, 2018

StephenHodgson Jul 30, 2018 •

edited

Loading

david-c-kline Jul 30, 2018

StephenHodgson Jul 30, 2018

StephenHodgson Jul 30, 2018 •

edited

Loading

david-c-kline Jul 30, 2018

StephenHodgson Jul 30, 2018 •

edited

Loading

StephenHodgson Jul 30, 2018

SimonDarksideJ Jul 30, 2018

StephenHodgson Jul 30, 2018

SimonDarksideJ commented Jul 30, 2018 •

edited

Loading

SimonDarksideJ left a comment

SimonDarksideJ Jul 30, 2018

SimonDarksideJ Jul 30, 2018

SimonDarksideJ Jul 30, 2018

SimonDarksideJ Jul 30, 2018

SimonDarksideJ Jul 30, 2018

SimonDarksideJ Jul 30, 2018

SimonDarksideJ Jul 30, 2018

keveleigh Jul 31, 2018

StephenHodgson Jul 31, 2018

vNEXT - UX Lines feature port #2513

vNEXT - UX Lines feature port #2513

Conversation

StephenHodgson commented Jul 29, 2018 • edited Loading

Overview

Line Data Providers

Line Renderers

Other changes outside of line additions

Some things to discuss

Known Issues

StephenHodgson commented Jul 29, 2018

SimonDarksideJ commented Jul 29, 2018

Choose a reason for hiding this comment

StephenHodgson Jul 30, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephenHodgson Jul 30, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephenHodgson Jul 30, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SimonDarksideJ commented Jul 30, 2018 • edited Loading

SimonDarksideJ left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

StephenHodgson commented Jul 29, 2018 •

edited

Loading

StephenHodgson Jul 30, 2018 •

edited

Loading

StephenHodgson Jul 30, 2018 •

edited

Loading

StephenHodgson Jul 30, 2018 •

edited

Loading

SimonDarksideJ commented Jul 30, 2018 •

edited

Loading