1. Epic GamesDeveloper
  3. UPhysicsHandleComponent

UPhysicsHandleComponent

Utility object for moving physics objects around.

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

Inheritance Hierarchy

References

   
Module Engine
Header /Engine/Source/Runtime/Engine/Classes/PhysicsEngine/PhysicsHandleComponent.h
Include #include "PhysicsEngine/PhysicsHandleComponent.h"

Syntax

class UPhysicsHandleComponent : public UActorComponent

Remarks

Utility object for moving physics objects around.

Variables

  Type Name Description
Public variable float AngularDamping Angular damping of the handle spring
Public variable float AngularStiffness Angular stiffness of the handle spring
Public variable uint32: 1 bInterpolateTarget  
Protected variable bool bPendingConstraint  
Public variable uint32: 1 bRotationConstrained Are we currently constraining the rotation of the grabbed object.
Public variable uint32: 1 bSoftAngularConstraint  
Public variable uint32: 1 bSoftLinearConstraint  
Protected variable FPhysicsConstraintHandle ConstraintHandle  
Protected variable FConstraintInstance ConstraintInstance  
Protected variable FVector ConstraintLocalPosition  
Protected variable FRotator ConstraintLocalRotation  
Public variable FTransform CurrentTransform Current transform
Public variable FName GrabbedBoneName Name of bone, if we are grabbing a skeletal component
Public variable TObjectPtr< class UPrimitiveComponent > GrabbedComponent Component we are currently holding
Protected variable FPhysicsActorHandle GrabbedHandle  
Public variable float InterpolationSpeed How quickly we interpolate the physics target transform
Protected variable FPhysicsActorHandle KinematicHandle  
Public variable float LinearDamping Linear damping of the handle spring.
Public variable float LinearStiffness Linear stiffness of the handle spring
Protected variable FPhysicsUserData PhysicsUserData  
Protected variable FTransform PreviousTransform  
Public variable FTransform TargetTransform Target transform

Constructors

  Type Name Description
Public function  

UPhysicsHandleComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const UPrimitiveComponent * Returns the currently grabbed component, or null if nothing is grabbed.
Public function Const void

GetTargetLocationAndRotation ( FVector& TargetLocation,
FRotator& TargetRotation
)

 Get the current location and rotation
Public function void

GrabComponentAtLocation ( UPrimitiveComponent* Component,
FName InBoneName,
FVector GrabLocation
)

 Grab the specified component at a given location.
Public function void

GrabComponentAtLocationWithRotation ( UPrimitiveComponent* Component,
FName InBoneName,
FVector Location,
FRotator Rotation
)

 Grab the specified component at a given location and rotation. Constrains rotation.
Protected function Virtual void

GrabComponentImp ( UPrimitiveComponent* Component,
FName InBoneName,
const FVector& Location,
const FRotator& Rotation,
bool bRotationConstrained
)

  
Public function Virtual void Release the currently held component
Public function void

SetAngularDamping ( float NewAngularDamping
)

 Set angular damping
Public function void

SetAngularStiffness ( float NewAngularStiffness
)

 Set angular stiffness
Public function void

SetInterpolationSpeed ( float NewInterpolationSpeed
)

 Set interpolation speed
Public function void

SetLinearDamping ( float NewLinearDamping
)

 Set linear damping
Public function void

SetLinearStiffness ( float NewLinearStiffness
)

 Set linear stiffness
Public function void

SetTargetLocation ( FVector NewLocation
)

 Set the target location
Public function void

SetTargetLocationAndRotation ( FVector NewLocation,
FRotator NewRotation
)

 Set target location and rotation
Public function void

SetTargetRotation ( FRotator NewRotation
)

 Set the target rotation
Protected function Virtual void Update the underlying constraint drive settings from the params in this component
Protected function Virtual void

UpdateHandleTransform ( const FTransform& NewTransform
)

 Move the kinematic handle to the specified

Overridden from UActorComponent

  Type Name Description
Protected function Virtual void Called when a component is unregistered.
Protected function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

 Function called every frame on this ActorComponent.

Deprecated Functions

  Type Name Description
Public function Virtual void

GrabComponent ( UPrimitiveComponent* Component,
FName InBoneName,
FVector GrabLocation,
bool bConstrainRotation
)

 Please use GrabComponentAtLocation or GrabComponentAtLocationWithRotation

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page