microsoft / MixedRealityToolkit-Unity

This repository is for the legacy Mixed Reality Toolkit (MRTK) v2. For the latest version of the MRTK please visit https://github.com/MixedRealityToolkit/MixedRealityToolkit-Unity
https://aka.ms/mrtkdocs
MIT License
6.01k stars 2.12k forks source link

SpatialMappingManager: change "drawVisualMeshes" to "drawSurface" #162

Closed richiecarmichael closed 8 years ago

richiecarmichael commented 8 years ago

I think it makes more sense to have surfaceMaterial/drawSurface property pairing rather than surfaceMaterial/drawVisualMeshes.

angelaHillier commented 8 years ago

While I agree that 'drawSurface' would be a better name, if we change the name, it would be a 'breaking change' that will require anyone setting this property in code to fix their code. Devs would have to double-check that their prefab settings are still correct after updating to the latest HoloToolkit. Changing public properties has the potential of causing regressions for other developers, so we should be careful about doing so.

jwittner commented 8 years ago

Well, one could use the FormerlySerializedAsAttribute to markup the new property without breaking anything.

https://docs.unity3d.com/ScriptReference/Serialization.FormerlySerializedAsAttribute.html

jwittner commented 8 years ago

@richiecarmichael you want to make this change?

jwittner commented 8 years ago

@richiecarmichael Any chance you'll do this?

jwittner commented 8 years ago

Closing as won't fix.