UConstraintInstanceBlueprintLibrary

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UBlueprintFunctionLibrary

UConstraintInstanceBlueprintLibrary

References

Module

Engine

Header

/Engine/Source/Runtime/Engine/Classes/PhysicsEngine/ConstraintInstanceBlueprintLibrary.h

Include

#include "PhysicsEngine/ConstraintInstanceBlueprintLibrary.h"

Syntax

class UConstraintInstanceBlueprintLibrary : public UBlueprintFunctionLibrary

Functions

Name Description

Public function Static

void

 

CopyParams

(
    FConstraintInstanceAccessor& Acces...,
    FConstraintInstanceAccessor& Sourc...,
    bool bKeepPosition,
    bool bKeepRotation
)

Copies all properties from one constraint to another

Public function Static

void

 

GetAngularBreakable

(
    FConstraintInstanceAccessor& Acces...,
    bool& bAngularBreakable,
    float& AngularBreakThreshold
)

Gets Constraint Angular Breakable properties

Public function Static

void

 

GetAngularDriveMode

Gets the angular drive mode ( SLERP or Twist And Swing)

Public function Static

void

 

GetAngularDriveParams

(
    FConstraintInstanceAccessor& Acces...,
    float& OutPositionStrength,
    float& OutVelocityStrength,
    float& OutForceLimit
)

Gets the drive params for the angular drive.

Public function Static

void

 

GetAngularLimits

(
    FConstraintInstanceAccessor& Acces...,
    TEnumAsByte< EAngularConstraintMoti...,
    float& Swing1LimitAngle,
    TEnumAsByte< EAngularConstraintMoti...,
    float& Swing2LimitAngle,
    TEnumAsByte< EAngularConstraintMoti...,
    float& TwistLimitAngle
)

Gets Constraint Angular Motion Ranges

Public function Static

void

 

GetAngularOrientationTarget

(
    FConstraintInstanceAccessor& Acces...,
    FRotator& OutPosTarget
)

Gets the target orientation for the angular drive.

Public function Static

void

 

GetAngularPlasticity

(
    FConstraintInstanceAccessor& Acces...,
    bool& bAngularPlasticity,
    float& AngularPlasticityThreshold
)

Sets Constraint Angular Plasticity properties

Public function Static

void

 

GetAngularSoftSwingLimitParams

(
    FConstraintInstanceAccessor& Acces...,
    bool& bSoftSwingLimit,
    float& SwingLimitStiffness,
    float& SwingLimitDamping,
    float& SwingLimitRestitution,
    float& SwingLimitContactDistance
)

Gets Constraint Angular Soft Swing Limit parameters

Public function Static

void

 

GetAngularSoftTwistLimitParams

(
    FConstraintInstanceAccessor& Acces...,
    bool& bSoftTwistLimit,
    float& TwistLimitStiffness,
    float& TwistLimitDamping,
    float& TwistLimitRestitution,
    float& TwistLimitContactDistance
)

Gets Constraint Angular Soft Twist Limit parameters

Public function Static

void

 

GetAngularVelocityDriveSLERP

(
    FConstraintInstanceAccessor& Acces...,
    bool& bOutEnableSLERP
)

Gets whether the angular velocity slerp drive is enabled or not.

Public function Static

void

 

GetAngularVelocityDriveTwistAndSwing

(
    FConstraintInstanceAccessor& Acces...,
    bool& bOutEnableTwistDrive,
    bool& bOutEnableSwingDrive
)

Gets whether angular velocity twist and swing drive is enabled or not.

Public function Static

void

 

GetAngularVelocityTarget

(
    FConstraintInstanceAccessor& Acces...,
    FVector& OutVelTarget
)

Gets the target velocity for the angular drive.

Public function Static

void

 

GetAttachedBodyNames

(
    FConstraintInstanceAccessor& Acces...,
    FName& ParentBody,
    FName& ChildBody
)

CONSTRAINT BODIES Gets Attached body names

Public function Static

void

 

GetContactTransferScale

(
    FConstraintInstanceAccessor& Acces...,
    float& ContactTransferScale
)

Contact Transfer Gets Constraint Contact Transfer Scale properties

Public function Static

bool

 

GetDisableCollsion

(
    FConstraintInstanceAccessor& Acces...
)

Gets whether bodies attched to the constraint can collide or not

Public function Static

void

 

GetLinearBreakable

(
    FConstraintInstanceAccessor& Acces...,
    bool& bLinearBreakable,
    float& LinearBreakThreshold
)

Gets Constraint Linear Breakable properties

Public function Static

void

 

GetLinearDriveParams

(
    FConstraintInstanceAccessor& Acces...,
    float& OutPositionStrength,
    float& OutVelocityStrength,
    float& OutForceLimit
)

Gets the drive params for the linear drive.

Public function Static

void

 

GetLinearLimits

(
    FConstraintInstanceAccessor& Acces...,
    TEnumAsByte< ELinearConstraintMotio...,
    TEnumAsByte< ELinearConstraintMotio...,
    TEnumAsByte< ELinearConstraintMotio...,
    float& Limit
)

Gets Constraint Linear Motion Ranges

Public function Static

void

 

GetLinearPlasticity

(
    FConstraintInstanceAccessor& Acces...,
    bool& bLinearPlasticity,
    float& LinearPlasticityThreshold,
    TEnumAsByte< EConstraintPlasticityT...
)

Gets Constraint Linear Plasticity properties

Public function Static

void

 

GetLinearPositionDrive

(
    FConstraintInstanceAccessor& Acces...,
    bool& bOutEnableDriveX,
    bool& bOutEnableDriveY,
    bool& bOutEnableDriveZ
)

Gets whether linear position drive is enabled or not

Public function Static

void

 

GetLinearPositionTarget

(
    FConstraintInstanceAccessor& Acces...,
    FVector& OutPosTarget
)

Gets the target position for the linear drive.

Public function Static

void

 

GetLinearSoftLimitParams

(
    FConstraintInstanceAccessor& Acces...,
    bool& bSoftLinearLimit,
    float& LinearLimitStiffness,
    float& LinearLimitDamping,
    float& LinearLimitRestitution,
    float& LinearLimitContactDistance
)

Gets Constraint Linear Soft Limit parameters

Public function Static

void

 

GetLinearVelocityDrive

(
    FConstraintInstanceAccessor& Acces...,
    bool& bOutEnableDriveX,
    bool& bOutEnableDriveY,
    bool& bOutEnableDriveZ
)

Gets whether linear velocity drive is enabled or not

Public function Static

void

 

GetLinearVelocityTarget

(
    FConstraintInstanceAccessor& Acces...,
    FVector& OutVelTarget
)

Gets the target velocity for the linear drive.

Public function Static

void

 

GetOrientationDriveSLERP

(
    FConstraintInstanceAccessor& Acces...,
    bool& bOutEnableSLERP
)

Gets whether the angular orientation slerp drive is enabled or not.

Public function Static

void

 

GetOrientationDriveTwistAndSwing

(
    FConstraintInstanceAccessor& Acces...,
    bool& bOutEnableTwistDrive,
    bool& bOutEnableSwingDrive
)

Gets whether angular orientation drive are enabled.

Public function Static

bool

 

GetParentDominates

(
    FConstraintInstanceAccessor& Acces...
)

Gets whether the parent body is not affected by it's child motion

Public function Static

void

 

GetProjectionParams

(
    FConstraintInstanceAccessor& Acces...,
    bool& bEnableProjection,
    float& ProjectionLinearAlpha,
    float& ProjectionAngularAlpha
)

Gets projection parameters of the constraint

Public function Static

void

 

SetAngularBreakable

(
    FConstraintInstanceAccessor& Acces...,
    bool bAngularBreakable,
    float AngularBreakThreshold
)

Sets Constraint Angular Breakable properties

Public function Static

void

 

SetAngularDriveMode

(
    FConstraintInstanceAccessor& Acces...,
    EAngularDriveMode::Type DriveMode
)

Switches the angular drive mode between SLERP and Twist And Swing

Public function Static

void

 

SetAngularDriveParams

(
    FConstraintInstanceAccessor& Acces...,
    float PositionStrength,
    float VelocityStrength,
    float InForceLimit
)

Sets the drive params for the angular drive.

Public function Static

void

 

SetAngularLimits

(
    FConstraintInstanceAccessor& Acces...,
    TEnumAsByte< EAngularConstraintMoti...,
    float Swing1LimitAngle,
    TEnumAsByte< EAngularConstraintMoti...,
    float Swing2LimitAngle,
    TEnumAsByte< EAngularConstraintMoti...,
    float TwistLimitAngle
)

ANGULAR LIMITS Sets COnstraint Angular Motion Ranges

Public function Static

void

 

SetAngularOrientationTarget

(
    FConstraintInstanceAccessor& Acces...,
    const FRotator& InPosTarget
)

Sets the target orientation for the angular drive.

Public function Static

void

 

SetAngularPlasticity

(
    FConstraintInstanceAccessor& Acces...,
    bool bAngularPlasticity,
    float AngularPlasticityThreshold
)

Sets Constraint Angular Plasticity properties

Public function Static

void

 

SetAngularSoftSwingLimitParams

(
    FConstraintInstanceAccessor& Acces...,
    bool bSoftSwingLimit,
    float SwingLimitStiffness,
    float SwingLimitDamping,
    float SwingLimitRestitution,
    float SwingLimitContactDistance
)

Sets Constraint Angular Soft Swing Limit parameters

Public function Static

void

 

SetAngularSoftTwistLimitParams

(
    FConstraintInstanceAccessor& Acces...,
    bool bSoftTwistLimit,
    float TwistLimitStiffness,
    float TwistLimitDamping,
    float TwistLimitRestitution,
    float TwistLimitContactDistance
)

Sets Constraint Angular Soft Twist Limit parameters

Public function Static

void

 

SetAngularVelocityDriveSLERP

(
    FConstraintInstanceAccessor& Acces...,
    bool bEnableSLERP
)

Enables/Disables the angular velocity slerp drive.

Public function Static

void

 

SetAngularVelocityDriveTwistAndSwing

(
    FConstraintInstanceAccessor& Acces...,
    bool bEnableTwistDrive,
    bool bEnableSwingDrive
)

Enables/Disables angular velocity twist and swing drive.

Public function Static

void

 

SetAngularVelocityTarget

(
    FConstraintInstanceAccessor& Acces...,
    const FVector& InVelTarget
)

Sets the target velocity for the angular drive.

Public function Static

void

 

SetContactTransferScale

(
    FConstraintInstanceAccessor& Acces...,
    float ContactTransferScale
)

Set Contact Transfer Scale

Public function Static

void

 

SetDisableCollision

(
    FConstraintInstanceAccessor& Acces...,
    bool bDisableCollision
)

CONSTRAINT BEHAVIOR Sets whether bodies attched to the constraint can collide or not

Public function Static

void

 

SetLinearBreakable

(
    FConstraintInstanceAccessor& Acces...,
    bool bLinearBreakable,
    float LinearBreakThreshold
)

Sets the Linear Breakable properties

Public function Static

void

 

SetLinearDriveParams

(
    FConstraintInstanceAccessor& Acces...,
    float PositionStrength,
    float VelocityStrength,
    float InForceLimit
)

Sets the drive params for the linear drive.

Public function Static

void

 

SetLinearLimits

(
    FConstraintInstanceAccessor& Acces...,
    TEnumAsByte< ELinearConstraintMotio...,
    TEnumAsByte< ELinearConstraintMotio...,
    TEnumAsByte< ELinearConstraintMotio...,
    float Limit
)

LINEAR LIMITS Sets Constraint Linear Motion Ranges

Public function Static

void

 

SetLinearPlasticity

(
    FConstraintInstanceAccessor& Acces...,
    bool bLinearPlasticity,
    float LinearPlasticityThreshold,
    TEnumAsByte< EConstraintPlasticityT...
)

Sets Constraint Linear Plasticity properties

Public function Static

void

 

SetLinearPositionDrive

(
    FConstraintInstanceAccessor& Acces...,
    bool bEnableDriveX,
    bool bEnableDriveY,
    bool bEnableDriveZ
)

LINEAR MOTOR Enables/Disables linear position drive

Public function Static

void

 

SetLinearPositionTarget

(
    FConstraintInstanceAccessor& Acces...,
    const FVector& InPosTarget
)

Sets the target position for the linear drive.

Public function Static

void

 

SetLinearSoftLimitParams

(
    FConstraintInstanceAccessor& Acces...,
    bool bSoftLinearLimit,
    float LinearLimitStiffness,
    float LinearLimitDamping,
    float LinearLimitRestitution,
    float LinearLimitContactDistance
)

Sets Constraint Linear Soft Limit parameters

Public function Static

void

 

SetLinearVelocityDrive

(
    FConstraintInstanceAccessor& Acces...,
    bool bEnableDriveX,
    bool bEnableDriveY,
    bool bEnableDriveZ
)

Enables/Disables linear velocity drive

Public function Static

void

 

SetLinearVelocityTarget

(
    FConstraintInstanceAccessor& Acces...,
    const FVector& InVelTarget
)

Sets the target velocity for the linear drive.

Public function Static

void

 

SetOrientationDriveSLERP

(
    FConstraintInstanceAccessor& Acces...,
    bool bEnableSLERP
)

Enables/Disables the angular orientation slerp drive.

Public function Static

void

 

SetOrientationDriveTwistAndSwing

(
    FConstraintInstanceAccessor& Acces...,
    bool bEnableTwistDrive,
    bool bEnableSwingDrive
)

ANGULAR MOTOR Enables/Disables angular orientation drive.

Public function Static

void

 

SetParentDominates

(
    FConstraintInstanceAccessor& Acces...,
    bool bParentDominates
)

Sets whether the parent body is not affected by it's child motion

Public function Static

void

 

SetProjectionParams

(
    FConstraintInstanceAccessor& Acces...,
    bool bEnableProjection,
    float ProjectionLinearAlpha,
    float ProjectionAngularAlpha
)

Sets projection parameters of the constraint