@quenty/camera 9.15.0 → 9.16.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.
 
+# [9.16.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/camera@9.15.0...@quenty/camera@9.16.0) (2023-06-18)
+
+
+### Features
+
+* Better interopability between Roblox and camera stack system ([1916352](https://github.com/Quenty/NevermoreEngine/commit/1916352394a777ec6ab01e869cc7d0cfe92bae76))
+
+
+
+
+
 # [9.15.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/camera@9.14.0...@quenty/camera@9.15.0) (2023-06-17)
 
 **Note:** Version bump only for package @quenty/camera

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/camera",
-  "version": "9.15.0",
+  "version": "9.16.0",
   "description": "Quenty's camera system for Roblox",
   "keywords": [
     "Roblox",
@@ -43,5 +43,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "dc77d6de09e9eb9d3fd6dafd790c052d8393d38f"
+  "gitHead": "2e4b57d56175186261d4f80a334816e03d63f80e"
 }

package/src/Client/CameraStackService.lua

@@ -48,10 +48,14 @@ function CameraStackService:Init(serviceBag)
 		debug.profilebegin("camerastackservice")
 
 		local state = self:GetTopState()
+
+		self._rawDefaultCamera:SetLastSetCameraFrame(state.CameraFrame)
+
 		if state then
 			state:Set(Workspace.CurrentCamera)
 		end
 
+
 		debug.profileend()
 	end)
 
@@ -72,7 +76,7 @@ function CameraStackService:Start()
 			Workspace.CurrentCamera.CameraType = Enum.CameraType.Scriptable
 		end)
 	else
-		self._rawDefaultCamera:BindToRenderStep()
+		self._maid:GiveTask(self._rawDefaultCamera:BindToRenderStep())
 	end
 end
 

package/src/Client/CameraState.lua

@@ -54,6 +54,10 @@ function CameraState:__index(index)
 		return self.CameraFrame.CFrame
 	elseif index == "Position" then
 		return self.CameraFrame.Position
+	elseif index == "CameraFrame" then
+		return rawget(self, "CameraFrame")
+	elseif index == "CameraFrameDerivative" then
+		return rawget(self, "CameraFrameDerivative")
 	elseif index == "Velocity" then
 		return self.CameraFrameDerivative.Position
 	elseif index == "FieldOfView" then

package/src/Client/Effects/DefaultCamera.lua

@@ -14,6 +14,11 @@ local HttpService = game:GetService("HttpService")
 
 local CameraState = require("CameraState")
 local SummedCamera = require("SummedCamera")
+local Maid = require("Maid")
+local CFrameUtils = require("CFrameUtils")
+local CameraFrame = require("CameraFrame")
+
+local EPSILON = 0.001
 
 local DefaultCamera = {}
 DefaultCamera.ClassName = "DefaultCamera"
@@ -27,6 +32,7 @@ function DefaultCamera.new()
 	local self = setmetatable({}, DefaultCamera)
 
 	self._key = HttpService:GenerateGUID(false)
+	self._maid = Maid.new()
 	self._cameraState = CameraState.new(Workspace.CurrentCamera)
 
 	return self
@@ -40,14 +46,52 @@ end
 	Overrides the global field of view in the cached camera state
 	@param fieldOfView number
 ]=]
-function DefaultCamera:OverrideGlobalFieldOfView(fieldOfView)
+function DefaultCamera:SetRobloxFieldOfView(fieldOfView)
 	self._cameraState.FieldOfView = fieldOfView
 end
 
-function DefaultCamera:OverrideCameraState(cameraState)
+-- Back compat
+DefaultCamera.OverrideGlobalFieldOfView = DefaultCamera.SetRobloxFieldOfView
+
+--[=[
+	Sets the Roblox camera state to look at things
+
+	@param cameraState CameraState
+]=]
+function DefaultCamera:SetRobloxCameraState(cameraState)
 	self._cameraState = cameraState or error("No CameraState")
 end
 
+-- Back compat
+DefaultCamera.OverrideCameraState = DefaultCamera.SetRobloxCameraState
+
+--[=[
+	Sets the CFrame of the Roblox Camera
+
+	@param cframe CFrame
+]=]
+function DefaultCamera:SetRobloxCFrame(cframe)
+	self._cameraState.CFrame = cframe
+end
+
+--[=[
+	Gets the current Roblox camera state, free of any influence
+
+	@return CameraState
+]=]
+function DefaultCamera:GetRobloxCameraState()
+	return self._cameraState
+end
+
+--[=[
+	Sets the camera state different
+
+	@param cameraFrame CameraState | nil
+]=]
+function DefaultCamera:SetLastSetCameraFrame(cameraFrame)
+	self._lastCameraFrame = CameraFrame.new(cameraFrame.QFrame, cameraFrame.FieldOfView)
+end
+
 --[=[
 	Binds the camera to RunService RenderStepped event.
 
@@ -56,30 +100,59 @@ end
 	:::
 ]=]
 function DefaultCamera:BindToRenderStep()
+	local maid = Maid.new()
+
 	RunService:BindToRenderStep("DefaultCamera_Preupdate" .. self._key, Enum.RenderPriority.Camera.Value-2, function()
-		self._cameraState:Set(Workspace.CurrentCamera)
+		local camera = Workspace.CurrentCamera
+
+		if self._lastCameraFrame then
+			-- Assume something wrote these values and so we should
+			-- pass these through to Roblox's camera
+
+			if not CFrameUtils.areClose(self._lastCameraFrame.CFrame, camera.CFrame, EPSILON) then
+				self._cameraState.CFrame = camera.CFrame
+			end
+
+			if math.abs(self._lastCameraFrame.FieldOfView - camera.FieldOfView) > EPSILON then
+				self._cameraState.FieldOfView = camera.FieldOfView
+			end
+
+			self._lastCameraFrame = nil
+		end
+
+		-- Restore our state
+		self._cameraState:Set(camera)
 	end)
 
 	RunService:BindToRenderStep("DefaultCamera_PostUpdate" .. self._key, Enum.RenderPriority.Camera.Value+2, function()
+		-- Capture
 		self._cameraState = CameraState.new(Workspace.CurrentCamera)
 	end)
 
+	maid:GiveTask(function()
+		RunService:UnbindFromRenderStep("DefaultCamera_Preupdate" .. self._key)
+		RunService:UnbindFromRenderStep("DefaultCamera_PostUpdate" .. self._key)
+	end)
+
 	self._cameraState = CameraState.new(Workspace.CurrentCamera)
+
+	self._maid._binding = maid
+
+	return maid
 end
 
 --[=[
 	Unbinds the camera from the RunService
 ]=]
 function DefaultCamera:UnbindFromRenderStep()
-	RunService:UnbindFromRenderStep("DefaultCamera_Preupdate" .. self._key)
-	RunService:UnbindFromRenderStep("DefaultCamera_PostUpdate" .. self._key)
+	self._maid._binding = nil
 end
 
 --[=[
 	Cleans up the binding
 ]=]
 function DefaultCamera:Destroy()
-	self:UnbindFromRenderStep()
+	self._maid:DoCleaning()
 end
 
 --[=[
@@ -91,6 +164,8 @@ end
 function DefaultCamera:__index(index)
 	if index == "CameraState" then
 		return rawget(self, "_cameraState")
+	elseif index == "_maid" or index == "_lastCameraFrame" or index == "_key" then
+		return rawget(self, index)
 	else
 		return DefaultCamera[index]
 	end

package/src/Client/Effects/HeartbeatCamera.lua

@@ -45,7 +45,7 @@ end
 	The current state.
 	@readonly
 	@prop CameraState CameraState
-	@within DefaultCamera
+	@within HeartbeatCamera
 ]=]
 function HeartbeatCamera:__index(index)
 	if index == "CameraState" then

package/src/Client/Effects/ImpulseCamera.lua

@@ -55,7 +55,7 @@ end
 	The current state.
 	@readonly
 	@prop CameraState CameraState
-	@within DefaultCamera
+	@within ImpulseCamera
 ]=]
 function ImpulseCamera:__index(index)
 	if index == "CameraState" then

package/src/Client/Effects/OverrideDefaultCameraToo.lua

@@ -0,0 +1,69 @@
+--[=[
+	Allows you to override the default camera with this cameras
+	information. Useful for custom camera controls that the user
+	controls.
+
+	```lua
+	local combiner = OverrideDefaultCameraToo.new(effect, self._cameraStackService:GetRawDefaultCamera())
+	combiner.Predicate = function()
+		return self._cameraStateTweener:IsFinishedShowing()
+	end
+	```
+
+	@class OverrideDefaultCameraToo
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local SummedCamera = require("SummedCamera")
+
+local OverrideDefaultCameraToo = {}
+OverrideDefaultCameraToo.ClassName = "OverrideDefaultCameraToo"
+
+--[=[
+	Initializes a new OverrideDefaultCameraToo
+
+	@param baseCamera Camera
+	@param defaultCamera DefaultCamera
+	@param predicate Filter on whether to override or not
+]=]
+function OverrideDefaultCameraToo.new(baseCamera, defaultCamera, predicate)
+	local self = setmetatable({}, OverrideDefaultCameraToo)
+
+	self.BaseCamera = assert(baseCamera, "No baseCamera")
+	self.DefaultCamera = assert(defaultCamera, "No defaultCamera")
+	self.Predicate = predicate
+
+	return self
+end
+
+function OverrideDefaultCameraToo:__add(other)
+	return SummedCamera.new(self, other)
+end
+
+function OverrideDefaultCameraToo:__newindex(index, value)
+	if index == "BaseCamera" or index == "DefaultCamera" or index == "Predicate" then
+		rawset(self, index, value)
+	else
+		error(index .. " is not a valid member of OverrideDefaultCameraToo")
+	end
+end
+
+function OverrideDefaultCameraToo:__index(index)
+	if index == "CameraState" then
+		local result = self.BaseCamera.CameraState
+
+		local predicate = self.Predicate
+		if not predicate or predicate(result) then
+			self.DefaultCamera:SetRobloxCFrame(result.CFrame)
+		end
+
+		return result
+	elseif index == "BaseCamera" or index == "DefaultCamera" or index == "Predicate" then
+		return rawget(self, index)
+	else
+		return OverrideDefaultCameraToo[index]
+	end
+end
+
+return OverrideDefaultCameraToo

package/src/Client/Utility/CameraStateTweener.lua

@@ -10,10 +10,10 @@ local require = require(script.Parent.loader).load(script)
 
 local CameraStackService = require("CameraStackService")
 local FadeBetweenCamera3 = require("FadeBetweenCamera3")
-local Maid = require("Maid")
 local ServiceBag = require("ServiceBag")
+local BaseObject = require("BaseObject")
 
-local CameraStateTweener = {}
+local CameraStateTweener = setmetatable({}, BaseObject)
 CameraStateTweener.ClassName = "CameraStateTweener"
 CameraStateTweener.__index = CameraStateTweener
 
@@ -26,13 +26,11 @@ CameraStateTweener.__index = CameraStateTweener
 	@return CameraStateTweener
 ]=]
 function CameraStateTweener.new(serviceBag, cameraEffect, speed)
-	local self = setmetatable({}, CameraStateTweener)
+	local self = setmetatable(BaseObject.new(), CameraStateTweener)
 
 	assert(ServiceBag.isServiceBag(serviceBag), "No serviceBag")
 	assert(cameraEffect, "No cameraEffect")
 
-	self._maid = Maid.new()
-
 	self._cameraStackService = serviceBag:GetService(CameraStackService)
 	local cameraBelow, assign = self._cameraStackService:GetNewStateBelow()
 
@@ -86,6 +84,14 @@ function CameraStateTweener:IsFinishedHiding()
 	return self._fadeBetween.HasReachedTarget and self._fadeBetween.Target == 0
 end
 
+--[=[
+	Returns true if we're done showing
+	@return boolean
+]=]
+function CameraStateTweener:IsFinishedShowing()
+	return self._fadeBetween.HasReachedTarget and self._fadeBetween.Target == 1
+end
+
 --[=[
 	Hides the tweener, and invokes the callback once the tweener
 	is finished hiding.
@@ -172,12 +178,4 @@ function CameraStateTweener:GetFader()
 	return self._fadeBetween
 end
 
---[=[
-	Cleans up the fader, preventing any animation at all
-]=]
-function CameraStateTweener:Destroy()
-	self._maid:DoCleaning()
-	setmetatable(self, nil)
-end
-
 return CameraStateTweener