1. Epic GamesDeveloper
  3. USkeletonEditingTool

USkeletonEditingTool

[USkeletonEditingTool](API\Plugins\MeshModelingToolsEditorOnlyExp\SkeletalMesh\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/MeshModelingToolsEditorOnlyExp > API/Plugins/MeshModelingToolsEditorOnlyExp/SkeletalMesh

Inheritance Hierarchy

References

   
Module MeshModelingToolsEditorOnlyExp
Header /Engine/Plugins/Experimental/MeshModelingToolsetExp/Source/MeshModelingToolsEditorOnlyExp/Public/SkeletalMesh/SkeletonEditingTool.h
Include #include "SkeletalMesh/SkeletonEditingTool.h"

Syntax

UCLASS&40;&41;  
class USkeletonEditingTool :  
    public USingleSelectionTool,  
    public IClickDragBehaviorTarget,  
    public ISkeletalMeshEditingInterface

Remarks

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.

Variables

  Type Name Description
Protected variable TUniquePtr< SkeletonEditingTool::FRefSkeletonChange > ActiveChange  
Protected variable UProperty TWeakObjectPtr< USkeletalMeshEditorContextObjectBase > EditorContext  
Protected variable UProperty TWeakObjectPtr< USkeletalMeshGizmoContextObjectBase > GizmoContext Gizmo
Protected variable UProperty TObjectPtr< USkeletalMeshGizmoWrapperBase > GizmoWrapper  
Protected variable UProperty TObjectPtr< USingleClickInputBehavior > LeftClickBehavior  
Protected variable UProperty TObjectPtr< UMirroringProperties > MirroringProperties  
Protected variable UProperty TObjectPtr< USkeletonModifier > Modifier  
Protected variable UProperty EEditingOperation Operation  
Public variable UProperty TObjectPtr< UOrientingProperties > OrientingProperties  
Protected variable UProperty TObjectPtr< UPreviewMesh > PreviewMesh  
Protected variable UProperty TObjectPtr< UProjectionProperties > ProjectionProperties  
Protected variable UProperty TObjectPtr< USkeletonEditingProperties > Properties  
Protected variable UProperty TWeakObjectPtr< UWorld > TargetWorld  
Protected variable UProperty TWeakObjectPtr< UGizmoViewContext > ViewContext  

Functions

  Type Name Description
Protected function void Ref skeleton transactions
Protected function void  
Protected function void Modifier functions.
Protected function void  
Public function Const EEditingOperation  
Public function Const const TArray< FName > &  
Public function Const const FTransform &

GetTransform ( const FName InBoneName,
const bool bWorld
)

  
Public function void

Init ( const FToolBuilderState& InSceneState
)

 USkeletonEditingTool
Public function void Modifier functions.
Public function void  
Public function void  
Protected function void

ParentBones ( const FName& InParentName
)

  
Public function void  
Public function void  
Public function void

SetOperation ( const EEditingOperation InOperation,
const bool bUpdateGizmo
)

  
Public function Const void

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

  
Public function void  
Protected function Const void  

Overridden from UInteractiveTool

  Type Name Description
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual void

OnTick ( float DeltaTime
)

 Allow the Tool to do any necessary processing on Tick
Protected function Virtual void Override this function to register the set of Actions this Tool supports, using FInteractiveToolActionSet::RegisterAction.
Public function Virtual void Allow the Tool to do any custom drawing (ie via PDI/RHI)
Public function Virtual void

Setup ()

 Called by ToolManager to initialize the Tool after ToolBuilder::BuildTool() has been called
Public function Virtual void

Shutdown ( EToolShutdownType ShutdownType
)

 Called by ToolManager to shut down the Tool

Overridden from IInteractiveToolCameraFocusAPI

  Type Name Description
Public function Virtual FBox  

Overridden from IClickDragBehaviorTarget

  Type Name Description
Public function Virtual FInputRayHit Test if target can begin click-drag interaction at this point
Public function Virtual void

OnClickDrag ( const FInputDeviceRay& DragPos
)

 Notify Target that input position has changed
Public function Virtual void

OnClickPress ( const FInputDeviceRay& PressPos
)

 Notify Target that click press ocurred
Public function Virtual void

OnClickRelease ( const FInputDeviceRay& ReleasePos
)

 Notify Target that click release occurred
Public function Virtual void Notify Target that click-drag sequence has been explicitly terminated (eg by escape key)

Overridden from IModifierToggleBehaviorTarget

  Type Name Description
Public function Virtual void

OnUpdateModifierState ( int ModifierID,
bool bIsOn
)

 Notify target of current modifier state

Overridden from ISkeletalMeshEditingInterface

  Type Name Description
Public function Virtual Const TWeakObjectPtr< USkeletonModifier >  
Public function Virtual Const TArray< FName >  
Protected function Virtual void

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

  

Enums

  Type Name Description
Private enum EBoneSelectionMode    

Constants

Name Description
AddToSelectionModifier Flags used to identify behavior modifier keys/buttons
ToggleSelectionModifier  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page