1. Epic GamesDeveloper
  3. URigMapperEditorSubsystem

URigMapperEditorSubsystem

[URigMapperEditorSubsystem](API\Plugins\RigMapperEditor\URigMapperEditorSubsystem) Subsystem to remap animation from/to all kinds of formats using the Rig Mapper API.

API > API/Plugins > API/Plugins/RigMapperEditor

URigMapperEditorSubsystem Subsystem to remap animation from/to all kinds of formats using the Rig Mapper API.

   
Name URigMapperEditorSubsystem
Type class
Header File /Engine/Plugins/Experimental/Animation/RigMapper/Source/RigMapperEditor/Public/RigMapperEditorSubsystem.h
Include Path #include "RigMapperEditorSubsystem.h"

Syntax

UCLASS (MinimalAPI)  
class URigMapperEditorSubsystem : public UEditorSubsystem

Inheritance Hierarchy

Typedefs

Name Type Remarks Include Path
FFramePoses TArray< FRigMapperProcessor::FPose >   RigMapperEditorSubsystem.h
FFrameValues TArray< FRigMapperProcessor::FPoseValues >   RigMapperEditorSubsystem.h

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool AddCurveValuesToAnimSequence ( UAnimSequence* Target,
const TArray< FString >& CurveNames,
const TArray< FFrameTime >& FrameTimes,
const FFrameValues& CurveValuesPerFrame
)

   RigMapperEditorSubsystem.h  

static bool AddCurveValuesToControlRigSection ( UMovieSceneControlRigParameterSection* Target,
const TArray< FString >& CurveNames,
const TArray< FFrameTime >& FrameTimes,
const FFrameValues& CurveValuesPerFrame
)

   RigMapperEditorSubsystem.h  

static bool BakeSparseKeys ( const FFramePoses& Poses,
const TArray< FString >& CurveNames,
TArray< FFrameTime >& FrameTimes,
FFrameValues& CurveValuesPerFrame
)

   RigMapperEditorSubsystem.h  

static bool ConvertAnimSequence ( const UAnimSequence* Source,
UAnimSequence* Target,
const TArray< URigMapperDefinition* >& Definitions
)

 Remap an anim sequence to another existing one, remapping it using the given definitions The target sequence rate will be unchanged (see SetAnimSequenceRate if required) RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static UAnimSequence * ConvertAnimSequenceNew ( const UAnimSequence* Source,
USkeletalMesh* TargetMesh,
const TArray< URigMapperDefinition* >& Definitions,
const FDirectoryPath& NewAssetPath,
const FName NewAssetName
)

 Remap an anim sequence to a new one, remapping it using the given definitions RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static bool ConvertAnimSequenceToControlRigSection ( const UAnimSequence* Source,
UMovieSceneControlRigParameterSection* Target,
const TArray< URigMapperDefinition* >& Definitions
)

 Convert an AnimSequence to an existing Control Rig section, remapping it using the given definitions Control Rig transform/vector2d/float channels are currently supported The target sequence rate will be unchanged RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static UMovieSceneControlRigParameterSection * ConvertAnimSequenceToControlRigSectionNew ( const UAnimSequence* Source,
USkeletalMesh* TargetMesh,
const TArray< URigMapperDefinition* >& Definitions,
const TSubclassOf< UControlRig >& ControlRigClass,
const FDirectoryPath& NewAssetPath,
const FName NewAssetName
)

 Convert an AnimSequence to a Control Rig section in a new Level Sequence, remapping it using the given definitions Control Rig transform/vector2d/float channels are currently supported RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static bool ConvertAnimSequenceToCsv ( const UAnimSequence* Source,
const FFilePath& OutputFile,
const TArray< URigMapperDefinition* >& Definitions,
bool bOutputIntermediateCsvFiles
)

 Export a CSV file from an anim sequence, remapping it using the given definitions RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static bool ConvertControlRigSection ( const UMovieSceneControlRigParameterSection* Source,
UMovieSceneControlRigParameterSection* Target,
const TArray< URigMapperDefinition* >& Definitions
)

 Convert a Control Rig section to another existing one, remapping it using the given definitions Control Rig transform/vector2d/float channels are currently supported The target sequence rate will be unchanged RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static UMovieSceneControlRigParameterSection * ConvertControlRigSectionNew ( const UMovieSceneControlRigParameterSection* Source,
USkeletalMesh* TargetMesh,
const TArray< URigMapperDefinition* >& Definitions,
const TSubclassOf< UControlRig >& ControlRigClass,
const FDirectoryPath& NewAssetPath,
const FName NewAssetName
)

 Convert a Control Rig section to a section in a new Level Sequence, remapping it using the given definitions Control Rig transform/vector2d/float channels are currently supported RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static bool ConvertControlRigSectionToAnimSequence ( const UMovieSceneControlRigParameterSection* Source,
UAnimSequence* Target,
const TArray< URigMapperDefinition* >& Definitions
)

 Convert a Control Rig section to an existing AnimSequence, remapping it using the given definitions The target sequence rate will be unchanged RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static UAnimSequence * ConvertControlRigSectionToAnimSequenceNew ( const UMovieSceneControlRigParameterSection* Source,
USkeletalMesh* TargetMesh,
const TArray< URigMapperDefinition* >& Definitions,
const FDirectoryPath& NewAssetPath,
const FName NewAssetName
)

 Convert a Control Rig section to a new AnimSequence asset, remapping it using the given definitions RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static bool ConvertControlRigSectionToCsv ( const UMovieSceneControlRigParameterSection* Source,
const FFilePath& OutputFile,
const TArray< URigMapperDefinition* >& Definitions,
bool bOutputIntermediateCsvFiles
)

 Export a CSV file from a Control Rig Section, remapping it using the given definitions RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static bool ConvertCsv ( const FFilePath& InputFile,
const FFilePath& OutputFile,
const TArray< URigMapperDefinition* >& Definitions,
bool bOutputIntermediateCsvFiles
)

 Remap a CSV file using the given definitions, and optionally outputting separate files for each definition's output The following header is expected at the first line of the CSV file: curve_name, frame_number, value RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static bool ConvertCsvToAnimSequence ( const FFilePath& InputFile,
UAnimSequence* Target,
const TArray< URigMapperDefinition* >& Definitions
)

 Import a CSV file to an existing anim sequence, remapping it using the given definitions The following header is expected at the first line of the CSV file: curve_name, frame_number, value The target sequence rate will be unchanged (see SetAnimSequenceRate if required) RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static UAnimSequence * ConvertCsvToAnimSequenceNew ( const FFilePath& InputFile,
USkeletalMesh* TargetMesh,
const TArray< URigMapperDefinition* >& Definitions,
const FFrameRate& FrameRate,
const FDirectoryPath& NewAssetPath,
const FName NewAssetName
)

 Import a CSV file to a new anim sequence asset, remapping it using the given definitions The following header is expected at the first line of the CSV file: curve_name, frame_number, value RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static bool ConvertCsvToControlRigSection ( const FFilePath& InputFile,
UMovieSceneControlRigParameterSection* Target,
const TArray< URigMapperDefinition* >& Definitions
)

 Import a CSV file to the given control rig section, remapping it using the given definitions The following header is expected at the first line of the CSV file: curve_name, frame_number, value Control Rig transform/vector2d/float channels are currently supported The target sequence rate will be unchanged RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static UMovieSceneControlRigParameterSection * ConvertCsvToControlRigSectionNew ( const FFilePath& InputFile,
USkeletalMesh* TargetMesh,
const TArray< URigMapperDefinition* >& Definitions,
const FFrameRate& FrameRate,
const TSubclassOf< UControlRig >& ControlRigClass,
const FDirectoryPath& NewAssetPath,
const FName NewAssetName
)

 Import a CSV file to a control rig section in a new Level Sqeuence, remapping it using the given definitions The following header is expected at the first line of the CSV file: curve_name, frame_number, value Control Rig transform/vector2d/float channels are currently supported RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static bool ConvertCurveValuesToAnimSequence ( TArray< FString >& CurveNames,
const TArray< FFrameTime >& FrameTimes,
FFrameValues& CurveValuesPerFrame,
UAnimSequence* Target,
const TArray< URigMapperDefinition* >& Definitions
)

   RigMapperEditorSubsystem.h  

static bool ConvertCurveValuesToControlRigSection ( TArray< FString >& CurveNames,
const TArray< FFrameTime >& FrameTimes,
FFrameValues& CurveValuesPerFrame,
UMovieSceneControlRigParameterSection* Target,
const TArray< URigMapperDefinition* >& Definitions
)

   RigMapperEditorSubsystem.h  

static bool ConvertCurveValuesToCsv ( TArray< FString >& CurveNames,
const TArray< FFrameTime >& FrameTimes,
FFrameValues& CurveValuesPerFrame,
const FFilePath& OutputFile,
const TArray< URigMapperDefinition* >& Definitions,
bool bOutputIntermediateCsvFiles
)

   RigMapperEditorSubsystem.h  

static FFrameRate GetAnimSequenceRate ( const UAnimSequence* AnimSequence
)

   RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static TArray< UMovieSceneControlRigParameterSection * > GetSectionsFromSequence ( ULevelSequence* Sequence
)

   RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static ULevelSequence * GetSequenceFromSection ( const UMovieSceneControlRigParameterSection* Section
)

   RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static bool LoadCurveValuesFromAnimSequence ( const UAnimSequence* Source,
TArray< FString >& CurveNames,
TArray< FFrameTime >& FrameTimes,
FFrameValues& CurveValuesPerFrame
)

   RigMapperEditorSubsystem.h  

static bool LoadCurveValuesFromAnimSequence ( const UAnimSequence* InSource,
const USkeleton* InSourceSkeleton,
TArray< FName >& OutCurveNames,
TArray< FFrameTime >& OutFrameTimes,
FFrameValues& OutCurveValuesPerFrame,
TArray< int32 >& OutCurveFlags,
TArray< FLinearColor >& OutCurveColors
)

 Load curve values from animation sequence (not blueprint callable) RigMapperEditorSubsystem.h  

static bool LoadCurveValuesFromControlRigSection ( const UMovieSceneControlRigParameterSection* Source,
TArray< FString >& CurveNames,
TArray< FFrameTime >& FrameTimes,
FFrameValues& CurveValuesPerFrame,
const TArray< FString >& InputNames
)

   RigMapperEditorSubsystem.h  

static bool LoadCurveValuesFromCsv ( const FFilePath& InputFile,
TArray< FString >& CurveNames,
TArray< FFrameTime >& FrameTimes,
FFrameValues& CurveValuesPerFrame
)

   RigMapperEditorSubsystem.h  

static void SetAnimSequenceRate ( UAnimSequence* AnimSequence,
FFrameRate FrameRate,
bool bSetImportProperties
)

   RigMapperEditorSubsystem.h
  • BlueprintCallable
  • Category="Editor Scripting|Animation|Rig Mapper"

static void SparseBakeCurve ( const FString& CurveName,
int32 CurveIndex,
float CurveValue,
FFrameValues& CurveValuesPerFrame,
const TArray< FFrameTime >& FrameTimesInOrder,
int32 FrameIndex,
const FFramePoses& Poses,
const TArray< FFrameTime >& FrameTimes,
const int32 ActualFrameIndex
)

   RigMapperEditorSubsystem.h  

static bool WriteCurveValuesToCsv ( const FFilePath& OutputFile,
const TArray< FString >& CurveNames,
const TArray< FFrameTime >& FrameTimes,
const FFrameValues& CurveValuesPerFrame
)

   RigMapperEditorSubsystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page