1. Epic GamesDeveloper
  3. FGenerationTools

FGenerationTools

API > API/Plugins > API/Plugins/AnimNext

References

   
Module AnimNext
Header /Engine/Plugins/Experimental/AnimNext/Source/AnimNext/Public/GenerationTools.h
Include #include "GenerationTools.h"

Syntax

class FGenerationTools

Functions

  Type Name Description
Public function Static void

CalculateDifferenceFromParentLOD ( int32 LODIndex,
TArray< FGenerationLODData >& GenerationLODData
)

 Calculate the bone indexes difference from LOD0 for LODIndex.
Public function Static bool

CheckExcludedBones ( const int32 NumLODs,
const TArray< FGenerationLODData >& GenerationLODData,
const USkeletalMesh* SkeletalMesh
)

 For each LOD : Check the excluded bones in LOD(N) contain all the bones excluded in LOD(N-1)
Public function Static bool

CheckSkeletalAllMeshSocketsAlwaysAnimate ( const USkeletalMesh* SkeletalMesh
)

 Checks if all sockets of a skeletal mesh are set to always animate, as it is a requirement for generating a single reference pose, where the local space pose and the component space pose use the same bone indexes
Public function Static void

ConvertLocalSpaceToComponentSpace ( TConstArrayView< FBoneIndexType > InParentIndices,
TConstArrayView< FTransform > InBoneSpaceTransforms,
TConstArrayView< FBoneIndexType > InRequiredBoneIndices,
TArrayView< FTransform > OutComponentSpaceTransforms
)

 Converts a local space to component space buffer given a number of required bones.
Public function Static void Utility for taking two arrays of bone indices, which must be strictly increasing, and finding the A - B.
Public function Static void

FixLODRequiredBones ( const int32 NumLODs,
const USkeletalMesh* SkeletalMesh,
TArray< FGenerationLODData >& GenerationLODData,
TArray< FGenerationLODData >& GenerationComponentSpaceLODData
)

 Check the required bones in LOD(N) are required in LOD(N-1) and add missing bones at LOD(N-1), to enable fast path on malformed LODs
Public function Static void

GenerateLODData ( const USkeletalMeshComponent* SkeletalMeshComponent,
const USkeletalMesh* SkeletalMesh,
const int32 StartLOD,
const int32 NumLODs,
const TIndirectArray< FSkeletalMeshLODRenderData >& LODRenderData,
const TArray< FBoneIndexType >& RequiredBones_LOD0,
TArray< FGenerationLODData >& GenerationLODData,
TArray< FGenerationLODData >& GenerationComponentSpaceLODData
)

 For each LOD > 0: Retrieve RequiredBones Compute ExcludedBones versus LOD0 and PreviousLOD
Public function Static bool

GenerateOrderedBoneList ( const USkeletalMesh* SkeletalMesh,
TArray< FGenerationLODData >& GenerationLODData,
TArray< FBoneIndexType >& OrderedBoneList
)

 For each LOD : Generates an unified list of bones, in LOD order (if possible) Returns true if the unified list could be created, false otherwise
Public function Static void

GenerateRawLODData ( const USkeletalMeshComponent* SkeletalMeshComponent,
const USkeletalMesh* SkeletalMesh,
const int32 LODIndex,
const TIndirectArray< FSkeletalMeshLODRenderData >& LODRenderData,
TArray< FBoneIndexType >& OutRequiredBones,
TArray< FBoneIndexType >& OutFillComponentSpaceTransformsRequiredBones
)

 Generates the full list of bones required by a LOD, based on the SkeletalRetrieve RequiredBones Compute ExcludedBones versus LOD0 and PreviousLOD Remove ExcludedBonesFromPrevLOD from BonesInAllLODS
Public function Static bool

GenerateReferencePose ( const USkeletalMeshComponent* SkeletalMeshComponent,
const USkeletalMesh* SkeletalMesh,
UE::AnimNext::FReferencePose& OutAnimationReferencePose
)

 Generates the reference pose data from a SkeletalMeshComponent and / or Skeletal Mesh asset If no SkeletalMeshComponent is passed, the reference pose will not exclude invisible bones and will not include shadow shapes required bones If no SkeletalMesh asset is passed, there will be no generation
Public function Static void

RemapAttributes ( const FLODPose& LODPose,
const UE::Anim::FHeapAttributeContainer& InAttributes,
UE::Anim::FMeshAttributeContainer& OutAttributes
)

 Converts AnimNext attributes to AnimBP attributes.
Public function Static void

RemapAttributes ( const FLODPose& LODPose,
const UE::Anim::FHeapAttributeContainer& InAttributes,
FPoseContext& OutPose
)

 Converts AnimNext attributes to AnimBP attributes.
Public function Static void

RemapPose ( const FPoseContext& SourcePose,
FLODPose& TargetPose
)

 Converts AnimBP pose to AnimNext Pose This function expects both poses to have the same LOD (number of bones and indexes) The target pose should be assigned to the correct reference pose prior to this call
Public function Static void

RemapPose ( const FLODPose& SourcePose,
FPoseContext& TargetPose
)

 Converts AnimNext pose to AnimBP Pose This function expects both poses to have the same LOD (number of bones and indexes) The target pose should be assigned to the correct reference pose prior to this call
Public function Static void

RemapPose ( const FLODPose& SourcePose,
TArrayView< FTransform > TargetTransforms
)

 Converts AnimNext pose to local space transform array This function expects the output pose to have the same or a greater number of bones (as it may be being calculated for a lower LOD) The target pose should be assigned to the correct reference pose prior to this call, as transforms will not be filled in by this call if they are not affected by the current LOD.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page