1. Epic GamesDeveloper
  3. FPBDLongRangeConstraintsBase

FPBDLongRangeConstraintsBase

API > API/Runtime > API/Runtime/Chaos

   
Name FPBDLongRangeConstraintsBase
Type class
Header File /Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/PBDLongRangeConstraintsBase.h
Include Path #include "Chaos/PBDLongRangeConstraintsBase.h"

Syntax

class FPBDLongRangeConstraintsBase

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FPBDLongRangeConstraintsBase ( const FSolverParticles& Particles,
const int32 InParticleOffset,
const int32 InParticleCount,
const TArray< TConstArrayView< TTuple< int32, int32, FRealSingle > > >& InTethers,
const TConstArrayView< FRealSingle >& StiffnessMultipliers,
const TConstArrayView< FRealSingle >& ScaleMultipliers,
const FSolverVec2& InStiffness,
const FSolverVec2& InScale,
FSolverReal MaxStiffness,
FSolverReal MeshScale
)

   Chaos/PBDLongRangeConstraintsBase.h  
  Chaos/PBDLongRangeConstraintsBase.h  
  Chaos/PBDLongRangeConstraintsBase.h  

FPBDLongRangeConstraintsBase ( const FSolverParticlesRange& Particles,
const TArray< TConstArrayView< TTuple< int32, int32, FRealSingle > > >& InTethers,
const TConstArrayView< FRealSingle >& StiffnessMultipliers,
const TConstArrayView< FRealSingle >& ScaleMultipliers,
const FSolverVec2& InStiffness,
const FSolverVec2& InScale,
FSolverReal MaxStiffness,
FSolverReal MeshScale
)

   Chaos/PBDLongRangeConstraintsBase.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS ~FPBDLongRangeConstraintsBase()

   Chaos/PBDLongRangeConstraintsBase.h  

Typedefs

Name Type Remarks Include Path
FTether TTuple< int32, int32, FRealSingle >   Chaos/PBDLongRangeConstraintsBase.h

Constants

Name Type Remarks Include Path
MaxTetherScale FSolverReal   Chaos/PBDLongRangeConstraintsBase.h
MinTetherScale FSolverReal   Chaos/PBDLongRangeConstraintsBase.h
TableSize int32   Chaos/PBDLongRangeConstraintsBase.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ApplyProperties ( const FSolverReal Dt,
const int32 NumIterations
)

 Set stiffness offset and range, as well as the simulation stiffness exponent. Chaos/PBDLongRangeConstraintsBase.h  

int32 GetEndIndex ( const FTether& Tether
) const

 Return the end index of the specified tether. Chaos/PBDLongRangeConstraintsBase.h  

int32 GetEndParticle ( const FTether& Tether
) const

 Return the dynamic particle index of the specified tether. Chaos/PBDLongRangeConstraintsBase.h  

FSolverReal GetRefLength ( const FTether& Tether
) const

 Return the reference length of the specified tether. Chaos/PBDLongRangeConstraintsBase.h  

FSolverReal GetScale ( const FTether& Tether
) const

 Return the Tether scale for the specified tether. Chaos/PBDLongRangeConstraintsBase.h  

int32 GetStartIndex ( const FTether& Tether
) const

 Return the start index of the specified tether. Chaos/PBDLongRangeConstraintsBase.h  

int32 GetStartParticle ( const FTether& Tether
) const

 Return the kinematic particle index of the specified tether. Chaos/PBDLongRangeConstraintsBase.h  

FSolverVec2 GetStiffness()

 Return the stiffness input values used by the constraint. Chaos/PBDLongRangeConstraintsBase.h  

FSolverReal GetTargetLength ( const FTether& Tether
) const

 Return the target length of the specified tether (= RefLength * Scale) Chaos/PBDLongRangeConstraintsBase.h  

const TArray< TConstArrayView< FTether > > & GetTethers()

 Return the tethers, organized in concurent friendly batches. Chaos/PBDLongRangeConstraintsBase.h  

void SetProperties ( const FSolverVec2& InStiffness,
const FSolverVec2& InTetherScale,
FSolverReal MeshScale
)

 Set the stiffness and scale values used by the constraint. Chaos/PBDLongRangeConstraintsBase.h  

Protected

Name Remarks Include Path Unreal Specifiers

void GetDelta ( const SolverParticlesOrRange& Particles,
const FTether& Tether,
const FSolverReal InScale,
FSolverVec3& OutDirection,
FSolverReal& OutOffset
) const

 Return a direction and length representing the amount of segment required for the tether to shrink back to its maximum target length constraint, or zero if the constraint is already met. Chaos/PBDLongRangeConstraintsBase.h  

FSolverVec3 GetDelta ( const SolverParticlesOrRange& Particles,
const FTether& Tether,
const FSolverReal InScale
) const

 Return a vector representing the amount of segment required for the tether to shrink back to its maximum target length constraint, or zero if the constraint is already met. Chaos/PBDLongRangeConstraintsBase.h  

Static

Name Remarks Include Path Unreal Specifiers

static int32 GetMinParallelBatchSize()

 Return the minimum number of long range tethers in a batch to process in parallel. Chaos/PBDLongRangeConstraintsBase.h  

Operators

Name Remarks Include Path Unreal Specifiers
  Chaos/PBDLongRangeConstraintsBase.h  
  Chaos/PBDLongRangeConstraintsBase.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page