SkeletalMeshSocket.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "UObject/ScriptMacros.h"
#include "SkeletalMeshSocket.generated.h"
 
UCLASS(hidecategories=Object, hidecategories=Actor, BlueprintType, MinimalAPI)
class USkeletalMeshSocket : public UObject
{
    GENERATED_BODY()
 
public:
    UPROPERTY(Category="Socket Parameters", VisibleAnywhere, BlueprintReadOnly)
    FName SocketName;
 
    UPROPERTY(Category="Socket Parameters", VisibleAnywhere, BlueprintReadOnly)
    FName BoneName;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Socket Parameters")
    FVector RelativeLocation = FVector::ZeroVector;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Socket Parameters")
    FRotator RelativeRotation = FRotator::ZeroRotator;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Socket Parameters")
    FVector RelativeScale = FVector::OneVector;
 
    UPROPERTY(EditAnywhere, BlueprintReadOnly, Category="Socket Parameters")
    bool bForceAlwaysAnimated = true;
 
#if WITH_EDITOR
    UFUNCTION(BlueprintCallable, Category="Socket Parameters")
    ENGINE_API void SetSocketParent(USkeletalMesh* InSkeletalMesh, FName InBoneName);
#endif
    
    UFUNCTION(BlueprintCallable, Category="Components|SkeletalMesh")
    ENGINE_API FVector GetSocketLocation(const class USkeletalMeshComponent* SkelComp) const;
 
    UFUNCTION(BlueprintCallable, Category="Components|SkeletalMesh")
    ENGINE_API void InitializeSocketFromLocation(const class USkeletalMeshComponent* SkelComp, FVector WorldLocation, FVector WorldNormal);
 
    ENGINE_API bool GetSocketMatrix(FMatrix& OutMatrix, const class USkeletalMeshComponent* SkelComp) const;
 
    UFUNCTION(BlueprintCallable, Category="Socket Parameters")
    ENGINE_API FTransform GetSocketLocalTransform() const;
 
#if WITH_EDITOR
    UFUNCTION(BlueprintCallable, Category="Socket Parameters")
    ENGINE_API void SetSocketLocalTransform(FTransform InTransform);
#endif
 
    ENGINE_API FTransform GetSocketTransform( const class USkeletalMeshComponent* SkelComp ) const;
 
    bool GetSocketMatrixWithOffset(FMatrix& OutMatrix, class USkeletalMeshComponent* SkelComp, const FVector& InOffset, const FRotator& InRotation) const;
 
    bool GetSocketPositionWithOffset(FVector& OutPosition, class USkeletalMeshComponent* SkelComp, const FVector& InOffset, const FRotator& InRotation) const;
 
    ENGINE_API bool AttachActor (class AActor* Actor, class USkeletalMeshComponent* SkelComp) const;
 
    virtual void Serialize(FArchive& Ar) override;
 
#if WITH_EDITOR
    DECLARE_EVENT_TwoParams(USkeletalMeshSocket, FSocketChangedEvent, const class USkeletalMeshSocket*, const class FProperty*);
    FSocketChangedEvent& OnPropertyChanged() { return ChangedEvent; }
 
    //~ Begin UObject Interface
    virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    //~ End UObject Interface
 
    // Utility function to copy socket 
    ENGINE_API void CopyFrom(const class USkeletalMeshSocket* OtherSocket);
 
private: 
    FSocketChangedEvent ChangedEvent;
 
#endif // WITH_EDITOR
};