1. Epic GamesDeveloper
  3. UPhysicsConstraintComponent

UPhysicsConstraintComponent

This is effectively a joint that allows you to connect 2 rigid bodies together.

API > API/Runtime > API/Runtime/Engine

This is effectively a joint that allows you to connect 2 rigid bodies together. You can create different types of joints using the various parameters of this component.

   
Name UPhysicsConstraintComponent
Type class
Header File /Engine/Source/Runtime/Engine/Classes/PhysicsEngine/PhysicsConstraintComponent.h
Include Path #include "PhysicsEngine/PhysicsConstraintComponent.h"

Syntax

UCLASS (ClassGroup=Physics, Meta=(BlueprintSpawnableComponent),  
       HideCategories=(Activation, "Components|Activation", Physics, Mobility),  
       ShowCategories=("Physics|Components|PhysicsConstraint"), MinimalAPI)  
class UPhysicsConstraintComponent : public USceneComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UPhysicsConstraintComponent ( const FObjectInitializer& ObjectInitializer
)

   PhysicsEngine/PhysicsConstraintComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ComponentName1 FConstrainComponentPropName Name of first component property to constrain. PhysicsEngine/PhysicsConstraintComponent.h
  • EditAnywhere
  • Category=Constraint
ComponentName2 FConstrainComponentPropName Name of second component property to constrain. PhysicsEngine/PhysicsConstraintComponent.h
  • EditAnywhere
  • Category=Constraint
ConstraintActor1 TObjectPtr< AActor > Pointer to first Actor to constrain. PhysicsEngine/PhysicsConstraintComponent.h
  • EditInstanceOnly
  • Category=Constraint
ConstraintActor2 TObjectPtr< AActor > Pointer to second Actor to constrain. PhysicsEngine/PhysicsConstraintComponent.h
  • EditInstanceOnly
  • Category=Constraint
ConstraintInstance FConstraintInstance All constraint settings PhysicsEngine/PhysicsConstraintComponent.h
  • EditAnywhere
  • Category=ConstraintComponent
  • Meta=(ShowOnlyInnerProperties)
OnConstraintBroken FConstraintBrokenSignature Notification when constraint is broken. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintAssignable
OnPlasticDeformation FPlasticDeformationEventSignature Notification when constraint plasticity drive target changes. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintAssignable
OverrideComponent1 TWeakObjectPtr< UPrimitiveComponent > Allows direct setting of first component to constraint. PhysicsEngine/PhysicsConstraintComponent.h  
OverrideComponent2 TWeakObjectPtr< UPrimitiveComponent > Allows direct setting of second component to constraint. PhysicsEngine/PhysicsConstraintComponent.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsBrokenLocal bool   PhysicsEngine/PhysicsConstraintComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void BreakConstraint()

 Break this constraint PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

FBox GetBodyBox ( EConstraintFrame::Type Frame
) const

 Get body bounding box. Works without constraint being created PhysicsEngine/PhysicsConstraintComponent.h  

FTransform GetBodyTransform ( EConstraintFrame::Type Frame
) const

 Get the body frame. Works without constraint being created PhysicsEngine/PhysicsConstraintComponent.h  

void GetConstrainedComponents ( UPrimitiveComponent*& OutComponent1,
FName& OutBoneName1,
UPrimitiveComponent*& OutComponent2,
FName& OutBoneName2
)

 Get connected components and potential related attachement bones PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

FConstraintInstanceAccessor GetConstraint()

 Gets the constraint object PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void GetConstraintForce ( FVector& OutLinearForce,
FVector& OutAngularForce
)

 Retrieve the constraint force most recently applied to maintain this constraint. Returns 0 forces if the constraint is not initialized or broken. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

float GetCurrentSwing1()

 Gets the current Swing1 of the constraint PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

float GetCurrentSwing2()

 Gets the current Swing2 of the constraint PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

float GetCurrentTwist()

 Gets the current Angular Twist of the constraint PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void InitComponentConstraint()

 Initialize the frames and creates constraint PhysicsEngine/PhysicsConstraintComponent.h  

bool IsBroken()

 Retrieve the status of constraint being broken. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

bool IsProjectionEnabled()

 Is projection enabled. See SetProjectionEnabled. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetAngularBreakable ( bool bAngularBreakable,
float AngularBreakThreshold
)

 Sets the Angular Breakable properties PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetAngularDriveAccelerationMode ( bool bAccelerationMode
)

 Toggles the angular drive acceleration mode. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetAngularDriveMode ( EAngularDriveMode::Type DriveMode
)

 Switches the angular drive mode between SLERP and Twist And Swing PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetAngularDriveParams ( float PositionStrength,
float VelocityStrength,
float InForceLimit
)

 Sets the drive params for the angular drive. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetAngularOrientationDrive ( bool bEnableSwingDrive,
bool bEnableTwistDrive
)

 Enables/Disables angular orientation drive. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"
  • Meta=(DeprecatedFunction, DeprecationMessage="Use SetOrientationDriveTwistAndSwing instead.")

void SetAngularOrientationTarget ( const FRotator& InPosTarget
)

 Sets the target orientation for the angular drive. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetAngularPlasticity ( bool bAngularPlasticity,
float AngularPlasticityThreshold
)

 Sets the Angular Plasticity properties PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetAngularSwing1Limit ( EAngularConstraintMotion MotionType,
float Swing1LimitAngle
)

 Sets the Angular Swing1 Motion Type PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetAngularSwing2Limit ( EAngularConstraintMotion MotionType,
float Swing2LimitAngle
)

 Sets the Angular Swing2 Motion Type PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetAngularTwistLimit ( EAngularConstraintMotion ConstraintType,
float TwistLimitAngle
)

 Sets the Angular Twist Motion Type PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetAngularVelocityDrive ( bool bEnableSwingDrive,
bool bEnableTwistDrive
)

   PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"
  • Meta=(DeprecatedFunction, DeprecationMessage="Use SetAngularVelocityDriveTwistAndSwing instead.")

void SetAngularVelocityDriveSLERP ( bool bEnableSLERP
)

 Enables/Disables the angular velocity slerp drive. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetAngularVelocityDriveTwistAndSwing ( bool bEnableTwistDrive,
bool bEnableSwingDrive
)

 Enables/Disables angular velocity twist and swing drive. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetAngularVelocityTarget ( const FVector& InVelTarget
)

 Sets the target velocity for the angular drive. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetConstrainedComponents ( UPrimitiveComponent* Component1,
FName BoneName1,
UPrimitiveComponent* Component2,
FName BoneName2
)

 Directly specify component to connect. Will update frames based on current position. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetConstraintReferenceFrame ( EConstraintFrame::Type Frame,
const FTransform& RefFrame
)

 Pass in reference frame in. If the constraint is currently active, this will set its active local pose. Otherwise the change will take affect in InitConstraint. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetConstraintReferenceOrientation ( EConstraintFrame::Type Frame,
const FVector& PriAxis,
const FVector& SecAxis
)

 Pass in reference orientation in (maintains reference position). If the constraint is currently active, this will set its active local pose. Otherwise the change will take affect in InitConstraint. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetConstraintReferencePosition ( EConstraintFrame::Type Frame,
const FVector& RefPosition
)

 Pass in reference position in (maintains reference orientation). If the constraint is currently active, this will set its active local pose. Otherwise the change will take affect in InitConstraint. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetContactTransferScale ( float ContactTransferScale
)

 Sets the contact transfer scale properties PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetDisableCollision ( bool bDisableCollision
)

 If true, the collision between the two rigid bodies of the constraint will be disabled. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetLinearBreakable ( bool bLinearBreakable,
float LinearBreakThreshold
)

 Sets the Linear Breakable properties PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetLinearDriveAccelerationMode ( bool bAccelerationMode
)

 Toggles the linear drive acceleration mode. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetLinearDriveParams ( float PositionStrength,
float VelocityStrength,
float InForceLimit
)

 Sets the drive params for the linear drive. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetLinearPlasticity ( bool bLinearPlasticity,
float LinearPlasticityThreshold,
EConstraintPlasticityType PlasticityType
)

 Sets the Linear Plasticity properties PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetLinearPositionDrive ( bool bEnableDriveX,
bool bEnableDriveY,
bool bEnableDriveZ
)

 Enables/Disables linear position drive PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetLinearPositionTarget ( const FVector& InPosTarget
)

 Sets the target position for the linear drive. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetLinearVelocityDrive ( bool bEnableDriveX,
bool bEnableDriveY,
bool bEnableDriveZ
)

 Enables/Disables linear position drive PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetLinearVelocityTarget ( const FVector& InVelTarget
)

 Sets the target velocity for the linear drive. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetLinearXLimit ( ELinearConstraintMotion ConstraintType,
float LimitSize
)

 Sets the LinearX Motion Type PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetLinearYLimit ( ELinearConstraintMotion ConstraintType,
float LimitSize
)

 Sets the LinearY Motion Type PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetLinearZLimit ( ELinearConstraintMotion ConstraintType,
float LimitSize
)

 Sets the LinearZ Motion Type PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetOrientationDriveSLERP ( bool bEnableSLERP
)

 Enables/Disables the angular orientation slerp drive. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetOrientationDriveTwistAndSwing ( bool bEnableTwistDrive,
bool bEnableSwingDrive
)

 Enables/Disables angular orientation drive. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetProjectionEnabled ( bool bProjectionEnabled
)

 If true, joint projection is enabled. Projection is a semi-physics post-solve correction for fixing small errors, and a teleport for fixing larger errors. See SetProjectionParams. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void SetProjectionParams ( float ProjectionLinearAlpha,
float ProjectionAngularAlpha,
float ProjectionLinearTolerance,
float ProjectionAngularTolerance
)

 Set the projection settings for use when projection is enabled. PhysicsEngine/PhysicsConstraintComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsConstraint"

void TermComponentConstraint()

 Break the constraint PhysicsEngine/PhysicsConstraintComponent.h  
Update the reference frames held inside the constraint that indicate the joint location in the reference frame of the two connected bodies. PhysicsEngine/PhysicsConstraintComponent.h  

void UpdateSpriteTexture()

   PhysicsEngine/PhysicsConstraintComponent.h  

Overridden from USceneComponent

Name Remarks Include Path Unreal Specifiers

virtual void PostEditComponentMove ( bool bFinished
)

 Called when this component is moved in the editor PhysicsEngine/PhysicsConstraintComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void CheckForErrors ()

 Function that gets called from within Map_Check to allow this actor component to check itself for any potential errors and register them with map check dialog. PhysicsEngine/PhysicsConstraintComponent.h  

virtual void EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Ends gameplay for this component. Called from AActor::EndPlay only if bHasBegunPlay is true PhysicsEngine/PhysicsConstraintComponent.h  

virtual void InitializeComponent ()

 Initializes the component. PhysicsEngine/PhysicsConstraintComponent.h  

virtual void OnRegister()

 Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called. PhysicsEngine/PhysicsConstraintComponent.h  

virtual void OnUnregister ()

 Called when a component is unregistered. PhysicsEngine/PhysicsConstraintComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   PhysicsEngine/PhysicsConstraintComponent.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   PhysicsEngine/PhysicsConstraintComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   PhysicsEngine/PhysicsConstraintComponent.h  

virtual void PostLoad()

   PhysicsEngine/PhysicsConstraintComponent.h  

virtual void Serialize ( FArchive& Ar
)

   PhysicsEngine/PhysicsConstraintComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

FBox GetBodyBoxInternal ( EConstraintFrame::Type Frame,
FName InBoneName
) const

 Internal util to get body box from actor/component name/bone name information PhysicsEngine/PhysicsConstraintComponent.h  

FBodyInstance * GetBodyInstance ( EConstraintFrame::Type Frame
) const

 Get the body instance that we want to constrain to PhysicsEngine/PhysicsConstraintComponent.h  

FTransform GetBodyTransformInternal ( EConstraintFrame::Type Frame,
FName InBoneName
) const

 Internal util to get body transform from actor/component name/bone name information PhysicsEngine/PhysicsConstraintComponent.h  

UPrimitiveComponent * GetComponentInternal ( EConstraintFrame::Type Frame
) const

 Internal util to get component from actor/component name PhysicsEngine/PhysicsConstraintComponent.h  

float GetConstraintScale()

 Returns the scale of the constraint as it will be passed into the ConstraintInstance PhysicsEngine/PhysicsConstraintComponent.h  

Chaos::FPhysicsObject * GetPhysicsObject ( EConstraintFrame::Type Frame
) const

 Get the physics object that we want to constrain to. PhysicsEngine/PhysicsConstraintComponent.h  

void OnConstraintBrokenHandler ( FConstraintInstance* BrokenConstraint
)

 Routes the FConstraint callback to the dynamic delegate PhysicsEngine/PhysicsConstraintComponent.h  

void OnPlasticDeformationHandler ( FConstraintInstance* Constraint
)

 Routes the FConstraint callback to the dynamic delegate PhysicsEngine/PhysicsConstraintComponent.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
ConstraintSetup_DEPRECATED TObjectPtr< class UPhysicsConstraintTemplate >   PhysicsEngine/PhysicsConstraintComponent.h
  • Instanced

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page