1. Epic GamesDeveloper
  3. UGeometryScriptLibrary_StaticMeshFunctions

UGeometryScriptLibrary_StaticMeshFunctions

Although the class name indicates StaticMeshFunctions, that was a naming mistake that is difficult to correct.

API > API/Plugins > API/Plugins/GeometryScriptingCore

Although the class name indicates StaticMeshFunctions, that was a naming mistake that is difficult to correct. This class is intended to serve as a generic asset utils function library. The naming issue is only visible at the C++ level. It is not visible in Python or BP.

   
Name UGeometryScriptLibrary_StaticMeshFunctions
Type class
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshAssetFunctions.h
Include Path #include "GeometryScript/MeshAssetFunctions.h"

Syntax

UCLASS (MinimalAPI, Meta=(ScriptName="GeometryScript_AssetUtils"))  
class UGeometryScriptLibrary_StaticMeshFunctions : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AssetOptions UDynamicMeshFGeometryScriptCopyMeshFromAssetOptions   GeometryScript/MeshAssetFunctions.h  
bUseSectionMaterials UDynamicMeshFGeometryScriptCopyMeshFromAssetOptionsFGeometryScriptMeshReadLODEGeometryScriptOutcomePins bool   GeometryScript/MeshAssetFunctions.h  
Debug USkeletalMeshFNameFNameFGeometryScriptCopySkinWeightProfileToAssetOptionsFGeometryScriptMeshWriteLODEGeometryScriptOutcomePinsUGeometryScriptDebug *   GeometryScript/MeshAssetFunctions.h  
Debug USkeletalMeshFGeometryScriptCopyMeshToAssetOptionsFGeometryScriptMeshWriteLODEGeometryScriptOutcomePinsUGeometryScriptDebug *   GeometryScript/MeshAssetFunctions.h  
Debug USkeletalMeshFNameFGeometryScriptCopyMorphTargetToAssetOptionsFGeometryScriptMeshWriteLODEGeometryScriptOutcomePinsUGeometryScriptDebug *   GeometryScript/MeshAssetFunctions.h  
Debug UDynamicMeshFGeometryScriptCopyMeshFromAssetOptionsFGeometryScriptMeshReadLODEGeometryScriptOutcomePinsUGeometryScriptDebug *   GeometryScript/MeshAssetFunctions.h  
Debug UDynamicMeshFGeometryScriptCopyMeshFromAssetOptionsFGeometryScriptMeshReadLODEGeometryScriptOutcomePins bool UGeometryScriptDebug *   GeometryScript/MeshAssetFunctions.h  
MorphTargetName USkeletalMeshFName   GeometryScript/MeshAssetFunctions.h  
Options USkeletalMeshFNameFGeometryScriptCopyMorphTargetToAssetOptions   GeometryScript/MeshAssetFunctions.h  
Options USkeletalMeshFNameFNameFGeometryScriptCopySkinWeightProfileToAssetOptions   GeometryScript/MeshAssetFunctions.h  
Options USkeletalMeshFGeometryScriptCopyMeshToAssetOptions   GeometryScript/MeshAssetFunctions.h  
Outcome USkeletalMeshFGeometryScriptCopyMeshToAssetOptionsFGeometryScriptMeshWriteLODEGeometryScriptOutcomePins &   GeometryScript/MeshAssetFunctions.h  
Outcome USkeletalMeshFNameFGeometryScriptCopyMorphTargetToAssetOptionsFGeometryScriptMeshWriteLODEGeometryScriptOutcomePins &   GeometryScript/MeshAssetFunctions.h  
Outcome USkeletalMeshFNameFNameFGeometryScriptCopySkinWeightProfileToAssetOptionsFGeometryScriptMeshWriteLODEGeometryScriptOutcomePins &   GeometryScript/MeshAssetFunctions.h  
Outcome UDynamicMeshFGeometryScriptCopyMeshFromAssetOptionsFGeometryScriptMeshReadLODEGeometryScriptOutcomePins &   GeometryScript/MeshAssetFunctions.h  
RequestedLOD UDynamicMeshFGeometryScriptCopyMeshFromAssetOptionsFGeometryScriptMeshReadLOD   GeometryScript/MeshAssetFunctions.h  
SourceProfileName USkeletalMeshFNameFName   GeometryScript/MeshAssetFunctions.h  
TargetLOD USkeletalMeshFGeometryScriptCopyMeshToAssetOptionsFGeometryScriptMeshWriteLOD   GeometryScript/MeshAssetFunctions.h  
TargetLOD USkeletalMeshFNameFNameFGeometryScriptCopySkinWeightProfileToAssetOptionsFGeometryScriptMeshWriteLOD   GeometryScript/MeshAssetFunctions.h  
TargetLOD USkeletalMeshFNameFGeometryScriptCopyMorphTargetToAssetOptionsFGeometryScriptMeshWriteLOD   GeometryScript/MeshAssetFunctions.h  
TargetProfileName USkeletalMeshFName   GeometryScript/MeshAssetFunctions.h  
ToDynamicMesh UDynamicMesh *   GeometryScript/MeshAssetFunctions.h  
ToSkeletalMeshAsset USkeletalMesh *   GeometryScript/MeshAssetFunctions.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UMaterialInterface * ConvertMaterialListToMaterialMap ( const TArray< UMaterialInterface* >& MaterialList,
const TArray< FName >& MaterialSlotNames
)

   GeometryScript/MeshAssetFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Materials"

Static

Name Remarks Include Path Unreal Specifiers

static bool CheckStaticMeshHasAvailableLOD ( UStaticMesh* StaticMeshAsset,
FGeometryScriptMeshReadLOD RequestedLOD,
EGeometryScriptSearchOutcomePins& Outcome,
UGeometryScriptDebug* Debug
)

 Check if a Static Mesh Asset has the RequestedLOD available, ie if CopyMeshFromStaticMesh will be able to succeed for the given LODType and LODIndex. GeometryScript/MeshAssetFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|StaticMesh"
  • Meta=(HidePin="Debug", ExpandEnumAsExecs="Outcome")

static void ConvertMaterialMapToMaterialList ( const TMap< FName, UMaterialInterface* >& MaterialMap,
TArray< UMaterialInterface* >& MaterialList,
TArray< FName >& MaterialSlotNames
)

 Converts material map to a material list and a slot names list. GeometryScript/MeshAssetFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Materials"

static UDynamicMesh * CopyMeshToStaticMesh ( UDynamicMesh* FromDynamicMesh,
UStaticMesh* ToStaticMeshAsset,
FGeometryScriptCopyMeshToAssetOptions Options,
FGeometryScriptMeshWriteLOD TargetLOD,
EGeometryScriptOutcomePins& Outcome,
UGeometryScriptDebug* Debug
)

   GeometryScript/MeshAssetFunctions.h  

static void GetLODMaterialListFromSkeletalMesh ( USkeletalMesh* FromSkeletalMeshAsset,
FGeometryScriptMeshReadLOD RequestedLOD,
TArray< UMaterialInterface* >& MaterialList,
TArray< int32 >& MaterialIndex,
TArray< FName >& MaterialSlotNames,
EGeometryScriptOutcomePins& Outcome,
UGeometryScriptDebug* Debug
)

 Extracts the Material List and corresponding Material Indices from the specified LOD of the Skeletal Mesh Asset. GeometryScript/MeshAssetFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|SkeletalMesh"
  • Meta=(HidePin="Debug", DisplayName="Get LOD Material List From Skeletal Mesh", ExpandEnumAsExecs="Outcome")

static void GetMaterialListFromSkeletalMesh ( const USkeletalMesh* FromSkeletalMeshAsset,
TArray< UMaterialInterface* >& MaterialList,
TArray< FName >& MaterialSlotNames,
UGeometryScriptDebug* Debug
)

 Get the asset materials from the skeletal mesh asset. GeometryScript/MeshAssetFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|SkeletalMesh"
  • Meta=(HidePin="Debug")

static void GetMaterialListFromStaticMesh ( const UStaticMesh* FromStaticMeshAsset,
TArray< UMaterialInterface* >& MaterialList,
TArray< FName >& MaterialSlotNames,
UGeometryScriptDebug* Debug
)

 Get the asset materials from the static mesh asset. GeometryScript/MeshAssetFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|StaticMesh"
  • Meta=(HidePin="Debug")

static int GetNumStaticMeshLODsOfType ( UStaticMesh* StaticMeshAsset,
EGeometryScriptLODType LODType
)

 Determine the number of available LODs of the requested LODType in a Static Mesh Asset GeometryScript/MeshAssetFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|StaticMesh"
  • Meta=(ScriptName="GetNumStaticMeshLodsOfType;GetNumStaticMeshLODsOfType")

static void GetSectionMaterialListFromStaticMesh ( UStaticMesh* FromStaticMeshAsset,
FGeometryScriptMeshReadLOD RequestedLOD,
TArray< UMaterialInterface* >& MaterialList,
TArray< int32 >& MaterialIndex,
TArray< FName >& MaterialSlotNames,
EGeometryScriptOutcomePins& Outcome,
UGeometryScriptDebug* Debug
)

 Extracts the Material List and corresponding Material Indices from the specified LOD of the Static Mesh Asset. GeometryScript/MeshAssetFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|StaticMesh"
  • Meta=(HidePin="Debug", ExpandEnumAsExecs="Outcome")

static static UPARAM ( DisplayName
)

 Extracts a Dynamic Mesh from a Static Mesh Asset. GeometryScript/MeshAssetFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|StaticMesh"
  • Meta=(HidePin="Debug", DisplayName="Copy Mesh From Static Mesh", ExpandEnumAsExecs="Outcome")

static static UPARAM ( DisplayName
)

 Extracts a Dynamic Mesh from a Static Mesh Asset, using section indices for the material IDs use GetSectionMaterialListFromStaticMesh to get the corresponding materials. GeometryScript/MeshAssetFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|StaticMesh"
  • Meta=(HidePin="Debug", DisplayName="Copy Mesh From Static Mesh with Section Materials", ExpandEnumAsExecs="Outcome")

static static UPARAM ( DisplayName
)

 Converts material list and slot names list to material map, which is the format expected by CreateNewSkeletalMeshAssetFromMesh. GeometryScript/MeshAssetFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Materials"

static static UPARAM ( DisplayName
)

 Extracts a Dynamic Mesh from a Skeletal Mesh Asset. GeometryScript/MeshAssetFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|SkeletalMesh"
  • Meta=(HidePin="Debug", ExpandEnumAsExecs="Outcome")

static static UPARAM ( DisplayName
)

 Updates a Skeletal Mesh Asset with new geometry and bone weights data from a Dynamic Mesh. GeometryScript/MeshAssetFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|SkeletalMesh"
  • Meta=(HidePin="Debug", ExpandEnumAsExecs="Outcome")

static static UPARAM ( DisplayName
)

 Add a Dynamic Mesh morph target to a Skeletal Mesh Asset. GeometryScript/MeshAssetFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|SkeletalMesh"
  • Meta=(HidePin="Debug", ExpandEnumAsExecs="Outcome")

static static UPARAM ( DisplayName
)

 Add a Dynamic Mesh skin weight profile to a Skeletal Mesh Asset. GeometryScript/MeshAssetFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|SkeletalMesh"
  • Meta=(HidePin="Debug", ExpandEnumAsExecs="Outcome")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page