Jolt Physics
A multi core friendly Game Physics Engine
Loading...
Searching...
No Matches
SoftBodySharedSettings::Edge Struct Reference

An edge keeps two vertices at a constant distance using a spring: |x1 - x2| = rest length. More...

#include <SoftBodySharedSettings.h>

Public Member Functions

 Edge ()=default
 Constructor. More...
 
 Edge (uint32 inVertex1, uint32 inVertex2, float inCompliance=0.0f)
 
uint32 GetMinVertexIndex () const
 Return the lowest vertex index of this constraint. More...
 

Public Attributes

uint32 mVertex [2]
 Indices of the vertices that form the edge. More...
 
float mRestLength = 1.0f
 Rest length of the spring. More...
 
float mCompliance = 0.0f
 Inverse of the stiffness of the spring. More...
 

Detailed Description

An edge keeps two vertices at a constant distance using a spring: |x1 - x2| = rest length.

Constructor & Destructor Documentation

◆ Edge() [1/2]

SoftBodySharedSettings::Edge::Edge ( )
default

Constructor.

◆ Edge() [2/2]

SoftBodySharedSettings::Edge::Edge ( uint32  inVertex1,
uint32  inVertex2,
float  inCompliance = 0.0f 
)
inline

Member Function Documentation

◆ GetMinVertexIndex()

uint32 SoftBodySharedSettings::Edge::GetMinVertexIndex ( ) const
inline

Return the lowest vertex index of this constraint.

Member Data Documentation

◆ mCompliance

float SoftBodySharedSettings::Edge::mCompliance = 0.0f

Inverse of the stiffness of the spring.

◆ mRestLength

float SoftBodySharedSettings::Edge::mRestLength = 1.0f

Rest length of the spring.

◆ mVertex

uint32 SoftBodySharedSettings::Edge::mVertex[2]

Indices of the vertices that form the edge.


The documentation for this struct was generated from the following file: