1. Epic GamesDeveloper
  3. FConstraintInstance

FConstraintInstance

Container for a physics representation of an object.

API > API/Runtime > API/Runtime/Engine

Container for a physics representation of an object.

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

Syntax

USTRUCT ()  
struct FConstraintInstance : public FConstraintInstanceBase

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FConstraintInstance()

 Constructor PhysicsEngine/ConstraintInstance.h  

Structs

Name Remarks
FPDIOrCollector  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AngularRotationOffset FRotator Specifies the angular offset between the two frames of reference. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Angular
AverageMass float   PhysicsEngine/ConstraintInstance.h  
bScaleLinearLimits uint32 If true, linear limits scale using the absolute min of the 3d scale of the owning component PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Linear
ConstraintBone1 FName Name of first bone (body) that this constraint is connecting. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Constraint
ConstraintBone2 FName Name of second bone (body) that this constraint is connecting. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Constraint
JointName FName Name of bone that this joint is associated with. PhysicsEngine/ConstraintInstance.h
  • VisibleAnywhere
  • Category=Constraint
Pos1 FVector Location of constraint in Body1 reference frame (usually the "child" body for skeletal meshes). PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Constraint
Pos2 FVector Location of constraint in Body2 reference frame (usually the "parent" body for skeletal meshes). PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Constraint
PriAxis1 FVector Primary (twist) axis in Body1 reference frame. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Constraint
PriAxis2 FVector Primary (twist) axis in Body2 reference frame. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Constraint
ProfileInstance FConstraintProfileProperties Constraint Data (properties easily swapped at runtime based on different constraint profiles) PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Constraint
SecAxis1 FVector Secondary axis in Body1 reference frame. Orthogonal to PriAxis1. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Constraint
SecAxis2 FVector Secondary axis in Body2 reference frame. Orthogonal to PriAxis2. PhysicsEngine/ConstraintInstance.h
  • EditAnywhere
  • Category=Constraint
UserData FChaosUserData   PhysicsEngine/ConstraintInstance.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
LastKnownScale float The component scale passed in during initialization PhysicsEngine/ConstraintInstance.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ApplySerializedState ( Chaos::FSerializedDataBufferPtr&& InSerializedState,
Chaos::ESerializedDataContext DataContext
)

 Deserializes the provided array of bytes representing a saved physics thread state and applies it to this constraint PhysicsEngine/ConstraintInstance.h  

FTransform CalculateDefaultChildTransform()

 Returns this constraint's default transform relative to its child bone. PhysicsEngine/ConstraintInstance.h  

FTransform CalculateDefaultParentTransform ( const UPhysicsAsset*const PhysicsAsset
) const

 Returns this constraint's default transform relative to its parent bone. PhysicsEngine/ConstraintInstance.h  

void CopyConstraintGeometryFrom ( const FConstraintInstance* FromInstance
)

   PhysicsEngine/ConstraintInstance.h  

void CopyConstraintParamsFrom ( const FConstraintInstance* FromInstance
)

   PhysicsEngine/ConstraintInstance.h  

void CopyConstraintPhysicalPropertiesFrom ( const FConstraintInstance* FromInstance,
bool bKeepPosition,
bool bKeepRotation
)

 Copies non-identifying properties from another constraint instance PhysicsEngine/ConstraintInstance.h  
Copies behavior properties from the given profile. PhysicsEngine/ConstraintInstance.h  
Disable maxx conditioning. PhysicsEngine/ConstraintInstance.h  

void DisableParentDominates()

   PhysicsEngine/ConstraintInstance.h  

void DisableProjection()

 Turn off linear and angular projection PhysicsEngine/ConstraintInstance.h  

void DrawConstraint ( int32 ViewIndex,
FMeshElementCollector& Collector,
float Scale,
float LimitDrawScale,
bool bDrawLimits,
bool bDrawSelected,
const FTransform& Con1Frame,
const FTransform& Con2Frame,
bool bDrawAsPoint,
bool bDrawViolatedLimits
) const

   PhysicsEngine/ConstraintInstance.h  

void DrawConstraint ( FPrimitiveDrawInterface* PDI,
float Scale,
float LimitDrawScale,
bool bDrawLimits,
bool bDrawSelected,
const FTransform& Con1Frame,
const FTransform& Con2Frame,
bool bDrawAsPoint,
bool bDrawViolatedLimits
) const

   PhysicsEngine/ConstraintInstance.h  
Enable maxx conditioning. PhysicsEngine/ConstraintInstance.h  

void EnableParentDominates()

 Enable/Disable parent dominates (meaning the parent body cannot be be affected at all by a child) PhysicsEngine/ConstraintInstance.h  

void EnableProjection()

 Turn on linear and angular projection PhysicsEngine/ConstraintInstance.h  

float GetAngularBreakThreshold()

 Gets Torque needed to break the joint PhysicsEngine/ConstraintInstance.h  

EAngularDriveMode::Type GetAngularDriveMode()

 Set the angular drive mode PhysicsEngine/ConstraintInstance.h  

void GetAngularDriveParams ( float& OutSpring,
float& OutDamping,
float& OutForceLimit
) const

 Get the angular drive's strength parameters PhysicsEngine/ConstraintInstance.h  

const FRotator & GetAngularOrientationTarget()

 Get the angular drive's orientation target PhysicsEngine/ConstraintInstance.h  

float GetAngularPlasticityThreshold()

 Gets Delta from target needed to reset the target joint PhysicsEngine/ConstraintInstance.h  

float GetAngularSwing1Limit()

 Gets the cone limit swing1 angle in degrees PhysicsEngine/ConstraintInstance.h  

EAngularConstraintMotion GetAngularSwing1Motion()

 Gets the motion type for the swing1 of the cone constraint PhysicsEngine/ConstraintInstance.h  

float GetAngularSwing2Limit()

 Gets the cone limit swing2 angle in degrees PhysicsEngine/ConstraintInstance.h  

EAngularConstraintMotion GetAngularSwing2Motion()

 Gets the motion type for the swing2 of the cone constraint PhysicsEngine/ConstraintInstance.h  

float GetAngularTwistLimit()

 Gets the twist limit angle in degrees PhysicsEngine/ConstraintInstance.h  

EAngularConstraintMotion GetAngularTwistMotion()

 Gets the motion type for the twist of the cone constraint PhysicsEngine/ConstraintInstance.h  
Get whether the SLERP angular velocity drive is enabled. PhysicsEngine/ConstraintInstance.h  

void GetAngularVelocityDriveTwistAndSwing ( bool& bOutEnableTwistDrive,
bool& bOutEnableSwingDrive
)

 Get which twist and swing angular velocity drives are enabled. PhysicsEngine/ConstraintInstance.h  

const FVector & GetAngularVelocityTarget()

 Get the angular drive's angular velocity target PhysicsEngine/ConstraintInstance.h  

const FName & GetChildBoneName()

 Get the child bone name PhysicsEngine/ConstraintInstance.h  

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/ConstraintInstance.h  

FVector GetConstraintLocation()

 Get the position of this constraint in world space. PhysicsEngine/ConstraintInstance.h  

float GetContactTransferScale()

 Get the Contact Transfer Scale for the parent of the joint PhysicsEngine/ConstraintInstance.h  

float GetCurrentSwing1()

 The current swing1 of the constraint. PhysicsEngine/ConstraintInstance.h  

float GetCurrentSwing2()

 The current swing2 of the constraint. PhysicsEngine/ConstraintInstance.h  

float GetCurrentTwist()

 The current twist of the constraint. PhysicsEngine/ConstraintInstance.h  

bool GetIsSoftLinearLimit()

 Whether the linear limits are soft (only if at least one axis if Limited) PhysicsEngine/ConstraintInstance.h  

bool GetIsSoftSwingLimit()

 Whether the swing limits are soft (only available if swing1 and/or swing2 is Limited) PhysicsEngine/ConstraintInstance.h  

bool GetIsSoftTwistLimit()

 Whether the twist limits are soft (only available if twist is Limited) PhysicsEngine/ConstraintInstance.h  

float GetLastKnownScale()

   PhysicsEngine/ConstraintInstance.h  

float GetLinearBreakThreshold()

 Gets linear force needed to break the joint PhysicsEngine/ConstraintInstance.h  

void GetLinearDriveParams ( float& OutPositionStrength,
float& OutVelocityStrength,
float& OutForceLimit
)

 Get the linear drive's strength parameters. PhysicsEngine/ConstraintInstance.h  

void GetLinearDriveParams ( FVector& OutPositionStrength,
FVector& OutVelocityStrength,
FVector& OutForceLimit
)

 Get the linear drive's strength parameters.Get the linear drive's strength parameters PhysicsEngine/ConstraintInstance.h  

float GetLinearLimit()

 Gets the linear limit size PhysicsEngine/ConstraintInstance.h  

float GetLinearPlasticityThreshold()

 Gets Delta from target needed to reset the target joint PhysicsEngine/ConstraintInstance.h  

TEnumAsByte< enum EConstraintPlasticityType > GetLinearPlasticityType()

 Gets Plasticity Type from joint PhysicsEngine/ConstraintInstance.h  

const FVector & GetLinearPositionTarget()

 Get the linear drive's target position position PhysicsEngine/ConstraintInstance.h  

const FVector & GetLinearVelocityTarget()

 Get the linear drive's target velocity PhysicsEngine/ConstraintInstance.h  

ELinearConstraintMotion GetLinearXMotion()

 Gets the motion type for the linear X-axis limit. PhysicsEngine/ConstraintInstance.h  

ELinearConstraintMotion GetLinearYMotion()

 Gets the motion type for the linear Y-axis limit. PhysicsEngine/ConstraintInstance.h  

ELinearConstraintMotion GetLinearZMotion()

 Gets the motion type for the linear Z-axis limit. PhysicsEngine/ConstraintInstance.h  
Get whether the SLERP angular position drive is enabled. PhysicsEngine/ConstraintInstance.h  

void GetOrientationDriveTwistAndSwing ( bool& bOutEnableTwistDrive,
bool& bOutEnableSwingDrive
)

 Get which twist and swing orientation drives are enabled. PhysicsEngine/ConstraintInstance.h  

const FName & GetParentBoneName()

 Get the parent bone name PhysicsEngine/ConstraintInstance.h  

const FPhysicsConstraintHandle & GetPhysicsConstraintRef()

 Get underlying physics engine constraint PhysicsEngine/ConstraintInstance.h  

void GetProjectionParams ( float& ProjectionLinearAlpha,
float& ProjectionAngularAlpha,
float& ProjectionLinearTolerance,
float& ProjectionAngularTolerance
) const

 Get projection parameters PhysicsEngine/ConstraintInstance.h  

FTransform GetRefFrame ( EConstraintFrame::Type Frame
) const

 Get component ref frame. PhysicsEngine/ConstraintInstance.h  

float GetShockPropagationAlpha()

 Get the shock propagation amount [0, 1] PhysicsEngine/ConstraintInstance.h  

float GetSoftLinearLimitContactDistance()

 Linear contact distance if the constraint is set to use soft linear limits PhysicsEngine/ConstraintInstance.h  

float GetSoftLinearLimitDamping()

 Linear damping if the constraint is set to use soft linear limits PhysicsEngine/ConstraintInstance.h  

float GetSoftLinearLimitRestitution()

 Linear restitution if the constraint is set to use soft linear limits PhysicsEngine/ConstraintInstance.h  

float GetSoftLinearLimitStiffness()

 Linear stiffness if the constraint is set to use soft linear limits PhysicsEngine/ConstraintInstance.h  

float GetSoftSwingLimitContactDistance()

 Swing Contact distance if the constraint is set to use soft limits PhysicsEngine/ConstraintInstance.h  

float GetSoftSwingLimitDamping()

 Swing damping if the constraint is set to use soft limits PhysicsEngine/ConstraintInstance.h  

float GetSoftSwingLimitRestitution()

 Swing restitution if the constraint is set to use soft limits PhysicsEngine/ConstraintInstance.h  

float GetSoftSwingLimitStiffness()

 Swing stiffness if the constraint is set to use soft limits PhysicsEngine/ConstraintInstance.h  

float GetSoftTwistLimitContactDistance()

 Twist contact distance if the constraint is set to use soft limits PhysicsEngine/ConstraintInstance.h  

float GetSoftTwistLimitDamping()

 Twist damping if the constraint is set to use soft limits PhysicsEngine/ConstraintInstance.h  

float GetSoftTwistLimitRestitution()

 Twist restitution if the constraint is set to use soft limits PhysicsEngine/ConstraintInstance.h  

float GetSoftTwistLimitStiffness()

 Twist stiffness if the constraint is set to use soft limits PhysicsEngine/ConstraintInstance.h  

void GetUsedMaterials ( TArray< UMaterialInterface* >& Materials
)

   PhysicsEngine/ConstraintInstance.h  

bool HasAngularPlasticity()

 Gets Whether it is possible to reset the target angles PhysicsEngine/ConstraintInstance.h  

bool HasLinearPlasticity()

 Gets Whether it is possible to reset the target position PhysicsEngine/ConstraintInstance.h  

void InitConstraint ( Chaos::FPhysicsObject* Body1,
Chaos::FPhysicsObject* Body2,
float Scale,
UObject* DebugOwner,
FOnConstraintBroken InConstraintBrokenDelegate,
FOnPlasticDeformation InPlasticDeformationDelegate
)

   PhysicsEngine/ConstraintInstance.h  

void InitConstraint ( FBodyInstance* Body1,
FBodyInstance* Body2,
float Scale,
UObject* DebugOwner,
FOnConstraintBroken InConstraintBrokenDelegate,
FOnPlasticDeformation InPlasticDeformationDelegate
)

 Create physics engine constraint. PhysicsEngine/ConstraintInstance.h  

void InitConstraint_AssumesLocked ( Chaos::FPhysicsObject* Body1,
Chaos::FPhysicsObject* Body2,
float InScale,
FOnConstraintBroken InConstraintBrokenDelegate,
FOnPlasticDeformation InPlasticDeformationDelegate
)

   PhysicsEngine/ConstraintInstance.h  

void InitConstraint_AssumesLocked ( const FPhysicsActorHandle& ActorRef1,
const FPhysicsActorHandle& ActorRef2,
float InScale,
FOnConstraintBroken InConstraintBrokenDelegate,
FOnPlasticDeformation InPlasticDeformationDelegate
)

 Create physics engine constraint using physx actors. PhysicsEngine/ConstraintInstance.h  

bool IsAngularBreakable()

 Gets Whether it is possible to break the joint with angular force PhysicsEngine/ConstraintInstance.h  

bool IsAngularOrientationDriveEnabled()

 Whether the angular orientation drive is enabled PhysicsEngine/ConstraintInstance.h  

bool IsAngularVelocityDriveEnabled()

 Whether the angular velocity drive is enabled PhysicsEngine/ConstraintInstance.h  

bool IsBroken()

 Retrieve the status of constraint being broken. PhysicsEngine/ConstraintInstance.h  

bool IsCollisionDisabled()

 Whether collision is currently disabled PhysicsEngine/ConstraintInstance.h  

bool IsLinearBreakable()

 Gets Whether it is possible to break the joint with linear force PhysicsEngine/ConstraintInstance.h  

bool IsLinearPositionDriveEnabled()

 Whether the linear position drive is enabled PhysicsEngine/ConstraintInstance.h  

bool IsLinearPositionDriveXEnabled()

 Get which linear position drives is enabled on XAxis PhysicsEngine/ConstraintInstance.h  

bool IsLinearPositionDriveYEnabled()

 Get which linear position drives is enabled on YAxis PhysicsEngine/ConstraintInstance.h  

bool IsLinearPositionDriveZEnabled()

 Get which linear position drives is enabled on ZAxis PhysicsEngine/ConstraintInstance.h  

bool IsLinearVelocityDriveEnabled()

 Whether the linear velocity drive is enabled PhysicsEngine/ConstraintInstance.h  

bool IsLinearVelocityDriveXEnabled()

 Get which linear position drives is enabled on XAxis PhysicsEngine/ConstraintInstance.h  

bool IsLinearVelocityDriveYEnabled()

 Get which linear position drives is enabled on YAxis PhysicsEngine/ConstraintInstance.h  

bool IsLinearVelocityDriveZEnabled()

 Get which linear position drives is enabled on ZAxis PhysicsEngine/ConstraintInstance.h  
Whether mass conditioning is enabled. PhysicsEngine/ConstraintInstance.h  

bool IsParentDominatesEnabled()

 Whether parent domination is enabled (meaning the parent body cannot be be affected at all by a child) PhysicsEngine/ConstraintInstance.h  

bool IsProjectionEnabled()

 Whether projection is enabled for this constraint PhysicsEngine/ConstraintInstance.h  

bool IsTerminated()

 Whether the physics engine constraint has been terminated PhysicsEngine/ConstraintInstance.h  

bool IsValidConstraintInstance()

 See if this constraint is valid. PhysicsEngine/ConstraintInstance.h  

void PostSerialize ( const FArchive& Ar
)

   PhysicsEngine/ConstraintInstance.h  

bool Serialize ( FArchive& Ar
)

   PhysicsEngine/ConstraintInstance.h  

void SerializeState ( Chaos::FSerializedDataBuffer& OutSerializedState,
Chaos::ESerializedDataContext DataContext
)

 Serialized out the physics thread state of this constraint as an array of bytes PhysicsEngine/ConstraintInstance.h  

void SetAngularBreakable ( bool bInAngularBreakable,
float InAngularBreakThreshold
)

 Sets the Angular Breakable properties PhysicsEngine/ConstraintInstance.h  

void SetAngularDOFLimitScale ( float InSwing1LimitScale,
float InSwing2LimitScale,
float InTwistLimitScale
)

 Scale Angular Limit Constraints (as defined in RB_ConstraintSetup). PhysicsEngine/ConstraintInstance.h  

void SetAngularDriveAccelerationMode ( bool bAccelerationMode
)

 Set the angular drive force-mode PhysicsEngine/ConstraintInstance.h  

void SetAngularDriveMode ( EAngularDriveMode::Type DriveMode
)

 Set the angular drive mode PhysicsEngine/ConstraintInstance.h  

void SetAngularDriveParams ( float InSpring,
float InDamping,
float InForceLimit
)

 Set the angular drive's strength parametersFunction for setting angular motor parameters. PhysicsEngine/ConstraintInstance.h  

void SetAngularOrientationTarget ( const FQuat& InPosTarget
)

 Set the angular drive's orientation targetFunction for setting target angular position. PhysicsEngine/ConstraintInstance.h  

void SetAngularPlasticity ( bool bInAngularPlasticity,
float InAngularPlasticityThreshold
)

 Sets the Angular Plasticity properties PhysicsEngine/ConstraintInstance.h  

void SetAngularSwing1Limit ( EAngularConstraintMotion MotionType,
float InSwing1LimitAngle
)

 Sets the Angular Swing1 Motion Type PhysicsEngine/ConstraintInstance.h  

void SetAngularSwing1Motion ( EAngularConstraintMotion MotionType
)

 Sets the cone limit's swing1 motion type PhysicsEngine/ConstraintInstance.h  

void SetAngularSwing2Limit ( EAngularConstraintMotion MotionType,
float InSwing2LimitAngle
)

 Sets the Angular Swing2 Motion Type PhysicsEngine/ConstraintInstance.h  

void SetAngularSwing2Motion ( EAngularConstraintMotion MotionType
)

 Sets the cone limit's swing2 motion type PhysicsEngine/ConstraintInstance.h  

void SetAngularTwistLimit ( EAngularConstraintMotion MotionType,
float InTwistLimitAngle
)

 Sets the Angular Twist Motion Type PhysicsEngine/ConstraintInstance.h  

void SetAngularTwistMotion ( EAngularConstraintMotion MotionType
)

 Sets the twist limit's motion type PhysicsEngine/ConstraintInstance.h  

void SetAngularVelocityDriveSLERP ( bool bInEnableSLERP
)

 Set whether the SLERP angular velocity drive is enabled. PhysicsEngine/ConstraintInstance.h  

void SetAngularVelocityDriveTwistAndSwing ( bool bInEnableTwistDrive,
bool bInEnableSwingDrive
)

 Set which twist and swing angular velocity drives are enabled. PhysicsEngine/ConstraintInstance.h  

void SetAngularVelocityTarget ( const FVector& InVelTarget
)

 Set the angular drive's angular velocity target (in revolutions per second) PhysicsEngine/ConstraintInstance.h  

void SetContactTransferScale ( float InContactTransferScale
)

 Sets the Contact Transfer Scale properties PhysicsEngine/ConstraintInstance.h  

void SetDisableCollision ( bool InDisableCollision
)

 Set whether jointed actors can collide with each other PhysicsEngine/ConstraintInstance.h  

void SetDriveParams ( const FVector& InPositionStrength,
const FVector& InVelocityStrength,
const FVector& InForceLimit,
const FVector& InAngularSpring,
const FVector& InAngularDamping,
const FVector& InTorqueLimit,
EAngularDriveMode::Type InAngularDriveMode
)

 This allows the most common drive parameters to be set in one call, avoiding lock overheads etc. PhysicsEngine/ConstraintInstance.h  

void SetLinearBreakable ( bool bInLinearBreakable,
float InLinearBreakThreshold
)

 Sets the Linear Breakable properties PhysicsEngine/ConstraintInstance.h  

void SetLinearDriveAccelerationMode ( bool bAccelerationMode
)

 Set the linear drive force-mode PhysicsEngine/ConstraintInstance.h  

void SetLinearDriveParams ( float InPositionStrength,
float InVelocityStrength,
float InForceLimit
)

 Set the linear drive's strength parametersFunction for setting linear motor parameters. PhysicsEngine/ConstraintInstance.h  

void SetLinearDriveParams ( const FVector& InPositionStrength,
const FVector& InVelocityStrength,
const FVector& InForceLimit
)

 Set the linear drive's strength parameters per-axis PhysicsEngine/ConstraintInstance.h  

void SetLinearLimits ( ELinearConstraintMotion XConstraintType,
ELinearConstraintMotion YConstraintType,
ELinearConstraintMotion ZConstraintType,
float InLinearLimitSize
)

 Sets the Linear XYZ Motion Type and the limit distance (Note distance is the same for all 3 axes) PhysicsEngine/ConstraintInstance.h  

void SetLinearLimitSize ( float NewLimitSize
)

 Allows you to dynamically change the size of the linear limit 'sphere'. PhysicsEngine/ConstraintInstance.h  

void SetLinearPlasticity ( bool bInLinearPlasticity,
float InLinearPlasticityThreshold,
EConstraintPlasticityType InLinearPlasticityType
)

 Sets the Linear Plasticity properties PhysicsEngine/ConstraintInstance.h  

void SetLinearPositionDrive ( bool bEnableXDrive,
bool bEnableYDrive,
bool bEnableZDrive
)

 Set which linear position drives are enabled PhysicsEngine/ConstraintInstance.h  

void SetLinearPositionTarget ( const FVector& InPosTarget
)

 Set the linear drive's target position positionFunction for setting linear position target. PhysicsEngine/ConstraintInstance.h  

void SetLinearVelocityDrive ( bool bEnableXDrive,
bool bEnableYDrive,
bool bEnableZDrive
)

 Set which linear velocity drives are enabled PhysicsEngine/ConstraintInstance.h  

void SetLinearVelocityTarget ( const FVector& InVelTarget
)

 Set the linear drive's target velocityFunction for setting linear velocity target. PhysicsEngine/ConstraintInstance.h  

void SetLinearXLimit ( ELinearConstraintMotion XConstraintType,
float InLinearLimitSize
)

 Sets the LinearX Motion Type and the limit distance (Note distance is the same for all 3 axes) PhysicsEngine/ConstraintInstance.h  

void SetLinearXMotion ( ELinearConstraintMotion XConstraintType
)

 Sets the Linear XMotion type PhysicsEngine/ConstraintInstance.h  

void SetLinearYLimit ( ELinearConstraintMotion YConstraintType,
float InLinearLimitSize
)

 Sets the LinearY Motion Type and the limit distance (Note distance is the same for all 3 axes) PhysicsEngine/ConstraintInstance.h  

void SetLinearYMotion ( ELinearConstraintMotion YConstraintType
)

 Sets the Linear YMotion type PhysicsEngine/ConstraintInstance.h  

void SetLinearZLimit ( ELinearConstraintMotion ZConstraintType,
float InLinearLimitSize
)

 Sets the LinearZ Motion Type and the limit distance (Note distance is the same for all 3 axes) PhysicsEngine/ConstraintInstance.h  

void SetLinearZMotion ( ELinearConstraintMotion ZConstraintType
)

 Sets the Linear ZMotion type PhysicsEngine/ConstraintInstance.h  

void SetOrientationDriveSLERP ( bool bInEnableSLERP
)

 Set whether the SLERP angular position drive is enabled. PhysicsEngine/ConstraintInstance.h  

void SetOrientationDriveTwistAndSwing ( bool bInEnableTwistDrive,
bool bInEnableSwingDrive
)

 Set which twist and swing orientation drives are enabled. PhysicsEngine/ConstraintInstance.h  

void SetParentDominates ( bool bParentDominates
)

   PhysicsEngine/ConstraintInstance.h  

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

 Set projection parameters PhysicsEngine/ConstraintInstance.h  

void SetRefFrame ( 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/ConstraintInstance.h  

void SetRefOrientation ( 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/ConstraintInstance.h  

void SetRefPosition ( 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/ConstraintInstance.h  

void SetShockPropagationParams ( bool bEnableShockPropagation,
float ShockPropagationAlpha
)

 Set the shock propagation amount [0, 1] PhysicsEngine/ConstraintInstance.h  

void SetSoftLinearLimitParams ( bool bIsSoftLimit,
float Stiffness,
float Damping,
float Restitution,
float ContactDistance
)

 Set twist soft limit parameters PhysicsEngine/ConstraintInstance.h  

void SetSoftSwingLimitParams ( bool bIsSoftLimit,
float Stiffness,
float Damping,
float Restitution,
float ContactDistance
)

 Set twist soft limit parameters PhysicsEngine/ConstraintInstance.h  

void SetSoftTwistLimitParams ( bool bIsSoftLimit,
float Stiffness,
float Damping,
float Restitution,
float ContactDistance
)

 Set twist soft limit parameters PhysicsEngine/ConstraintInstance.h  

void SnapTransformsToDefault ( const EConstraintTransformComponentFlags SnapFlags,
const UPhysicsAsset*const PhysicsAsset
)

 Set the constraint transform components specified by the SnapFlags to their default values (derived from the parent and child bone transforms). PhysicsEngine/ConstraintInstance.h  

void TermConstraint()

 Terminate physics engine constraint PhysicsEngine/ConstraintInstance.h  
Refreshes the physics engine joint's angular limits. PhysicsEngine/ConstraintInstance.h  
Refreshes the physics engine joint's linear limits. PhysicsEngine/ConstraintInstance.h  

Static

Name Remarks Include Path Unreal Specifiers

static FConstraintInstance * Alloc()

   PhysicsEngine/ConstraintInstance.h  

static void Free ( FConstraintInstance* Ptr
)

 Hacks to easily get zeroed memory for special case when we don't use GC. PhysicsEngine/ConstraintInstance.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
AngularBreakThreshold_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
AngularDriveDamping_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
AngularDriveForceLimit_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
AngularDriveMode_DEPRECATED TEnumAsByte< EAngularDriveMode::Type >   PhysicsEngine/ConstraintInstance.h  
AngularDriveSpring_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
AngularOrientationTarget_DEPRECATED FRotator   PhysicsEngine/ConstraintInstance.h  
AngularPositionTarget_DEPRECATED FQuat   PhysicsEngine/ConstraintInstance.h  
AngularSwing1Motion_DEPRECATED TEnumAsByte< enum EAngularConstraintMotion >   PhysicsEngine/ConstraintInstance.h  
AngularSwing2Motion_DEPRECATED TEnumAsByte< enum EAngularConstraintMotion >   PhysicsEngine/ConstraintInstance.h  
AngularTwistMotion_DEPRECATED TEnumAsByte< enum EAngularConstraintMotion >   PhysicsEngine/ConstraintInstance.h  
AngularVelocityTarget_DEPRECATED FVector   PhysicsEngine/ConstraintInstance.h  
bAngularBreakable_DEPRECATED uint32   PhysicsEngine/ConstraintInstance.h  
bAngularOrientationDrive_DEPRECATED uint32   PhysicsEngine/ConstraintInstance.h  
bAngularSlerpDrive_DEPRECATED uint32   PhysicsEngine/ConstraintInstance.h  
bAngularVelocityDrive_DEPRECATED uint32   PhysicsEngine/ConstraintInstance.h  
bDisableCollision_DEPRECATED uint32 DEPRECATED Most of these properties have moved inside the ProfileInstance member (FConstraintProfileProperties struct) PhysicsEngine/ConstraintInstance.h  
bEnableProjection_DEPRECATED uint32   PhysicsEngine/ConstraintInstance.h  
bLinearBreakable_DEPRECATED uint32   PhysicsEngine/ConstraintInstance.h  
bLinearLimitSoft_DEPRECATED uint32   PhysicsEngine/ConstraintInstance.h  
bLinearPositionDrive_DEPRECATED uint32   PhysicsEngine/ConstraintInstance.h  
bLinearVelocityDrive_DEPRECATED uint32   PhysicsEngine/ConstraintInstance.h  
bSwingLimitSoft_DEPRECATED uint32   PhysicsEngine/ConstraintInstance.h  
bSwingPositionDrive_DEPRECATED uint32   PhysicsEngine/ConstraintInstance.h  
bSwingVelocityDrive_DEPRECATED uint32   PhysicsEngine/ConstraintInstance.h  
bTwistLimitSoft_DEPRECATED uint32   PhysicsEngine/ConstraintInstance.h  
bTwistPositionDrive_DEPRECATED uint32   PhysicsEngine/ConstraintInstance.h  
bTwistVelocityDrive_DEPRECATED uint32   PhysicsEngine/ConstraintInstance.h  
LinearBreakThreshold_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
LinearDriveDamping_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
LinearDriveForceLimit_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
LinearDriveSpring_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
LinearLimitDamping_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
LinearLimitSize_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
LinearLimitStiffness_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
LinearPositionTarget_DEPRECATED FVector   PhysicsEngine/ConstraintInstance.h  
LinearVelocityTarget_DEPRECATED FVector   PhysicsEngine/ConstraintInstance.h  
LinearXMotion_DEPRECATED TEnumAsByte< enum ELinearConstraintMotion >   PhysicsEngine/ConstraintInstance.h  
LinearYMotion_DEPRECATED TEnumAsByte< enum ELinearConstraintMotion >   PhysicsEngine/ConstraintInstance.h  
LinearZMotion_DEPRECATED TEnumAsByte< enum ELinearConstraintMotion >   PhysicsEngine/ConstraintInstance.h  
ProjectionAngularTolerance_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
ProjectionLinearTolerance_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
Swing1LimitAngle_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
Swing2LimitAngle_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
SwingLimitDamping_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
SwingLimitStiffness_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
TwistLimitAngle_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
TwistLimitDamping_DEPRECATED float   PhysicsEngine/ConstraintInstance.h  
TwistLimitStiffness_DEPRECATED float   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