@quenty/camerastoryutils 3.2.0 → 3.3.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/camerastoryutils@3.2.0...@quenty/camerastoryutils@3.3.0) (2021-12-18)
+
+
+### Features
+
+* Better camera explainability ([4fd9016](https://github.com/Quenty/NevermoreEngine/commit/4fd9016f6914bf181e421753cbaca555394537d8))
+
+
+
+
+
 # [3.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/camerastoryutils@3.1.2...@quenty/camerastoryutils@3.2.0) (2021-11-20)
 
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014 Quenty
+Copyright (c) 2014-2021 Quenty
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/camerastoryutils",
-  "version": "3.2.0",
+  "version": "3.3.0",
   "description": "CameraStoryUtils - utility functions for 3D viewport hoarcekat stories.",
   "keywords": [
     "Roblox",
@@ -26,13 +26,13 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/insertserviceutils": "^3.2.0",
+    "@quenty/insertserviceutils": "^3.3.0",
     "@quenty/loader": "^3.1.1",
     "@quenty/math": "^2.0.0",
-    "@quenty/promise": "^3.2.0"
+    "@quenty/promise": "^3.3.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "87ab1435a59a05e7dd745db1dfcec26116d1d71d"
+  "gitHead": "6eb398e9fb81191f0815885f807ab0cb3bb9bad1"
 }

package/src/Client/CameraStoryUtils.lua

@@ -5,6 +5,7 @@
 local require = require(script.Parent.loader).load(script)
 
 local RunService = game:GetService("RunService")
+local TextService = game:GetService("TextService")
 
 local InsertServiceUtils = require("InsertServiceUtils")
 local Promise = require("Promise")
@@ -33,7 +34,7 @@ function CameraStoryUtils.setupViewportFrame(maid, target)
 	local viewportFrame = Instance.new("ViewportFrame")
 	viewportFrame.ZIndex = 0
 	viewportFrame.BorderSizePixel = 0
-	viewportFrame.BackgroundColor3 = Color3.new(0.7, 0.7, 0.7)
+	viewportFrame.BackgroundColor3 = Color3.new(0.9, 0.9, 0.85)
 	viewportFrame.Size = UDim2.new(1, 0, 1, 0)
 	maid:GiveTask(viewportFrame)
 
@@ -86,15 +87,57 @@ function CameraStoryUtils.getInterpolationFactory(maid, viewportFrame, low, high
 	assert(type(period) == "number", "Bad period")
 	assert(type(toCFrame) == "function", "Bad toCFrame")
 
-	return function(interpolate, color)
+	return function(interpolate, color, labelText, labelOffset)
 		assert(type(interpolate) == "function", "Bad interpolate")
 		assert(typeof(color) == "Color3", "Bad color")
 
+		labelOffset = labelOffset or Vector2.new(0, 0)
+
 		maid:GivePromise(CameraStoryUtils.promiseCrate(maid, viewportFrame, {
 			Color = color;
 			Transparency = 0.5
 		}))
 			:Then(function(crate)
+				local label
+				if labelText then
+					local h, s, _ = Color3.toHSV(color)
+					label = Instance.new("TextLabel")
+					label.AnchorPoint = Vector2.new(0.5, 0.5)
+					label.Text = labelText
+					label.BorderSizePixel = 0
+					label.BackgroundTransparency = 0.5
+					label.BackgroundColor3 = Color3.fromHSV(h, math.clamp(s/(s+0.1), 0, 1), 0.25)
+					label.TextColor3 = Color3.new(1, 1, 1)
+					label.Font = Enum.Font.FredokaOne
+					label.TextSize = 15
+					label.Parent = viewportFrame
+					label.Visible = false
+					maid:GiveTask(label)
+
+					local size = TextService:GetTextSize(labelText, label.TextSize, label.Font, Vector2.new(1e6, 1e6))
+						label.Size = UDim2.new(0, size.x + 20, 0, 20)
+
+					local uiCorner = Instance.new("UICorner")
+					uiCorner.CornerRadius = UDim.new(0.5, 0)
+					uiCorner.Parent = label
+					maid:GiveTask(label)
+				end
+
+				-- avoid floating point numbers from :SetPrimaryPartCFrame
+				local primaryPart, primaryCFrame
+				local relCFrame = {}
+				for _, part in pairs(crate:GetDescendants()) do
+					if part:IsA("BasePart") then
+						if primaryPart then
+							relCFrame[part] = primaryCFrame:toObjectSpace(part.CFrame)
+						else
+							primaryPart = part
+							primaryCFrame = part.CFrame
+							relCFrame[part] = CFrame.new()
+						end
+					end
+				end
+
 				maid:GiveTask(RunService.RenderStepped:Connect(function()
 					local t = (os.clock()/period % 2/period)*period
 					if t >= 1 then
@@ -105,7 +148,23 @@ function CameraStoryUtils.getInterpolationFactory(maid, viewportFrame, low, high
 					t = math.clamp(t, low, high)
 
 					local cframe = toCFrame(interpolate(t))
-					crate:SetPrimaryPartCFrame(cframe)
+
+					if label then
+						local camera = viewportFrame.CurrentCamera
+						local pos = camera:WorldToViewportPoint(cframe.p)
+						local viewportSize = viewportFrame.AbsoluteSize
+						local aspectRatio = viewportSize.x/viewportSize.y
+						if pos.z > 0 then
+							label.Position = UDim2.new((pos.x - 0.5)/aspectRatio + 0.5, labelOffset.x, pos.y, 0 + labelOffset.y)
+							label.Visible = true
+						else
+							label.Visible = false
+						end
+					end
+
+					for part, rel in pairs(relCFrame) do
+						part.CFrame = cframe:toWorldSpace(rel)
+					end
 				end))
 			end)
 	end