1. Epic GamesDeveloper
  3. UPhysicsConstraintComponent

UPhysicsConstraintComponent

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

Unreal Engine C++ API Reference > Runtime > Engine > PhysicsEngine

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/PhysicsEngine/PhysicsConstraintComponent.h
Include #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

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

  Type Name Description
Public variable UProperty Category, EditAnywhere FConstrainComponentPropName ComponentName1 Name of first component property to constrain.
Public variable UProperty Category, EditAnywhere FConstrainComponentPropName ComponentName2 Name of second component property to constrain.
Public variable UProperty Category editinstanceonly TObjectPtr< AActor > ConstraintActor1 Pointer to first Actor to constrain.
Public variable UProperty Category editinstanceonly TObjectPtr< AActor > ConstraintActor2 Pointer to second Actor to constrain.
Public variable UProperty Category, EditAnywhere, Meta FConstraintInstance ConstraintInstance All constraint settings
Public variable UProperty BlueprintAssignable FConstraintBrokenSignature OnConstraintBroken Notification when constraint is broken.
Public variable UProperty BlueprintAssignable FPlasticDeformationEventSignature OnPlasticDeformation Notification when constraint plasticity drive target changes.
Public variable TWeakObjectPtr< UPrimitiveComponent > OverrideComponent1 Allows direct setting of first component to constraint.
Public variable TWeakObjectPtr< UPrimitiveComponent > OverrideComponent2 Allows direct setting of second component to constraint.

Constructors

  Type Name Description
Public function  

UPhysicsConstraintComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category void Break this constraint
Public function Const FBox Get body bounding box. Works without constraint being created
Protected function Const FBox Internal util to get body box from actor/component name/bone name information
Protected function Const FBodyInstance * Get the body instance that we want to constrain to
Public function Const FTransform Get the body frame. Works without constraint being created
Protected function Const FTransform Internal util to get body transform from actor/component name/bone name information
Protected function Const UPrimitiveComponent * Internal util to get component from actor/component name
Public function UFunction BlueprintCallable, Category void

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

 Get connected components and potential related attachement bones
Public function UFunction BlueprintCallable, Category FConstraintInstanceAccessor Gets the constraint object
Public function UFunction BlueprintCallable, Category 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.
Protected function Const float Returns the scale of the constraint as it will be passed into the ConstraintInstance
Public function Const UFunction BlueprintCallable, Category float Gets the current Swing1 of the constraint
Public function Const UFunction BlueprintCallable, Category float Gets the current Swing2 of the constraint
Public function Const UFunction BlueprintCallable, Category float Gets the current Angular Twist of the constraint
Protected function Const Chaos::FPhysicsObject * Get the physics object that we want to constrain to.
Public function void Initialize the frames and creates constraint
Public function UFunction BlueprintCallable, Category bool Retrieve the status of constraint being broken.
Public function Const UFunction BlueprintCallable, Category bool Is projection enabled. See SetProjectionEnabled.
Protected function void Routes the FConstraint callback to the dynamic delegate
Protected function void Routes the FConstraint callback to the dynamic delegate
Public function UFunction BlueprintCallable, Category void

SetAngularBreakable ( bool bAngularBreakable,
float AngularBreakThreshold
)

 Sets the Angular Breakable properties
Public function UFunction BlueprintCallable, Category void Switches the angular drive mode between SLERP and Twist And Swing
Public function UFunction BlueprintCallable, Category void

SetAngularDriveParams ( float PositionStrength,
float VelocityStrength,
float InForceLimit
)

 Sets the drive params for the angular drive.
Public function UFunction BlueprintCallable, Category, Meta void

SetAngularOrientationDrive ( bool bEnableSwingDrive,
bool bEnableTwistDrive
)

 Enables/Disables angular orientation drive.
Public function UFunction BlueprintCallable, Category void

SetAngularOrientationTarget ( const FRotator& InPosTarget
)

 Sets the target orientation for the angular drive.
Public function UFunction BlueprintCallable, Category void

SetAngularPlasticity ( bool bAngularPlasticity,
float AngularPlasticityThreshold
)

 Sets the Angular Plasticity properties
Public function UFunction BlueprintCallable, Category void

SetAngularSwing1Limit ( EAngularConstraintMotion MotionType,
float Swing1LimitAngle
)

 Sets the Angular Swing1 Motion Type
Public function UFunction BlueprintCallable, Category void

SetAngularSwing2Limit ( EAngularConstraintMotion MotionType,
float Swing2LimitAngle
)

 Sets the Angular Swing2 Motion Type
Public function UFunction BlueprintCallable, Category void

SetAngularTwistLimit ( EAngularConstraintMotion ConstraintType,
float TwistLimitAngle
)

 Sets the Angular Twist Motion Type
Public function UFunction BlueprintCallable, Category, Meta void

SetAngularVelocityDrive ( bool bEnableSwingDrive,
bool bEnableTwistDrive
)

  
Public function UFunction BlueprintCallable, Category void

SetAngularVelocityDriveSLERP ( bool bEnableSLERP
)

 Enables/Disables the angular velocity slerp drive.
Public function UFunction BlueprintCallable, Category void

SetAngularVelocityDriveTwistAndSwing ( bool bEnableTwistDrive,
bool bEnableSwingDrive
)

 Enables/Disables angular velocity twist and swing drive.
Public function UFunction BlueprintCallable, Category void

SetAngularVelocityTarget ( const FVector& InVelTarget
)

 Sets the target velocity for the angular drive.
Public function UFunction BlueprintCallable, Category void

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

 Directly specify component to connect. Will update frames based on current position.
Public function UFunction BlueprintCallable, Category void 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.
Public function UFunction BlueprintCallable, Category 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.
Public function UFunction BlueprintCallable, Category void 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.
Public function UFunction BlueprintCallable, Category void

SetContactTransferScale ( float ContactTransferScale
)

 Sets the contact transfer scale properties
Public function UFunction BlueprintCallable, Category void

SetDisableCollision ( bool bDisableCollision
)

 If true, the collision between the two rigid bodies of the constraint will be disabled.
Public function UFunction BlueprintCallable, Category void

SetLinearBreakable ( bool bLinearBreakable,
float LinearBreakThreshold
)

 Sets the Linear Breakable properties
Public function UFunction BlueprintCallable, Category void

SetLinearDriveParams ( float PositionStrength,
float VelocityStrength,
float InForceLimit
)

 Sets the drive params for the linear drive.
Public function UFunction BlueprintCallable, Category void

SetLinearPlasticity ( bool bLinearPlasticity,
float LinearPlasticityThreshold,
EConstraintPlasticityType PlasticityType
)

 Sets the Linear Plasticity properties
Public function UFunction BlueprintCallable, Category void

SetLinearPositionDrive ( bool bEnableDriveX,
bool bEnableDriveY,
bool bEnableDriveZ
)

 Enables/Disables linear position drive
Public function UFunction BlueprintCallable, Category void

SetLinearPositionTarget ( const FVector& InPosTarget
)

 Sets the target position for the linear drive.
Public function UFunction BlueprintCallable, Category void

SetLinearVelocityDrive ( bool bEnableDriveX,
bool bEnableDriveY,
bool bEnableDriveZ
)

 Enables/Disables linear position drive
Public function UFunction BlueprintCallable, Category void

SetLinearVelocityTarget ( const FVector& InVelTarget
)

 Sets the target velocity for the linear drive.
Public function UFunction BlueprintCallable, Category void

SetLinearXLimit ( ELinearConstraintMotion ConstraintType,
float LimitSize
)

 Sets the LinearX Motion Type
Public function UFunction BlueprintCallable, Category void

SetLinearYLimit ( ELinearConstraintMotion ConstraintType,
float LimitSize
)

 Sets the LinearY Motion Type
Public function UFunction BlueprintCallable, Category void

SetLinearZLimit ( ELinearConstraintMotion ConstraintType,
float LimitSize
)

 Sets the LinearZ Motion Type
Public function UFunction BlueprintCallable, Category void

SetOrientationDriveSLERP ( bool bEnableSLERP
)

 Enables/Disables the angular orientation slerp drive.
Public function UFunction BlueprintCallable, Category void

SetOrientationDriveTwistAndSwing ( bool bEnableTwistDrive,
bool bEnableSwingDrive
)

 Enables/Disables angular orientation drive.
Public function UFunction BlueprintCallable, Category 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.
Public function UFunction BlueprintCallable, Category void

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

 Set the projection settings for use when projection is enabled.
Public function void Break the constraint
Public function void Update the reference frames held inside the constraint that indicate the joint location in the reference frame of the two connected bodies.
Public function void  

Overridden from USceneComponent

  Type Name Description
Public function Virtual void

PostEditComponentMove ( bool bFinished
)

 Called when this component is moved in the editor

Overridden from UActorComponent

  Type Name Description
Public function Virtual void 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.
Public function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Ends gameplay for this component.
Public function Virtual void Initializes the component.
Public function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Public function Virtual void Called when a component is unregistered.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.
Public function Virtual void Handles reading, writing, and reference collecting using FArchive.

Deprecated Variables

  Type Name Description
Public variable UProperty instanced TObjectPtr< class UPhysicsConstraintTemplate > ConstraintSetup_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page