Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Engine > PhysicsEngine > UPhysicsConstraintComponent

Light Theme

Dark Theme

UPhysicsConstraintComponent

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

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UActorComponent

USceneComponent

UPhysicsConstraintComponent

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Classes/PhysicsEngine/PhysicsConstraintComponent.h
Include	#include "PhysicsEngine/PhysicsConstraintComponent.h"

Syntax

class UPhysicsConstraintComponent : public USceneComponent

Remarks

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.

Variables

	Name	Description
FConstrainCompo...	ComponentName1	Name of first component property to constrain.
FConstrainCompo...	ComponentName2	Name of second component property to constrain.
AActor *	ConstraintActor1	Pointer to first Actor to constrain.
AActor *	ConstraintActor2	Pointer to second Actor to constrain.
FConstraintInst...	ConstraintInstance	All constraint settings
FConstraintBrok...	OnConstraintBroken	Notification when constraint is broken.
TWeakObjectPtr<...	OverrideComponent1	Allows direct setting of first component to constraint.
TWeakObjectPtr<...	OverrideComponent2	Allows direct setting of second component to constraint.

Constructors

	Name	Description
	UPhysicsConstraintComponent ( const FObjectInitializer& ObjectIn... )

Functions

	Name	Description
void	BreakConstraint()	Break this constraint
FBox	GetBodyBox ( EConstraintFrame::Type Frame )	Get body bounding box. Works without constraint being created
FBox	GetBodyBoxInternal ( EConstraintFrame::Type Frame, FName InBoneName )	Internal util to get body box from actor/component name/bone name information
FBodyInstanc...	GetBodyInstance ( EConstraintFrame::Type Frame )	Get the body instance that we want to constrain to
FTransform	GetBodyTransform ( EConstraintFrame::Type Frame )	Get the body frame. Works without constraint being created
FTransform	GetBodyTransformInternal ( EConstraintFrame::Type Frame, FName InBoneName )	Internal util to get body transform from actor/component name/bone name information
UPrimitiveCo...	GetComponentInternal ( EConstraintFrame::Type Frame )	Internal util to get component from actor/component name
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.
float	GetConstraintScale()	Returns the scale of the constraint as it will be passed into the ConstraintInstance
float	GetCurrentSwing1()	Gets the current Swing1 of the constraint
float	GetCurrentSwing2()	Gets the current Swing2 of the constraint
float	GetCurrentTwist()	Gets the current Angular Twist of the constraint
void	InitComponentConstraint()	Initialize the frames and creates constraint
bool	IsBroken()	Retrieve the status of constraint being broken.
void	OnConstraintBrokenHandler ( FConstraintInstance* BrokenCon... )	Routes the FConstraint callback to the dynamic delegate
void	SetAngularBreakable ( bool bAngularBreakable, float AngularBreakThreshold )	Sets the Angular Breakable properties
void	SetAngularDriveMode ( EAngularDriveMode::Type DriveMode )	Switches the angular drive mode between SLERP and Twist And Swing
void	SetAngularDriveParams ( float PositionStrength, float VelocityStrength, float InForceLimit )	Sets the drive params for the angular drive.
void	SetAngularOrientationDrive ( bool bEnableSwingDrive, bool bEnableTwistDrive )	Enables/Disables angular orientation drive.
void	SetAngularOrientationTarget ( const FRotator& InPosTarget )	Sets the target orientation for the angular drive.
void	SetAngularSwing1Limit ( EAngularConstraintMotion MotionType, float Swing1LimitAngle )	Sets the Angular Swing1 Motion Type
void	SetAngularSwing2Limit ( EAngularConstraintMotion MotionType, float Swing2LimitAngle )	Sets the Angular Swing2 Motion Type
void	SetAngularTwistLimit ( EAngularConstraintMotion Constraint..., float TwistLimitAngle )	Sets the Angular Twist Motion Type
void	SetAngularVelocityDrive ( bool bEnableSwingDrive, bool bEnableTwistDrive )
void	SetAngularVelocityDriveSLERP ( bool bEnableSLERP )	Enables/Disables the angular velocity slerp drive.
void	SetAngularVelocityDriveTwistAndSwing ( bool bEnableTwistDrive, bool bEnableSwingDrive )	Enables/Disables angular velocity twist and swing drive.
void	SetAngularVelocityTarget ( const FVector& InVelTarget )	Sets the target velocity for the angular drive.
void	SetConstrainedComponents ( UPrimitiveComponent* Component..., FName BoneName1, UPrimitiveComponent* Component..., FName BoneName2 )	Directly specify component to connect. Will update frames based on current position.
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.
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.
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.
void	SetDisableCollision ( bool bDisableCollision )	If true, the collision between the two rigid bodies of the constraint will be disabled.
void	SetLinearBreakable ( bool bLinearBreakable, float LinearBreakThreshold )	Sets the Linear Breakable properties
void	SetLinearDriveParams ( float PositionStrength, float VelocityStrength, float InForceLimit )	Sets the drive params for the linear drive.
void	SetLinearPositionDrive ( bool bEnableDriveX, bool bEnableDriveY, bool bEnableDriveZ )	Enables/Disables linear position drive
void	SetLinearPositionTarget ( const FVector& InPosTarget )	Sets the target position for the linear drive.
void	SetLinearVelocityDrive ( bool bEnableDriveX, bool bEnableDriveY, bool bEnableDriveZ )	Enables/Disables linear position drive
void	SetLinearVelocityTarget ( const FVector& InVelTarget )	Sets the target velocity for the linear drive.
void	SetLinearXLimit ( ELinearConstraintMotion ConstraintT..., float LimitSize )	Sets the LinearX Motion Type
void	SetLinearYLimit ( ELinearConstraintMotion ConstraintT..., float LimitSize )	Sets the LinearY Motion Type
void	SetLinearZLimit ( ELinearConstraintMotion ConstraintT..., float LimitSize )	Sets the LinearZ Motion Type
void	SetOrientationDriveSLERP ( bool bEnableSLERP )	Enables/Disables the angular orientation slerp drive.
void	SetOrientationDriveTwistAndSwing ( bool bEnableTwistDrive, bool bEnableSwingDrive )	Enables/Disables angular orientation drive.
void	TermComponentConstraint()	Break the constraint
void	UpdateConstraintFrames()	Update the reference frames held inside the constraint that indicate the joint location in the reference frame of the two connected bodies.
void	UpdateSpriteTexture()

Overridden from USceneComponent

		Name	Description
	void	PostEditComponentMove ( bool bFinished )	Called when this component is moved in the editor

Overridden from UActorComponent

	Name	Description
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.
void	InitializeComponent()	Initializes the component.
void	OnRegister()	Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
void	OnUnregister()	Called when a component is unregistered.

Overridden from UObject

	Name	Description
void	BeginDestroy()	Called before destroying the object.
void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )	This alternate version of PostEditChange is called when properties inside structs are modified.
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyCha... )	Called when a property on this object has been modified externally
void	PostLoad()	Do any object-specific cleanup required immediately after loading an object.

Deprecated Variables

		Name	Description
	UPhysicsConstra...	ConstraintSetup_DEPRECATED

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss