--!strict
--[=[
	@class AnimatedHighlightModel
]=]

local require = require(script.Parent.loader).load(script)

local BaseObject = require("BaseObject")
local DuckTypeUtils = require("DuckTypeUtils")
local EnumUtils = require("EnumUtils")
local Signal = require("Signal")
local ValueObject = require("ValueObject")

local AnimatedHighlightModel = setmetatable({}, BaseObject)
AnimatedHighlightModel.ClassName = "AnimatedHighlightModel"
AnimatedHighlightModel.__index = AnimatedHighlightModel

export type AnimatedHighlightModel =
	typeof(setmetatable(
		{} :: {
			HighlightDepthMode: ValueObject.ValueObject<Enum.HighlightDepthMode?>,
			FillColor: ValueObject.ValueObject<Color3?>,
			OutlineColor: ValueObject.ValueObject<Color3?>,
			FillTransparency: ValueObject.ValueObject<number?>,
			OutlineTransparency: ValueObject.ValueObject<number?>,
			Speed: ValueObject.ValueObject<number?>,
			ColorSpeed: ValueObject.ValueObject<number?>,
			TransparencySpeed: ValueObject.ValueObject<number?>,
			FillSpeed: ValueObject.ValueObject<number?>,
			Destroying: Signal.Signal<()>,
		},
		{} :: typeof({ __index = AnimatedHighlightModel })
	))
	& BaseObject.BaseObject

--[=[
	Constructs a new data model for an animated highlight. Probably retrieve via an
	[AnimatedHighlightStack] or more likely an [AnimatedHighlightGroup] or even the
	[HighlightServiceClient.Highlight].

	@return AnimatedHighlightModel
]=]
function AnimatedHighlightModel.new(): AnimatedHighlightModel
	local self: AnimatedHighlightModel = setmetatable(BaseObject.new() :: any, AnimatedHighlightModel)

	self.HighlightDepthMode = self._maid:Add(ValueObject.new(nil))
	self.FillColor = self._maid:Add(ValueObject.new(nil))
	self.OutlineColor = self._maid:Add(ValueObject.new(nil))
	self.FillTransparency = self._maid:Add(ValueObject.new(nil))
	self.OutlineTransparency = self._maid:Add(ValueObject.new(nil))
	self.Speed = self._maid:Add(ValueObject.new(nil))
	self.ColorSpeed = self._maid:Add(ValueObject.new(nil))
	self.TransparencySpeed = self._maid:Add(ValueObject.new(nil))
	self.FillSpeed = self._maid:Add(ValueObject.new(nil))

	self.Destroying = Signal.new()
	self._maid:GiveTask(function()
		self.Destroying:Fire()
		self.Destroying:Destroy()
	end)

	return self
end

--[=[
	Returns true if it's an animated highlight model

	@param value any
	@return boolean
]=]
function AnimatedHighlightModel.isAnimatedHighlightModel(value: any): boolean
	return DuckTypeUtils.isImplementation(AnimatedHighlightModel, value)
end

--[=[
	Sets the highlight depth mode

	@param depthMode HighlightDepthMode
]=]
function AnimatedHighlightModel:SetHighlightDepthMode(depthMode: Enum.HighlightDepthMode?): ()
	assert(depthMode == nil or EnumUtils.isOfType(Enum.HighlightDepthMode, depthMode), "Bad depthMode")

	self.HighlightDepthMode.Value = depthMode
end

--[=[
	Sets the transparency speed

	@param speed number?
]=]
function AnimatedHighlightModel:SetTransparencySpeed(speed: number?): ()
	assert(type(speed) == "number" or speed == nil, "Bad speed")

	self.TransparencySpeed:SetValue(speed)
end

--[=[
	Sets the color speed

	@param speed number?
]=]
function AnimatedHighlightModel:SetColorSpeed(speed: number?): ()
	assert(type(speed) == "number" or speed == nil, "Bad speed")

	self.ColorSpeed:SetValue(speed)
end

--[=[
	Sets the visiblity speed speed

	@param speed number?
]=]
function AnimatedHighlightModel:SetSpeed(speed: number?): ()
	assert(type(speed) == "number" or speed == nil, "Bad speed")

	self.Speed:SetValue(speed)
end

--[=[
	Sets fill color

	@param color Color3?
	@param doNotAnimate boolean?
]=]
function AnimatedHighlightModel:SetFillColor(color: Color3?, doNotAnimate: boolean?): ()
	assert(typeof(color) == "Color3" or color == nil, "Bad color")

	self.FillColor:SetValue(color, doNotAnimate)
end

--[=[
	Gets the fill color

	@return Color3?
]=]
function AnimatedHighlightModel:GetFillColor(): Color3?
	return self.FillColor.Value
end

--[=[
	Sets the outline color

	@param color Color3?
	@param doNotAnimate boolean?
]=]
function AnimatedHighlightModel:SetOutlineColor(color: Color3?, doNotAnimate: boolean?): ()
	assert(typeof(color) == "Color3" or color == nil, "Bad color")

	self.OutlineColor:SetValue(color, doNotAnimate)
end

--[=[
	Gets the outline color

	@return Color3?
]=]
function AnimatedHighlightModel:GetOutlineColor(): Color3?
	return self.OutlineColor.Value
end

--[=[
	Sets the outline transparency

	@param outlineTransparency number
	@param doNotAnimate boolean?
]=]
function AnimatedHighlightModel:SetOutlineTransparency(outlineTransparency: number?, doNotAnimate: boolean?): ()
	assert(type(outlineTransparency) == "number" or outlineTransparency == nil, "Bad outlineTransparency")

	self.OutlineTransparency:SetValue(outlineTransparency, doNotAnimate)
end

--[=[
	Sets the fill transparency

	@param fillTransparency number
	@param doNotAnimate boolean?
]=]
function AnimatedHighlightModel:SetFillTransparency(fillTransparency: number?, doNotAnimate: boolean?): ()
	assert(type(fillTransparency) == "number" or fillTransparency == nil, "Bad fillTransparency")

	self.FillTransparency:SetValue(fillTransparency, doNotAnimate)
end

return AnimatedHighlightModel