1. Epic GamesDeveloper
  3. IEditableSkeleton

IEditableSkeleton

Interface used to deal with skeletons that are currently being edited

API > API/Editor > API/Editor/SkeletonEditor

References

   
Module SkeletonEditor
Header /Engine/Source/Editor/SkeletonEditor/Public/IEditableSkeleton.h
Include #include "IEditableSkeleton.h"

Syntax

class IEditableSkeleton

Remarks

Interface used to deal with skeletons that are currently being edited

Functions

  Type Name Description
Public function void

AddCompatibleSkeleton ( const USkeleton* InCompatibleSkeleton
)

 Add a compatible skeleton
Public function void

AddNotify ( FName NewName
)

 Add a notify
Public function void

AddRetargetSource ( const FName& InName,
USkeletalMesh* InReferenceMesh
)

 Add a retarget source
Public function bool

AddSlotGroupName ( const FName& InSlotName
)

 Add a slot group name
Public function USkeletalMeshSocket *

AddSocket ( const FName& InBoneName
)

 Creates a new socket on the skeleton
Public function void

AddSyncMarker ( FName NewName
)

 Add a sync marker
Public function void Inform the system that something about a notify changed
Public function UBlendProfile *

CreateNewBlendProfile ( const FName& InBlendProfileName
)

 Create the named blend profile
Public function int32

DeleteAnimNotifies ( const TArray< FName >& InotifyNames,
bool bDeleteFromAnimations
)

 Delete anim notifies by name
Public function void

DeleteRetargetSources ( const TArray< FName >& InRetargetSourceNames
)

 Delete retarget sources
Public function void

DeleteSlotGroup ( const FName& InGroupName
)

 Delete a slot group
Public function void

DeleteSlotName ( const FName& InSlotName
)

 Delete a slot name
Public function int32

DeleteSyncMarkers ( const TArray< FName >& ISyncMarkerNames,
bool bDeleteFromAnimations
)

 Delete sync markers from the skeleton cache by name
Public function Const bool

DoesSocketAlreadyExist ( const USkeletalMeshSocket* InSocket,
const FText& InSocketName,
ESocketParentType SocketParentType,
USkeletalMesh* InSkeletalMesh
)

 Function to tell you if a socket name already exists.
Public function Const bool

DoesVirtualBoneAlreadyExist ( const FString& InVBName
)

 Function to tell you if a virtual bone name is already in use
Public function USkeletalMeshSocket *

DuplicateSocket ( const FSelectedSocketInfo& SocketInfoToDuplicate,
const FName& NewParentBoneName,
USkeletalMesh* InSkeletalMesh
)

 Handle drag-drop socket duplication
Public function UBlendProfile *

GetBlendProfile ( const FName& InBlendProfileName
)

 Get the named blend profile
Public function Const const TArray< class UBlendProfile * > & Get the blend profiles that this skeleton currently contains
Public function Const EBoneTranslationRetargetingMode::Type Wrap USkeleton::GetBoneTranslationRetargetingMode
Public function void

GetCompatibleAnimSequences ( TArray< struct FAssetData >& OutAssets
)

 Populates OutAssets with the AnimSequences that match this current skeleton
Public function Const const USkeleton & Get the skeleton. Const - to modify the skeleton you should use the wrapper methods below
Public function Const bool Checks to see if the editable skeleton is valid.
Public function void Load any additional meshes we may have
Public function void

RecreateBoneTree ( USkeletalMesh* NewPreviewMesh
)

 Merge has failed, then Recreate BoneTree
Public function void Broadcasts tree refresh delegate
Public function void

RefreshRetargetSources ( const TArray< FName >& InRetargetSourceNames
)

 Refresh retarget sources
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGSvoid Refreshes the rig config, validating the mappings
Public function void

RegisterOnNotifiesChanged ( const FSimpleMulticastDelegate::FDelegate& InDelegate
)

 Register a delegate to be called when this skeletons notifies are changed
Public function FDelegateHandle

RegisterOnSlotsChanged ( const FSimpleMulticastDelegate::FDelegate& InDelegate
)

 Register a delegate to be called when this skeletons slots are changed
Public function void

RegisterSlotNode ( const FName& InSlotName
)

 Register a slot node
Public function void

RemoveBlendProfile ( UBlendProfile* InBlendProfile
)

 Remove the specifed blend profile
Public function void

RemoveCompatibleSkeleton ( const USkeleton* InCompatibleSkeleton
)

 Remove a compatible skeleton
Public function void Remove any bones that are not used by any skeletal meshes
Public function int32

RenameNotify ( const FName NewName,
const FName OldName,
bool bRenameInAnimations
)

 Rename a notify
Public function void

RenameRetargetSource ( const FName InOldName,
const FName InNewName
)

 Rename the specified retarget source
Public function void

RenameSlotName ( const FName InOldSlotName,
const FName InNewSlotName
)

 Rename a slot name
Public function void

RenameSocket ( const FName OldSocketName,
const FName NewSocketName,
USkeletalMesh* InSkeletalMesh
)

 Rename a socket on the mesh or the skeleton
Public function int32

RenameSyncMarker ( FName NewName,
const FName OldName,
bool bRenameInAnimations
)

 Rename a sync marker
Public function void

RenameVirtualBone ( const FName OriginalName,
const FName InVBName
)

 Rename an existing virtual bone
Public function void

SetAdditionalPreviewSkeletalMeshes ( UDataAsset* InPreviewCollectionAsset
)

 Set the additional skeletal meshes we use when previewing this skeleton
Public function void

SetBlendProfileMode ( FName InBlendProfileName,
EBlendProfileMode ProfileMode
)

 Change an existing blend profile's mode (See EBlendProfileMode for details)
Public function void

SetBlendProfileScale ( const FName& InBlendProfileName,
const FName& InBoneName,
float InNewScale,
bool bInRecurse
)

 Set the blend profile scale for the specified bone
Public function void Wrap USkeleton::SetBoneTranslationRetargetingMode
Public function void

SetPreviewMesh ( USkeletalMesh* InSkeletalMesh
)

 Set the preview mesh in the skeleton
Public function void

SetRigBoneMapping ( const FName& InNodeName,
const FName& InBoneName
)

 Set a rig bone mapping
Public function void

SetRigBoneMappings ( const TMap< FName, FName >& InMappings
)

 Set multiple bone mappings
Public function void

SetRigConfig ( URig* InRig
)

 Set the rig config
Public function void

SetSlotGroupName ( const FName& InSlotName,
const FName& InGroupName
)

 Set the group name of the specified slot
Public function void

SetSocketParent ( const FName& SocketName,
const FName& NewParentName,
USkeletalMesh* InSkeletalMesh
)

 Set the parent of a socket
Public function void

UnregisterOnNotifiesChanged ( void* Thing
)

 Unregister a delegate to be called when this skeletons notifies are changed
Public function void Unregister a delegate to be called when this skeletons slots are changed
Public function void Create RefLocalPoses from InSkeletalMesh
Public function int32 Makes sure all attached objects are valid and removes any that aren't.

Deprecated Functions

  Type Name Description
Public function Virtual bool

AddSmartname ( const FName& InContainerName,
const FName& InNewName,
FSmartName& OutSmartName
)

 Please use IInterface_AnimCurveMetaData::AddCurveMetaData.
Public function Virtual FDelegateHandle

RegisterOnSmartNameChanged ( const FOnSmartNameChanged::FDelegate& InOnSmartNameChanged
)

 Please use IInterface_AnimCurveMetaData::RegisterOnCurveMetaDataChanged.
Public function Virtual void

RemoveSmartnamesAndFixupAnimations ( const FName& InContainerName,
const TArray< FName >& InNames
)

 Please use IInterface_AnimCurveMetaData::RemoveCurveMetaData.
Public function Virtual void

RenameSmartname ( const FName InContainerName,
SmartName::UID_Type InNameUid,
const FName InNewName
)

 Please use IInterface_AnimCurveMetaData::RenameCurveMetaData.
Public function Virtual void

SetCurveMetaBoneLinks ( const FSmartName& CurveName,
const TArray< FBoneReference >& BoneLinks,
uint8 InMaxLOD
)

 Please use IInterface_AnimCurveMetaData::SetCurveMetaDataBoneLinks.
Public function Virtual void

SetCurveMetaDataMaterial ( const FSmartName& CurveName,
bool bOverrideMaterial
)

 Please use IInterface_AnimCurveMetaData::SetCurveMetaDataMaterial.
Public function Virtual void

SetCurveMetaDataMorphTarget ( const FSmartName& CurveName,
bool bOverrideMorphTarget
)

 Please use IInterface_AnimCurveMetaData::SetCurveMetaDataMorphTarget.
Public function Virtual void Please use IInterface_AnimCurveMetaData::UnegisterOnCurveMetaDataChanged.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page