Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. USkeletonEditingTool

USkeletonEditingTool

[USkeletonEditingTool](API\Plugins\MeshModelingToolsEditorOnly\USkeletonEditingTool) is a tool to edit a the ReferenceSkeleton of a SkeletalMesh (target) Changed are actually commit to the SkeletalMesh and it's mesh description on Accept.

API > API/Plugins > API/Plugins/MeshModelingToolsEditorOnly

USkeletonEditingTool is a tool to edit a the ReferenceSkeleton of a SkeletalMesh (target) Changed are actually commit to the SkeletalMesh and it's mesh description on Accept.

   
Name USkeletonEditingTool
Type class
Header File /Engine/Plugins/Runtime/MeshModelingToolset/Source/MeshModelingToolsEditorOnly/Public/SkeletalMesh/SkeletonEditingTool.h
Include Path #include "SkeletalMesh/SkeletonEditingTool.h"

Syntax

UCLASS (MinimalAPI)  
class USkeletonEditingTool :  
    public USingleSelectionTool ,  
    public IClickDragBehaviorTarget ,  
    public ISkeletalMeshEditingInterface

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constants

Name Type Remarks Include Path
AddToSelectionModifier int Flags used to identify behavior modifier keys/buttons SkeletalMesh/SkeletonEditingTool.h
ToggleSelectionModifier int   SkeletalMesh/SkeletonEditingTool.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
MirroringProperties TObjectPtr< UMirroringProperties >   SkeletalMesh/SkeletonEditingTool.h  
OrientingProperties TObjectPtr< UOrientingProperties >   SkeletalMesh/SkeletonEditingTool.h  
ProjectionProperties TObjectPtr< UProjectionProperties >   SkeletalMesh/SkeletonEditingTool.h  
Properties TObjectPtr< USkeletonEditingProperties >   SkeletalMesh/SkeletonEditingTool.h  
SelectionMechanic TObjectPtr< UPolygonSelectionMechanic >   SkeletalMesh/SkeletonEditingTool.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bDeferUntilFocused bool Defer pending function on tick to allow other external notification to be handled. SkeletalMesh/SkeletonEditingTool.h  
CoordinateSystemWatcher TValueWatcher< EToolContextCoordinateSystem >   SkeletalMesh/SkeletonEditingTool.h  
ParentIndex int32   SkeletalMesh/SkeletonEditingTool.h  
PendingFunction TFunction< void()>   SkeletalMesh/SkeletonEditingTool.h  
Selection TArray< FName >   SkeletalMesh/SkeletonEditingTool.h  
SelectionMode EBoneSelectionMode   SkeletalMesh/SkeletonEditingTool.h  
SelectionWatcher TValueWatcher< TArray< FName > >   SkeletalMesh/SkeletonEditingTool.h  
Topology TUniquePtr< UE::Geometry::FTriangleGroupTopology >   SkeletalMesh/SkeletonEditingTool.h  
WeakMesh TWeakObjectPtr< USkeletalMesh >   SkeletalMesh/SkeletonEditingTool.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

EEditingOperation GetOperation()

   SkeletalMesh/SkeletonEditingTool.h  

const TArray< FName > & GetSelection()

   SkeletalMesh/SkeletonEditingTool.h  

const FTransform & GetTransform ( const FName InBoneName,
const bool bWorld
) const

   SkeletalMesh/SkeletonEditingTool.h  

bool HasSelectedComponent()

   SkeletalMesh/SkeletonEditingTool.h  

void Init ( const FToolBuilderState& InSceneState
)

 USkeletonEditingTool SkeletalMesh/SkeletonEditingTool.h  

void MirrorBones()

 Modifier functions. SkeletalMesh/SkeletonEditingTool.h  

void MoveBones()

   SkeletalMesh/SkeletonEditingTool.h  

void OrientBones()

   SkeletalMesh/SkeletonEditingTool.h  

void RemoveBones()

   SkeletalMesh/SkeletonEditingTool.h  

void RenameBones()

   SkeletalMesh/SkeletonEditingTool.h  

void SetOperation ( const EEditingOperation InOperation,
const bool bUpdateGizmo
)

   SkeletalMesh/SkeletonEditingTool.h  

void SetTransforms ( const TArray< FName >& InBones,
const TArray< FTransform >& InTransforms,
const bool bWorld
) const

   SkeletalMesh/SkeletonEditingTool.h  

void SnapBoneToComponentSelection ( const bool bCreate
)

   SkeletalMesh/SkeletonEditingTool.h  

void UnParentBones()

   SkeletalMesh/SkeletonEditingTool.h  

Overridden from UInteractiveTool

Name Remarks Include Path Unreal Specifiers

virtual bool CanAccept()

   SkeletalMesh/SkeletonEditingTool.h  

virtual void DrawHUD ( FCanvas* Canvas,
IToolsContextRenderAPI* RenderAPI
)

   SkeletalMesh/SkeletonEditingTool.h  

virtual bool HasAccept()

   SkeletalMesh/SkeletonEditingTool.h  

virtual bool HasCancel()

   SkeletalMesh/SkeletonEditingTool.h  

virtual void OnPropertyModified ( UObject* PropertySet,
FProperty* Property
)

   SkeletalMesh/SkeletonEditingTool.h  

virtual void OnTick ( float DeltaTime
)

   SkeletalMesh/SkeletonEditingTool.h  

virtual void Render ( IToolsContextRenderAPI* RenderAPI
)

   SkeletalMesh/SkeletonEditingTool.h  

virtual void Setup()

   SkeletalMesh/SkeletonEditingTool.h  

virtual void Shutdown ( EToolShutdownType ShutdownType
)

   SkeletalMesh/SkeletonEditingTool.h  

Overridden from IInteractiveToolCameraFocusAPI

Name Remarks Include Path Unreal Specifiers

virtual FBox GetWorldSpaceFocusBox()

   SkeletalMesh/SkeletonEditingTool.h  

Overridden from IClickDragBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual FInputRayHit CanBeginClickDragSequence ( const FInputDeviceRay& InPressPos
)

   SkeletalMesh/SkeletonEditingTool.h  

virtual void OnClickDrag ( const FInputDeviceRay& InDragPos
)

   SkeletalMesh/SkeletonEditingTool.h  

virtual void OnClickPress ( const FInputDeviceRay& InPressPos
)

   SkeletalMesh/SkeletonEditingTool.h  

virtual void OnClickRelease ( const FInputDeviceRay& InReleasePos
)

   SkeletalMesh/SkeletonEditingTool.h  

virtual void OnTerminateDragSequence()

   SkeletalMesh/SkeletonEditingTool.h  

Overridden from IModifierToggleBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual void OnUpdateModifierState ( int ModifierID,
bool bIsOn
)

   SkeletalMesh/SkeletonEditingTool.h  

Overridden from ISkeletalMeshEditingInterface

Name Remarks Include Path Unreal Specifiers

virtual TWeakObjectPtr< USkeletonModifier > GetModifier()

   SkeletalMesh/SkeletonEditingTool.h  

Protected

Name Remarks Include Path Unreal Specifiers

void BeginChange()

 Ref skeleton transactions SkeletalMesh/SkeletonEditingTool.h  

void CancelChange()

   SkeletalMesh/SkeletonEditingTool.h  

void CreateNewBone()

 Modifier functions. SkeletalMesh/SkeletonEditingTool.h  

void EndChange()

   SkeletalMesh/SkeletonEditingTool.h  

void ParentBones ( const FName& InParentName
)

   SkeletalMesh/SkeletonEditingTool.h  

void UpdateGizmo()

   SkeletalMesh/SkeletonEditingTool.h  

Overridden from UInteractiveTool

Name Remarks Include Path Unreal Specifiers

virtual void RegisterActions ( FInteractiveToolActionSet& ActionSet
)

   SkeletalMesh/SkeletonEditingTool.h  

Overridden from ISkeletalMeshEditingInterface

Name Remarks Include Path Unreal Specifiers

virtual void HandleSkeletalMeshModified ( const TArray< FName >& BoneNames,
const ESkeletalMeshNotifyType InNotifyType
)

   SkeletalMesh/SkeletonEditingTool.h  

Static

Name Remarks Include Path Unreal Specifiers

static TOptional< FName > GetBoneName ( HHitProxy* InHitProxy
)

   SkeletalMesh/SkeletonEditingTool.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page