Functions
Physics\|Constraints
void	GetProjectionParams (FConstraintInstanceAccessor &Accessor, bool &bEnableProjection, float32 &ProjectionLinearAlpha, float32 &ProjectionAngularAlpha)
	Gets projection parameters of the constraint.
void	GetAngularBreakable (FConstraintInstanceAccessor &Accessor, bool &bAngularBreakable, float32 &AngularBreakThreshold)
	Gets Constraint Angular Breakable properties.
void	GetAngularDriveMode (FConstraintInstanceAccessor &Accessor, EAngularDriveMode &OutDriveMode)
	Gets the angular drive mode ( SLERP or Twist And Swing).
void	GetAngularDriveParams (FConstraintInstanceAccessor &Accessor, float32 &OutPositionStrength, float32 &OutVelocityStrength, float32 &OutForceLimit)
	Gets the drive params for the angular drive.
void	GetAngularLimits (FConstraintInstanceAccessor &Accessor, EAngularConstraintMotion &Swing1MotionType, float32 &Swing1LimitAngle, EAngularConstraintMotion &Swing2MotionType, float32 &Swing2LimitAngle, EAngularConstraintMotion &TwistMotionType, float32 &TwistLimitAngle)
	Gets Constraint Angular Motion Ranges.
void	GetAngularOrientationTarget (FConstraintInstanceAccessor &Accessor, FRotator &OutPosTarget)
	Gets the target orientation for the angular drive.
void	GetAngularPlasticity (FConstraintInstanceAccessor &Accessor, bool &bAngularPlasticity, float32 &AngularPlasticityThreshold)
	Sets Constraint Angular Plasticity properties.
void	GetAngularSoftSwingLimitParams (FConstraintInstanceAccessor &Accessor, bool &bSoftSwingLimit, float32 &SwingLimitStiffness, float32 &SwingLimitDamping, float32 &SwingLimitRestitution, float32 &SwingLimitContactDistance)
	Gets Constraint Angular Soft Swing Limit parameters.
void	GetAngularSoftTwistLimitParams (FConstraintInstanceAccessor &Accessor, bool &bSoftTwistLimit, float32 &TwistLimitStiffness, float32 &TwistLimitDamping, float32 &TwistLimitRestitution, float32 &TwistLimitContactDistance)
	Gets Constraint Angular Soft Twist Limit parameters.
void	GetAngularVelocityDriveSLERP (FConstraintInstanceAccessor &Accessor, bool &bOutEnableSLERP)
	Gets whether the angular velocity slerp drive is enabled or not. Only relevant if the AngularDriveMode is set to SLERP.
void	GetAngularVelocityDriveTwistAndSwing (FConstraintInstanceAccessor &Accessor, bool &bOutEnableTwistDrive, bool &bOutEnableSwingDrive)
	Gets whether angular velocity twist and swing drive is enabled or not. Only relevant if the AngularDriveMode is set to Twist and Swing.
void	GetAngularVelocityTarget (FConstraintInstanceAccessor &Accessor, FVector &OutVelTarget)
	Gets the target velocity for the angular drive.
void	GetAttachedBodyNames (FConstraintInstanceAccessor &Accessor, FName &ParentBody, FName &ChildBody)
	Gets Attached body names.
void	GetContactTransferScale (FConstraintInstanceAccessor &Accessor, float32 &ContactTransferScale)
	Gets Constraint Contact Transfer Scale properties.
bool	GetDisableCollsion (FConstraintInstanceAccessor &Accessor)
	Gets whether bodies attched to the constraint can collide or not.
void	GetLinearBreakable (FConstraintInstanceAccessor &Accessor, bool &bLinearBreakable, float32 &LinearBreakThreshold)
	Gets Constraint Linear Breakable properties.
void	GetLinearDriveParams (FConstraintInstanceAccessor &Accessor, float32 &OutPositionStrength, float32 &OutVelocityStrength, float32 &OutForceLimit)
	Gets the drive params for the linear drive.
void	GetLinearLimits (FConstraintInstanceAccessor &Accessor, ELinearConstraintMotion &XMotion, ELinearConstraintMotion &YMotion, ELinearConstraintMotion &ZMotion, float32 &Limit)
	Gets Constraint Linear Motion Ranges.
void	GetLinearPlasticity (FConstraintInstanceAccessor &Accessor, bool &bLinearPlasticity, float32 &LinearPlasticityThreshold, EConstraintPlasticityType &PlasticityType)
	Gets Constraint Linear Plasticity properties.
void	GetLinearPositionDrive (FConstraintInstanceAccessor &Accessor, bool &bOutEnableDriveX, bool &bOutEnableDriveY, bool &bOutEnableDriveZ)
	Gets whether linear position drive is enabled or not.
void	GetLinearPositionTarget (FConstraintInstanceAccessor &Accessor, FVector &OutPosTarget)
	Gets the target position for the linear drive.
void	GetLinearSoftLimitParams (FConstraintInstanceAccessor &Accessor, bool &bSoftLinearLimit, float32 &LinearLimitStiffness, float32 &LinearLimitDamping, float32 &LinearLimitRestitution, float32 &LinearLimitContactDistance)
	Gets Constraint Linear Soft Limit parameters.
void	GetLinearVelocityDrive (FConstraintInstanceAccessor &Accessor, bool &bOutEnableDriveX, bool &bOutEnableDriveY, bool &bOutEnableDriveZ)
	Gets whether linear velocity drive is enabled or not.
void	GetLinearVelocityTarget (FConstraintInstanceAccessor &Accessor, FVector &OutVelTarget)
	Gets the target velocity for the linear drive.
bool	GetMassConditioningEnabled (FConstraintInstanceAccessor &Accessor)
	@brief Gets whether mass conditioning is enabled for the constraint.
void	GetOrientationDriveSLERP (FConstraintInstanceAccessor &Accessor, bool &bOutEnableSLERP)
	Gets whether the angular orientation slerp drive is enabled or not. Only relevant if the AngularDriveMode is set to SLERP.
void	GetOrientationDriveTwistAndSwing (FConstraintInstanceAccessor &Accessor, bool &bOutEnableTwistDrive, bool &bOutEnableSwingDrive)
	Gets whether angular orientation drive are enabled. Only relevant if the AngularDriveMode is set to Twist and Swing.
bool	GetParentDominates (FConstraintInstanceAccessor &Accessor)
	Gets whether the parent body is not affected by it's child motion.
void	CopyParams (FConstraintInstanceAccessor &Accessor, FConstraintInstanceAccessor &SourceAccessor, bool bKeepPosition=true, bool bKeepRotation=true)
	Copies all properties from one constraint to another.
void	SetAngularBreakable (FConstraintInstanceAccessor &Accessor, bool bAngularBreakable, float32 AngularBreakThreshold)
	Sets Constraint Angular Breakable properties.
void	SetAngularDriveMode (FConstraintInstanceAccessor &Accessor, EAngularDriveMode DriveMode)
	Switches the angular drive mode between SLERP and Twist And Swing.
void	SetAngularDriveParams (FConstraintInstanceAccessor &Accessor, float32 PositionStrength, float32 VelocityStrength, float32 InForceLimit)
	Sets the drive params for the angular drive.
void	SetAngularLimits (FConstraintInstanceAccessor &Accessor, EAngularConstraintMotion Swing1MotionType, float32 Swing1LimitAngle, EAngularConstraintMotion Swing2MotionType, float32 Swing2LimitAngle, EAngularConstraintMotion TwistMotionType, float32 TwistLimitAngle)
	Sets COnstraint Angular Motion Ranges.
void	SetAngularOrientationTarget (FConstraintInstanceAccessor &Accessor, FRotator InPosTarget)
	Sets the target orientation for the angular drive.
void	SetAngularPlasticity (FConstraintInstanceAccessor &Accessor, bool bAngularPlasticity, float32 AngularPlasticityThreshold)
	Sets Constraint Angular Plasticity properties.
void	SetAngularSoftSwingLimitParams (FConstraintInstanceAccessor &Accessor, bool bSoftSwingLimit, float32 SwingLimitStiffness, float32 SwingLimitDamping, float32 SwingLimitRestitution, float32 SwingLimitContactDistance)
	Sets Constraint Angular Soft Swing Limit parameters.
void	SetAngularSoftTwistLimitParams (FConstraintInstanceAccessor &Accessor, bool bSoftTwistLimit, float32 TwistLimitStiffness, float32 TwistLimitDamping, float32 TwistLimitRestitution, float32 TwistLimitContactDistance)
	Sets Constraint Angular Soft Twist Limit parameters.
void	SetAngularVelocityDriveSLERP (FConstraintInstanceAccessor &Accessor, bool bEnableSLERP)
	Enables/Disables the angular velocity slerp drive. Only relevant if the AngularDriveMode is set to SLERP.
void	SetAngularVelocityDriveTwistAndSwing (FConstraintInstanceAccessor &Accessor, bool bEnableTwistDrive, bool bEnableSwingDrive)
	Enables/Disables angular velocity twist and swing drive. Only relevant if the AngularDriveMode is set to Twist and Swing.
void	SetAngularVelocityTarget (FConstraintInstanceAccessor &Accessor, FVector InVelTarget)
	Sets the target velocity for the angular drive.
void	SetContactTransferScale (FConstraintInstanceAccessor &Accessor, float32 ContactTransferScale)
	Set Contact Transfer Scale.
void	SetDisableCollision (FConstraintInstanceAccessor &Accessor, bool bDisableCollision)
	Sets whether bodies attched to the constraint can collide or not.
void	SetLinearBreakable (FConstraintInstanceAccessor &Accessor, bool bLinearBreakable, float32 LinearBreakThreshold)
	Sets the Linear Breakable properties.
void	SetLinearDriveParams (FConstraintInstanceAccessor &Accessor, float32 PositionStrength, float32 VelocityStrength, float32 InForceLimit)
	Sets the drive params for the linear drive.
void	SetLinearLimits (FConstraintInstanceAccessor &Accessor, ELinearConstraintMotion XMotion, ELinearConstraintMotion YMotion, ELinearConstraintMotion ZMotion, float32 Limit)
	Sets Constraint Linear Motion Ranges.
void	SetLinearPlasticity (FConstraintInstanceAccessor &Accessor, bool bLinearPlasticity, float32 LinearPlasticityThreshold, EConstraintPlasticityType PlasticityType)
	Sets Constraint Linear Plasticity properties.
void	SetLinearPositionDrive (FConstraintInstanceAccessor &Accessor, bool bEnableDriveX, bool bEnableDriveY, bool bEnableDriveZ)
	Enables/Disables linear position drive.
void	SetLinearPositionTarget (FConstraintInstanceAccessor &Accessor, FVector InPosTarget)
	Sets the target position for the linear drive.
void	SetLinearSoftLimitParams (FConstraintInstanceAccessor &Accessor, bool bSoftLinearLimit, float32 LinearLimitStiffness, float32 LinearLimitDamping, float32 LinearLimitRestitution, float32 LinearLimitContactDistance)
	Sets Constraint Linear Soft Limit parameters.
void	SetLinearVelocityDrive (FConstraintInstanceAccessor &Accessor, bool bEnableDriveX, bool bEnableDriveY, bool bEnableDriveZ)
	Enables/Disables linear velocity drive.
void	SetLinearVelocityTarget (FConstraintInstanceAccessor &Accessor, FVector InVelTarget)
	Sets the target velocity for the linear drive.
void	SetMassConditioningEnabled (FConstraintInstanceAccessor &Accessor, bool bEnableMassConditioning)
	@brief Enable or disable mass conditioning for the constraint.
void	SetOrientationDriveSLERP (FConstraintInstanceAccessor &Accessor, bool bEnableSLERP)
	Enables/Disables the angular orientation slerp drive. Only relevant if the AngularDriveMode is set to SLERP.
void	SetOrientationDriveTwistAndSwing (FConstraintInstanceAccessor &Accessor, bool bEnableTwistDrive, bool bEnableSwingDrive)
	Enables/Disables angular orientation drive. Only relevant if the AngularDriveMode is set to Twist and Swing.
void	SetParentDominates (FConstraintInstanceAccessor &Accessor, bool bParentDominates)
	Sets whether the parent body is not affected by it's child motion.
void	SetProjectionParams (FConstraintInstanceAccessor &Accessor, bool bEnableProjection, float32 ProjectionLinearAlpha, float32 ProjectionAngularAlpha)
	Sets projection parameters of the constraint.

Function Documentation

◆ CopyParams()

void CopyParams	(	FConstraintInstanceAccessor &	Accessor,
		FConstraintInstanceAccessor &	SourceAccessor,
		bool	bKeepPosition = true,
		bool	bKeepRotation = true )

Copies all properties from one constraint to another.

Parameters

Accessor	Constraint accessor to write to
SourceAccessor	Constraint accessor to read from
bKeepPosition	Whether to keep original constraint positions
bKeepRotation	Whether to keep original constraint rotations

◆ GetAngularBreakable()

void GetAngularBreakable	(	FConstraintInstanceAccessor &	Accessor,
		bool &	bAngularBreakable,
		float32 &	AngularBreakThreshold )

Gets Constraint Angular Breakable properties.

Parameters

Accessor	Constraint accessor to query
bAngularBreakable	Whether it is possible to break the joint with angular force
AngularBreakThreshold	Torque needed to break the joint

◆ GetAngularDriveMode()

void GetAngularDriveMode	(	FConstraintInstanceAccessor &	Accessor,
		EAngularDriveMode &	OutDriveMode )

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

Parameters

Accessor	Constraint accessor to query
OutDriveMode	The angular drive mode to use. SLERP uses shortest spherical path, but will not work if any angular constraints are locked. Twist and Swing decomposes the path into the different angular degrees of freedom but may experience gimbal lock

◆ GetAngularDriveParams()

void GetAngularDriveParams	(	FConstraintInstanceAccessor &	Accessor,
		float32 &	OutPositionStrength,
		float32 &	OutVelocityStrength,
		float32 &	OutForceLimit )

Gets the drive params for the angular drive.

Parameters

Accessor	Constraint accessor to query
OutPositionStrength	Positional strength for the drive (stiffness)
OutVelocityStrength	Velocity strength of the drive (damping)
OutForceLimit	Max force applied by the drive

◆ GetAngularLimits()

void GetAngularLimits	(	FConstraintInstanceAccessor &	Accessor,
		EAngularConstraintMotion &	Swing1MotionType,
		float32 &	Swing1LimitAngle,
		EAngularConstraintMotion &	Swing2MotionType,
		float32 &	Swing2LimitAngle,
		EAngularConstraintMotion &	TwistMotionType,
		float32 &	TwistLimitAngle )

Gets Constraint Angular Motion Ranges.

Parameters

Accessor	Constraint accessor to query
Swing1MotionType	Type of swing motion ( first axis )
Swing1LimitAngle	Size of limit in degrees in [0, 180] range
Swing2MotionType	Type of swing motion ( second axis )
Swing2LimitAngle	Size of limit in degrees in [0, 180] range
TwistMotionType	Type of twist motion
TwistLimitAngle	Size of limit in degrees in [0, 180] range

◆ GetAngularOrientationTarget()

void GetAngularOrientationTarget	(	FConstraintInstanceAccessor &	Accessor,
		FRotator &	OutPosTarget )

Gets the target orientation for the angular drive.

Parameters

Accessor	Constraint accessor to query
OutPosTarget	Target orientation

◆ GetAngularPlasticity()

void GetAngularPlasticity	(	FConstraintInstanceAccessor &	Accessor,
		bool &	bAngularPlasticity,
		float32 &	AngularPlasticityThreshold )

Sets Constraint Angular Plasticity properties.

Parameters

Accessor	Constraint accessor to query
bAngularPlasticity	Whether it is possible to reset the target angle from the angular displacement
AngularPlasticityThreshold	Degrees needed to reset the rest state of the joint

◆ GetAngularSoftSwingLimitParams()

void GetAngularSoftSwingLimitParams	(	FConstraintInstanceAccessor &	Accessor,
		bool &	bSoftSwingLimit,
		float32 &	SwingLimitStiffness,
		float32 &	SwingLimitDamping,
		float32 &	SwingLimitRestitution,
		float32 &	SwingLimitContactDistance )

Gets Constraint Angular Soft Swing Limit parameters.

Parameters

Accessor	Constraint accessor to query *
bSoftSwingLimit	True is the swing limit is soft
SwingLimitStiffness	Stiffness of the soft swing limit. Only used when Soft limit is on ( positive value )
SwingLimitDamping	Damping of the soft swing limit. Only used when Soft limit is on ( positive value )
SwingLimitRestitution	Controls the amount of bounce when the constraint is violated. A restitution value of 1 will bounce back with the same velocity the limit was hit. A value of 0 will stop dead.
SwingLimitContactDistance	Determines how close to the limit we have to get before turning the joint on. Larger value will be more expensive, but will do a better job not violating constraints. A smaller value will be more efficient, but easier to violate.

◆ GetAngularSoftTwistLimitParams()

void GetAngularSoftTwistLimitParams	(	FConstraintInstanceAccessor &	Accessor,
		bool &	bSoftTwistLimit,
		float32 &	TwistLimitStiffness,
		float32 &	TwistLimitDamping,
		float32 &	TwistLimitRestitution,
		float32 &	TwistLimitContactDistance )

Gets Constraint Angular Soft Twist Limit parameters.

Parameters

Accessor	Constraint accessor to query *
bSoftTwistLimit	True is the Twist limit is soft
TwistLimitStiffness	Stiffness of the soft Twist limit. Only used when Soft limit is on ( positive value )
TwistLimitDamping	Damping of the soft Twist limit. Only used when Soft limit is on ( positive value )
TwistLimitRestitution	Controls the amount of bounce when the constraint is violated. A restitution value of 1 will bounce back with the same velocity the limit was hit. A value of 0 will stop dead.
TwistLimitContactDistance	Determines how close to the limit we have to get before turning the joint on. Larger value will be more expensive, but will do a better job not violating constraints. A smaller value will be more efficient, but easier to violate.

◆ GetAngularVelocityDriveSLERP()

void GetAngularVelocityDriveSLERP	(	FConstraintInstanceAccessor &	Accessor,
		bool &	bOutEnableSLERP )

Gets whether the angular velocity slerp drive is enabled or not. Only relevant if the AngularDriveMode is set to SLERP.

Parameters

Accessor	Constraint accessor to query
bOutEnableSLERP	Indicates whether the SLERP drive is enabled. Only relevant if the AngularDriveMode is set to SLERP

◆ GetAngularVelocityDriveTwistAndSwing()

void GetAngularVelocityDriveTwistAndSwing	(	FConstraintInstanceAccessor &	Accessor,
		bool &	bOutEnableTwistDrive,
		bool &	bOutEnableSwingDrive )

Gets whether angular velocity twist and swing drive is enabled or not. Only relevant if the AngularDriveMode is set to Twist and Swing.

Parameters

Accessor	Constraint accessor to query
bOutEnableTwistDrive	Indicates whether the drive for the twist axis should be enabled. Only relevant if the AngularDriveMode is set to Twist and Swing
bOutEnableSwingDrive	Indicates whether the drive for the swing axis should be enabled. Only relevant if the AngularDriveMode is set to Twist and Swing

◆ GetAngularVelocityTarget()

void GetAngularVelocityTarget	(	FConstraintInstanceAccessor &	Accessor,
		FVector &	OutVelTarget )

Gets the target velocity for the angular drive.

Parameters

Accessor	Constraint accessor to query
OutVelTarget	Target velocity

◆ GetAttachedBodyNames()

void GetAttachedBodyNames	(	FConstraintInstanceAccessor &	Accessor,
		FName &	ParentBody,
		FName &	ChildBody )

Gets Attached body names.

Parameters

Accessor	Constraint accessor to query
ParentBody	Parent body name of the constraint
ChildBody	Child body name of the constraint

◆ GetContactTransferScale()

void GetContactTransferScale	(	FConstraintInstanceAccessor &	Accessor,
		float32 &	ContactTransferScale )

Gets Constraint Contact Transfer Scale properties.

Parameters

Accessor	Constraint accessor to query
ContactTransferScale	Scale for transfer of child energy to parent.

◆ GetDisableCollsion()

bool GetDisableCollsion ( FConstraintInstanceAccessor & Accessor )

Gets whether bodies attched to the constraint can collide or not.

Parameters

Accessor Constraint accessor to query

◆ GetLinearBreakable()

void GetLinearBreakable	(	FConstraintInstanceAccessor &	Accessor,
		bool &	bLinearBreakable,
		float32 &	LinearBreakThreshold )

Gets Constraint Linear Breakable properties.

Parameters

Accessor	Constraint accessor to query
bLinearBreakable	Whether it is possible to break the joint with linear force
LinearBreakThreshold	Force needed to break the joint

◆ GetLinearDriveParams()

void GetLinearDriveParams	(	FConstraintInstanceAccessor &	Accessor,
		float32 &	OutPositionStrength,
		float32 &	OutVelocityStrength,
		float32 &	OutForceLimit )

Gets the drive params for the linear drive.

Parameters

Accessor	Constraint accessor to query
OutPositionStrength	Positional strength for the drive (stiffness)
OutVelocityStrength	Velocity strength of the drive (damping)
OutForceLimit	Max force applied by the drive

◆ GetLinearLimits()

void GetLinearLimits	(	FConstraintInstanceAccessor &	Accessor,
		ELinearConstraintMotion &	XMotion,
		ELinearConstraintMotion &	YMotion,
		ELinearConstraintMotion &	ZMotion,
		float32 &	Limit )

Gets Constraint Linear Motion Ranges.

Parameters

Accessor	Constraint accessor to query
XMotion	Type of motion along the X axis
YMotion	Type of motion along the Y axis
ZMotion	Type of motion along the Z axis
Limit	linear limit applied to all axis

◆ GetLinearPlasticity()

void GetLinearPlasticity	(	FConstraintInstanceAccessor &	Accessor,
		bool &	bLinearPlasticity,
		float32 &	LinearPlasticityThreshold,
		EConstraintPlasticityType &	PlasticityType )

Gets Constraint Linear Plasticity properties.

Parameters

Accessor Constraint accessor to query

◆ GetLinearPositionDrive()

void GetLinearPositionDrive	(	FConstraintInstanceAccessor &	Accessor,
		bool &	bOutEnableDriveX,
		bool &	bOutEnableDriveY,
		bool &	bOutEnableDriveZ )

Gets whether linear position drive is enabled or not.

Parameters

Accessor	Constraint accessor to query
bOutEnableDriveX	Indicates whether the drive for the X-Axis is enabled
bOutEnableDriveY	Indicates whether the drive for the Y-Axis is enabled
bOutEnableDriveZ	Indicates whether the drive for the Z-Axis is enabled

◆ GetLinearPositionTarget()

void GetLinearPositionTarget	(	FConstraintInstanceAccessor &	Accessor,
		FVector &	OutPosTarget )

Gets the target position for the linear drive.

Parameters

Accessor	Constraint accessor to query
OutPosTarget	Target position

◆ GetLinearSoftLimitParams()

void GetLinearSoftLimitParams	(	FConstraintInstanceAccessor &	Accessor,
		bool &	bSoftLinearLimit,
		float32 &	LinearLimitStiffness,
		float32 &	LinearLimitDamping,
		float32 &	LinearLimitRestitution,
		float32 &	LinearLimitContactDistance )

Gets Constraint Linear Soft Limit parameters.

Parameters

Accessor	Constraint accessor to query *
bSoftLinearLimit	True is the Linear limit is soft
LinearLimitStiffness	Stiffness of the soft Linear limit. Only used when Soft limit is on ( positive value )
LinearLimitDamping	Damping of the soft Linear limit. Only used when Soft limit is on ( positive value )
LinearLimitRestitution	Controls the amount of bounce when the constraint is violated. A restitution value of 1 will bounce back with the same velocity the limit was hit. A value of 0 will stop dead.
LinearLimitContactDistance	Determines how close to the limit we have to get before turning the joint on. Larger value will be more expensive, but will do a better job not violating constraints. A smaller value will be more efficient, but easier to violate.

◆ GetLinearVelocityDrive()

void GetLinearVelocityDrive	(	FConstraintInstanceAccessor &	Accessor,
		bool &	bOutEnableDriveX,
		bool &	bOutEnableDriveY,
		bool &	bOutEnableDriveZ )

Gets whether linear velocity drive is enabled or not.

Parameters

Accessor	Constraint accessor to query
bOutEnableDriveX	Indicates whether the drive for the X-Axis is enabled
bOutEnableDriveY	Indicates whether the drive for the Y-Axis is enabled
bOutEnableDriveZ	Indicates whether the drive for the Z-Axis is enabled

◆ GetLinearVelocityTarget()

void GetLinearVelocityTarget	(	FConstraintInstanceAccessor &	Accessor,
		FVector &	OutVelTarget )

Gets the target velocity for the linear drive.

Parameters

Accessor	Constraint accessor to query
OutVelTarget	Target velocity

◆ GetMassConditioningEnabled()

bool GetMassConditioningEnabled ( FConstraintInstanceAccessor & Accessor )

@brief Gets whether mass conditioning is enabled for the constraint.

◆ GetOrientationDriveSLERP()

void GetOrientationDriveSLERP	(	FConstraintInstanceAccessor &	Accessor,
		bool &	bOutEnableSLERP )

Gets whether the angular orientation slerp drive is enabled or not. Only relevant if the AngularDriveMode is set to SLERP.

Parameters

Accessor	Constraint accessor to query
bOutEnableSLERP	Indicates whether the SLERP drive should be enabled. Only relevant if the AngularDriveMode is set to SLERP

◆ GetOrientationDriveTwistAndSwing()

void GetOrientationDriveTwistAndSwing	(	FConstraintInstanceAccessor &	Accessor,
		bool &	bOutEnableTwistDrive,
		bool &	bOutEnableSwingDrive )

Gets whether angular orientation drive are enabled. Only relevant if the AngularDriveMode is set to Twist and Swing.

Parameters

Accessor	Constraint accessor to query
bOutEnableTwistDrive	Indicates whether the drive for the twist axis is enabled. Only relevant if the AngularDriveMode is set to Twist and Swing
bOutEnableSwingDrive	Indicates whether the drive for the swing axis is enabled. Only relevant if the AngularDriveMode is set to Twist and Swing

◆ GetParentDominates()

bool GetParentDominates ( FConstraintInstanceAccessor & Accessor )

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

Parameters

Accessor Constraint accessor to query

◆ GetProjectionParams()

void GetProjectionParams	(	FConstraintInstanceAccessor &	Accessor,
		bool &	bEnableProjection,
		float32 &	ProjectionLinearAlpha,
		float32 &	ProjectionAngularAlpha )

Gets projection parameters of the constraint.

Parameters

Accessor	Constraint accessor to query
bEnableProjection	true to enable projection
ProjectionLinearAlpha	how much linear projection to apply in [0,1] range
ProjectionAngularAlpha	how much angular projection to apply in [0,1] range

◆ SetAngularBreakable()

void SetAngularBreakable	(	FConstraintInstanceAccessor &	Accessor,
		bool	bAngularBreakable,
		float32	AngularBreakThreshold )

Sets Constraint Angular Breakable properties.

Parameters

Accessor	Constraint accessor to change
bAngularBreakable	Whether it is possible to break the joint with angular force
AngularBreakThreshold	Torque needed to break the joint

◆ SetAngularDriveMode()

void SetAngularDriveMode	(	FConstraintInstanceAccessor &	Accessor,
		EAngularDriveMode	DriveMode )

Switches the angular drive mode between SLERP and Twist And Swing.

Parameters

Accessor	Constraint accessor to change
DriveMode	The angular drive mode to use. SLERP uses shortest spherical path, but will not work if any angular constraints are locked. Twist and Swing decomposes the path into the different angular degrees of freedom but may experience gimbal lock

◆ SetAngularDriveParams()

void SetAngularDriveParams	(	FConstraintInstanceAccessor &	Accessor,
		float32	PositionStrength,
		float32	VelocityStrength,
		float32	InForceLimit )

Sets the drive params for the angular drive.

Parameters

Accessor	Constraint accessor to change
PositionStrength	Positional strength for the drive (stiffness)
VelocityStrength	Velocity strength of the drive (damping)
InForceLimit	Max force applied by the drive

◆ SetAngularLimits()

void SetAngularLimits	(	FConstraintInstanceAccessor &	Accessor,
		EAngularConstraintMotion	Swing1MotionType,
		float32	Swing1LimitAngle,
		EAngularConstraintMotion	Swing2MotionType,
		float32	Swing2LimitAngle,
		EAngularConstraintMotion	TwistMotionType,
		float32	TwistLimitAngle )

Sets COnstraint Angular Motion Ranges.

Parameters

Accessor	Constraint accessor to change
Swing1MotionType	Type of swing motion ( first axis )
Swing1LimitAngle	Size of limit in degrees in [0, 180] range
Swing2MotionType	Type of swing motion ( second axis )
Swing2LimitAngle	Size of limit in degrees in [0, 180] range
TwistMotionType	Type of twist motion
TwistLimitAngle	Size of limit in degrees in [0, 180] range

◆ SetAngularOrientationTarget()

void SetAngularOrientationTarget	(	FConstraintInstanceAccessor &	Accessor,
		FRotator	InPosTarget )

Sets the target orientation for the angular drive.

Parameters

Accessor	Constraint accessor to change
InPosTarget	Target orientation

◆ SetAngularPlasticity()

void SetAngularPlasticity	(	FConstraintInstanceAccessor &	Accessor,
		bool	bAngularPlasticity,
		float32	AngularPlasticityThreshold )

Sets Constraint Angular Plasticity properties.

Parameters

Accessor	Constraint accessor to change
bAngularPlasticity	Whether it is possible to reset the target angle from the angular displacement
AngularPlasticityThreshold	Degrees needed to reset the rest state of the joint

◆ SetAngularSoftSwingLimitParams()

void SetAngularSoftSwingLimitParams	(	FConstraintInstanceAccessor &	Accessor,
		bool	bSoftSwingLimit,
		float32	SwingLimitStiffness,
		float32	SwingLimitDamping,
		float32	SwingLimitRestitution,
		float32	SwingLimitContactDistance )

Sets Constraint Angular Soft Swing Limit parameters.

Parameters

Accessor	Constraint accessor to change *
bSoftSwingLimit	True is the swing limit is soft
SwingLimitStiffness	Stiffness of the soft swing limit. Only used when Soft limit is on ( positive value )
SwingLimitDamping	Damping of the soft swing limit. Only used when Soft limit is on ( positive value )
SwingLimitRestitution	Controls the amount of bounce when the constraint is violated. A restitution value of 1 will bounce back with the same velocity the limit was hit. A value of 0 will stop dead.
SwingLimitContactDistance	Determines how close to the limit we have to get before turning the joint on. Larger value will be more expensive, but will do a better job not violating constraints. A smaller value will be more efficient, but easier to violate.

◆ SetAngularSoftTwistLimitParams()

void SetAngularSoftTwistLimitParams	(	FConstraintInstanceAccessor &	Accessor,
		bool	bSoftTwistLimit,
		float32	TwistLimitStiffness,
		float32	TwistLimitDamping,
		float32	TwistLimitRestitution,
		float32	TwistLimitContactDistance )

Sets Constraint Angular Soft Twist Limit parameters.

Parameters

Accessor	Constraint accessor to change *
bSoftTwistLimit	True is the twist limit is soft
TwistLimitStiffness	Stiffness of the soft Twist limit. Only used when Soft limit is on ( positive value )
TwistLimitDamping	Damping of the soft Twist limit. Only used when Soft limit is on ( positive value )
TwistLimitRestitution	Controls the amount of bounce when the constraint is violated. A restitution value of 1 will bounce back with the same velocity the limit was hit. A value of 0 will stop dead.
TwistLimitContactDistance	Determines how close to the limit we have to get before turning the joint on. Larger value will be more expensive, but will do a better job not violating constraints. A smaller value will be more efficient, but easier to violate.

◆ SetAngularVelocityDriveSLERP()

void SetAngularVelocityDriveSLERP	(	FConstraintInstanceAccessor &	Accessor,
		bool	bEnableSLERP )

Enables/Disables the angular velocity slerp drive. Only relevant if the AngularDriveMode is set to SLERP.

Parameters

Accessor	Constraint accessor to change
bEnableSLERP	Indicates whether the SLERP drive should be enabled. Only relevant if the AngularDriveMode is set to SLERP

◆ SetAngularVelocityDriveTwistAndSwing()

void SetAngularVelocityDriveTwistAndSwing	(	FConstraintInstanceAccessor &	Accessor,
		bool	bEnableTwistDrive,
		bool	bEnableSwingDrive )

Enables/Disables angular velocity twist and swing drive. Only relevant if the AngularDriveMode is set to Twist and Swing.

Parameters

Accessor	Constraint accessor to change
bEnableTwistDrive	Indicates whether the drive for the twist axis should be enabled. Only relevant if the AngularDriveMode is set to Twist and Swing
bEnableSwingDrive	Indicates whether the drive for the swing axis should be enabled. Only relevant if the AngularDriveMode is set to Twist and Swing

◆ SetAngularVelocityTarget()

void SetAngularVelocityTarget	(	FConstraintInstanceAccessor &	Accessor,
		FVector	InVelTarget )

Sets the target velocity for the angular drive.

Parameters

Accessor	Constraint accessor to change
InVelTarget	Target velocity

◆ SetContactTransferScale()

void SetContactTransferScale	(	FConstraintInstanceAccessor &	Accessor,
		float32	ContactTransferScale )

Set Contact Transfer Scale.

Parameters

Accessor	Constraint accessor to change
ContactTransferScale	Set Contact Transfer Scale onto joints parent

◆ SetDisableCollision()

void SetDisableCollision	(	FConstraintInstanceAccessor &	Accessor,
		bool	bDisableCollision )

Sets whether bodies attched to the constraint can collide or not.

Parameters

Accessor	Constraint accessor to change
bDisableCollision	true to disable collision between constrained bodies

◆ SetLinearBreakable()

void SetLinearBreakable	(	FConstraintInstanceAccessor &	Accessor,
		bool	bLinearBreakable,
		float32	LinearBreakThreshold )

Sets the Linear Breakable properties.

Parameters

Accessor	Constraint accessor to change
bLinearBreakable	Whether it is possible to break the joint with linear force
LinearBreakThreshold	Force needed to break the joint

◆ SetLinearDriveParams()

void SetLinearDriveParams	(	FConstraintInstanceAccessor &	Accessor,
		float32	PositionStrength,
		float32	VelocityStrength,
		float32	InForceLimit )

Sets the drive params for the linear drive.

Parameters

Accessor	Constraint accessor to change
PositionStrength	Positional strength for the drive (stiffness)
VelocityStrength	Velocity strength of the drive (damping)
InForceLimit	Max force applied by the drive

◆ SetLinearLimits()

void SetLinearLimits	(	FConstraintInstanceAccessor &	Accessor,
		ELinearConstraintMotion	XMotion,
		ELinearConstraintMotion	YMotion,
		ELinearConstraintMotion	ZMotion,
		float32	Limit )

Sets Constraint Linear Motion Ranges.

Parameters

Accessor	Constraint accessor to change
XMotion	Type of motion along the X axis
YMotion	Type of motion along the Y axis
ZMotion	Type of motion along the Z axis
Limit	linear limit to apply to all axis

◆ SetLinearPlasticity()

void SetLinearPlasticity	(	FConstraintInstanceAccessor &	Accessor,
		bool	bLinearPlasticity,
		float32	LinearPlasticityThreshold,
		EConstraintPlasticityType	PlasticityType )

Sets Constraint Linear Plasticity properties.

Parameters

Accessor	Constraint accessor to change
bLinearPlasticity	Whether it is possible to reset the target position from the linear displacement
LinearPlasticityThreshold	Delta from target needed to reset the target joint

◆ SetLinearPositionDrive()

void SetLinearPositionDrive	(	FConstraintInstanceAccessor &	Accessor,
		bool	bEnableDriveX,
		bool	bEnableDriveY,
		bool	bEnableDriveZ )

Enables/Disables linear position drive.

Parameters

Accessor	Constraint accessor to change
bEnableDriveX	Indicates whether the drive for the X-Axis should be enabled
bEnableDriveY	Indicates whether the drive for the Y-Axis should be enabled
bEnableDriveZ	Indicates whether the drive for the Z-Axis should be enabled

◆ SetLinearPositionTarget()

void SetLinearPositionTarget	(	FConstraintInstanceAccessor &	Accessor,
		FVector	InPosTarget )

Sets the target position for the linear drive.

Parameters

Accessor	Constraint accessor to change
InPosTarget	Target position

◆ SetLinearSoftLimitParams()

void SetLinearSoftLimitParams	(	FConstraintInstanceAccessor &	Accessor,
		bool	bSoftLinearLimit,
		float32	LinearLimitStiffness,
		float32	LinearLimitDamping,
		float32	LinearLimitRestitution,
		float32	LinearLimitContactDistance )

Sets Constraint Linear Soft Limit parameters.

Parameters

Accessor	Constraint accessor to change *
bSoftLinearLimit	True is the linear limit is soft
LinearLimitStiffness	Stiffness of the soft linear limit. Only used when Soft limit is on ( positive value )
LinearLimitDamping	Damping of the soft linear limit. Only used when Soft limit is on ( positive value )
LinearLimitRestitution	Controls the amount of bounce when the constraint is violated. A restitution value of 1 will bounce back with the same velocity the limit was hit. A value of 0 will stop dead.
LinearLimitContactDistance	Determines how close to the limit we have to get before turning the joint on. Larger value will be more expensive, but will do a better job not violating constraints. A smaller value will be more efficient, but easier to violate.

◆ SetLinearVelocityDrive()

void SetLinearVelocityDrive	(	FConstraintInstanceAccessor &	Accessor,
		bool	bEnableDriveX,
		bool	bEnableDriveY,
		bool	bEnableDriveZ )

Enables/Disables linear velocity drive.

Parameters

Accessor	Constraint accessor to change
bEnableDriveX	Indicates whether the drive for the X-Axis should be enabled
bEnableDriveY	Indicates whether the drive for the Y-Axis should be enabled
bEnableDriveZ	Indicates whether the drive for the Z-Axis should be enabled

◆ SetLinearVelocityTarget()

void SetLinearVelocityTarget	(	FConstraintInstanceAccessor &	Accessor,
		FVector	InVelTarget )

Sets the target velocity for the linear drive.

Parameters

Accessor	Constraint accessor to change
InVelTarget	Target velocity

◆ SetMassConditioningEnabled()

void SetMassConditioningEnabled	(	FConstraintInstanceAccessor &	Accessor,
		bool	bEnableMassConditioning )

@brief Enable or disable mass conditioning for the constraint.

◆ SetOrientationDriveSLERP()

void SetOrientationDriveSLERP	(	FConstraintInstanceAccessor &	Accessor,
		bool	bEnableSLERP )

Enables/Disables the angular orientation slerp drive. Only relevant if the AngularDriveMode is set to SLERP.

Parameters

Accessor	Constraint accessor to change
bEnableSLERP	Indicates whether the SLERP drive should be enabled. Only relevant if the AngularDriveMode is set to SLERP

◆ SetOrientationDriveTwistAndSwing()

void SetOrientationDriveTwistAndSwing	(	FConstraintInstanceAccessor &	Accessor,
		bool	bEnableTwistDrive,
		bool	bEnableSwingDrive )

Enables/Disables angular orientation drive. Only relevant if the AngularDriveMode is set to Twist and Swing.

Parameters

Accessor	Constraint accessor to change
bEnableTwistDrive	Indicates whether the drive for the twist axis should be enabled. Only relevant if the AngularDriveMode is set to Twist and Swing
bEnableSwingDrive	Indicates whether the drive for the swing axis should be enabled. Only relevant if the AngularDriveMode is set to Twist and Swing

◆ SetParentDominates()

void SetParentDominates	(	FConstraintInstanceAccessor &	Accessor,
		bool	bParentDominates )

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

Parameters

Accessor	Constraint accessor to change
bParentDominates	true to avoid the parent being affected by its child motion

◆ SetProjectionParams()

void SetProjectionParams	(	FConstraintInstanceAccessor &	Accessor,
		bool	bEnableProjection,
		float32	ProjectionLinearAlpha,
		float32	ProjectionAngularAlpha )

Sets projection parameters of the constraint.

Parameters

Accessor	Constraint accessor to change
bEnableProjection	true to enable projection
ProjectionLinearAlpha	how much linear projection to apply in [0,1] range
ProjectionAngularAlpha	how much angular projection to apply in [0,1] range

Functions

Function Documentation

◆ CopyParams()

◆ GetAngularBreakable()

◆ GetAngularDriveMode()

◆ GetAngularDriveParams()

◆ GetAngularLimits()

◆ GetAngularOrientationTarget()

◆ GetAngularPlasticity()

◆ GetAngularSoftSwingLimitParams()

◆ GetAngularSoftTwistLimitParams()

◆ GetAngularVelocityDriveSLERP()

◆ GetAngularVelocityDriveTwistAndSwing()

◆ GetAngularVelocityTarget()

◆ GetAttachedBodyNames()

◆ GetContactTransferScale()

◆ GetDisableCollsion()

◆ GetLinearBreakable()

◆ GetLinearDriveParams()

◆ GetLinearLimits()

◆ GetLinearPlasticity()

◆ GetLinearPositionDrive()

◆ GetLinearPositionTarget()

◆ GetLinearSoftLimitParams()

◆ GetLinearVelocityDrive()

◆ GetLinearVelocityTarget()

◆ GetMassConditioningEnabled()

◆ GetOrientationDriveSLERP()

◆ GetOrientationDriveTwistAndSwing()

◆ GetParentDominates()

◆ GetProjectionParams()

◆ SetAngularBreakable()

◆ SetAngularDriveMode()

◆ SetAngularDriveParams()

◆ SetAngularLimits()

◆ SetAngularOrientationTarget()

◆ SetAngularPlasticity()

◆ SetAngularSoftSwingLimitParams()

◆ SetAngularSoftTwistLimitParams()

◆ SetAngularVelocityDriveSLERP()

◆ SetAngularVelocityDriveTwistAndSwing()

◆ SetAngularVelocityTarget()

◆ SetContactTransferScale()

◆ SetDisableCollision()

◆ SetLinearBreakable()

◆ SetLinearDriveParams()

◆ SetLinearLimits()

◆ SetLinearPlasticity()

◆ SetLinearPositionDrive()

◆ SetLinearPositionTarget()

◆ SetLinearSoftLimitParams()

◆ SetLinearVelocityDrive()

◆ SetLinearVelocityTarget()

◆ SetMassConditioningEnabled()

◆ SetOrientationDriveSLERP()

◆ SetOrientationDriveTwistAndSwing()

◆ SetParentDominates()

◆ SetProjectionParams()