1. Epic GamesDeveloper
  3. UPhysicsHandleComponent

UPhysicsHandleComponent

Utility object for moving physics objects around.

API > API/Runtime > API/Runtime/Engine

Utility object for moving physics objects around.

   
Name UPhysicsHandleComponent
Type class
Header File /Engine/Source/Runtime/Engine/Classes/PhysicsEngine/PhysicsHandleComponent.h
Include Path #include "PhysicsEngine/PhysicsHandleComponent.h"

Syntax

UCLASS (CollapseCategories, ClassGroup=Physics, HideCategories=Object,  
       Meta=(BlueprintSpawnableComponent), MinimalAPI)  
class UPhysicsHandleComponent : public UActorComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

UPhysicsHandleComponent ( const FObjectInitializer& ObjectInitializer
)

   PhysicsEngine/PhysicsHandleComponent.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AngularDamping float Angular damping of the handle spring PhysicsEngine/PhysicsHandleComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=PhysicsHandle
  • Meta=(EditCondition="bSoftAngularConstraint")
AngularStiffness float Angular stiffness of the handle spring PhysicsEngine/PhysicsHandleComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=PhysicsHandle
  • Meta=(EditCondition="bSoftAngularConstraint")
bInterpolateTarget uint32   PhysicsEngine/PhysicsHandleComponent.h
  • EditAnywhere
  • BlueprintReadWrite
  • Category=PhysicsHandle
bRotationConstrained uint32 Are we currently constraining the rotation of the grabbed object. PhysicsEngine/PhysicsHandleComponent.h  
bSoftAngularConstraint uint32   PhysicsEngine/PhysicsHandleComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=PhysicsHandle
bSoftLinearConstraint uint32   PhysicsEngine/PhysicsHandleComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=PhysicsHandle
CurrentTransform FTransform Current transform PhysicsEngine/PhysicsHandleComponent.h  
GrabbedBoneName FName Name of bone, if we are grabbing a skeletal component PhysicsEngine/PhysicsHandleComponent.h  
GrabbedComponent TObjectPtr< class UPrimitiveComponent > Component we are currently holding PhysicsEngine/PhysicsHandleComponent.h  
InterpolationSpeed float How quickly we interpolate the physics target transform PhysicsEngine/PhysicsHandleComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=PhysicsHandle
  • Meta=(EditCondition="bInterpolateTarget")
LinearDamping float Linear damping of the handle spring. PhysicsEngine/PhysicsHandleComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=PhysicsHandle
  • Meta=(EditCondition="bSoftLinearConstraint")
LinearStiffness float Linear stiffness of the handle spring PhysicsEngine/PhysicsHandleComponent.h
  • EditAnywhere
  • BlueprintReadOnly
  • Category=PhysicsHandle
  • Meta=(EditCondition="bSoftLinearConstraint")
TargetTransform FTransform Target transform PhysicsEngine/PhysicsHandleComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UPrimitiveComponent * GetGrabbedComponent()

 Returns the currently grabbed component, or null if nothing is grabbed. PhysicsEngine/PhysicsHandleComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsHandle"

void GetTargetLocationAndRotation ( FVector& TargetLocation,
FRotator& TargetRotation
) const

 Get the current location and rotation PhysicsEngine/PhysicsHandleComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsHandle"

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

 Grab the specified component PhysicsEngine/PhysicsHandleComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsHandle"
  • Meta=(DeprecatedFunction, DeprecationMessage="Please use GrabComponentAtLocation or GrabComponentAtLocationWithRotation")

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

 Grab the specified component at a given location. PhysicsEngine/PhysicsHandleComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsHandle"

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

 Grab the specified component at a given location and rotation. Constrains rotation. PhysicsEngine/PhysicsHandleComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsHandle"

virtual void ReleaseComponent()

 Release the currently held component PhysicsEngine/PhysicsHandleComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsHandle"

void SetAngularDamping ( float NewAngularDamping
)

 Set angular damping PhysicsEngine/PhysicsHandleComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsHandle"

void SetAngularStiffness ( float NewAngularStiffness
)

 Set angular stiffness PhysicsEngine/PhysicsHandleComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsHandle"

void SetInterpolationSpeed ( float NewInterpolationSpeed
)

 Set interpolation speed PhysicsEngine/PhysicsHandleComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsHandle"

void SetLinearDamping ( float NewLinearDamping
)

 Set linear damping PhysicsEngine/PhysicsHandleComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsHandle"

void SetLinearStiffness ( float NewLinearStiffness
)

 Set linear stiffness PhysicsEngine/PhysicsHandleComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsHandle"

void SetTargetLocation ( FVector NewLocation
)

 Set the target location PhysicsEngine/PhysicsHandleComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsHandle"

void SetTargetLocationAndRotation ( FVector NewLocation,
FRotator NewRotation
)

 Set target location and rotation PhysicsEngine/PhysicsHandleComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsHandle"

void SetTargetRotation ( FRotator NewRotation
)

 Set the target rotation PhysicsEngine/PhysicsHandleComponent.h
  • BlueprintCallable
  • Category="Physics|Components|PhysicsHandle"

Protected

Name Remarks Include Path Unreal Specifiers

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

   PhysicsEngine/PhysicsHandleComponent.h  

virtual void UpdateDriveSettings()

 Update the underlying constraint drive settings from the params in this component PhysicsEngine/PhysicsHandleComponent.h  

virtual void UpdateHandleTransform ( const FTransform& NewTransform
)

 Move the kinematic handle to the specified PhysicsEngine/PhysicsHandleComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void OnUnregister ()

 Called when a component is unregistered. PhysicsEngine/PhysicsHandleComponent.h  

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

 Function called every frame on this ActorComponent. PhysicsEngine/PhysicsHandleComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page