1. Epic GamesDeveloper
  3. UPARAM

UPARAM

Function Overloads

API > API/Plugins > API/Plugins/GeometryScriptingCore > API/Plugins/GeometryScriptingCore/UGeometryScriptLibrary_MeshModel-

Overloads

Name Remarks Include Path Unreal Specifiers

static static UPARAM ( DisplayName
)

 Disconnect the triangles of TargetMesh identified by the Selection. GeometryScript/MeshModelingFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Modeling"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Disconnect triangles of TargetMesh along the edges of the Selection. GeometryScript/MeshModelingFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Modeling"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Duplicate the triangles of TargetMesh identified by the Selection GeometryScript/MeshModelingFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Modeling"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Offset the vertices of TargetMesh from their initial positions based on averaged vertex normals. GeometryScript/MeshModelingFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Modeling"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Create a thickened shell from TargetMesh by offsetting the vertex positions along averaged vertex normals, inwards or outwards. GeometryScript/MeshModelingFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Modeling"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Apply Linear Extrusion (ie extrusion in a single direction) to the triangles of TargetMesh identified by the Selection. GeometryScript/MeshModelingFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Modeling"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Apply an Offset to the faces of TargetMesh identified by the Selection, or all faces if the Selection is empty. GeometryScript/MeshModelingFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Modeling"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Apply an Inset or Outset to the faces of TargetMesh identified by the Selection, or all faces if the Selection is empty. GeometryScript/MeshModelingFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Modeling"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Apply a Mesh Bevel operation to parts of TargetMesh using the BevelOptions settings. GeometryScript/MeshModelingFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Modeling"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Apply a Mesh Bevel operation to parts of TargetMesh using the BevelOptions settings, with additional options to handle region selections GeometryScript/MeshModelingFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Modeling"
  • Meta=(ScriptMethod, DisplayName="Apply Mesh Bevel Region Selection")

static static UPARAM ( DisplayName
)

 Apply a Mesh Bevel operation to all PolyGroup Edges. GeometryScript/MeshModelingFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Modeling"
  • Meta=(ScriptMethod, DisplayName="Apply Mesh PolyGroup Bevel")

static static UPARAM ( DisplayName
)

 Backwards-Compatibility implementations. GeometryScript/MeshModelingFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Compatibility"
  • Meta=(ScriptMethod)

UPARAM(DisplayName)

Description

Disconnect the triangles of TargetMesh identified by the Selection. The input Selection will still identify the same geometric elements after Disconnecting.

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

Parameters

Name Remarks
bAllowBowtiesInOutput if false, any bowtie vertices created by the operation will be automatically split

UPARAM(DisplayName)

Description

Disconnect triangles of TargetMesh along the edges of the Selection. The input Selection will still identify the same geometric elements after Disconnecting.

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

Parameters

Name Remarks
TargetMesh Mesh to operate on
Selection Which edges to operate on. Non-edge selections will be interpreted as edge selections i.e., all selected triangles' edges, or all selected vertices' one-ring edges.

UPARAM(DisplayName)

Description

Duplicate the triangles of TargetMesh identified by the Selection

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

Parameters

Name Remarks
NewTriangles a Mesh Selection of the duplicate triangles is returned here (with type Triangles)
bAllowBowtiesInOutput if false, any bowtie vertices resulting created in the Duplicate area will be disconnected into unique vertices

UPARAM(DisplayName)

Description

Offset the vertices of TargetMesh from their initial positions based on averaged vertex normals. This function is intended for high-res meshes, for polymodeling-style offsets, ApplyMeshOffsetFaces will produce better results.

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

UPARAM(DisplayName)

Description

Create a thickened shell from TargetMesh by offsetting the vertex positions along averaged vertex normals, inwards or outwards. Similar to ApplyMeshOffset but also includes the initial mesh (possibly flipped, if the offset is positive)

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

UPARAM(DisplayName)

Description

Apply Linear Extrusion (ie extrusion in a single direction) to the triangles of TargetMesh identified by the Selection. The input Selection will still identify the same geometric elements after the Extrusion

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

UPARAM(DisplayName)

Description

Apply an Offset to the faces of TargetMesh identified by the Selection, or all faces if the Selection is empty. The Offset direction at each vertex can be derived from the averaged vertex normals or per-triangle normals.

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

UPARAM(DisplayName)

Description

Apply an Inset or Outset to the faces of TargetMesh identified by the Selection, or all faces if the Selection is empty.

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

UPARAM(DisplayName)

Description

Apply a Mesh Bevel operation to parts of TargetMesh using the BevelOptions settings.

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

Parameters

Name Remarks
Selection specifies which mesh edges to Bevel
BevelOptions settings for the Bevel Operation

UPARAM(DisplayName)

Description

Apply a Mesh Bevel operation to parts of TargetMesh using the BevelOptions settings, with additional options to handle region selections

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshModelingFunctions.h
Include Path #include "GeometryScript/MeshModelingFunctions.h" 
UFUNCTION (BlueprintCallable, Category="GeometryScript|Modeling",  
          Meta=(ScriptMethod, DisplayName="Apply Mesh Bevel Region Selection"))  
static static UPARAM  
(  
    DisplayName  
)

Parameters

Name Remarks
Selection specifies which mesh edges to Bevel
BevelMode specifies whether Selection should be optionally converted to a Triangle Region or set of PolyGroup Edges
BevelOptions settings for the Bevel Operation

UPARAM(DisplayName)

Description

Apply a Mesh Bevel operation to all PolyGroup Edges.

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

UPARAM(DisplayName)

Description

These are versions/variants of the above functions that were released in previous UE 5.x versions, that have since been updated. To avoid breaking user scripts, these previous versions are currently kept and called via redirectors registered in GeometryScriptingCoreModule.cpp.

These functions may be deprecated in future UE releases.

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page