VR-36 Show/Hide 2D GUIs with New Toggle Button (#415)

Author: SolarCrane

CoreScriptsRoot/CoreScripts/Topbar.lua

@@ -38,6 +38,9 @@ local DEBOUNCE_TIME = 0.25
 local defeatableTopbarSuccess, defeatableTopbarFlagValue = pcall(function() return settings():GetFFlag("EnableSetCoreTopbarEnabled") end)
 local defeatableTopbar = (defeatableTopbarSuccess and defeatableTopbarFlagValue == true)
 
+local vr3dGuisSuccess, vr3dGuisFlagValue = pcall(function() return settings():GetFFlag("RenderUserGuiIn3DSpace") end)
+local vr3dGuis = (vr3dGuisSuccess and vr3dGuisFlagValue == true)
+
 --[[ END OF FFLAG VALUES ]]
 
 
@@ -50,6 +53,7 @@ local InputService = game:GetService('UserInputService')
 local StarterGui = game:GetService('StarterGui')
 local ContextActionService = game:GetService("ContextActionService")
 local RunService = game:GetService('RunService')
+local TextService = game:GetService('TextService')
 
 --[[ END OF SERVICES ]]
 
@@ -511,7 +515,12 @@ local function Create3DMenuItem()
 
 	function menuItem:SetHoverText(text)
 		hoverTextLabel.Text = text
-		local frameWidth = hoverTextLabel.TextBounds.X + 20
+		local textSize = TextService:GetTextSize(
+			hoverTextLabel.Text,
+			24,
+			hoverTextLabel.Font,
+			Vector2.new(1000, 10000))
+		local frameWidth = textSize.x + 20
 		hoverTextFrame.Position = UDim2.new(0.5, -frameWidth / 2, 0, 55)
 		hoverTextFrame.Size = UDim2.new(0, frameWidth, 0, 60)
 	end
@@ -1253,6 +1262,70 @@ local function Create3DChatIcon(topBarInstance, panel, menubar)
 	return menuItem
 end
 
+local function Create3DUserGuiToggleIcon(topBarInstance, panel, menubar)
+	local menuItem = Create3DMenuItem()
+	menuItem:SetHoverText("2D UI")
+
+	local icon = Util.Create "ImageLabel" {
+		Parent = menuItem:GetInstance(),
+
+		Position = UDim2.new(0.5, -14, 0.5, -14),
+		Size = UDim2.new(0, 28, 0, 28),
+
+		BackgroundTransparency = 1,
+
+		Image = "rbxasset://textures/ui/VR/toggle2D.png"
+	}
+
+	local userGuiPanel = Panel3D.Get("UserGui")
+	userGuiPanel:SetType(Panel3D.Type.Fixed)
+	userGuiPanel:ResizePixels(300, 125)
+	userGuiPanel:SetVisible(false, false)
+
+	menuItem.MouseButton1Click:connect(function()
+		if InputService.VREnabled then
+			userGuiPanel:SetVisible(not userGuiPanel.isVisible, false)
+		end
+	end)
+
+	function userGuiPanel:OnVisibilityChanged(visible)
+		if visible then
+			local headLook = Panel3D.GetHeadLookXZ(true)
+			userGuiPanel.localCF = headLook * CFrame.Angles(math.rad(5), 0, 0) * CFrame.new(0, 0, 5)
+		end
+		menuItem:SetActive(visible)
+		local success, msg = pcall(function()
+			CoreGuiService:SetUserGuiRendering(true, visible and userGuiPanel:GetPart() or nil, Enum.NormalId.Front)
+		end)
+		if not success then
+			print("Topbar - userGuiPanel:OnVisibilityChanged:" , msg)
+		end
+	end
+
+	local function OnVREnabled(prop)
+		if prop == 'VREnabled' then
+			local guiPart = nil
+			if InputService.VREnabled then
+				if userGuiPanel.isVisible then
+					guiPart = userGuiPanel:GetPart()
+				end
+			else
+				userGuiPanel:SetVisible(false, false)
+			end
+			local success, msg = pcall(function()
+				CoreGuiService:SetUserGuiRendering(InputService.VREnabled, guiPart, Enum.NormalId.Front)
+			end)
+			if not success then
+				print("Topbar - OnVREnabled:" , msg)
+			end
+		end
+	end
+	InputService.Changed:connect(OnVREnabled)
+	spawn(function() OnVREnabled("VREnabled") end)
+
+	return menuItem
+end
+
 -----------
 
 --- Backpack ---
@@ -1346,6 +1419,7 @@ local nameAndHealthMenuItem = CreateUsernameHealthMenuItem()
 
 local settingsIcon3D = Create3DSettingsIcon(TopBar, Topbar3DPanel, ThreeDMenubar)
 local chatIcon3D = Create3DChatIcon(TopBar, Topbar3DPanel, ThreeDMenubar)
+local userGuiIcon3D = Create3DUserGuiToggleIcon(TopBar, Topbar3DPanel, ThreeDMenubar)
 
 local LEFT_ITEM_ORDER = {}
 local RIGHT_ITEM_ORDER = {}
@@ -1382,6 +1456,9 @@ end
 if chatIcon3D then
 	THREE_D_ITEM_ORDER[chatIcon3D] = 2
 end
+if userGuiIcon3D then
+	THREE_D_ITEM_ORDER[userGuiIcon3D] = 3
+end
 
 -------------------------
 
@@ -1476,6 +1553,39 @@ if nameAndHealthMenuItem and topbarEnabled and not isTenFootInterface then
 	AddItemInOrder(RightMenubar, nameAndHealthMenuItem, RIGHT_ITEM_ORDER)
 end
 
+if userGuiIcon3D and vr3dGuis then
+	local function FindScreenGuiChild(object)
+		for _, child in pairs(object:GetChildren()) do
+			if child:IsA('ScreenGui') then
+				return child
+			end
+		end
+	end
+
+	local function onPlayerGuiAdded(playerGui)
+		playerGui.ChildAdded:connect(function(child)
+			if FindScreenGuiChild(playerGui) then
+				AddItemInOrder(ThreeDMenubar, userGuiIcon3D, THREE_D_ITEM_ORDER)
+			end
+		end)
+		playerGui.ChildRemoved:connect(function(child)
+			if child:IsA('ScreenGui') and not FindScreenGuiChild(playerGui) then
+				ThreeDMenubar:RemoveItem(userGuiIcon3D)
+			end
+		end)
+		if FindScreenGuiChild(playerGui) then
+			AddItemInOrder(ThreeDMenubar, userGuiIcon3D, THREE_D_ITEM_ORDER)
+		end
+	end
+	Player.ChildAdded:connect(function(child)
+		if child:IsA('PlayerGui') then
+			onPlayerGuiAdded(child)
+		end
+	end)
+	if Player:FindFirstChild('PlayerGui') then
+		onPlayerGuiAdded(Player:FindFirstChild('PlayerGui'))
+	end
+end
 
 
 local function MoveHamburgerTo3D()

CoreScriptsRoot/StarterScript.lua

@@ -57,3 +57,4 @@ end
 if useVRKeyboard then
 	require(RobloxGui.Modules.VR.VirtualKeyboard)
 end
+

PlayerScripts/PlayerScriptsPlace/StarterPlayer/StarterPlayerScripts/CameraScript/ShiftLockController.rbxmx

@@ -1,7 +1,7 @@
 <roblox xmlns:xmime="http://www.w3.org/2005/05/xmlmime" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://www.roblox.com/roblox.xsd" version="4">
 	<External>null</External>
 	<External>nil</External>
-	<Item class="ModuleScript" referent="RBX7441C7686732497F97F2119BEAB662F5">
+	<Item class="ModuleScript" referent="RBX2C86BBBF120542588339BAC4360424A7">
 		<Properties>
 			<Content name="LinkedSource"><null></null></Content>
 			<string name="Name">ShiftLockController</string>
@@ -95,12 +95,12 @@ local function initialize()
 	ShiftLockIcon.Position = UDim2.new(0, 12, 0, 2)
 	ShiftLockIcon.BackgroundTransparency = 1
 	ShiftLockIcon.Image = IsShiftLocked and SHIFT_LOCK_ON or SHIFT_LOCK_OFF
-	ShiftLockIcon.Visible = IsShiftLockMode
+	ShiftLockIcon.Visible = true
 	ShiftLockIcon.Parent = frame
 
 	ShiftLockIcon.MouseButton1Click:connect(onShiftLockToggled)
 
-	ScreenGui.Parent = PlayerGui
+	ScreenGui.Parent = IsShiftLockMode and PlayerGui or nil
 end
 
 --[[ Public API ]]--
@@ -120,7 +120,7 @@ local mouseLockSwitchFunc = function(actionName, inputState, inputObject)
 end
 
 local function disableShiftLock()
-	if ShiftLockIcon then ShiftLockIcon.Visible = false end
+	if ScreenGui then ScreenGui.Parent = nil end
 	IsShiftLockMode = false
 	Mouse.Icon = ""
 	if InputCn then
@@ -144,8 +144,8 @@ end
 local function enableShiftLock()
 	IsShiftLockMode = isShiftLockMode()
 	if IsShiftLockMode then
-		if ShiftLockIcon then
-			ShiftLockIcon.Visible = true
+		if ScreenGui then
+			ScreenGui.Parent = PlayerGui
 		end
 		if IsShiftLocked then
 			Mouse.Icon = SHIFT_LOCK_CURSOR
@@ -213,4 +213,4 @@ return ShiftLockController
 ]]></ProtectedString>
 		</Properties>
 	</Item>
-</roblox>
+</roblox>