Initial support for World Locking Tools in Unreal

Author: fieldsJacksonG

Images/QRCode_01.png

@@ -1,14 +1,44 @@
-# Project
+# What is World Locking Tools
+World Locking Tools for provides a stable and reliable world-locked coordinate system, binding the virtual/holographic world to the physical world.
 
-> This repo has been populated by an initial template to help get you started. Please
-> make sure to update the content to build a great experience for community-building.
+World Locking Tools locks the entire holograph space of your application to the physical world. A hologram put in position relative to physical world features will stay fixed relative to those features, and remain fixed relative to other holograms.
 
-As the maintainer of this project, please make a few updates:
+World Locking Tools also includes Space Pins, which reposition the scene to match real-world features like QRCodes.
+
+
+# Using the Plugin
+Add the plugin to your project from either GitHub or the Marketplace and enable it in the Plugins window.  Call the "StartWorldLockingTools" function to start using world locking tools with the given parameters.
+
+This plugin was written for HoloLens, and is meant to be used with the [Microsoft OpenXR](https://github.com/microsoft/Microsoft-OpenXR-Unreal) plugin.  The underlying FrozenWorld binaries that world locking tools depends on are available for Android and iOS, and this plugin uses ARBlueprintLibrary when using core AR features like ARPins, so this can be modified to build for ARKit and ARCore as well.
+
+
+## From GitHub source
+Copy the WLT_Project/Plugins/WorldLockingTools directory into your game's Plugins directory.  Reopen your project and enable the World Locking Tools plugin in your Plugins window.
+
+
+## World Locking Tools Pawn
+World Locking Tools works by repositioning the users' head to match a pose the underlying frozen world system is generating from nearby anchors that have been created while walking around.  To do this, the camera on the pawn must have a parent and grandparent component that are children of the DefaultSceneRoot.  The sample's WLTPawn is setup this way, and one is also included in the plugin under Source/WorldLockingTools/Public/WorldLockingToolsPawn.h.
+
+
+## Space Pins
+Space Pins have a virtual position in your scene and need to be given a physical position in your world to reposition the scene to match the real-world.  This is accomplished by calling SetSpongyPose on a SpacePin with a transform in the device's tracking space.  When multiple space pins are locked in a scene, the relative real-world offsets between them should closely match how they are setup in the virtual scene to minimize drift as you walk from one space pin to another.
+
+
+## Try the example project
+The sample project has two levels which demonstrate starting world locking tools, and using space pins with either hand manipulation in one level or QRCodes in the other level.  Both levels have an 8 meter long hologram with a space pin on either side.  Build, deploy, and run the sample on a HoloLens and take note of the direction the hologram is facing.  Close the application, rotate your body to face a different direction, then relaunch the application.
+
+Without using world locking tools, the scene will face the new direction you are facing.  With world locking tools, the scene will be oriented based on the first saved launch.
+
+Test the space pins by grabbing the cube on one end of the 8 meter hologram.  It will turn pink when it can be interacted with.  Face the direction of the white arrow off of this cube and move your hand around while gripped to move the space pin around.  The entire scene will move around as the space pin moves.  Walk to the other space pin, face the same direction as its white arrow, grip and move this space pin around too.  Once both space pins have been positioned, walk between the two and observe that the scene will shift into place to match the space pin's locked real-world position as you get closer to it.
+
+The second scene does the same thing, but positions the space pins based on the QRCodes in the Images directory.
+
+
+# See Also
+[World Locking Tools](https://learn.microsoft.com/en-us/mixed-reality/world-locking-tools/)
+
+[Space Pins](https://learn.microsoft.com/en-us/mixed-reality/world-locking-tools/documentation/concepts/advanced/spacepins)
 
-- Improving this README.MD file to provide a great experience
-- Updating SUPPORT.MD with content about this project's support experience
-- Understanding the security reporting process in SECURITY.MD
-- Remove this section from the README
 
 ## Contributing
 
@@ -24,6 +54,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct](https://ope
 For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
 contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
 
+
 ## Trademarks
 
 This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft 

Images/QRCode_02.png

@@ -1,13 +1,3 @@
-# TODO: The maintainer of this repo has not yet edited this file
-
-**REPO OWNER**: Do you want Customer Service & Support (CSS) support for this product/project?
-
-- **No CSS support:** Fill out this template with information about how to file issues and get help.
-- **Yes CSS support:** Fill out an intake form at [aka.ms/onboardsupport](https://aka.ms/onboardsupport). CSS will work with/help you to determine next steps.
-- **Not sure?** Fill out an intake as though the answer were "Yes". CSS will help you decide.
-
-*Then remove this first heading from this SUPPORT.MD file before publishing your repo.*
-
 # Support
 
 ## How to file issues and get help  
@@ -16,9 +6,7 @@ This project uses GitHub Issues to track bugs and feature requests. Please searc
 issues before filing new issues to avoid duplicates.  For new issues, file your bug or 
 feature request as a new Issue.
 
-For help and questions about using this project, please **REPO MAINTAINER: INSERT INSTRUCTIONS HERE 
-FOR HOW TO ENGAGE REPO OWNERS OR COMMUNITY FOR HELP. COULD BE A STACK OVERFLOW TAG OR OTHER
-CHANNEL. WHERE WILL YOU HELP PEOPLE?**.
+For help and questions about using this project, please [file an issue](https://github.com/microsoft/WorldLockingTools-Unreal/issues).
 
 ## Microsoft Support Policy  
 

README.md

@@ -0,0 +1,180 @@
+
+
+[Audio]
+UseAudioMixer=True
+
+[/Script/Engine.RendererSettings]
+r.Mobile.DisableVertexFog=False
+r.Shadow.CSM.MaxMobileCascades=2
+r.Mobile.AntiAliasing=1
+r.Mobile.FloatPrecisionMode=0
+r.Mobile.AllowDitheredLODTransition=False
+r.Mobile.VirtualTextures=False
+r.Mobile.ReflectionCaptureCompression=False
+r.DiscardUnusedQuality=False
+r.Shaders.CompressionFormat=2
+r.AllowOcclusionQueries=False
+r.MinScreenRadiusForLights=0.030000
+r.MinScreenRadiusForDepthPrepass=0.030000
+r.MinScreenRadiusForCSMDepth=0.010000
+r.PrecomputedVisibilityWarning=False
+r.TextureStreaming=True
+Compat.UseDXT5NormalMaps=False
+r.VirtualTextures=False
+r.VT.EnableAutoImport=True
+r.VirtualTexturedLightmaps=False
+r.VT.AnisotropicFiltering=False
+r.VT.TileSize=128
+r.VT.TileBorderSize=4
+r.vt.FeedbackFactor=16
+WorkingColorSpaceChoice=sRGB
+RedChromaticityCoordinate=(X=0.640000,Y=0.330000)
+GreenChromaticityCoordinate=(X=0.300000,Y=0.600000)
+BlueChromaticityCoordinate=(X=0.150000,Y=0.060000)
+WhiteChromaticityCoordinate=(X=0.312700,Y=0.329000)
+r.ClearCoatNormal=False
+r.DynamicGlobalIlluminationMethod=1
+r.ReflectionMethod=1
+r.ReflectionCaptureResolution=128
+r.ReflectionEnvironmentLightmapMixBasedOnRoughness=True
+r.Lumen.HardwareRayTracing=False
+r.Lumen.HardwareRayTracing.LightingMode=0
+r.Lumen.TraceMeshSDFs=1
+r.Shadow.Virtual.Enable=1
+r.RayTracing=False
+r.RayTracing.Shadows=False
+r.RayTracing.Skylight=False
+r.RayTracing.UseTextureLod=False
+r.PathTracing=True
+r.GenerateMeshDistanceFields=True
+r.DistanceFields.DefaultVoxelDensity=0.200000
+r.AllowStaticLighting=True
+r.NormalMapsForStaticLighting=False
+r.ForwardShading=False
+r.VertexFoggingForOpaque=True
+r.SeparateTranslucency=False
+r.TranslucentSortPolicy=0
+TranslucentSortAxis=(X=0.000000,Y=-1.000000,Z=0.000000)
+vr.VRS.HMDFixedFoveationLevel=0
+vr.VRS.HMDFixedFoveationDynamic=False
+r.CustomDepth=1
+r.CustomDepthTemporalAAJitter=True
+r.PostProcessing.PropagateAlpha=0
+r.DefaultFeature.Bloom=False
+r.DefaultFeature.AmbientOcclusion=False
+r.DefaultFeature.AmbientOcclusionStaticFraction=True
+r.DefaultFeature.AutoExposure=False
+r.DefaultFeature.AutoExposure.Method=0
+r.DefaultFeature.AutoExposure.Bias=1.000000
+r.DefaultFeature.AutoExposure.ExtendDefaultLuminanceRange=True
+r.DefaultFeature.MotionBlur=False
+r.DefaultFeature.LensFlare=False
+r.TemporalAA.Upsampling=True
+r.AntiAliasingMethod=0
+r.MSAACount=4
+r.DefaultFeature.LightUnits=1
+r.DefaultBackBufferPixelFormat=4
+r.Shadow.UnbuiltPreviewInGame=True
+r.StencilForLODDither=False
+r.EarlyZPass=3
+r.EarlyZPassOnlyMaterialMasking=False
+r.Shadow.CSMCaching=False
+r.DBuffer=True
+r.ClearSceneMethod=1
+r.VelocityOutputPass=0
+r.Velocity.EnableVertexDeformation=2
+r.SelectiveBasePassOutputs=False
+bDefaultParticleCutouts=False
+fx.GPUSimulationTextureSizeX=1024
+fx.GPUSimulationTextureSizeY=1024
+r.AllowGlobalClipPlane=False
+r.GBufferFormat=1
+r.MorphTarget.Mode=True
+r.GPUCrashDebugging=False
+vr.InstancedStereo=True
+r.MobileHDR=False
+vr.MobileMultiView=True
+r.Mobile.UseHWsRGBEncoding=False
+vr.RoundRobinOcclusion=False
+vr.ODSCapture=False
+r.MeshStreaming=False
+r.WireframeCullThreshold=5.000000
+r.SupportStationarySkylight=True
+r.SupportLowQualityLightmaps=True
+r.SupportPointLightWholeSceneShadows=True
+r.SupportSkyAtmosphere=True
+r.SupportSkyAtmosphereAffectsHeightFog=True
+r.SupportCloudShadowOnForwardLitTranslucent=False
+r.Material.RoughDiffuse=False
+r.Material.EnergyConservation=False
+r.SkinCache.CompileShaders=False
+r.SkinCache.DefaultBehavior=1
+r.SkinCache.SceneMemoryLimitInMB=128.000000
+r.Mobile.EnableStaticAndCSMShadowReceivers=True
+r.Mobile.EnableMovableLightCSMShaderCulling=True
+r.Mobile.EnableNoPrecomputedLightingCSMShader=False
+r.Mobile.AllowDistanceFieldShadows=True
+r.Mobile.AllowMovableDirectionalLights=True
+r.MobileNumDynamicPointLights=4
+r.Mobile.EnableMovableSpotlights=False
+r.Mobile.EnableMovableSpotlightsShadow=False
+r.GPUSkin.Support16BitBoneIndex=False
+r.GPUSkin.Limit2BoneInfluences=False
+r.SupportDepthOnlyIndexBuffers=True
+r.SupportReversedIndexBuffers=True
+r.Mobile.AmbientOcclusion=False
+r.GPUSkin.UnlimitedBoneInfluences=False
+r.GPUSkin.UnlimitedBoneInfluencesThreshold=8
+MaxSkinBones=(Default=65536,PerPlatform=(("Mobile", 256)))
+r.Mobile.PlanarReflectionMode=0
+r.Mobile.SupportsGen4TAA=True
+bStreamSkeletalMeshLODs=(Default=False,PerPlatform=())
+bDiscardSkeletalMeshOptionalLODs=(Default=False,PerPlatform=())
+VisualizeCalibrationColorMaterialPath=/Engine/EngineMaterials/PPM_DefaultCalibrationColor.PPM_DefaultCalibrationColor
+VisualizeCalibrationCustomMaterialPath=None
+VisualizeCalibrationGrayscaleMaterialPath=/Engine/EngineMaterials/PPM_DefaultCalibrationGrayscale.PPM_DefaultCalibrationGrayscale
+
+[/Script/HardwareTargeting.HardwareTargetingSettings]
+TargetedHardwareClass=Mobile
+AppliedTargetedHardwareClass=Mobile
+DefaultGraphicsPerformance=Scalable
+AppliedDefaultGraphicsPerformance=Scalable
+
+[/Script/WindowsTargetPlatform.WindowsTargetSettings]
+DefaultGraphicsRHI=DefaultGraphicsRHI_DX12
+
+[/Script/WorldPartitionEditor.WorldPartitionEditorSettings]
+CommandletClass=Class'/Script/UnrealEd.WorldPartitionConvertCommandlet'
+
+[/Script/EngineSettings.GameMapsSettings]
+EditorStartupMap=/Game/WLT.WLT
+LocalMapOptions=
+TransitionMap=None
+bUseSplitscreen=False
+TwoPlayerSplitscreenLayout=Horizontal
+ThreePlayerSplitscreenLayout=FavorTop
+FourPlayerSplitscreenLayout=Grid
+bOffsetPlayerGamepadIds=False
+GameInstanceClass=/Script/Engine.GameInstance
+GameDefaultMap=/Game/WLT.WLT
+ServerDefaultMap=/Engine/Maps/Entry.Entry
+GlobalDefaultGameMode=/Game/WLTGameMode.WLTGameMode_C
+GlobalDefaultServerGameMode=None
+
+[/Script/Slate.SlateSettings]
+bExplicitCanvasChildZOrder=True
+
+[/Script/AndroidFileServerEditor.AndroidFileServerRuntimeSettings]
+bEnablePlugin=True
+bAllowNetworkConnection=True
+SecurityToken=7868A8A34018B7FE67DEF5BF5BCB1635
+bIncludeInShipping=False
+bAllowExternalStartInShipping=False
+bCompileAFSProject=False
+bUseCompression=False
+bLogFiles=False
+bReportStats=False
+ConnectionType=USBOnly
+bUseManualIPAddress=False
+ManualIPAddress=
+

SUPPORT.md

@@ -0,0 +1,9 @@
+[/Script/EngineSettings.GeneralProjectSettings]
+ProjectID=C57AEC0549C91B6BAF1428899BD5E345
+ProjectName=WLT
+CompanyDistinguishedName=CN=NoPublisher
+bStartInVR=True
+
+[/Script/UnrealEd.ProjectPackagingSettings]
+FullRebuild=False
+