Navigation
API > API/Plugins > API/Plugins/GeometryScriptingCore > API/Plugins/GeometryScriptingCore/UGeometryScriptLibrary_MeshSpati-
Overloads
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static static UPARAM
(
DisplayName |
Builds a Bounding Volume Hierarchy (BVH) object for a mesh that can be used with multiple spatial queries. | GeometryScript/MeshSpatialFunctions.h |
|
static static UPARAM
(
DisplayName |
Checks if the provided Bounding Volume Hierarchy (BVH) can still be used with the Mesh — it generally returns false if the mesh has been changed. | GeometryScript/MeshSpatialFunctions.h |
|
static static UPARAM
(
DisplayName |
Rebuilds the Bounding Volume Hierarchy (BVH) for the mesh in-place, which can reduce memory allocations, compared to building a new BVH. | GeometryScript/MeshSpatialFunctions.h |
|
static static UPARAM
(
DisplayName |
Finds the nearest point (Nearest Result) on the Target Mesh to a given 3D point (Query Point) by using the Query BVH. | GeometryScript/MeshSpatialFunctions.h |
|
static static UPARAM
(
DisplayName |
Finds the nearest intersection of a 3D ray with the mesh by using the Query BVH. | GeometryScript/MeshSpatialFunctions.h |
|
static static UPARAM
(
DisplayName |
Tests if a point is inside the mesh using the Fast Winding Number query and data stored in the BVH. | GeometryScript/MeshSpatialFunctions.h |
|
static static UPARAM
(
DisplayName |
Create Mesh Selection of mesh elements in TargetMesh contained by QueryBox, using QueryBVH to accellerate the computation. | GeometryScript/MeshSpatialFunctions.h |
|
static UPARAM
(
ref |
GeometryScript/MeshSpatialFunctions.h | ||
static UPARAM
(
ref |
GeometryScript/MeshSpatialFunctions.h | ||
static UPARAM
(
ref |
GeometryScript/MeshSpatialFunctions.h | ||
static UPARAM
(
ref |
GeometryScript/MeshSpatialFunctions.h | ||
static UPARAM
(
ref |
GeometryScript/MeshSpatialFunctions.h | ||
static UPARAM
(
ref |
GeometryScript/MeshSpatialFunctions.h | ||
| GeometryScript/MeshSpatialFunctions.h |
UPARAM(DisplayName)
Description
Builds a Bounding Volume Hierarchy (BVH) object for a mesh that can be used with multiple spatial queries.
| Name | UPARAM |
| Type | function |
| Header File | /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshSpatialFunctions.h |
| Include Path | #include "GeometryScript/MeshSpatialFunctions.h" |
UFUNCTION (BlueprintCallable, Category="GeometryScript|Spatial",
Meta=(ScriptMethod, DisplayName="Build BVH For Mesh"))
static static UPARAM
(
DisplayName
)
UPARAM(DisplayName)
Description
Checks if the provided Bounding Volume Hierarchy (BVH) can still be used with the Mesh — it generally returns false if the mesh has been changed.
| Name | UPARAM |
| Type | function |
| Header File | /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshSpatialFunctions.h |
| Include Path | #include "GeometryScript/MeshSpatialFunctions.h" |
UFUNCTION (BlueprintCallable, Category="GeometryScript|Spatial",
Meta=(ScriptMethod, DisplayName="Is BVH Valid For Mesh"))
static static UPARAM
(
DisplayName
)
UPARAM(DisplayName)
Description
Rebuilds the Bounding Volume Hierarchy (BVH) for the mesh in-place, which can reduce memory allocations, compared to building a new BVH.
| Name | UPARAM |
| Type | function |
| Header File | /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshSpatialFunctions.h |
| Include Path | #include "GeometryScript/MeshSpatialFunctions.h" |
UFUNCTION (BlueprintCallable, Category="GeometryScript|Spatial",
Meta=(ScriptMethod, DisplayName="Rebuild BVH For Mesh"))
static static UPARAM
(
DisplayName
)
UPARAM(DisplayName)
Description
Finds the nearest point (Nearest Result) on the Target Mesh to a given 3D point (Query Point) by using the Query BVH.
| Name | UPARAM |
| Type | function |
| Header File | /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshSpatialFunctions.h |
| Include Path | #include "GeometryScript/MeshSpatialFunctions.h" |
UFUNCTION (BlueprintCallable, Category="GeometryScript|Spatial",
Meta=(ScriptMethod, ExpandEnumAsExecs="Outcome"))
static static UPARAM
(
DisplayName
)
Parameters
| Name | Remarks |
|---|---|
| QueryBVH | a BVH associated with the Target Mesh |
| QueryPoint | a 3D location relative to the local space of the mesh |
| NearestResult | on return, holds the nearest point on the mesh to the QueryPoint |
| Outcome | will be either Found or Not Found depending on the success of the query. Note NearestResult.bValid will be false if the query failed. |
UPARAM(DisplayName)
Description
Finds the nearest intersection of a 3D ray with the mesh by using the Query BVH. Note, depending on the Ray Origin and Ray Direction, there is the possibility that the ray might not intersect with the Target Mesh. Should the ray miss, the HitResult.bHit will be false and the Outcome will be Not Found.
| Name | UPARAM |
| Type | function |
| Header File | /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshSpatialFunctions.h |
| Include Path | #include "GeometryScript/MeshSpatialFunctions.h" |
UFUNCTION (BlueprintCallable, Category="GeometryScript|Spatial",
Meta=(ScriptMethod, ExpandEnumAsExecs="Outcome"))
static static UPARAM
(
DisplayName
)
UPARAM(DisplayName)
Description
Tests if a point is inside the mesh using the Fast Winding Number query and data stored in the BVH.
| Name | UPARAM |
| Type | function |
| Header File | /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshSpatialFunctions.h |
| Include Path | #include "GeometryScript/MeshSpatialFunctions.h" |
UFUNCTION (BlueprintCallable, Category="GeometryScript|Spatial",
Meta=(ScriptMethod, ExpandEnumAsExecs="Outcome"))
static static UPARAM
(
DisplayName
)
Parameters
| Name | Remarks |
|---|---|
| QueryBVH | is an acceleration structure previously built with this mesh. |
| QueryPoint | the point in the mesh's 3D local space. |
| Options | control the fast winding number threshold |
UPARAM(DisplayName)
Description
Create Mesh Selection of mesh elements in TargetMesh contained by QueryBox, using QueryBVH to accellerate the computation. Triangles and Edges are selected if Min Element Vertices (clamped to a 1-3 or 1-2 range, for triangles or edges respectively) or more are inside the box. PolyGroups are selected if any of their triangles are inside the box
Note that this method cannot select mesh elements that cut through the query box without having any vertices in the query box.
| Name | UPARAM |
| Type | function |
| Header File | /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshSpatialFunctions.h |
| Include Path | #include "GeometryScript/MeshSpatialFunctions.h" |
UFUNCTION (BlueprintCallable, Category="GeometryScript|Spatial",
Meta=(ScriptMethod, AdvancedDisplay="MinNumTrianglePoints"))
static static UPARAM
(
DisplayName
)
Parameters
| Name | Remarks |
|---|---|
| QueryBVH | is an acceleration structure previously built with TargetMesh. |
| QueryPoint | the point in the mesh's 3D local space. |
| Options | control the fast winding number threshold |
UPARAM(ref)
| Name | UPARAM |
| Type | function |
| Header File | /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshSpatialFunctions.h |
| Include Path | #include "GeometryScript/MeshSpatialFunctions.h" |
static UPARAM
(
ref
) const
UPARAM(ref)
| Name | UPARAM |
| Type | function |
| Header File | /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshSpatialFunctions.h |
| Include Path | #include "GeometryScript/MeshSpatialFunctions.h" |
static UPARAM
(
ref
)
UPARAM(ref)
| Name | UPARAM |
| Type | function |
| Header File | /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshSpatialFunctions.h |
| Include Path | #include "GeometryScript/MeshSpatialFunctions.h" |
static UPARAM
(
ref
) const
UPARAM(ref)
| Name | UPARAM |
| Type | function |
| Header File | /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshSpatialFunctions.h |
| Include Path | #include "GeometryScript/MeshSpatialFunctions.h" |
static UPARAM
(
ref
) const
UPARAM(ref)
| Name | UPARAM |
| Type | function |
| Header File | /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshSpatialFunctions.h |
| Include Path | #include "GeometryScript/MeshSpatialFunctions.h" |
static UPARAM
(
ref
) const
UPARAM(ref)
| Name | UPARAM |
| Type | function |
| Header File | /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshSpatialFunctions.h |
| Include Path | #include "GeometryScript/MeshSpatialFunctions.h" |
static UPARAM
(
ref
) const
UPARAM(DisplayName)
| Name | UPARAM |
| Type | function |
| Header File | /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/MeshSpatialFunctions.h |
| Include Path | #include "GeometryScript/MeshSpatialFunctions.h" |
FBoxFGeometryScriptSpatialQueryOptions FGeometryScriptMeshSelection EGeometryScriptMeshSelectionType UPARAM
(
DisplayName
)