1. Epic GamesDeveloper
  3. FConstraintProfileProperties

FConstraintProfileProperties

Container for properties of a physics constraint that can be easily swapped at runtime.

API > API/Runtime > API/Runtime/Engine

Container for properties of a physics constraint that can be easily swapped at runtime. This is useful for switching different setups when going from ragdoll to standup for example

   
Name FConstraintProfileProperties
Type struct
Header File /Engine/Source/Runtime/Engine/Classes/PhysicsEngine/ConstraintInstance.h
Include Path #include "PhysicsEngine/ConstraintInstance.h"

Syntax

USTRUCT ()  
struct FConstraintProfileProperties

Constructors

Name Remarks Include Path Unreal Specifiers

FConstraintProfileProperties()

   PhysicsEngine/ConstraintInstance.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AngularBreakThreshold float Torque needed to break the joint. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • AdvancedDisplay
  • Category=Angular
  • Meta=(editcondition="bAngularBreakable", ClampMin="0.0")
AngularDrive FAngularDriveConstraint   PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Angular
AngularPlasticityThreshold float [Chaos Only] Degree threshold from target angle needed to reset the target angle. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • AdvancedDisplay
  • Category=Angular
  • Meta=(editcondition="bAngularPlasticity", ClampMin="0.0")
bAngularBreakable uint8 Whether it is possible to break the joint with angular force. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • AdvancedDisplay
  • Category=Angular
bAngularPlasticity uint8 Whether it is possible to reset target rotations from the angular displacement. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • AdvancedDisplay
  • Category=Angular
bDisableCollision uint8 Disable collision between bodies joined by this constraint. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Constraint
bEnableMassConditioning uint8 Whether mass conditioning is enabled for this joint. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Projection
bEnableProjection uint8 Projection is a post-solve position and angular fixup consisting of two correction procedures. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Projection
bEnableShockPropagation uint8 Shock propagation increases the mass of the parent body for the last iteration of the position and velocity solve phases. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Projection
bLinearBreakable uint8 Whether it is possible to break the joint with linear force. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • AdvancedDisplay
  • Category=Linear
bLinearPlasticity uint8 Whether it is possible to reset spring rest length from the linear deformation. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • AdvancedDisplay
  • Category=Linear
bParentDominates uint8 When set, the parent body in a constraint will not be affected by the motion of the child. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Constraint
bUseLinearJointSolver uint8 World Solver: Whether to use linear solver for this joint. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Projection
ConeLimit FConeConstraint   PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Angular
ContactTransferScale float [Chaos Only] Colliison transfer on parent from the joints child. Range is 0.0-MAX PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • AdvancedDisplay
  • Category=Linear
  • Meta=(ClampMin="0.0")
LinearBreakThreshold float Force needed to break the distance constraint. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • AdvancedDisplay
  • Category=Linear
  • Meta=(editcondition="bLinearBreakable", ClampMin="0.0")
LinearDrive FLinearDriveConstraint   PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Linear
LinearLimit FLinearConstraint   PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Linear
LinearPlasticityThreshold float [Chaos Only] Percent threshold from center of mass distance needed to reset the linear drive position target. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • AdvancedDisplay
  • Category=Linear
  • Meta=(editcondition="bLinearPlasticity", ClampMin="0.0")
LinearPlasticityType TEnumAsByte< enum EConstraintPlasticityType > Whether linear plasticity has a operation mode [free] PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • AdvancedDisplay
  • Category=Linear
ProjectionAngularAlpha float How much semi-physical angular projection correction to apply [0-1]. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Projection
  • Meta=(ClampMin="0.0", ClampMax="1.0")
ProjectionAngularTolerance float If the joint error is above this distance after the solve phase, the child body will be teleported to fix the error. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Projection
  • Meta=(ClampMin="0.0")
ProjectionLinearAlpha float How much semi-physical linear projection correction to apply [0-1]. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Projection
  • Meta=(ClampMin="0.0", ClampMax="1.0")
ProjectionLinearTolerance float If the joint error is above this distance after the solve phase, the child body will be teleported to fix the error. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Projection
  • Meta=(ClampMin="0.0")
ShockPropagationAlpha float How much shock propagation to apply [0-1]. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Projection
  • Meta=(ClampMin="0.0", ClampMax="1.0")
TwistLimit FTwistConstraint   PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Angular

Functions

Public

Name Remarks Include Path Unreal Specifiers

void SyncChangedConstraintProperties ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   PhysicsEngine/ConstraintInstance.h  

void Update_AssumesLocked ( const FPhysicsConstraintHandle& InConstraintRef,
float AverageMass,
float UseScale,
bool InInitialize
) const

 Updates physx joint properties from unreal properties (limits, drives, flags, etc...) PhysicsEngine/ConstraintInstance.h  

void UpdateBreakable_AssumesLocked ( const FPhysicsConstraintHandle& InConstraintRef
) const

 Updates joint breakable properties (threshold, etc...) PhysicsEngine/ConstraintInstance.h  

void UpdateConstraintFlags_AssumesLocked ( const FPhysicsConstraintHandle& InConstraintRef
) const

 Updates joint flag based on profile properties PhysicsEngine/ConstraintInstance.h  

void UpdateContactTransferScale_AssumesLocked ( const FPhysicsConstraintHandle& InConstraintRef
) const

 Updates joint linear mass scales. PhysicsEngine/ConstraintInstance.h  

void UpdatePlasticity_AssumesLocked ( const FPhysicsConstraintHandle& InConstraintRef
) const

 Updates joint breakable properties (threshold, etc...) PhysicsEngine/ConstraintInstance.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page