1. Epic GamesDeveloper
  3. FAngularDriveConstraint

FAngularDriveConstraint

Angular Drive

API > API/Runtime > API/Runtime/Engine

Angular Drive

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

Syntax

USTRUCT ()  
struct FAngularDriveConstraint

Constructors

Name Remarks Include Path Unreal Specifiers

FAngularDriveConstraint()

   PhysicsEngine/ConstraintDrives.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AngularDriveMode TEnumAsByte< enum EAngularDriveMode::Type > Whether motors use SLERP (spherical lerp) or decompose into a Swing motor (cone constraints) and Twist motor (roll constraints). PhysicsEngine/ConstraintDrives.h
  • EditAnywhere
  • Category=AngularMotor
AngularVelocityTarget FVector Target angular velocity relative to the body reference frame in revolutions per second. PhysicsEngine/ConstraintDrives.h
  • EditAnywhere
  • Category=AngularMotor
bAccelerationMode bool Whether to use acceleration mode for angular drive. The other option is force mode. (default:true) PhysicsEngine/ConstraintDrives.h
  • EditAnywhere
  • Category=AngularMotor
OrientationTarget FRotator Target orientation relative to the the body reference frame. PhysicsEngine/ConstraintDrives.h
  • EditAnywhere
  • Category=AngularMotor
SlerpDrive FConstraintDrive Controls the SLERP (spherical lerp) drive between current orientation/velocity and target orientation/velocity. PhysicsEngine/ConstraintDrives.h
  • EditAnywhere
  • Category=LinearMotor
  • Meta=(DisplayName="SLERP")
SwingDrive FConstraintDrive Controls the cone constraint drive between current orientation/velocity and target orientation/velocity. PhysicsEngine/ConstraintDrives.h
  • EditAnywhere
  • Category=LinearMotor
  • Meta=(DisplayName="Swing")
TwistDrive FConstraintDrive Controls the twist (roll) constraint drive between current orientation/velocity and target orientation/velocity. PhysicsEngine/ConstraintDrives.h
  • EditAnywhere
  • Category=LinearMotor
  • Meta=(DisplayName="Twist")

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool GetAccelerationMode()

   PhysicsEngine/ConstraintDrives.h  

void GetDriveParams ( float& OutStiffness,
float& OutDamping,
float& OutForceLimit
) const

 Gets just the swing drive parameters - assuming the single-float set function has previously been used. PhysicsEngine/ConstraintDrives.h  

void GetDriveParams ( FVector& OutStiffness,
FVector& OutDamping,
FVector& OutForceLimit
) const

 Gets drive parameters in the order swing, twist, slerp. PhysicsEngine/ConstraintDrives.h  

bool IsOrientationDriveEnabled()

   PhysicsEngine/ConstraintDrives.h  

bool IsVelocityDriveEnabled()

   PhysicsEngine/ConstraintDrives.h  

void SetAccelerationMode ( bool bAccelerationMode
)

   PhysicsEngine/ConstraintDrives.h  

void SetAngularDriveMode ( EAngularDriveMode::Type DriveMode
)

   PhysicsEngine/ConstraintDrives.h  

void SetAngularVelocityDriveSLERP ( bool InEnableSLERP
)

   PhysicsEngine/ConstraintDrives.h  

void SetAngularVelocityDriveTwistAndSwing ( bool InEnableTwistDrive,
bool InEnableSwingDrive
)

   PhysicsEngine/ConstraintDrives.h  

void SetDriveParams ( float InStiffness,
float InDamping,
float InForceLimit
)

 Sets the three drive parameters (swing, twist and slerp) to the same value. PhysicsEngine/ConstraintDrives.h  

void SetDriveParams ( const FVector& InStiffness,
const FVector& InDamping,
const FVector& InForceLimit
)

 Sets drive parameters in the order swing, twist, slerp. PhysicsEngine/ConstraintDrives.h  

void SetOrientationDriveSLERP ( bool InEnableSLERP
)

   PhysicsEngine/ConstraintDrives.h  

void SetOrientationDriveTwistAndSwing ( bool InEnableTwistDrive,
bool InEnableSwingDrive
)

 Updates physx drive with properties from unreal These functions may leave the struct in an invalid state unless calling UpdatePhysX* functions. PhysicsEngine/ConstraintDrives.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page