1. Epic GamesDeveloper
  3. UPARAM

UPARAM

Function Overloads

API > API/Plugins > API/Plugins/GeometryScriptingCore > API/Plugins/GeometryScriptingCore/UGeometryScriptLibrary_MeshBasic-

Overloads

Name Remarks Include Path Unreal Specifiers

static static UPARAM ( DisplayName
)

   GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

   GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Set all vertex positions in the TargetMesh to the specified Positions. GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Adds a new vertex to the mesh and returns a new Vertex ID (NewVertexIndex). GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Adds a list of vertices to the mesh, and populates the NewIndicesList with the corresponding new Vertex IDs. GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Removes a vertex from the mesh as indicated by the VertexID. GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Removes a list of vertices from the mesh. GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Adds a triangle (Vertex ID triplet) to the mesh and updates New Triangle Index with the resulting Triangle ID. GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Adds a list of triangles to the mesh and populates the New Indices List with the corresponding new Triangle IDs. GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Removes a triangle from the mesh as indicated by the Triangle ID. GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Removes a list of triangles from the mesh. GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Removes specified triangles, identified by mesh selection, from the mesh. GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Attempt to merge together two vertices, and report whether they were merged. GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Attempt to merge together vertices in one selection to their closest vertices in the second selection, within a distance threshold. GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Apply Append Transform to Append Mesh and then add its geometry to the Target Mesh. GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Apply Append Transform to Append Mesh and then add its geometry to the Target Mesh. GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 For each transform in AppendTransforms, apply the transform to AppendMesh and then add its geometry to the TargetMesh. GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 For each transform in AppendTransforms, apply the transform to AppendMesh and then add its geometry to the TargetMesh. GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Repeatedly apply AppendTransform to the AppendMesh, each time adding the geometry to TargetMesh. GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Repeatedly apply AppendTransform to the AppendMesh, each time adding the geometry to TargetMesh. GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Adds a set of vertices/triangles to the mesh, with Normals, UVs, and Colors; returning the new triangles indices GeometryScript/MeshBasicEditFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|MeshEdits"
  • Meta=(ScriptMethod)

static UPARAM ( DisplayName
)

   GeometryScript/MeshBasicEditFunctions.h  

UPARAM(DisplayName)

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

UPARAM(DisplayName)

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

UPARAM(DisplayName)

Description

Set all vertex positions in the TargetMesh to the specified Positions.

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

Parameters

Name Remarks
PositionList new vertex Positions. Size must be less than or equal to the MaxVertexID of TargetMesh (ie gaps are supported).

UPARAM(DisplayName)

Description

Adds a new vertex to the mesh and returns a new Vertex ID (NewVertexIndex).

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

UPARAM(DisplayName)

Description

Adds a list of vertices to the mesh, and populates the NewIndicesList with the corresponding new Vertex IDs.

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

UPARAM(DisplayName)

Description

Removes a vertex from the mesh as indicated by the VertexID. Should the delete fail, e.g. if the specified vertex was not a mesh element, the flag bWasVertexDeleted will be set to false.

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

UPARAM(DisplayName)

Description

Removes a list of vertices from the mesh. On return, NumDeleted will contain the actual number of vertices removed.

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

UPARAM(DisplayName)

Description

Adds a triangle (Vertex ID triplet) to the mesh and updates New Triangle Index with the resulting Triangle ID.

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

UPARAM(DisplayName)

Description

Adds a list of triangles to the mesh and populates the New Indices List with the corresponding new Triangle IDs.

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

UPARAM(DisplayName)

Description

Removes a triangle from the mesh as indicated by the Triangle ID. Should the delete fail, e.g. if the specified triangle was not a mesh element, the flag bWasTriangleDelete will be set to false.

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

UPARAM(DisplayName)

Description

Removes a list of triangles from the mesh. On return, NumDeleted will contain the actual number of triangles removed.

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

UPARAM(DisplayName)

Description

Removes specified triangles, identified by mesh selection, from the mesh. On return, NumDeleted will contain the actual number of triangles removed.

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

UPARAM(DisplayName)

Description

Attempt to merge together two vertices, and report whether they were merged. Note that some merges may be prevented because they would create non-manifold edges in the mesh, which are not supported.

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

Parameters

Name Remarks
TargetMesh Mesh in which to merge vertices
VertexKeep Vertex to keep after merge
VertexDiscard Vertex to discard after merge
Options Options for merge, controlling which merges should be permitted
bSuccess Flag indicating whether the merge succeeded
InterpParam The kept vertex is moved to interpolated position Lerp(VertexKeep Position, VertexDiscard Position, InterpParam)
bDeferChangeNotifications Whether to defer change notifications after this operation

UPARAM(DisplayName)

Description

Attempt to merge together vertices in one selection to their closest vertices in the second selection, within a distance threshold. Note that some merges may be prevented because they would create non-manifold edges in the mesh, which are not supported.

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

Parameters

Name Remarks
TargetMesh Mesh in which to merge vertices
SelectionKeep Selection of vertices to be merged with SelectionDiscard, treated as 'kept' vertices for purposes of interpolation.
SelectionDiscard Selection of vertices to be merged with SelectionKeep. Note: If a vertex is in both selections, it will be treated as if it were only in SelectionKeep.
Options Options for merge, controlling which merges should be permitted
NumMerged Number of vertices merged
InterpParam The kept vertex is moved to interpolated position Lerp(VertexKeep Position, VertexDiscard Position, InterpParam)
DistanceThreshold Vertices further apart than this threshold will not be merged
bDeferChangeNotifications Whether to defer change notifications after this operation

UPARAM(DisplayName)

Description

Apply Append Transform to Append Mesh and then add its geometry to the Target Mesh.

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

Parameters

Name Remarks
AppendOptions Control how details like mesh attributes are handled when one mesh is appended to another.

UPARAM(DisplayName)

Description

Apply Append Transform to Append Mesh and then add its geometry to the Target Mesh. Also combines materials lists of the Target and Append meshes, and updates the output mesh materials to reference the combined list.

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

Parameters

Name Remarks
AppendOptions Control how details like mesh attributes are handled when one mesh is appended to another.

UPARAM(DisplayName)

Description

For each transform in AppendTransforms, apply the transform to AppendMesh and then add its geometry to the TargetMesh.

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

Parameters

Name Remarks
ConstantTransform the Constant transform will be applied after each Append transform
bConstantTransformIsRelative if true, the Constant transform is applied "in the frame" of the Append Transform, otherwise it is applied as a second transform in local coordinates (ie rotate around the AppendTransform X axis, vs around the local X axis)
AppendOptions Control how details like mesh attributes are handled when one mesh is appended to another

UPARAM(DisplayName)

Description

For each transform in AppendTransforms, apply the transform to AppendMesh and then add its geometry to the TargetMesh. Also combines materials lists of the Target and Append meshes, and updates the output mesh materials to reference the combined list.

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

Parameters

Name Remarks
ConstantTransform the Constant transform will be applied after each Append transform
bConstantTransformIsRelative if true, the Constant transform is applied "in the frame" of the Append Transform, otherwise it is applied as a second transform in local coordinates (ie rotate around the AppendTransform X axis, vs around the local X axis)
AppendOptions Control how details like mesh attributes are handled when one mesh is appended to another

UPARAM(DisplayName)

Description

Repeatedly apply AppendTransform to the AppendMesh, each time adding the geometry to TargetMesh.

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

Parameters

Name Remarks
RepeatCount number of times to repeat the transform-append cycle
bApplyTransformToFirstInstance if true, the AppendTransform is applied before the first mesh append, otherwise it is applied after
AppendOptions Control how details like mesh attributes are handled when one mesh is appended to another

UPARAM(DisplayName)

Description

Repeatedly apply AppendTransform to the AppendMesh, each time adding the geometry to TargetMesh. Also combines materials lists of the Target and Append meshes, and updates the output mesh materials to reference the combined list.

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

Parameters

Name Remarks
RepeatCount number of times to repeat the transform-append cycle
bApplyTransformToFirstInstance if true, the AppendTransform is applied before the first mesh append, otherwise it is applied after
AppendOptions Control how details like mesh attributes are handled when one mesh is appended to another

UPARAM(DisplayName)

Description

Adds a set of vertices/triangles to the mesh, with Normals, UVs, and Colors; returning the new triangles indices

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

UPARAM(DisplayName)

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshBasicEditFunctions.h
Include Path #include "GeometryScript/MeshBasicEditFunctions.h" 
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