UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
XPBDAnisotropicSpringConstraints.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2#pragma once
3
4#include "Chaos/CollectionPropertyFacade.h"
5#include "Chaos/PBDAxialSpringConstraintsBase.h"
6#include "Chaos/PBDSpringConstraintsBase.h"
7#include "Chaos/PBDWeightMap.h"
8#include "Chaos/PBDFlatWeightMap.h"
9
10namespace Chaos
11{
12class FTriangleMesh;
13}
14
15namespace Chaos::Softs
16{
17
18// Edge and axial springs. Spatially varying stiffnesses and restlengths controlled by Warp/Weft/Bias.
19// Both types of springs controlled by the same input parameters.
20class FXPBDAnisotropicEdgeSpringConstraints : public FPBDSpringConstraintsBase
21{
22 typedef FPBDSpringConstraintsBase Base;
23
24public:
25 // Stiffness is in kg /s^2
26 static constexpr FSolverReal MinStiffness = (FSolverReal)0; // We're not checking against MinStiffness (except when it's constant and == 0)
27 static constexpr FSolverReal MaxStiffness = (FSolverReal)1e9;
28 static constexpr FSolverReal MinDampingRatio = (FSolverReal)0.;
29 static constexpr FSolverReal MaxDampingRatio = (FSolverReal)1000.;
30 static constexpr FSolverReal MinWarpWeftScale = (FSolverReal)0.;
31 static constexpr FSolverReal MaxWarpWeftScale = (FSolverReal)1e7; // No particular reason for this number. Just can't imagine wanting something bigger?
32
33 CHAOS_API FXPBDAnisotropicEdgeSpringConstraints(
34 const FSolverParticlesRange& Particles,
35 const FTriangleMesh& TriangleMesh,
36 const TArray<TVec3<FVec2f>>& FaceVertexPatternPositions,
37 bool bUse3dRestLengths,
38 bool bSavePreResizedSimPosition3D,
39 const TArray<FVector3f>& PreResizedSimPosition3D,
40 FSolverReal MeshScale,
41 const TConstArrayView<FRealSingle>& StiffnessWarpMultipliers,
42 const TConstArrayView<FRealSingle>& StiffnessWeftMultipliers,
43 const TConstArrayView<FRealSingle>& StiffnessBiasMultipliers,
44 const TConstArrayView<FRealSingle>& DampingMultipliers,
45 const TConstArrayView<FRealSingle>& WarpScaleMultipliers,
46 const TConstArrayView<FRealSingle>& WeftScaleMultipliers,
47 const FSolverVec2& InStiffnessWarp,
48 const FSolverVec2& InStiffnessWeft,
49 const FSolverVec2& InStiffnessBias,
50 const FSolverVec2& InDampingRatio,
51 const FSolverVec2& InWarpScale,
52 const FSolverVec2& InWeftScale);
53
54 CHAOS_API FXPBDAnisotropicEdgeSpringConstraints(
55 const FSolverParticles& InParticles,
56 int32 InParticleOffset,
57 int32 InParticleCount,
58 const FTriangleMesh& TriangleMesh,
59 const TArray<TVec3<FVec2f>>& FaceVertexPatternPositions,
60 bool bUse3dRestLengths,
61 bool bSavePreResizedSimPosition3D,
62 const TArray<FVector3f>& PreResizedSimPosition3D,
63 FSolverReal MeshScale,
64 const TConstArrayView<FRealSingle>& StiffnessWarpMultipliers,
65 const TConstArrayView<FRealSingle>& StiffnessWeftMultipliers,
66 const TConstArrayView<FRealSingle>& StiffnessBiasMultipliers,
67 const TConstArrayView<FRealSingle>& DampingMultipliers,
68 const TConstArrayView<FRealSingle>& WarpScaleMultipliers,
69 const TConstArrayView<FRealSingle>& WeftScaleMultipliers,
70 const FSolverVec2& InStiffnessWarp,
71 const FSolverVec2& InStiffnessWeft,
72 const FSolverVec2& InStiffnessBias,
73 const FSolverVec2& InDampingRatio,
74 const FSolverVec2& InWarpScale,
75 const FSolverVec2& InWeftScale);
76
77 UE_DEPRECATED(5.6, "No longer supported, use new constructors instead")
78 CHAOS_API FXPBDAnisotropicEdgeSpringConstraints(
79 const FSolverParticlesRange& Particles,
80 const FTriangleMesh& TriangleMesh,
81 const TArray<TVec3<FVec2f>>& FaceVertexPatternPositions,
82 bool bUse3dRestLengths,
83 const TConstArrayView<FRealSingle>& StiffnessWarpMultipliers,
84 const TConstArrayView<FRealSingle>& StiffnessWeftMultipliers,
85 const TConstArrayView<FRealSingle>& StiffnessBiasMultipliers,
86 const TConstArrayView<FRealSingle>& DampingMultipliers,
87 const TConstArrayView<FRealSingle>& WarpScaleMultipliers,
88 const TConstArrayView<FRealSingle>& WeftScaleMultipliers,
89 const FSolverVec2& InStiffnessWarp,
90 const FSolverVec2& InStiffnessWeft,
91 const FSolverVec2& InStiffnessBias,
92 const FSolverVec2& InDampingRatio,
93 const FSolverVec2& InWarpScale,
94 const FSolverVec2& InWeftScale);
95
96 UE_DEPRECATED(5.6, "No longer supported, use new constructors instead")
97 CHAOS_API FXPBDAnisotropicEdgeSpringConstraints(
98 const FSolverParticles& InParticles,
99 int32 InParticleOffset,
100 int32 InParticleCount,
101 const FTriangleMesh& TriangleMesh,
102 const TArray<TVec3<FVec2f>>& FaceVertexPatternPositions,
103 bool bUse3dRestLengths,
104 const TConstArrayView<FRealSingle>& StiffnessWarpMultipliers,
105 const TConstArrayView<FRealSingle>& StiffnessWeftMultipliers,
106 const TConstArrayView<FRealSingle>& StiffnessBiasMultipliers,
107 const TConstArrayView<FRealSingle>& DampingMultipliers,
108 const TConstArrayView<FRealSingle>& WarpScaleMultipliers,
109 const TConstArrayView<FRealSingle>& WeftScaleMultipliers,
110 const FSolverVec2& InStiffnessWarp,
111 const FSolverVec2& InStiffnessWeft,
112 const FSolverVec2& InStiffnessBias,
113 const FSolverVec2& InDampingRatio,
114 const FSolverVec2& InWarpScale,
115 const FSolverVec2& InWeftScale);
116
117 virtual ~FXPBDAnisotropicEdgeSpringConstraints() override {}
118
119 void Init()
120 {
121 Lambdas.Reset();
122 Lambdas.AddZeroed(Constraints.Num());
123 LambdasDamping.Reset();
124 LambdasDamping.AddZeroed(Constraints.Num());
125 }
126
127 // Update rest lengths from warp/weft scale
128 void ApplyProperties(const FSolverReal /*Dt*/, const int32 /*NumIterations*/)
129 {
130 bool bWarpScaleChanged = false;
131 WarpScale.ApplyValues(&bWarpScaleChanged);
132 bool bWeftScaleChanged = false;
133 WeftScale.ApplyValues(&bWeftScaleChanged);
134 if (bWarpScaleChanged || bWeftScaleChanged)
135 {
136 // Need to update distances
137 UpdateDists();
138 }
139 }
140
141 template<typename SolverParticlesOrRange>
142 CHAOS_API void Apply(SolverParticlesOrRange& Particles, const FSolverReal Dt) const;
143
144 CHAOS_API void UpdateLinearSystem(const FSolverParticlesRange& Particles, const FSolverReal Dt, FEvolutionLinearSystem& LinearSystem) const;
145
146 const TArray<int32>& GetConstraintsPerColorStartIndex() const { return ConstraintsPerColorStartIndex; }
147 const TArray<FSolverVec3>& GetWarpWeftBiasBaseMultipliers() const { return WarpWeftBiasBaseMultipliers; }
148
154
155private:
156 template<typename SolverParticlesOrRange>
157 void InitColor(const SolverParticlesOrRange& InParticles);
158
159 void InitFromPatternData(int32 ParticlesSize, bool bUse3dRestLengths, const TArray<TVec3<FVec2f>>& FaceVertexPatternPositions, const FTriangleMesh& TriangleMesh, bool bSavePreResizedSimPosition3D, const TArray<FVector3f>& PreResizedSimPosition3D, FSolverReal MeshScale);
160
161 CHAOS_API void UpdateDists();
162
163 template<bool bDampingBefore, bool bSingleLambda, bool bSeparateStretch, bool bDampingAfter, typename SolverParticlesOrRange>
164 void ApplyHelper(SolverParticlesOrRange& Particles, const FSolverReal Dt, const int32 ConstraintIndex, const FSolverVec3& StiffnessValue, const FSolverReal DampingRatioValue) const;
165
166 using Base::Constraints;
167 using Base::ParticleOffset;
168 using Base::ParticleCount;
169 using Base::Dists; // These will be updated when Warp/Weft Scales change.
170
171 FPBDFlatWeightMap StiffnessWarp;
172 FPBDFlatWeightMap StiffnessWeft;
173 FPBDFlatWeightMap StiffnessBias;
174 FPBDFlatWeightMap DampingRatio;
175 FPBDWeightMap WarpScale;
176 FPBDWeightMap WeftScale;
177
178 mutable TArray<FSolverReal> Lambdas;
179 mutable TArray<FSolverReal> LambdasDamping;
180 TArray<FSolverReal> BaseDists; // Without Warp/Weft Scale applied
181 TArray<FSolverVec3> WarpWeftBiasBaseMultipliers;
182 TArray<FSolverVec2> WarpWeftScaleBaseMultipliers;
183 TArray<int32> ConstraintsPerColorStartIndex; // Constraints are ordered so each batch is contiguous. This is ColorNum + 1 length so it can be used as start and end.
184
185 friend class FXPBDAnisotropicSpringConstraints;
186};
187
188class FXPBDAnisotropicAxialSpringConstraints : public FPBDAxialSpringConstraintsBase
189{
190 typedef FPBDAxialSpringConstraintsBase Base;
191
192public:
193 // Stiffness is in kg /s^2
194 static constexpr FSolverReal MinStiffness = (FSolverReal)0; // We're not checking against MinStiffness (except when it's constant and == 0)
195 static constexpr FSolverReal MaxStiffness = (FSolverReal)1e9;
196 static constexpr FSolverReal MinDampingRatio = (FSolverReal)0.;
197 static constexpr FSolverReal MaxDampingRatio = (FSolverReal)1000.;
198 static constexpr FSolverReal MinWarpWeftScale = (FSolverReal)0.;
199 static constexpr FSolverReal MaxWarpWeftScale = (FSolverReal)1e7; // No particular reason for this number. Just can't imagine wanting something bigger?
200
201 CHAOS_API FXPBDAnisotropicAxialSpringConstraints(
202 const FSolverParticlesRange& Particles,
203 const FTriangleMesh& TriangleMesh,
204 const TArray<TVec3<FVec2f>>& FaceVertexPatternPositions,
205 bool bUse3dRestLengths,
206 bool bSavePreResizedSimPosition3D,
207 const TArray<FVector3f>& PreResizedSimPosition3D,
208 FSolverReal MeshScale,
209 const TConstArrayView<FRealSingle>& StiffnessWarpMultipliers,
210 const TConstArrayView<FRealSingle>& StiffnessWeftMultipliers,
211 const TConstArrayView<FRealSingle>& StiffnessBiasMultipliers,
212 const TConstArrayView<FRealSingle>& DampingMultipliers,
213 const TConstArrayView<FRealSingle>& WarpScaleMultipliers,
214 const TConstArrayView<FRealSingle>& WeftScaleMultipliers,
215 const FSolverVec2& InStiffnessWarp,
216 const FSolverVec2& InStiffnessWeft,
217 const FSolverVec2& InStiffnessBias,
218 const FSolverVec2& InDampingRatio,
219 const FSolverVec2& InWarpScale,
220 const FSolverVec2& InWeftScale);
221
222 CHAOS_API FXPBDAnisotropicAxialSpringConstraints(
223 const FSolverParticles& InParticles,
224 int32 InParticleOffset,
225 int32 InParticleCount,
226 const FTriangleMesh& TriangleMesh,
227 const TArray<TVec3<FVec2f>>& FaceVertexPatternPositions,
228 bool bUse3dRestLengths,
229 bool bSavePreResizedSimPosition3D,
230 const TArray<FVector3f>& PreResizedSimPosition3D,
231 FSolverReal MeshScale,
232 const TConstArrayView<FRealSingle>& StiffnessWarpMultipliers,
233 const TConstArrayView<FRealSingle>& StiffnessWeftMultipliers,
234 const TConstArrayView<FRealSingle>& StiffnessBiasMultipliers,
235 const TConstArrayView<FRealSingle>& DampingMultipliers,
236 const TConstArrayView<FRealSingle>& WarpScaleMultipliers,
237 const TConstArrayView<FRealSingle>& WeftScaleMultipliers,
238 const FSolverVec2& InStiffnessWarp,
239 const FSolverVec2& InStiffnessWeft,
240 const FSolverVec2& InStiffnessBias,
241 const FSolverVec2& InDampingRatio,
242 const FSolverVec2& InWarpScale,
243 const FSolverVec2& InWeftScale);
244
245 UE_DEPRECATED(5.6, "No longer supported, use new constructors instead")
246 CHAOS_API FXPBDAnisotropicAxialSpringConstraints(
247 const FSolverParticlesRange& Particles,
248 const FTriangleMesh& TriangleMesh,
249 const TArray<TVec3<FVec2f>>& FaceVertexPatternPositions,
250 bool bUse3dRestLengths,
251 const TConstArrayView<FRealSingle>& StiffnessWarpMultipliers,
252 const TConstArrayView<FRealSingle>& StiffnessWeftMultipliers,
253 const TConstArrayView<FRealSingle>& StiffnessBiasMultipliers,
254 const TConstArrayView<FRealSingle>& DampingMultipliers,
255 const TConstArrayView<FRealSingle>& WarpScaleMultipliers,
256 const TConstArrayView<FRealSingle>& WeftScaleMultipliers,
257 const FSolverVec2& InStiffnessWarp,
258 const FSolverVec2& InStiffnessWeft,
259 const FSolverVec2& InStiffnessBias,
260 const FSolverVec2& InDampingRatio,
261 const FSolverVec2& InWarpScale,
262 const FSolverVec2& InWeftScale);
263
264 UE_DEPRECATED(5.6, "No longer supported, use new constructors instead")
265 CHAOS_API FXPBDAnisotropicAxialSpringConstraints(
266 const FSolverParticles& InParticles,
267 int32 InParticleOffset,
268 int32 InParticleCount,
269 const FTriangleMesh& TriangleMesh,
270 const TArray<TVec3<FVec2f>>& FaceVertexPatternPositions,
271 bool bUse3dRestLengths,
272 const TConstArrayView<FRealSingle>& StiffnessWarpMultipliers,
273 const TConstArrayView<FRealSingle>& StiffnessWeftMultipliers,
274 const TConstArrayView<FRealSingle>& StiffnessBiasMultipliers,
275 const TConstArrayView<FRealSingle>& DampingMultipliers,
276 const TConstArrayView<FRealSingle>& WarpScaleMultipliers,
277 const TConstArrayView<FRealSingle>& WeftScaleMultipliers,
278 const FSolverVec2& InStiffnessWarp,
279 const FSolverVec2& InStiffnessWeft,
280 const FSolverVec2& InStiffnessBias,
281 const FSolverVec2& InDampingRatio,
282 const FSolverVec2& InWarpScale,
283 const FSolverVec2& InWeftScale);
284
285 virtual ~FXPBDAnisotropicAxialSpringConstraints() override {}
286
287 void Init()
288 {
289 Lambdas.Reset();
290 Lambdas.AddZeroed(Constraints.Num());
291 LambdasDamping.Reset();
292 LambdasDamping.AddZeroed(Constraints.Num());
293 }
294
295 // Update rest lengths from warp/weft scale
296 void ApplyProperties(const FSolverReal /*Dt*/, const int32 /*NumIterations*/)
297 {
298 bool bWarpScaleChanged = false;
299 WarpScale.ApplyValues(&bWarpScaleChanged);
300 bool bWeftScaleChanged = false;
301 WeftScale.ApplyValues(&bWeftScaleChanged);
302 if (bWarpScaleChanged || bWeftScaleChanged)
303 {
304 // Need to update distances
305 UpdateDists();
306 }
307 }
308
309 template<typename SolverParticlesOrRange>
310 CHAOS_API void Apply(SolverParticlesOrRange& Particles, const FSolverReal Dt) const;
311
312 CHAOS_API void UpdateLinearSystem(const FSolverParticlesRange& Particles, const FSolverReal Dt, FEvolutionLinearSystem& LinearSystem) const;
313
314 const TArray<int32>& GetConstraintsPerColorStartIndex() const { return ConstraintsPerColorStartIndex; }
315 const TArray<FSolverVec3>& GetWarpWeftBiasBaseMultipliers() const { return WarpWeftBiasBaseMultipliers; }
316
322
323private:
324 template<typename SolverParticlesOrRange>
325 void InitColor(const SolverParticlesOrRange& InParticles);
326
327 void InitFromPatternData(int32 ParticlesSize, bool bUse3dRestLengths, const TArray<TVec3<FVec2f>>& FaceVertexPatternPositions, const FTriangleMesh& TriangleMesh, bool bSavePreResizedSimPosition3D, const TArray<FVector3f>& PreResizedSimPosition3D, FSolverReal MeshScale);
328
329 CHAOS_API void UpdateDists();
330
331 template<bool bDampingBefore, bool bSingleLambda, bool bSeparateStretch, bool bDampingAfter, typename SolverParticlesOrRange>
332 void ApplyHelper(SolverParticlesOrRange& Particles, const FSolverReal Dt, const int32 ConstraintIndex, const FSolverVec3& StiffnessValue, const FSolverReal DampingRatioValue) const;
333
334 using Base::Constraints;
335 using Base::ParticleOffset;
336 using Base::ParticleCount;
337 using Base::Barys;
338 using Base::Dists; // These will be updated when Warp/Weft Scales change.
339
340 FPBDFlatWeightMap StiffnessWarp;
341 FPBDFlatWeightMap StiffnessWeft;
342 FPBDFlatWeightMap StiffnessBias;
343 FPBDFlatWeightMap DampingRatio;
344 FPBDWeightMap WarpScale;
345 FPBDWeightMap WeftScale;
346
347 mutable TArray<FSolverReal> Lambdas;
348 mutable TArray<FSolverReal> LambdasDamping;
349 TArray<FSolverReal> BaseDists; // Without Warp/Weft Scale applied
350 TArray<FSolverVec3> WarpWeftBiasBaseMultipliers;
351 TArray<FSolverVec2> WarpWeftScaleBaseMultipliers;
352 TArray<int32> ConstraintsPerColorStartIndex; // Constraints are ordered so each batch is contiguous. This is ColorNum + 1 length so it can be used as start and end.
353
354 friend class FXPBDAnisotropicSpringConstraints;
355
356};
357
358class FXPBDAnisotropicSpringConstraints final
359{
360public:
361 static constexpr FSolverReal DefaultStiffness = (FSolverReal)100.;
362 static constexpr FSolverReal DefaultDamping = (FSolverReal)1.;
363 static constexpr bool bDefaultUse3dRestLengths = true;
364 static constexpr FSolverReal DefaultWarpWeftScale = (FSolverReal)1.;
365 static constexpr bool bDefaultSavePreResizedSimPosition3D = false;
366
371
372 FXPBDAnisotropicSpringConstraints(
373 const FSolverParticlesRange& Particles,
374 const FTriangleMesh& TriangleMesh,
375 const TArray<TVec3<FVec2f>>& FaceVertexPatternPositions,
376 const TMap<FString, TConstArrayView<FRealSingle>>& WeightMaps,
377 const FCollectionPropertyConstFacade& PropertyCollection,
378 const TArray<FVector3f>& PreResizedSimPosition3D,
379 Softs::FSolverReal MeshScale)
380 : EdgeConstraints(
381 Particles,
382 TriangleMesh,
383 FaceVertexPatternPositions,
384 GetXPBDAnisoSpringUse3dRestLengths(PropertyCollection, bDefaultUse3dRestLengths),
385 GetSavePreResizedSimPosition3D(PropertyCollection, bDefaultSavePreResizedSimPosition3D),
386 PreResizedSimPosition3D,
387 MeshScale,
388 WeightMaps.FindRef(GetXPBDAnisoSpringStiffnessWarpString(PropertyCollection, XPBDAnisoSpringStiffnessWarpName.ToString())),
389 WeightMaps.FindRef(GetXPBDAnisoSpringStiffnessWeftString(PropertyCollection, XPBDAnisoSpringStiffnessWeftName.ToString())),
390 WeightMaps.FindRef(GetXPBDAnisoSpringStiffnessBiasString(PropertyCollection, XPBDAnisoSpringStiffnessBiasName.ToString())),
391 WeightMaps.FindRef(GetXPBDAnisoSpringDampingString(PropertyCollection, XPBDAnisoSpringDampingName.ToString())),
392 WeightMaps.FindRef(GetXPBDAnisoSpringWarpScaleString(PropertyCollection, XPBDAnisoSpringWarpScaleName.ToString())),
393 WeightMaps.FindRef(GetXPBDAnisoSpringWeftScaleString(PropertyCollection, XPBDAnisoSpringWeftScaleName.ToString())),
394 FSolverVec2(GetWeightedFloatXPBDAnisoSpringStiffnessWarp(PropertyCollection, DefaultStiffness)),
395 FSolverVec2(GetWeightedFloatXPBDAnisoSpringStiffnessWeft(PropertyCollection, DefaultStiffness)),
396 FSolverVec2(GetWeightedFloatXPBDAnisoSpringStiffnessBias(PropertyCollection, DefaultStiffness)),
397 FSolverVec2(GetWeightedFloatXPBDAnisoSpringDamping(PropertyCollection, DefaultDamping)),
398 FSolverVec2(GetWeightedFloatXPBDAnisoSpringWarpScale(PropertyCollection, DefaultWarpWeftScale)),
399 FSolverVec2(GetWeightedFloatXPBDAnisoSpringWeftScale(PropertyCollection, DefaultWarpWeftScale)))
400 , AxialConstraints(
401 Particles,
402 TriangleMesh,
403 FaceVertexPatternPositions,
404 GetXPBDAnisoSpringUse3dRestLengths(PropertyCollection, bDefaultUse3dRestLengths),
405 GetSavePreResizedSimPosition3D(PropertyCollection, bDefaultSavePreResizedSimPosition3D),
406 PreResizedSimPosition3D,
407 MeshScale,
408 WeightMaps.FindRef(GetXPBDAnisoSpringStiffnessWarpString(PropertyCollection, XPBDAnisoSpringStiffnessWarpName.ToString())),
409 WeightMaps.FindRef(GetXPBDAnisoSpringStiffnessWeftString(PropertyCollection, XPBDAnisoSpringStiffnessWeftName.ToString())),
410 WeightMaps.FindRef(GetXPBDAnisoSpringStiffnessBiasString(PropertyCollection, XPBDAnisoSpringStiffnessBiasName.ToString())),
411 WeightMaps.FindRef(GetXPBDAnisoSpringDampingString(PropertyCollection, XPBDAnisoSpringDampingName.ToString())),
412 WeightMaps.FindRef(GetXPBDAnisoSpringWarpScaleString(PropertyCollection, XPBDAnisoSpringWarpScaleName.ToString())),
413 WeightMaps.FindRef(GetXPBDAnisoSpringWeftScaleString(PropertyCollection, XPBDAnisoSpringWeftScaleName.ToString())),
414 FSolverVec2(GetWeightedFloatXPBDAnisoSpringStiffnessWarp(PropertyCollection, DefaultStiffness)),
415 FSolverVec2(GetWeightedFloatXPBDAnisoSpringStiffnessWeft(PropertyCollection, DefaultStiffness)),
416 FSolverVec2(GetWeightedFloatXPBDAnisoSpringStiffnessBias(PropertyCollection, DefaultStiffness)),
417 FSolverVec2(GetWeightedFloatXPBDAnisoSpringDamping(PropertyCollection, DefaultDamping)),
418 FSolverVec2(GetWeightedFloatXPBDAnisoSpringWarpScale(PropertyCollection, DefaultWarpWeftScale)),
419 FSolverVec2(GetWeightedFloatXPBDAnisoSpringWeftScale(PropertyCollection, DefaultWarpWeftScale)))
420 , XPBDAnisoSpringUse3dRestLengthsIndex(PropertyCollection)
421 , XPBDAnisoSpringStiffnessWarpIndex(PropertyCollection)
422 , XPBDAnisoSpringStiffnessWeftIndex(PropertyCollection)
423 , XPBDAnisoSpringStiffnessBiasIndex(PropertyCollection)
424 , XPBDAnisoSpringDampingIndex(PropertyCollection)
425 , XPBDAnisoSpringWarpScaleIndex(PropertyCollection)
426 , XPBDAnisoSpringWeftScaleIndex(PropertyCollection)
427 , SavePreResizedSimPosition3DIndex(PropertyCollection)
428 {}
429
430 FXPBDAnisotropicSpringConstraints(
431 const FSolverParticles& InParticles,
432 int32 InParticleOffset,
433 int32 InParticleCount,
434 const FTriangleMesh& TriangleMesh,
435 const TArray<TVec3<FVec2f>>& FaceVertexPatternPositions,
436 const TMap<FString, TConstArrayView<FRealSingle>>& WeightMaps,
437 const FCollectionPropertyConstFacade& PropertyCollection,
438 const TArray<FVector3f>& PreResizedSimPosition3D,
439 Softs::FSolverReal MeshScale)
440 : EdgeConstraints(
441 InParticles,
442 InParticleOffset,
443 InParticleCount,
444 TriangleMesh,
445 FaceVertexPatternPositions,
446 GetXPBDAnisoSpringUse3dRestLengths(PropertyCollection, bDefaultUse3dRestLengths),
447 GetSavePreResizedSimPosition3D(PropertyCollection, bDefaultSavePreResizedSimPosition3D),
448 PreResizedSimPosition3D,
449 MeshScale,
450 WeightMaps.FindRef(GetXPBDAnisoSpringStiffnessWarpString(PropertyCollection, XPBDAnisoSpringStiffnessWarpName.ToString())),
451 WeightMaps.FindRef(GetXPBDAnisoSpringStiffnessWeftString(PropertyCollection, XPBDAnisoSpringStiffnessWeftName.ToString())),
452 WeightMaps.FindRef(GetXPBDAnisoSpringStiffnessBiasString(PropertyCollection, XPBDAnisoSpringStiffnessBiasName.ToString())),
453 WeightMaps.FindRef(GetXPBDAnisoSpringDampingString(PropertyCollection, XPBDAnisoSpringDampingName.ToString())),
454 WeightMaps.FindRef(GetXPBDAnisoSpringWarpScaleString(PropertyCollection, XPBDAnisoSpringWarpScaleName.ToString())),
455 WeightMaps.FindRef(GetXPBDAnisoSpringWeftScaleString(PropertyCollection, XPBDAnisoSpringWeftScaleName.ToString())),
456 FSolverVec2(GetWeightedFloatXPBDAnisoSpringStiffnessWarp(PropertyCollection, DefaultStiffness)),
457 FSolverVec2(GetWeightedFloatXPBDAnisoSpringStiffnessWeft(PropertyCollection, DefaultStiffness)),
458 FSolverVec2(GetWeightedFloatXPBDAnisoSpringStiffnessBias(PropertyCollection, DefaultStiffness)),
459 FSolverVec2(GetWeightedFloatXPBDAnisoSpringDamping(PropertyCollection, DefaultDamping)),
460 FSolverVec2(GetWeightedFloatXPBDAnisoSpringWarpScale(PropertyCollection, DefaultWarpWeftScale)),
461 FSolverVec2(GetWeightedFloatXPBDAnisoSpringWeftScale(PropertyCollection, DefaultWarpWeftScale)))
462 , AxialConstraints(
463 InParticles,
464 InParticleOffset,
465 InParticleCount,
466 TriangleMesh,
467 FaceVertexPatternPositions,
468 GetXPBDAnisoSpringUse3dRestLengths(PropertyCollection, bDefaultUse3dRestLengths),
469 GetSavePreResizedSimPosition3D(PropertyCollection, bDefaultSavePreResizedSimPosition3D),
470 PreResizedSimPosition3D,
471 MeshScale,
472 WeightMaps.FindRef(GetXPBDAnisoSpringStiffnessWarpString(PropertyCollection, XPBDAnisoSpringStiffnessWarpName.ToString())),
473 WeightMaps.FindRef(GetXPBDAnisoSpringStiffnessWeftString(PropertyCollection, XPBDAnisoSpringStiffnessWeftName.ToString())),
474 WeightMaps.FindRef(GetXPBDAnisoSpringStiffnessBiasString(PropertyCollection, XPBDAnisoSpringStiffnessBiasName.ToString())),
475 WeightMaps.FindRef(GetXPBDAnisoSpringDampingString(PropertyCollection, XPBDAnisoSpringDampingName.ToString())),
476 WeightMaps.FindRef(GetXPBDAnisoSpringWarpScaleString(PropertyCollection, XPBDAnisoSpringWarpScaleName.ToString())),
477 WeightMaps.FindRef(GetXPBDAnisoSpringWeftScaleString(PropertyCollection, XPBDAnisoSpringWeftScaleName.ToString())),
478 FSolverVec2(GetWeightedFloatXPBDAnisoSpringStiffnessWarp(PropertyCollection, DefaultStiffness)),
479 FSolverVec2(GetWeightedFloatXPBDAnisoSpringStiffnessWeft(PropertyCollection, DefaultStiffness)),
480 FSolverVec2(GetWeightedFloatXPBDAnisoSpringStiffnessBias(PropertyCollection, DefaultStiffness)),
481 FSolverVec2(GetWeightedFloatXPBDAnisoSpringDamping(PropertyCollection, DefaultDamping)),
482 FSolverVec2(GetWeightedFloatXPBDAnisoSpringWarpScale(PropertyCollection, DefaultWarpWeftScale)),
483 FSolverVec2(GetWeightedFloatXPBDAnisoSpringWeftScale(PropertyCollection, DefaultWarpWeftScale)))
484 , XPBDAnisoSpringUse3dRestLengthsIndex(PropertyCollection)
485 , XPBDAnisoSpringStiffnessWarpIndex(PropertyCollection)
486 , XPBDAnisoSpringStiffnessWeftIndex(PropertyCollection)
487 , XPBDAnisoSpringStiffnessBiasIndex(PropertyCollection)
488 , XPBDAnisoSpringDampingIndex(PropertyCollection)
489 , XPBDAnisoSpringWarpScaleIndex(PropertyCollection)
490 , XPBDAnisoSpringWeftScaleIndex(PropertyCollection)
491 , SavePreResizedSimPosition3DIndex(PropertyCollection)
492 {}
493
494 CHAOS_API void SetProperties(
495 const FCollectionPropertyConstFacade& PropertyCollection,
496 const TMap<FString, TConstArrayView<FRealSingle>>& WeightMaps);
497
498 // Update rest lengths from warp/weft scale
499 void ApplyProperties(const FSolverReal Dt, const int32 NumIterations)
500 {
501 EdgeConstraints.ApplyProperties(Dt, NumIterations);
502 AxialConstraints.ApplyProperties(Dt, NumIterations);
503 }
504
505 void Init()
506 {
507 EdgeConstraints.Init();
508 AxialConstraints.Init();
509 }
510
511 const FXPBDAnisotropicEdgeSpringConstraints& GetEdgeConstraints() const { return EdgeConstraints; }
512 const FXPBDAnisotropicAxialSpringConstraints& GetAxialConstraints() const { return AxialConstraints; }
513
514 void ResetRestLengths(const TConstArrayView<FSolverVec3>& Positions)
515 {
516 EdgeConstraints.ResetRestLengths(Positions);
517 AxialConstraints.ResetRestLengths(Positions);
518 }
519
520private:
521 FXPBDAnisotropicEdgeSpringConstraints EdgeConstraints;
522 FXPBDAnisotropicAxialSpringConstraints AxialConstraints;
523
524 UE_CHAOS_DECLARE_PROPERTYCOLLECTION_NAME(XPBDAnisoSpringUse3dRestLengths, bool);
525 UE_CHAOS_DECLARE_PROPERTYCOLLECTION_NAME(XPBDAnisoSpringStiffnessWarp, float);
526 UE_CHAOS_DECLARE_PROPERTYCOLLECTION_NAME(XPBDAnisoSpringStiffnessWeft, float);
527 UE_CHAOS_DECLARE_PROPERTYCOLLECTION_NAME(XPBDAnisoSpringStiffnessBias, float);
528 UE_CHAOS_DECLARE_PROPERTYCOLLECTION_NAME(XPBDAnisoSpringDamping, float);
529 UE_CHAOS_DECLARE_PROPERTYCOLLECTION_NAME(XPBDAnisoSpringWarpScale, float);
530 UE_CHAOS_DECLARE_PROPERTYCOLLECTION_NAME(XPBDAnisoSpringWeftScale, float);
531 UE_CHAOS_DECLARE_PROPERTYCOLLECTION_NAME(SavePreResizedSimPosition3D, bool);
532};
533
534} // End namespace Chaos::Softs
535
UE_CHAOS_DECLARE_PROPERTYCOLLECTION_NAME
#define UE_CHAOS_DECLARE_PROPERTYCOLLECTION_NAME(PropertyName, Type)
Definition CollectionPropertyFacade.h:969
UE_DEPRECATED
#define UE_DEPRECATED(Version, Message)
Definition CoreMiscDefines.h:302
int32
FPlatformTypes::int32 int32
A 32-bit signed integer.
Definition Platform.h:1125
StaticCastSharedRef
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
Chaos::FTriangleMesh
Definition TriangleMesh.h:24
Chaos::Private::FCollisionParticlePairKey
Definition CollisionKeys.h:59
Chaos::Softs::FCollectionPropertyConstFacade
Definition CollectionPropertyFacade.h:49
Chaos::Softs::FEvolutionLinearSystem
Definition SoftsEvolutionLinearSystem.h:45
Chaos::Softs::FPBDAxialSpringConstraintsBase
Definition PBDAxialSpringConstraintsBase.h:16
Chaos::Softs::FPBDAxialSpringConstraintsBase::Dists
TArray< FSolverReal > Dists
Definition PBDAxialSpringConstraintsBase.h:246
Chaos::Softs::FPBDAxialSpringConstraintsBase::Barys
TArray< FSolverReal > Barys
Definition PBDAxialSpringConstraintsBase.h:245
Chaos::Softs::FPBDAxialSpringConstraintsBase::ParticleCount
const int32 ParticleCount
Definition PBDAxialSpringConstraintsBase.h:244
Chaos::Softs::FPBDAxialSpringConstraintsBase::Constraints
TArray< TVec3< int32 > > Constraints
Definition PBDAxialSpringConstraintsBase.h:242
Chaos::Softs::FPBDAxialSpringConstraintsBase::CalculateRestLengths
void CalculateRestLengths(const TConstArrayView< FSolverVec3 > &Positions, const TArrayView< FSolverReal > &DistsToCompute) const
Definition PBDAxialSpringConstraintsBase.h:91
Chaos::Softs::FPBDAxialSpringConstraintsBase::ParticleOffset
const int32 ParticleOffset
Definition PBDAxialSpringConstraintsBase.h:243
Chaos::Softs::FPBDFlatWeightMap
Definition PBDFlatWeightMap.h:98
Chaos::Softs::FPBDSpringConstraintsBase
Definition PBDSpringConstraintsBase.h:17
Chaos::Softs::FPBDSpringConstraintsBase::CalculateRestLengths
void CalculateRestLengths(const TConstArrayView< FSolverVec3 > &Positions, const TArrayView< FSolverReal > &DistsToCompute) const
Definition PBDSpringConstraintsBase.h:120
Chaos::Softs::FPBDSpringConstraintsBase::ParticleCount
const int32 ParticleCount
Definition PBDSpringConstraintsBase.h:159
Chaos::Softs::FPBDSpringConstraintsBase::ParticleOffset
const int32 ParticleOffset
Definition PBDSpringConstraintsBase.h:158
Chaos::Softs::FPBDSpringConstraintsBase::Dists
TArray< FSolverReal > Dists
Definition PBDSpringConstraintsBase.h:157
Chaos::Softs::FPBDSpringConstraintsBase::Constraints
TArray< TVec2< int32 > > Constraints
Definition PBDSpringConstraintsBase.h:156
Chaos::Softs::FPBDWeightMap
Definition PBDWeightMap.h:19
Chaos::Softs::FPBDWeightMap::ApplyValues
void ApplyValues(bool *bOutUpdated=nullptr)
Definition PBDWeightMap.h:71
Chaos::Softs::FSolverParticlesRange
Definition SoftsSolverParticlesRange.h:12
Chaos::Softs::FSolverParticles
Definition PBDSoftsSolverParticles.h:20
Chaos::Softs::FXPBDAnisotropicAxialSpringConstraints
Definition XPBDAnisotropicSpringConstraints.h:189
Chaos::Softs::FXPBDAnisotropicAxialSpringConstraints::UpdateLinearSystem
CHAOS_API void UpdateLinearSystem(const FSolverParticlesRange &Particles, const FSolverReal Dt, FEvolutionLinearSystem &LinearSystem) const
Definition XPBDAnisotropicSpringConstraints.cpp:2025
Chaos::Softs::FXPBDAnisotropicAxialSpringConstraints::GetWarpWeftBiasBaseMultipliers
const TArray< FSolverVec3 > & GetWarpWeftBiasBaseMultipliers() const
Definition XPBDAnisotropicSpringConstraints.h:315
Chaos::Softs::FXPBDAnisotropicAxialSpringConstraints::MaxWarpWeftScale
static constexpr FSolverReal MaxWarpWeftScale
Definition XPBDAnisotropicSpringConstraints.h:199
Chaos::Softs::FXPBDAnisotropicAxialSpringConstraints::ApplyProperties
void ApplyProperties(const FSolverReal, const int32)
Definition XPBDAnisotropicSpringConstraints.h:296
Chaos::Softs::FXPBDAnisotropicAxialSpringConstraints::ResetRestLengths
void ResetRestLengths(const TConstArrayView< FSolverVec3 > &Positions)
Definition XPBDAnisotropicSpringConstraints.h:317
Chaos::Softs::FXPBDAnisotropicAxialSpringConstraints::Init
void Init()
Definition XPBDAnisotropicSpringConstraints.h:287
Chaos::Softs::FXPBDAnisotropicAxialSpringConstraints::Apply
CHAOS_API void Apply(SolverParticlesOrRange &Particles, const FSolverReal Dt) const
Chaos::Softs::FXPBDAnisotropicAxialSpringConstraints::MinDampingRatio
static constexpr FSolverReal MinDampingRatio
Definition XPBDAnisotropicSpringConstraints.h:196
Chaos::Softs::FXPBDAnisotropicAxialSpringConstraints::MinWarpWeftScale
static constexpr FSolverReal MinWarpWeftScale
Definition XPBDAnisotropicSpringConstraints.h:198
Chaos::Softs::FXPBDAnisotropicAxialSpringConstraints::GetConstraintsPerColorStartIndex
const TArray< int32 > & GetConstraintsPerColorStartIndex() const
Definition XPBDAnisotropicSpringConstraints.h:314
Chaos::Softs::FXPBDAnisotropicAxialSpringConstraints::MaxStiffness
static constexpr FSolverReal MaxStiffness
Definition XPBDAnisotropicSpringConstraints.h:195
Chaos::Softs::FXPBDAnisotropicAxialSpringConstraints::MaxDampingRatio
static constexpr FSolverReal MaxDampingRatio
Definition XPBDAnisotropicSpringConstraints.h:197
Chaos::Softs::FXPBDAnisotropicAxialSpringConstraints::MinStiffness
static constexpr FSolverReal MinStiffness
Definition XPBDAnisotropicSpringConstraints.h:194
Chaos::Softs::FXPBDAnisotropicEdgeSpringConstraints
Definition XPBDAnisotropicSpringConstraints.h:21
Chaos::Softs::FXPBDAnisotropicEdgeSpringConstraints::ApplyProperties
void ApplyProperties(const FSolverReal, const int32)
Definition XPBDAnisotropicSpringConstraints.h:128
Chaos::Softs::FXPBDAnisotropicEdgeSpringConstraints::MinWarpWeftScale
static constexpr FSolverReal MinWarpWeftScale
Definition XPBDAnisotropicSpringConstraints.h:30
Chaos::Softs::FXPBDAnisotropicEdgeSpringConstraints::GetWarpWeftBiasBaseMultipliers
const TArray< FSolverVec3 > & GetWarpWeftBiasBaseMultipliers() const
Definition XPBDAnisotropicSpringConstraints.h:147
Chaos::Softs::FXPBDAnisotropicEdgeSpringConstraints::MaxWarpWeftScale
static constexpr FSolverReal MaxWarpWeftScale
Definition XPBDAnisotropicSpringConstraints.h:31
Chaos::Softs::FXPBDAnisotropicEdgeSpringConstraints::GetConstraintsPerColorStartIndex
const TArray< int32 > & GetConstraintsPerColorStartIndex() const
Definition XPBDAnisotropicSpringConstraints.h:146
Chaos::Softs::FXPBDAnisotropicEdgeSpringConstraints::MaxStiffness
static constexpr FSolverReal MaxStiffness
Definition XPBDAnisotropicSpringConstraints.h:27
Chaos::Softs::FXPBDAnisotropicEdgeSpringConstraints::MaxDampingRatio
static constexpr FSolverReal MaxDampingRatio
Definition XPBDAnisotropicSpringConstraints.h:29
Chaos::Softs::FXPBDAnisotropicEdgeSpringConstraints::Init
void Init()
Definition XPBDAnisotropicSpringConstraints.h:119
Chaos::Softs::FXPBDAnisotropicEdgeSpringConstraints::MinDampingRatio
static constexpr FSolverReal MinDampingRatio
Definition XPBDAnisotropicSpringConstraints.h:28
Chaos::Softs::FXPBDAnisotropicEdgeSpringConstraints::MinStiffness
static constexpr FSolverReal MinStiffness
Definition XPBDAnisotropicSpringConstraints.h:26
Chaos::Softs::FXPBDAnisotropicEdgeSpringConstraints::UpdateLinearSystem
CHAOS_API void UpdateLinearSystem(const FSolverParticlesRange &Particles, const FSolverReal Dt, FEvolutionLinearSystem &LinearSystem) const
Definition XPBDAnisotropicSpringConstraints.cpp:983
Chaos::Softs::FXPBDAnisotropicEdgeSpringConstraints::ResetRestLengths
void ResetRestLengths(const TConstArrayView< FSolverVec3 > &Positions)
Definition XPBDAnisotropicSpringConstraints.h:149
Chaos::Softs::FXPBDAnisotropicEdgeSpringConstraints::Apply
CHAOS_API void Apply(SolverParticlesOrRange &Particles, const FSolverReal Dt) const
Chaos::Softs::FXPBDAnisotropicSpringConstraints
Definition XPBDAnisotropicSpringConstraints.h:359
Chaos::Softs::FXPBDAnisotropicSpringConstraints::DefaultWarpWeftScale
static constexpr FSolverReal DefaultWarpWeftScale
Definition XPBDAnisotropicSpringConstraints.h:364
Chaos::Softs::FXPBDAnisotropicSpringConstraints::GetAxialConstraints
const FXPBDAnisotropicAxialSpringConstraints & GetAxialConstraints() const
Definition XPBDAnisotropicSpringConstraints.h:512
Chaos::Softs::FXPBDAnisotropicSpringConstraints::SetProperties
CHAOS_API void SetProperties(const FCollectionPropertyConstFacade &PropertyCollection, const TMap< FString, TConstArrayView< FRealSingle > > &WeightMaps)
Definition XPBDAnisotropicSpringConstraints.cpp:2120
Chaos::Softs::FXPBDAnisotropicSpringConstraints::ResetRestLengths
void ResetRestLengths(const TConstArrayView< FSolverVec3 > &Positions)
Definition XPBDAnisotropicSpringConstraints.h:514
Chaos::Softs::FXPBDAnisotropicSpringConstraints::ApplyProperties
void ApplyProperties(const FSolverReal Dt, const int32 NumIterations)
Definition XPBDAnisotropicSpringConstraints.h:499
Chaos::Softs::FXPBDAnisotropicSpringConstraints::FXPBDAnisotropicSpringConstraints
FXPBDAnisotropicSpringConstraints(const FSolverParticlesRange &Particles, const FTriangleMesh &TriangleMesh, const TArray< TVec3< FVec2f > > &FaceVertexPatternPositions, const TMap< FString, TConstArrayView< FRealSingle > > &WeightMaps, const FCollectionPropertyConstFacade &PropertyCollection, const TArray< FVector3f > &PreResizedSimPosition3D, Softs::FSolverReal MeshScale)
Definition XPBDAnisotropicSpringConstraints.h:372
Chaos::Softs::FXPBDAnisotropicSpringConstraints::bDefaultSavePreResizedSimPosition3D
static constexpr bool bDefaultSavePreResizedSimPosition3D
Definition XPBDAnisotropicSpringConstraints.h:365
Chaos::Softs::FXPBDAnisotropicSpringConstraints::Init
void Init()
Definition XPBDAnisotropicSpringConstraints.h:505
Chaos::Softs::FXPBDAnisotropicSpringConstraints::IsEnabled
static bool IsEnabled(const FCollectionPropertyConstFacade &PropertyCollection)
Definition XPBDAnisotropicSpringConstraints.h:367
Chaos::Softs::FXPBDAnisotropicSpringConstraints::DefaultDamping
static constexpr FSolverReal DefaultDamping
Definition XPBDAnisotropicSpringConstraints.h:362
Chaos::Softs::FXPBDAnisotropicSpringConstraints::bDefaultUse3dRestLengths
static constexpr bool bDefaultUse3dRestLengths
Definition XPBDAnisotropicSpringConstraints.h:363
Chaos::Softs::FXPBDAnisotropicSpringConstraints::GetEdgeConstraints
const FXPBDAnisotropicEdgeSpringConstraints & GetEdgeConstraints() const
Definition XPBDAnisotropicSpringConstraints.h:511
Chaos::Softs::FXPBDAnisotropicSpringConstraints::FXPBDAnisotropicSpringConstraints
FXPBDAnisotropicSpringConstraints(const FSolverParticles &InParticles, int32 InParticleOffset, int32 InParticleCount, const FTriangleMesh &TriangleMesh, const TArray< TVec3< FVec2f > > &FaceVertexPatternPositions, const TMap< FString, TConstArrayView< FRealSingle > > &WeightMaps, const FCollectionPropertyConstFacade &PropertyCollection, const TArray< FVector3f > &PreResizedSimPosition3D, Softs::FSolverReal MeshScale)
Definition XPBDAnisotropicSpringConstraints.h:430
Chaos::Softs::FXPBDAnisotropicSpringConstraints::DefaultStiffness
static constexpr FSolverReal DefaultStiffness
Definition XPBDAnisotropicSpringConstraints.h:361
Chaos::TVector< FRealSingle, 2 >
Definition Vector.h:823
Chaos::TVector< T, 3 >
Definition Vector.h:1000
Constraints
Definition Constraints.Build.cs:6
TArrayView
Definition ArrayView.h:139
TArray
Definition Array.h:670
TArray::Reset
void Reset(SizeType NewSize=0)
Definition Array.h:2246
TArray::AddZeroed
SizeType AddZeroed()
Definition Array.h:2755
TMap
Definition UnrealString.h.inl:34
Chaos::Softs
Definition CollectionEmbeddedSpringConstraintFacade.cpp:6
Chaos::Softs::FSolverReal
FRealSingle FSolverReal
Definition PBDSoftsEvolutionFwd.h:31
Chaos
Definition SkeletalMeshComponent.h:307
Chaos::FRealSingle
float FRealSingle
Definition Real.h:14