Back to Home

ESO Lua File v101044

libraries/zo_vectorrange/zo_vectorrange.lua

[◄ back to folders ]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
--[[
ZO_VectorRange
-- Example:
ZO_VectorRange:New(0, 1, 0, 2, 0, 3) -- Generates vectors in the range: {[0, 1], [0, 2], [0, 3]}
]]
ZO_VectorRange = ZO_InitializingObject:Subclass()
-- Constructor expects arguments to be specified in the order: lowerBound1, upperBound1, lowerBound2, upperBound2, ...
function ZO_VectorRange:Initialize(...)
    local values = {...}
    local numValues = #values
    if not internalassert(numValues > 0 and numValues % 2 == 0, "ZO_VectorRange: Lower and upper bounds are required.") then
        return
    end
    self.lowerBounds = {}
    self.upperBounds = {}
    for boundIndex = 1, numValues, 2 do
        local lowerBound = values[boundIndex]
        table.insert(self.lowerBounds, lowerBound)
        local upperBound = values[boundIndex + 1]
        table.insert(self.upperBounds, upperBound)
    end
end
function ZO_VectorRange:GetEasedInterval(normalizedInterval)
    if self.easingFunction then
        return self.easingFunction(normalizedInterval)
    end
    return normalizedInterval
end
function ZO_VectorRange:GetEasingFunction()
    return self.easingFunction
end
function ZO_VectorRange:SetEasingFunction(easingFunction)
    return self
end
function ZO_VectorRange:GetLowerBoundsArray()
    return self.lowerBounds
end
function ZO_VectorRange:GetLowerBounds()
    return unpack(self.lowerBounds)
end
function ZO_VectorRange:GetUpperBoundsArray()
    return self.upperBounds
end
function ZO_VectorRange:GetUpperBounds()
    return unpack(self.upperBounds)
end
-- Returns a vector array whose components are interpolated between
-- the lower and upper bound by 'normalizedInterval' amount [0, 1].
function ZO_VectorRange:GetNormalizedVectorArray(normalizedInterval)
    local easedInterval = self:GetEasedInterval(normalizedInterval)
    local vector = {}
    for boundIndex = 1, #self.lowerBounds do
        local lowerBound = self.lowerBounds[boundIndex]
        local upperBound = self.upperBounds[boundIndex]
        vector[boundIndex] = zo_lerp(lowerBound, upperBound, easedInterval)
    end
    return vector
end
-- Returns the vector components interpolated between the lower and
-- upper bound by 'normalizedInterval' amount [0, 1].
function ZO_VectorRange:GetNormalizedVector(normalizedInterval)
    return unpack(self:GetNormalizedVectorArray(normalizedInterval))
end
-- Returns a vector array whose components are interpolated between
-- the lower and upper bound by a shared, random interval.
function ZO_VectorRange:GetRandomProportionalVectorArray()
    local randomNormalizedInterval = zo_random()
    return self:GetNormalizedVectorArray(randomNormalizedInterval)
end
-- Returns the vector components interpolated between the lower and
-- upper bound by a shared, random interval.
function ZO_VectorRange:GetRandomProportionalVector()
end
-- Returns a vector array whose components are interpolated between
-- the lower and upper bound by a random interval per component.
function ZO_VectorRange:GetRandomVectorArray()
    local vector = {}
    for boundIndex = 1, #self.lowerBounds do
        local lowerBound = self.lowerBounds[boundIndex]
        local upperBound = self.upperBounds[boundIndex]
        local randomNormalizedInterval = zo_random()
        local randomEasedInterval = self:GetEasedInterval(randomNormalizedInterval)
        vector[boundIndex] = zo_lerp(lowerBound, upperBound, randomEasedInterval)
    end
    return vector
end
-- Returns the vector components interpolated between the lower and
-- upper bound by a random interval per component.
function ZO_VectorRange:GetRandomVector()
    return unpack(self:GetRandomVectorArray())
end
--[[
ZO_EasedVectorRange
-- Example:
ZO_EasedVectorRange:New(ZO_EaseInOutZeroToOneToZero, 0, 1, 0, 2, 0, 3) -- Generates sinusoidally eased vectors
-- in the range: {[0, 1], [0, 2], [0, 3]}
]]
ZO_EasedVectorRange = ZO_VectorRange:Subclass()
function ZO_EasedVectorRange:Initialize(easingFunction, ...)
    ZO_VectorRange.Initialize(self, ...)
end
--[[
ZO_VectorRangeAndWeight
-- Example:
local range = ZO_VectorRange:New(0, 1, 0, 1, 0, 1)
local relativeWeight = 10
ZO_VectorRangeAndWeight:New(range, relativeWeight) -- Represents the specified vector range weighted 10 out of
-- the total weight of a ZO_WeightedVectorRanges' vector ranges.
]]
ZO_VectorRangeAndWeight = ZO_InitializingObject:Subclass()
function ZO_VectorRangeAndWeight:Initialize(vectorRange, optionalWeight)
    self.vectorRange = vectorRange
    self.weight = optionalWeight or 1
end
function ZO_VectorRangeAndWeight:GetVectorRange()
    return self.vectorRange
end
function ZO_VectorRangeAndWeight:GetWeight()
    return self.weight
end
--[[
ZO_WeightedVectorRanges
-- Example:
local weightedRanges = ZO_WeightedVectorRanges:New()
weightedRanges:AddVectorRange(ZO_VectorRange:New(0, 1, 0, 1, 0, 1), 50) -- Relative weight of 50
weightedRanges:AddVectorRange(ZO_VectorRange:New(10, 20, 10, 20, 10, 20), 40) -- Relative weight of 40
weightedRanges:AddVectorRange(ZO_VectorRange:New(0.25, 0.75, 0.1, 0.4, 0.6, 1), 10) -- Relative weight of 10
local vectorRange1 = weightedRanges:GetVectorRangeByNormalizedInterval(0.1) -- Returns the first vector range.
local vectorRange2 = weightedRanges:GetVectorRangeByNormalizedInterval(0.5) -- Returns the first vector range.
local vectorRange3 = weightedRanges:GetVectorRangeByNormalizedInterval(0.51) -- Returns the second vector range.
local vectorRange4 = weightedRanges:GetVectorRangeByNormalizedInterval(0.95) -- Returns the third vector range.
]]
ZO_WeightedVectorRanges = ZO_InitializingObject:Subclass()
-- Constructor expects zero or more ZO_VectorRange instance(s).
function ZO_WeightedVectorRanges:Initialize(...)
    self.vectorRangesAndWeights = {}
    local DEFAULT_WEIGHT = 1
    local vectorRanges = {...}
    for vectorRangeIndex, vectorRange in ipairs(vectorRanges) do
        self.vectorRangesAndWeights[vectorRangeIndex] = ZO_VectorRangeAndWeight:New(vectorRange, DEFAULT_WEIGHT)
    end
    self.totalWeight = DEFAULT_WEIGHT * #self.vectorRangesAndWeights
end
-- Add a vector range with the specified relative weight.
-- When choosing a vector range using a normalized interval the
-- subinterval that returns a given vector is defined as:
-- vector range weight / total vector range weights
function ZO_WeightedVectorRanges:AddVectorRange(vectorRange, optionalWeight)
    local weight = optionalWeight or 1
    local vectorRangeAndWeight = ZO_VectorRangeAndWeight:New(vectorRange, weight)
    table.insert(self.vectorRangesAndWeights, vectorRangeAndWeight)
    self.totalWeight = self.totalWeight + weight
end
function ZO_WeightedVectorRanges:GetVectorRangeByNormalizedInterval(normalizedInterval)
    if not internalassert(#self.vectorRangesAndWeights > 0, "ZO_WeightedVectorRanges: No vector ranges have been added.") then
        return nil
    end
    normalizedInterval = zo_clamp(normalizedInterval, 0, 1)
    local targetWeight = normalizedInterval * self.totalWeight
    local currentWeight = 0
    for vectorRangeAndWeightIndex, vectorRangeAndWeight in ipairs(self.vectorRangesAndWeights) do
        currentWeight = currentWeight + vectorRangeAndWeight:GetWeight()
        if currentWeight >= targetWeight then
            return vectorRangeAndWeight:GetVectorRange()
        end
    end
    return nil
end
function ZO_WeightedVectorRanges:GetRandomVectorRange()
    local randomInterval = zo_random()
    local vectorRange = self:GetVectorRangeByNormalizedInterval(randomInterval)
    return vectorRange
end
function ZO_WeightedVectorRanges:GetRandomProportionalVectorArray()
    local vectorRange = self:GetRandomVectorRange()
    return vectorRange:GetRandomProportionalVectorArray()
end
function ZO_WeightedVectorRanges:GetRandomProportionalVector()
    local vectorRange = self:GetRandomVectorRange()
    return vectorRange:GetRandomProportionalVector()
end
function ZO_WeightedVectorRanges:GetRandomVectorArray()
    local vectorRange = self:GetRandomVectorRange()
    return vectorRange:GetRandomVectorArray()
end
function ZO_WeightedVectorRanges:GetRandomVector()
    local vectorRange = self:GetRandomVectorRange()
    return vectorRange:GetRandomVector()
end
--[[
ZO_ColorRange
-- Example:
local colorRange = ZO_ColorRange:New(0, 1, 0, 1, 0, 1, 1, 1)
local r, g, b, a = colorRange:GetRandomProportionalColor() -- Returns a shade of gray
-- (white to black) with alpha 1.
]]
ZO_ColorRange = ZO_VectorRange:Subclass()
function ZO_ColorRange:Initialize(minR, maxR, minG, maxG, minB, maxB, minA, maxA)
    minR = minR or 1
    maxR = maxR or minR
    minG = minG or 1
    maxG = maxG or minG
    minB = minB or 1
    maxB = maxB or minB
    minA = minA or 1
    maxA = maxA or minA
    ZO_VectorRange.Initialize(self, minR, maxR, minG, maxG, minB, maxB, minA, maxA)
end
--[[
ZO_WeightedColorRanges
-- Example:
local weightedColors = ZO_WeightedColorRanges:New()
weightedColors:AddColorRange(ZO_ColorRange:New(0, 1, 0, 0, 0, 0, 1, 1), 10)
weightedColors:AddColorRange(ZO_ColorRange:New(0, 0, 0, 1, 0, 0, 1, 1), 50)
weightedColors:AddColorRange(ZO_ColorRange:New(0, 0, 0, 0, 0, 1, 1, 1), 40)
weightedColors:GetRandomProportionalColor() -- Returns a shade of red 10% of the time,
-- a shade of green 50% of the time,
-- and a shade of blue 40% of the time.
]]
ZO_WeightedColorRanges = ZO_WeightedVectorRanges:Subclass()
function ZO_WeightedColorRanges:AddColorRange(colorRange, optionalWeight)
    local weight = optionalWeight or 1
    ZO_WeightedVectorRanges.AddVectorRange(self, colorRange, weight)
end
function ZO_WeightedColorRanges:GetColorRangeByNormalizedInterval(normalizedInterval)
    return ZO_WeightedVectorRanges.GetVectorRangeByNormalizedInterval(self, normalizedInterval)
end
function ZO_WeightedColorRanges:GetRandomProportionalColorArray()
    return ZO_WeightedVectorRanges.GetRandomProportionalVectorArray(self)
end
function ZO_WeightedColorRanges:GetRandomProportionalColor()
    return ZO_WeightedVectorRanges.GetRandomProportionalVector(self)
end
function ZO_WeightedColorRanges:GetRandomColorArray()
    return ZO_WeightedVectorRanges.GetRandomVectorArray(self)
end
function ZO_WeightedColorRanges:GetRandomColor()
    return ZO_WeightedVectorRanges.GetRandomVector(self)
end
--[[
ZO_WeightedValue
-- Example
ZO_WeightedValue:New(someValue, relativeWeight)
]]
ZO_WeightedValue = ZO_InitializingObject:Subclass()
function ZO_WeightedValue:Initialize(value, weight)
    weight = tonumber(weight)
    if internalassert(weight and weight > 0, "ZO_WeightedValue: weight must be numeric and greater than zero.") then
        self.value = value
        self.weight = weight
    end
end
function ZO_WeightedValue:GetValue()
    return self.value
end
function ZO_WeightedValue:GetWeight()
    return self.weight
end
--[[
ZO_WeightedValues
-- Example:
ZO_WeightedValues:New(
ZO_WeightedValue:New("This string shows up 50% of the time", 50),
ZO_WeightedValue:New("And this string... 35%", 35),
ZO_WeightedValue:New("...and this string appears only 15% of the time", 15))
local randomString = ZO_WeightedValues:GetRandomValue()
]]
ZO_WeightedValues = ZO_InitializingObject:Subclass()
-- Constructor expects zero or more ZO_WeightedValue instances.
function ZO_WeightedValues:Initialize(...)
    self.values = {...}
end
function ZO_WeightedValues:AddValueAndWeight(value, weight)
    local weightedValue = ZO_WeightedValue:New(value, weight)
    self:AddWeightedValue(weightedValue)
end
function ZO_WeightedValues:AddWeightedValue(weightedValue)
    if internalassert(weightedValue and weightedValue:IsInstanceOf(ZO_WeightedValue), "ZO_WeightedValues: ZO_WeightedValue instance required.") then
        table.insert(self.values, weightedValue)
        self.totalWeight = self.totalWeight + weightedValue:GetWeight()
    end
end
function ZO_WeightedValues:AddWeightedValues(...)
    local weightedValues = {...}
    for _, weightedValue in ipairs(weightedValues) do
        self:AddWeightedValue(weightedValue)
    end
end
function ZO_WeightedValues:GetValueByNormalizedInterval(normalizedInterval)
    normalizedInterval = zo_clamp(normalizedInterval, 0, 1)
    local currentWeight = 0
    local totalWeight = self.totalWeight
    for _, weightedValue in ipairs(self.values) do
        currentWeight = currentWeight + weightedValue:GetWeight()
        local currentNormalizedInterval = currentWeight / totalWeight
        if normalizedInterval <= currentNormalizedInterval then
            return weightedValue:GetValue()
        end
    end
    return nil
end
function ZO_WeightedValues:GetRandomValue()
    local randomNormalizedInterval = zo_random()
    return self:GetValueByNormalizedInterval(randomNormalizedInterval)
end
function ZO_WeightedValues:UpdateTotalWeight()
    local totalWeight = 0
    for _, weightedValue in ipairs(self.values) do
        totalWeight = totalWeight + weightedValue:GetWeight()
    end
    self.totalWeight = totalWeight
end