#include <SoftBodySharedSettings.h>

Public Member Functions
	RodStretchShear ()=default
	Constructor.

	RodStretchShear (uint32 inVertex1, uint32 inVertex2, float inCompliance=0.0f)

uint32	GetMinVertexIndex () const
	Return the lowest vertex index of this constraint.

Public Attributes
uint32	mVertex [2]
	Indices of the vertices that form the rod.

float	mLength = 1.0f
	Fixed length of the rod, calculated by CalculateRodProperties.

float	mInvMass = 1.0f
	Inverse of the mass of the rod (0 for static rods), calculated by CalculateRodProperties but can be overridden afterwards.

float	mCompliance = 0.0f
	Inverse of the stiffness of the rod.

Quat	mBishop = Quat::sZero()
	The Bishop frame of the rod (the rotation of the rod in its rest pose so that it has zero twist towards adjacent rods), calculated by CalculateRodProperties.

Detailed Description

A discrete Cosserat rod connects two particles with a rigid rod that has fixed length and inertia. A rod can be used instead of an Edge to constraint two vertices. The orientation of the rod can be used to orient geometry attached to the rod (e.g. a plant leaf). Note that each rod needs to be constrained by at least one RodBendTwist constraint in order to constrain the rotation of the rod. If you don't do this then the orientation is likely to rotate around the rod axis with constant velocity. Based on "Position and Orientation Based Cosserat Rods" - Kugelstadt and Schoemer - SIGGRAPH 2016 See: https://www.researchgate.net/publication/325597548_Position_and_Orientation_Based_Cosserat_Rods

Constructor & Destructor Documentation

◆ RodStretchShear() [1/2]

SoftBodySharedSettings::RodStretchShear::RodStretchShear ( )

default

Constructor.

◆ RodStretchShear() [2/2]

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

inline

Member Function Documentation

◆ GetMinVertexIndex()

uint32 SoftBodySharedSettings::RodStretchShear::GetMinVertexIndex ( ) const

inline

Return the lowest vertex index of this constraint.

Member Data Documentation

◆ mBishop

Quat SoftBodySharedSettings::RodStretchShear::mBishop = Quat::sZero()

The Bishop frame of the rod (the rotation of the rod in its rest pose so that it has zero twist towards adjacent rods), calculated by CalculateRodProperties.

◆ mCompliance

float SoftBodySharedSettings::RodStretchShear::mCompliance = 0.0f

Inverse of the stiffness of the rod.

◆ mInvMass

float SoftBodySharedSettings::RodStretchShear::mInvMass = 1.0f

Inverse of the mass of the rod (0 for static rods), calculated by CalculateRodProperties but can be overridden afterwards.

◆ mLength

float SoftBodySharedSettings::RodStretchShear::mLength = 1.0f

Fixed length of the rod, calculated by CalculateRodProperties.

◆ mVertex

uint32 SoftBodySharedSettings::RodStretchShear::mVertex[2]

Indices of the vertices that form the rod.

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

Jolt/Physics/SoftBody/SoftBodySharedSettings.h

Public Member Functions

Public Attributes