You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
0fe64da5e4
- CastShadow - RecomputeTangents - VisibleInRayTracing #jira UE-156212 #rb jeanmichel.dignard #preflight 62c58fbdf5149833402096be [CL 20966295 by Alexis Matte in ue5-main branch]
222 lines
11 KiB
C++
222 lines
11 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "CoreMinimal.h"
|
|
#include "Kismet/BlueprintFunctionLibrary.h"
|
|
#include "EditorSubsystem.h"
|
|
#include "Engine/EngineTypes.h"
|
|
|
|
#include "SkeletalMeshEditorSubsystem.generated.h"
|
|
|
|
DECLARE_LOG_CATEGORY_EXTERN(LogSkeletalMeshEditorSubsystem, Log, All);
|
|
|
|
/**
|
|
* USkeletalMeshEditorSubsystem
|
|
* Subsystem for exposing skeletal mesh functionality to scripts
|
|
*/
|
|
UCLASS()
|
|
class SKELETALMESHEDITOR_API USkeletalMeshEditorSubsystem : public UEditorSubsystem
|
|
{
|
|
GENERATED_BODY()
|
|
|
|
public:
|
|
USkeletalMeshEditorSubsystem();
|
|
|
|
/** Regenerate LODs of the mesh
|
|
*
|
|
* @param SkeletalMesh The mesh that will regenerate LOD
|
|
* @param NewLODCount Set valid value (>0) if you want to change LOD count.
|
|
* Otherwise, it will use the current LOD and regenerate
|
|
* @param bRegenerateEvenIfImported If this is true, it only regenerate even if this LOD was imported before
|
|
* If false, it will regenerate for only previously auto generated ones
|
|
* @param bGenerateBaseLOD If this is true and there is some reduction data, the base LOD will be reduce according to the settings
|
|
* @return true if succeed. If mesh reduction is not available this will return false.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category = "Skeletal Mesh Utilities", meta = (ScriptMethod))
|
|
static bool RegenerateLOD(USkeletalMesh* SkeletalMesh, int32 NewLODCount = 0, bool bRegenerateEvenIfImported = false, bool bGenerateBaseLOD = false);
|
|
|
|
/** Get number of mesh vertices for an LOD of a Skeletal Mesh
|
|
*
|
|
* @param SkeletalMesh Mesh to get number of vertices from.
|
|
* @param LODIndex Index of the mesh LOD.
|
|
* @return Number of vertices. Returns 0 if invalid mesh or LOD index.
|
|
*/
|
|
UFUNCTION(BlueprintPure, Category = "Skeletal Mesh Utilities")
|
|
int32 GetNumVerts(USkeletalMesh* SkeletalMesh, int32 LODIndex);
|
|
|
|
/** Get number of sections for a LOD of a Skeletal Mesh
|
|
*
|
|
* @param SkeletalMesh Mesh to get number of vertices from.
|
|
* @param LODIndex Index of the mesh LOD.
|
|
* @return Number of sections. Returns INDEX_NONE if invalid mesh or LOD index.
|
|
*/
|
|
UFUNCTION(BlueprintPure, Category = "Skeletal Mesh Utilities")
|
|
int32 GetNumSections(USkeletalMesh* SkeletalMesh, int32 LODIndex);
|
|
|
|
/** Get bRecomputeTangent from a section of a LOD of a Skeletal Mesh
|
|
*
|
|
* @param SkeletalMesh Mesh to get number of vertices from.
|
|
* @param LodIndex Index of the mesh LOD.
|
|
* @param SectionIndex Index of the LOD section.
|
|
* @param bOutRecomputeTangent The function will set the bRecomputeTangent used by the section
|
|
* @return false if invalid mesh or LOD index or section index.
|
|
*/
|
|
UFUNCTION(BlueprintPure, Category = "Skeletal Mesh Utilities")
|
|
bool GetSectionRecomputeTangent(const USkeletalMesh* SkeletalMesh, const int32 LODIndex, const int32 SectionIndex, bool& bOutRecomputeTangent);
|
|
|
|
/** Set bRecomputeTangent for a section of a LOD of a Skeletal Mesh.
|
|
*
|
|
* @param SkeletalMesh Mesh to get number of vertices from.
|
|
* @param LodIndex Index of the mesh LOD.
|
|
* @param SectionIndex Index of the LOD section.
|
|
* @param bRecomputeTangent The function will set the bRecomputeTangent used by the section
|
|
* @return false if invalid mesh or LOD index or section index.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category = "Skeletal Mesh Utilities")
|
|
bool SetSectionRecomputeTangent(USkeletalMesh* SkeletalMesh, const int32 LODIndex, const int32 SectionIndex, const bool bRecomputeTangent);
|
|
|
|
/** Get RecomputeTangentsVertexMaskChannel from a section of a LOD of a Skeletal Mesh
|
|
*
|
|
* @param SkeletalMesh Mesh to get number of vertices from.
|
|
* @param LodIndex Index of the mesh LOD.
|
|
* @param SectionIndex Index of the LOD section.
|
|
* @param OutRecomputeTangentsVertexMaskChannel The function will set the RecomputeTangentsVertexMaskChannel used by the section
|
|
* @return false if invalid mesh or LOD index or section index.
|
|
*/
|
|
UFUNCTION(BlueprintPure, Category = "Skeletal Mesh Utilities")
|
|
bool GetSectionRecomputeTangentsVertexMaskChannel(const USkeletalMesh* SkeletalMesh, const int32 LODIndex, const int32 SectionIndex, uint8& OutRecomputeTangentsVertexMaskChannel);
|
|
|
|
/** Set RecomputeTangentsVertexMaskChannel for a section of a LOD of a Skeletal Mesh.
|
|
*
|
|
* @param SkeletalMesh Mesh to get number of vertices from.
|
|
* @param LodIndex Index of the mesh LOD.
|
|
* @param SectionIndex Index of the LOD section.
|
|
* @param RecomputeTangentsVertexMaskChannel The function will set the RecomputeTangentsVertexMaskChannel used by the section
|
|
* @return false if invalid mesh or LOD index or section index.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category = "Skeletal Mesh Utilities")
|
|
bool SetSectionRecomputeTangentsVertexMaskChannel(USkeletalMesh* SkeletalMesh, const int32 LODIndex, const int32 SectionIndex, const uint8 RecomputeTangentsVertexMaskChannel);
|
|
|
|
/** Get bCastShadow from a section of a LOD of a Skeletal Mesh
|
|
*
|
|
* @param SkeletalMesh Mesh to get number of vertices from.
|
|
* @param LodIndex Index of the mesh LOD.
|
|
* @param SectionIndex Index of the LOD section.
|
|
* @param bOutCastShadow The function will set the bCastShadow used by the section
|
|
* @return false if invalid mesh or LOD index or section index.
|
|
*/
|
|
UFUNCTION(BlueprintPure, Category = "Skeletal Mesh Utilities")
|
|
bool GetSectionCastShadow(const USkeletalMesh* SkeletalMesh, const int32 LODIndex, const int32 SectionIndex, bool& bOutCastShadow);
|
|
|
|
/** Set bCastShadow for a section of a LOD of a Skeletal Mesh.
|
|
*
|
|
* @param SkeletalMesh Mesh to get number of vertices from.
|
|
* @param LodIndex Index of the mesh LOD.
|
|
* @param SectionIndex Index of the LOD section.
|
|
* @param bCastShadow The function will set the bCastShadow used by the section
|
|
* @return false if invalid mesh or LOD index or section index.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category = "Skeletal Mesh Utilities")
|
|
bool SetSectionCastShadow(USkeletalMesh* SkeletalMesh, const int32 LODIndex, const int32 SectionIndex, const bool bCastShadow);
|
|
|
|
/** Get bVisibleInRayTracing from a section of a LOD of a Skeletal Mesh
|
|
*
|
|
* @param SkeletalMesh Mesh to get number of vertices from.
|
|
* @param LodIndex Index of the mesh LOD.
|
|
* @param SectionIndex Index of the LOD section.
|
|
* @param bOutVisibleInRayTracing The function will set the bVisibleInRayTracing used by the section
|
|
* @return false if invalid mesh or LOD index or section index.
|
|
*/
|
|
UFUNCTION(BlueprintPure, Category = "Skeletal Mesh Utilities")
|
|
bool GetSectionVisibleInRayTracing(const USkeletalMesh* SkeletalMesh, const int32 LODIndex, const int32 SectionIndex, bool& bOutVisibleInRayTracing);
|
|
|
|
/** Set bVisibleInRayTracing for a section of a LOD of a Skeletal Mesh.
|
|
*
|
|
* @param SkeletalMesh Mesh to get number of vertices from.
|
|
* @param LodIndex Index of the mesh LOD.
|
|
* @param SectionIndex Index of the LOD section.
|
|
* @param bVisibleInRayTracing The function will set the bVisibleInRayTracing used by the section
|
|
* @return false if invalid mesh or LOD index or section index.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category = "Skeletal Mesh Utilities")
|
|
bool SetSectionVisibleInRayTracing(USkeletalMesh* SkeletalMesh, const int32 LODIndex, const int32 SectionIndex, const bool bVisibleInRayTracing);
|
|
|
|
/**
|
|
* Gets the material slot used for a specific LOD section.
|
|
* @param SkeletalMesh SkeletalMesh to get the material index from.
|
|
* @param LODIndex Index of the StaticMesh LOD.
|
|
* @param SectionIndex Index of the StaticMesh Section.
|
|
* @return MaterialSlotIndex Index of the material slot used by the section or INDEX_NONE in case of error.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category = "Skeletal Mesh Utilities")
|
|
int32 GetLODMaterialSlot(USkeletalMesh* SkeletalMesh, int32 LODIndex, int32 SectionIndex);
|
|
|
|
/** Rename a socket within a skeleton
|
|
* @param SkeletalMesh The mesh inside which we are renaming a socket
|
|
* @param OldName The old name of the socket
|
|
* @param NewName The new name of the socket
|
|
* @return true if the renaming succeeded.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category = "Skeletal Mesh Utilities", meta = (ScriptMethod))
|
|
static bool RenameSocket(USkeletalMesh* SkeletalMesh, FName OldName, FName NewName);
|
|
|
|
/**
|
|
* Retrieve the number of LOD contain in the specified skeletal mesh.
|
|
*
|
|
* @param SkeletalMesh: The static mesh we import or re-import a LOD.
|
|
*
|
|
* @return The LOD number.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category = "Editor Scripting | SkeletalMesh")
|
|
static int32 GetLODCount(USkeletalMesh* SkeletalMesh);
|
|
|
|
/**
|
|
* Import or re-import a LOD into the specified base mesh. If the LOD do not exist it will import it and add it to the base static mesh. If the LOD already exist it will re-import the specified LOD.
|
|
*
|
|
* @param BaseSkeletalMesh: The static mesh we import or re-import a LOD.
|
|
* @param LODIndex: The index of the LOD to import or re-import. Valid value should be between 0 and the base skeletal mesh LOD number. Invalid value will return INDEX_NONE
|
|
* @param SourceFilename: The fbx source filename. If we are re-importing an existing LOD, it can be empty in this case it will use the last import file. Otherwise it must be an existing fbx file.
|
|
*
|
|
* @return The index of the LOD that was imported or re-imported. Will return INDEX_NONE if anything goes bad.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category = "Editor Scripting | SkeletalMesh")
|
|
static int32 ImportLOD(USkeletalMesh* BaseMesh, const int32 LODIndex, const FString& SourceFilename);
|
|
|
|
/**
|
|
* Re-import the specified skeletal mesh and all the custom LODs.
|
|
*
|
|
* @param SkeletalMesh: is the skeletal mesh we import or re-import a LOD.
|
|
*
|
|
* @return true if re-import works, false otherwise see log for explanation.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category = "Editor Scripting | SkeletalMesh")
|
|
static bool ReimportAllCustomLODs(USkeletalMesh* SkeletalMesh);
|
|
|
|
/**
|
|
* Copy the build options with the specified LOD build settings.
|
|
* @param SkeletalMesh - Mesh to process.
|
|
* @param LodIndex - The LOD we get the reduction settings.
|
|
* @param OutBuildOptions - The build settings where we copy the build options.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category = "Editor Scripting | SkeletalMesh")
|
|
static void GetLodBuildSettings(const USkeletalMesh* SkeletalMesh, const int32 LodIndex, FSkeletalMeshBuildSettings& OutBuildOptions);
|
|
|
|
/**
|
|
* Set the LOD build options for the specified LOD index.
|
|
* @param SkeletalMesh - Mesh to process.
|
|
* @param LodIndex - The LOD we will apply the build settings.
|
|
* @param BuildOptions - The build settings we want to apply to the LOD.
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category = "Editor Scripting | SkeletalMesh")
|
|
static void SetLodBuildSettings(USkeletalMesh* SkeletalMesh, const int32 LodIndex, const FSkeletalMeshBuildSettings& BuildOptions);
|
|
|
|
/**
|
|
* This function creates a PhysicsAsset for the given SkeletalMesh with the same settings as if it were created through FBX import
|
|
*
|
|
* @Param SkeletalMesh: The SkeletalMesh we want to create the PhysicsAsset for
|
|
*/
|
|
UFUNCTION(BlueprintCallable, Category = "Editor Scripting | SkeletalMesh")
|
|
static UPhysicsAsset* CreatePhysicsAsset(USkeletalMesh* SkeletalMesh);
|
|
};
|