@quenty/depthoffield 4.0.1 → 4.1.1-canary.288.c2f64f9.0

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.1.1-canary.288.c2f64f9.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/depthoffield@4.1.0...@quenty/depthoffield@4.1.1-canary.288.c2f64f9.0) (2022-09-26)
+
+
+### Features
+
+* Support near and far intensity in depth of field tweener ([9dcb826](https://github.com/Quenty/NevermoreEngine/commit/9dcb826d1d621859637311e5493605c8b3b5242e))
+
+
+
+
+
+# [4.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/depthoffield@4.0.1...@quenty/depthoffield@4.1.0) (2022-08-22)
+
+**Note:** Version bump only for package @quenty/depthoffield
+
+
+
+
+
 ## [4.0.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/depthoffield@4.0.0...@quenty/depthoffield@4.0.1) (2022-08-16)
 
 **Note:** Version bump only for package @quenty/depthoffield

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/depthoffield",
-  "version": "4.0.1",
+  "version": "4.1.1-canary.288.c2f64f9.0",
   "description": "Depth of field service to allow multiple systems to write depth of field",
   "keywords": [
     "Roblox",
@@ -25,16 +25,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/acceltween": "^2.2.0",
-    "@quenty/baseobject": "^5.1.1",
-    "@quenty/loader": "^5.0.1",
-    "@quenty/maid": "^2.4.0",
-    "@quenty/signal": "^2.2.0",
-    "@quenty/steputils": "^3.1.0",
-    "@quenty/valueobject": "^6.0.1"
+    "@quenty/acceltween": "2.2.0",
+    "@quenty/baseobject": "5.1.2-canary.288.c2f64f9.0",
+    "@quenty/loader": "5.0.2-canary.288.c2f64f9.0",
+    "@quenty/maid": "2.4.0",
+    "@quenty/signal": "2.3.0",
+    "@quenty/steputils": "3.1.0",
+    "@quenty/valueobject": "6.1.1-canary.288.c2f64f9.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "340ac324c03fb3b844bbbe7ca57ee88874a724c9"
+  "gitHead": "c2f64f9bb90b0e5f0e4f4bc04a58af852bac6460"
 }

package/src/Client/DepthOfFieldModifier.lua

@@ -11,14 +11,23 @@ local DepthOfFieldModifier = setmetatable({}, BaseObject)
 DepthOfFieldModifier.ClassName = "DepthOfFieldModifier"
 DepthOfFieldModifier.__index = DepthOfFieldModifier
 
-function DepthOfFieldModifier.new(distance, radius)
+function DepthOfFieldModifier.new(distance, radius, nearIntensity, farIntensity)
 	local self = setmetatable(BaseObject.new(), DepthOfFieldModifier)
 
+	assert(type(distance) == "number", "Bad distance")
+	assert(type(radius) == "number", "Bad radius")
+	assert(type(nearIntensity) == "number", "Bad nearIntensity")
+	assert(type(farIntensity) == "number", "Bad farIntensity")
+
 	self._originalDistance = distance
 	self._originalRadius = radius
+	self._originalNearIntensity = nearIntensity
+	self._originalFarIntensity = farIntensity
 
 	self._distance = distance
 	self._radius = radius
+	self._nearIntensity = nearIntensity
+	self._farIntensity = farIntensity
 
 --[=[
 	Fires when the modifier is removing.
@@ -47,6 +56,12 @@ function DepthOfFieldModifier.new(distance, radius)
 	self.RadiusChanged = Signal.new()
 	self._maid:GiveTask(self.RadiusChanged)
 
+	self.NearIntensityChanged = Signal.new()
+	self._maid:GiveTask(self.NearIntensityChanged)
+
+	self.FarIntensityChanged = Signal.new()
+	self._maid:GiveTask(self.FarIntensityChanged)
+
 	return self
 end
 
@@ -66,6 +81,13 @@ function DepthOfFieldModifier:SetDistance(distance, doNotAnimate)
 	self.DistanceChanged:Fire(distance, doNotAnimate)
 end
 
+function DepthOfFieldModifier:GetOriginalDistance()
+	return self._originalDistance
+end
+
+function DepthOfFieldModifier:GetOriginalRadius()
+	return self._originalRadius
+end
 --[=[
 	Sets the target depth of field distance
 	@param radius number
@@ -82,6 +104,28 @@ function DepthOfFieldModifier:SetRadius(radius, doNotAnimate)
 	self.RadiusChanged:Fire(radius, doNotAnimate)
 end
 
+function DepthOfFieldModifier:SetNearIntensity(nearIntensity, doNotAnimate)
+	assert(type(nearIntensity) == "number", "Bad nearIntensity")
+
+	if self._nearIntensity == nearIntensity then
+		return
+	end
+
+	self._nearIntensity = nearIntensity
+	self.NearIntensityChanged:Fire(nearIntensity, doNotAnimate)
+end
+
+function DepthOfFieldModifier:SetFarIntensity(farIntensity, doNotAnimate)
+	assert(type(farIntensity) == "number", "Bad farIntensity")
+
+	if self._farIntensity == farIntensity then
+		return
+	end
+
+	self._farIntensity = farIntensity
+	self.FarIntensityChanged:Fire(farIntensity, doNotAnimate)
+end
+
 --[=[
 	Retrieves the distance
 	@return number
@@ -98,6 +142,14 @@ function DepthOfFieldModifier:GetRadius()
 	return self._radius
 end
 
+function DepthOfFieldModifier:GetNearIntensity()
+	return self._nearIntensity
+end
+
+function DepthOfFieldModifier:GetFarIntensity()
+	return self._farIntensity
+end
+
 --[=[
 	Resets the radius
 	@param doNotAnimate boolean
@@ -105,6 +157,8 @@ end
 function DepthOfFieldModifier:Reset(doNotAnimate)
 	self:SetDistance(self._originalDistance, doNotAnimate)
 	self:SetRadius(self._originalRadius, doNotAnimate)
+	self:SetNearIntensity(self._originalNearIntensity, doNotAnimate)
+	self:SetFarIntensity(self._originalFarIntensity, doNotAnimate)
 end
 
 return DepthOfFieldModifier

package/src/Client/DepthOfFieldService.lua

@@ -32,12 +32,16 @@ function DepthOfFieldService:Init(_serviceBag)
 	-- Assume we can enable now that we've recorded values
 	self._depthOfField.InFocusRadius = self._tweener:GetOriginalRadius()
 	self._depthOfField.FocusDistance = self._tweener:GetOriginalDistance()
+	self._depthOfField.NearIntensity = self._tweener:GetOriginalNearIntensity()
+	self._depthOfField.FarIntensity = self._tweener:GetOriginalFarIntensity()
 	self._depthOfField.Enabled = true
 
 	self._maid:GiveTask(self._topOfStack.Changed:Connect(function(new, _old, maid)
 		if new then
 			self._tweener:SetDistance(new:GetDistance(), false)
 			self._tweener:SetRadius(new:GetRadius(), false)
+			self._tweener:SetNearIntensity(new:GetNearIntensity(), false)
+			self._tweener:SetFarIntensity(new:GetFarIntensity(), false)
 
 			maid:GiveTask(new.DistanceChanged:Connect(function(distance, doNotAnimate)
 				self._tweener:SetDistance(distance, doNotAnimate)
@@ -45,6 +49,13 @@ function DepthOfFieldService:Init(_serviceBag)
 			maid:GiveTask(new.RadiusChanged:Connect(function(radius, doNotAnimate)
 				self._tweener:SetRadius(radius, doNotAnimate)
 			end))
+			maid:GiveTask(new.NearIntensityChanged:Connect(function(nearIntensity, doNotAnimate)
+				self._tweener:SetNearIntensity(nearIntensity, doNotAnimate)
+			end))
+			maid:GiveTask(new.FarIntensityChanged:Connect(function(farIntensity, doNotAnimate)
+				self._tweener:SetFarIntensity(farIntensity, doNotAnimate)
+			end))
+
 		else
 			self._tweener:Reset()
 		end
@@ -60,7 +71,11 @@ end
 function DepthOfFieldService:CreateModifier()
 	local maid = Maid.new()
 
-	local modifier = DepthOfFieldModifier.new(self._tweener:GetOriginalDistance(), self._tweener:GetOriginalRadius())
+	local modifier = DepthOfFieldModifier.new(
+		self._tweener:GetOriginalDistance(),
+		self._tweener:GetOriginalRadius(),
+		self._tweener:GetOriginalFarIntensity(),
+		self._tweener:GetOriginalNearIntensity())
 	maid:GiveTask(modifier)
 
 	maid:GiveTask(function()
@@ -109,7 +124,11 @@ function DepthOfFieldService:_getOrCreateDepthOfField()
 	warn("[DepthOfFieldService._getOrCreateDepthOfField] - Creating depthOfField effect!")
 
 	local depthOfField = Instance.new("DepthOfFieldEffect")
-	depthOfField.Enabled = false
+	depthOfField.FarIntensity = 0.75
+	depthOfField.FocusDistance = 500
+	depthOfField.InFocusRadius = 500
+	depthOfField.NearIntensity = 0.75
+	depthOfField.Enabled = true
 	depthOfField.Parent = Lighting
 	self._maid:GiveTask(depthOfField)
 

package/src/Client/DepthOfFieldTweener.lua

@@ -9,8 +9,6 @@ local AccelTween = require("AccelTween")
 local BaseObject = require("BaseObject")
 local StepUtils = require("StepUtils")
 
-local DEFAULT_SPEED = 10000
-
 local DepthOfFieldTweener = setmetatable({}, BaseObject)
 DepthOfFieldTweener.ClassName = "DepthOfFieldTweener"
 DepthOfFieldTweener.__index = DepthOfFieldTweener
@@ -18,10 +16,9 @@ DepthOfFieldTweener.__index = DepthOfFieldTweener
 --[=[
 	Create a new DepthOfFieldTweener.
 	@param depthOfField number
-	@param speed number?
 	@return DepthOfFieldTweener
 ]=]
-function DepthOfFieldTweener.new(depthOfField, speed)
+function DepthOfFieldTweener.new(depthOfField)
 	local self = setmetatable(BaseObject.new(), DepthOfFieldTweener)
 
 	self._depthOfField = assert(depthOfField, "No depthOfField")
@@ -29,18 +26,30 @@ function DepthOfFieldTweener.new(depthOfField, speed)
 	-- If we aren't enabled we make sure to set distance to be far
 	self._originalDistance = self._depthOfField.Enabled and self._depthOfField.FocusDistance or 500
 	self._originalRadius = self._depthOfField.Enabled and self._depthOfField.InFocusRadius or 500
+	self._originalNearIntensity = self._depthOfField.NearIntensity
+	self._originalFarIntensity = self._depthOfField.FarIntensity
 
-	self._distance = AccelTween.new(speed or DEFAULT_SPEED)
+	self._distance = AccelTween.new(10000)
 	self._distance.t = self._originalDistance
 	self._distance.p = self._originalDistance
 
-	self._radius = AccelTween.new(speed or DEFAULT_SPEED)
+	self._radius = AccelTween.new(10000)
 	self._radius.t = self._originalRadius
 	self._radius.p = self._originalRadius
 
+	self._nearIntensity = AccelTween.new(30)
+	self._nearIntensity.t = self._originalNearIntensity
+	self._nearIntensity.p = self._originalNearIntensity
+
+	self._farIntensity = AccelTween.new(30)
+	self._farIntensity.t = self._originalFarIntensity
+	self._farIntensity.p = self._originalFarIntensity
+
 	self._maid:GiveTask(function()
 		self._depthOfField.FocusDistance = self._originalDistance
 		self._depthOfField.InFocusRadius = self._originalRadius
+		self._depthOfField.NearIntensity = self._originalNearIntensity
+		self._depthOfField.FarIntensity = self._originalFarIntensity
 	end)
 
 	self._startAnimation, self._maid._stop = StepUtils.bindToRenderStep(self._update)
@@ -49,12 +58,41 @@ function DepthOfFieldTweener.new(depthOfField, speed)
 	return self
 end
 
+function DepthOfFieldTweener:SetNearIntensity(nearIntensity, doNotAnimate)
+	assert(type(nearIntensity) == "number", "Bad nearIntensity")
+
+	local target = math.clamp(nearIntensity, 0, 1)
+	self._nearIntensity.t = target
+	if doNotAnimate then
+		self._nearIntensity.p = target
+		self._nearIntensity.v = 0
+	end
+
+	self:_startAnimation()
+end
+
+function DepthOfFieldTweener:SetFarIntensity(farIntensity, doNotAnimate)
+	assert(type(farIntensity) == "number", "Bad farIntensity")
+
+	local target = math.clamp(farIntensity, 0, 1)
+	self._farIntensity.t = target
+	if doNotAnimate then
+		self._farIntensity.p = target
+		self._farIntensity.v = 0
+	end
+
+	self:_startAnimation()
+end
+
+
 --[=[
 	Sets the radius and starts any animation
 	@param radius number
 	@param doNotAnimate boolean
 ]=]
 function DepthOfFieldTweener:SetRadius(radius, doNotAnimate)
+	assert(type(radius) == "number", "Bad radius")
+
 	local target = math.clamp(radius, 0, 500)
 	self._radius.t = target
 	if doNotAnimate then
@@ -87,6 +125,8 @@ end
 	@param doNotAnimate boolean
 ]=]
 function DepthOfFieldTweener:SetDistance(distance, doNotAnimate)
+	assert(type(distance) == "number", "Bad distance")
+
 	local target = math.clamp(distance, 0, 500)
 	self._distance.t = target
 	if doNotAnimate then
@@ -104,6 +144,8 @@ end
 function DepthOfFieldTweener:Reset(doNotAnimate)
 	self:ResetRadius(doNotAnimate)
 	self:ResetDistance(doNotAnimate)
+	self:ResetNearIntensity(doNotAnimate)
+	self:ResetFarIntensity(doNotAnimate)
 end
 
 --[=[
@@ -112,7 +154,6 @@ end
 ]=]
 function DepthOfFieldTweener:ResetRadius(doNotAnimate)
 	self:SetRadius(self._originalRadius, doNotAnimate)
-	self:_startAnimation()
 end
 
 --[=[
@@ -121,7 +162,14 @@ end
 ]=]
 function DepthOfFieldTweener:ResetDistance(doNotAnimate)
 	self:SetDistance(self._originalDistance, doNotAnimate)
-	self:_startAnimation()
+end
+
+function DepthOfFieldTweener:ResetNearIntensity(doNotAnimate)
+	self:SetNearIntensity(self._originalNearIntensity, doNotAnimate)
+end
+
+function DepthOfFieldTweener:ResetFarIntensity(doNotAnimate)
+	self:SetFarIntensity(self._originalFarIntensity, doNotAnimate)
 end
 
 function DepthOfFieldTweener:GetOriginalRadius()
@@ -132,12 +180,24 @@ function DepthOfFieldTweener:GetOriginalDistance()
 	return self._originalDistance
 end
 
+function DepthOfFieldTweener:GetOriginalNearIntensity()
+	return self._originalNearIntensity
+end
+
+function DepthOfFieldTweener:GetOriginalFarIntensity()
+	return self._originalFarIntensity
+end
+
 function DepthOfFieldTweener:_update()
 	self._depthOfField.FocusDistance = self._distance.p
 	self._depthOfField.InFocusRadius = self._radius.p
+	self._depthOfField.NearIntensity = self._nearIntensity.p
+	self._depthOfField.FarIntensity = self._farIntensity.p
 
 	return self._radius.rtime > 0
 		or self._distance.rtime > 0
+		or self._nearIntensity.rtime > 0
+		or self._farIntensity.rtime > 0
 end
 
 return DepthOfFieldTweener