1. Epic GamesDeveloper
  3. UPARAM

UPARAM

Function Overloads

API > API/Plugins > API/Plugins/GeometryScriptingCore > API/Plugins/GeometryScriptingCore/UGeometryScriptLibrary_MeshMater-

Overloads

Name Remarks Include Path Unreal Specifiers

static static UPARAM ( DisplayName
)

   GeometryScript/MeshMaterialFunctions.h
  • BlueprintPure
  • Category="GeometryScript|MeshQueries"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Enables per-triangle Material IDs on a mesh and initializes the values to 0. GeometryScript/MeshMaterialFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Materials"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Resets all Material IDs on a mesh to the given ClearValue, or 0 if no ClearValue is provided. GeometryScript/MeshMaterialFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Materials"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 For all triangles with a Material ID matching the given value (From Material ID), update the Material ID to the new value (To Material ID). GeometryScript/MeshMaterialFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Materials"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Remap the Material IDs of the TargetMesh to a new set of Material IDs based on a 'From'/Current Material List, and a New Material List. GeometryScript/MeshMaterialFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Materials"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Remap material IDs to be consistent with a Required Materials list. GeometryScript/MeshMaterialFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Materials"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Returns the current Material ID for a Triangle. GeometryScript/MeshMaterialFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Materials"
  • Meta=(ScriptMethod, DisplayName="Get Material ID Of Triangle")

static static UPARAM ( DisplayName
)

 This populates the MaterialIDList with Material IDs for each triangle in the TriangleIDList. GeometryScript/MeshMaterialFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Materials"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Returns an Index List of all triangle Material IDs, constructed with one entry for each consecutive Triangle ID. GeometryScript/MeshMaterialFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Materials"
  • Meta=(ScriptMethod, DisplayName="Get Material IDs Of All Triangles")

static static UPARAM ( DisplayName
)

 Populates Triangle ID List with the Triangle IDs of triangles that share the specified Material ID in the Target Mesh. GeometryScript/MeshMaterialFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Selection"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Assigns the specified triangle the given Material ID. GeometryScript/MeshMaterialFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Materials"
  • Meta=(ScriptMethod, DisplayName="Set Material ID On Triangle")

static static UPARAM ( DisplayName
)

 Sets the Material ID of all triangles in a mesh to the values in an input Index List. GeometryScript/MeshMaterialFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Materials"
  • Meta=(ScriptMethod, DisplayName="Set Material IDs On All Triangles")

static static UPARAM ( DisplayName
)

 Assigns the Material ID to all the triangles specified by the Triangle ID List. GeometryScript/MeshMaterialFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Materials"
  • Meta=(ScriptMethod, DisplayName="Set Material ID On Triangles")

static static UPARAM ( DisplayName
)

 Set a new MaterialID on all the triangles of the given Selection. GeometryScript/MeshMaterialFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Materials"
  • Meta=(ScriptMethod, DisplayName="Set Material ID For Mesh Selection")

static static UPARAM ( DisplayName
)

 Set a new MaterialID on all the triangles of TargetMesh with the given PolyGroup. GeometryScript/MeshMaterialFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Materials"
  • Meta=(ScriptMethod, DisplayName="Set PolyGroup Material ID")

static static UPARAM ( DisplayName
)

 Delete all triangles in TargetMesh with the given MaterialID GeometryScript/MeshMaterialFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Materials"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Compact the MaterialIDs of the TargetMesh, ie remove any un-used MaterialIDs and remap the remaining N in-use MaterialIDs to the range [0,N-1]. GeometryScript/MeshMaterialFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Materials"
  • Meta=(ScriptMethod)

static UPARAM ( DisplayName
)

   GeometryScript/MeshMaterialFunctions.h  

static UPARAM ( DisplayName
)

   GeometryScript/MeshMaterialFunctions.h  

int UPARAM ( DisplayName
)

   GeometryScript/MeshMaterialFunctions.h  

static UPARAM ( DisplayName
)

   GeometryScript/MeshMaterialFunctions.h  

static UPARAM ( DisplayName
)

   GeometryScript/MeshMaterialFunctions.h  
  GeometryScript/MeshMaterialFunctions.h  

FGeometryScriptGroupLayer int UPARAM ( DisplayName
)

   GeometryScript/MeshMaterialFunctions.h  

UPARAM(DisplayName)

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
UFUNCTION (BlueprintPure, Category="GeometryScript|MeshQueries", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Enables per-triangle Material IDs on a mesh and initializes the values to 0. If Target Mesh already has Material IDs, this function will do nothing.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Materials", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Resets all Material IDs on a mesh to the given ClearValue, or 0 if no ClearValue is provided. If Material IDs are not already enabled on the Target Mesh, this function will first enable them and then set the value.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Materials", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

For all triangles with a Material ID matching the given value (From Material ID), update the Material ID to the new value (To Material ID).

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Materials", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Remap the Material IDs of the TargetMesh to a new set of Material IDs based on a 'From'/Current Material List, and a New Material List. For each triangle, the current Material is determined as FromMaterialList[MaterialID], and then the first index of this Material is found in the ToMaterialList, and this index is used as the new MaterialID

If a Material cannot be found in ToMaterialList, a warning will be printed and the MaterialID left unmodified, unless MissingMaterialID is set to a value >= 0, in which case MissingMaterialID will be assigned

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Materials", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Remap material IDs to be consistent with a Required Materials list. The Target Mesh material IDs will be remapped to reference the Combined Materials list, which will always start with the Required Materials.

If a Material cannot be found in CurrentMeshMaterials, a warning will be printed and the MaterialID left unmodified, unless RemapInvalidMaterialID is set to a value >= 0, in which case RemapInvalidMaterialID will be assigned

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Materials", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

Parameters

Name Remarks
TargetMesh Mesh to update
TargetMeshMaterials Initial materials used by the TargetMesh
RequiredMaterials Materials that must be used, unchanged, in the output
CombinedMaterials Final materials used by the TargetMesh after remapping. Always starts with the RequiredMaterials.
RemapInvalidMaterialID If >= 0, automatically remap invalid input material IDs to this value
bCompactDuplicateMaterials If true, materials from TargetMeshMaterials will only be added if they are not already in RequiredMaterials. If false, all TargetMeshMaterials are appended.

UPARAM(DisplayName)

Description

Returns the current Material ID for a Triangle. If the mesh does not have Material IDs enabled or if the Triangle ID is not an element of the mesh, the value 0 will be returned and bIsValidTriangle will be false.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
UFUNCTION (BlueprintPure, Category="GeometryScript|Materials",  
          Meta=(ScriptMethod, DisplayName="Get Material ID Of Triangle"))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

This populates the MaterialIDList with Material IDs for each triangle in the TriangleIDList. If a triangle is not present in the Target Mesh the number -1 will be used for the corresponding Material ID. If Material IDs are not enabled on the TargetMesh no Material IDs will be added to the result list.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
UFUNCTION (BlueprintPure, Category="GeometryScript|Materials", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Warnings * if the mesh is not Triangle-Compact (eg GetHasTriangleIDGaps == false) then the returned list will also have the same gaps where the number -1 will be recorded for any missing Triangle IDs.

Description

Returns an Index List of all triangle Material IDs, constructed with one entry for each consecutive Triangle ID. If Material IDs are not enabled on the mesh, bHasMaterialsIDs will be set to false on return and nothing will be added to the Material ID List.

if the mesh is not Triangle-Compact (eg GetHasTriangleIDGaps == false) then the returned list will also have the same gaps where the number -1 will be recorded for any missing Triangle IDs.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
UFUNCTION (BlueprintPure, Category="GeometryScript|Materials",  
          Meta=(ScriptMethod, DisplayName="Get Material IDs Of All Triangles"))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Populates Triangle ID List with the Triangle IDs of triangles that share the specified Material ID in the Target Mesh.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
UFUNCTION (BlueprintPure, Category="GeometryScript|Selection", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Assigns the specified triangle the given Material ID. If the Target Mesh does not have Material IDs enabled, or if the Triangle ID is not an element of the Target Mesh then bIsValidTriangle will be set to false.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Materials",  
          Meta=(ScriptMethod, DisplayName="Set Material ID On Triangle"))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Sets the Material ID of all triangles in a mesh to the values in an input Index List.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Materials",  
          Meta=(ScriptMethod, DisplayName="Set Material IDs On All Triangles"))  
static static UPARAM  
(  
    DisplayName  
)

Parameters

Name Remarks
TriangleMateralIDList the list of Material IDs, the length of this list should be the same as the Max Triangle ID for this mesh.
bDeferChangeNotifications if true, the UDynamicMesh does not emit a change event/signal for this modification.

UPARAM(DisplayName)

Description

Assigns the Material ID to all the triangles specified by the Triangle ID List.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Materials",  
          Meta=(ScriptMethod, DisplayName="Set Material ID On Triangles"))  
static static UPARAM  
(  
    DisplayName  
)

Parameters

Name Remarks
TriangleIDList the triangles in the target mesh that will be updated with the new Material ID
MaterialID the ID to be assigned to each triangle in the input list.
bDeferChangeNotifications if true, the UDynamicMesh does not emit a change event/signal for this modification.

UPARAM(DisplayName)

Description

Set a new MaterialID on all the triangles of the given Selection.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Materials",  
          Meta=(ScriptMethod, DisplayName="Set Material ID For Mesh Selection"))  
static static UPARAM  
(  
    DisplayName  
)

Parameters

Name Remarks
MaterialID new Material ID to set
bDeferChangeNotifications if true, the UDynamicMesh does not emit a change event/signal for this modification

UPARAM(DisplayName)

Description

Set a new MaterialID on all the triangles of TargetMesh with the given PolyGroup.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Materials",  
          Meta=(ScriptMethod, DisplayName="Set PolyGroup Material ID"))  
static static UPARAM  
(  
    DisplayName  
)

Parameters

Name Remarks
GroupLayer PolyGroup Layer to use as basis for PolyGroups
PolyGroupID PolyGroup ID that specifies Triangles to set to new MaterialID
MaterialID explicit new MaterialID to set
bDeferChangeNotifications if true, the UDynamicMesh does not emit a change event/signal for this modification

UPARAM(DisplayName)

Description

Delete all triangles in TargetMesh with the given MaterialID

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Materials", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

Parameters

Name Remarks
NumDeleted number of deleted triangles is returned here

UPARAM(DisplayName)

Description

Compact the MaterialIDs of the TargetMesh, ie remove any un-used MaterialIDs and remap the remaining N in-use MaterialIDs to the range [0,N-1]. Optionally compute a Compacted list of Materials.

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Materials", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

Parameters

Name Remarks
SourceMaterialList Input Material list, assumption is that SourceMaterialList.Num() == number of MaterialIDs on mesh at input
CompactedMaterialList new Compacted Material list, one-to-one with new compacted MaterialIDs
bRemoveDuplicateMaterials Whether to also remove duplicate materials from the compacted list

UPARAM(DisplayName)

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
int UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
FGeometryScriptGroupLayer UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshMaterialFunctions.h
Include Path #include "GeometryScript/MeshMaterialFunctions.h" 
FGeometryScriptGroupLayer int UPARAM  
(  
    DisplayName  
)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page