1. Epic GamesDeveloper
  3. UGeometryScriptLibrary_MeshSpatial

UGeometryScriptLibrary_MeshSpatial

API > API/Plugins > API/Plugins/GeometryScriptingCore

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

Syntax

UCLASS (MinimalAPI, Meta=(ScriptName="GeometryScript_MeshSpatial"))  
class UGeometryScriptLibrary_MeshSpatial : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bIsInside FVectorFGeometryScriptSpatialQueryOptions bool &   GeometryScript/MeshSpatialFunctions.h  
bIsValid bool &   GeometryScript/MeshSpatialFunctions.h  
bOnlyIfInvalid bool   GeometryScript/MeshSpatialFunctions.h  
Debug FGeometryScriptDynamicMeshBVHUGeometryScriptDebug *   GeometryScript/MeshSpatialFunctions.h  
Debug bool UGeometryScriptDebug *   GeometryScript/MeshSpatialFunctions.h  
Debug FBoxFGeometryScriptSpatialQueryOptionsFGeometryScriptMeshSelectionEGeometryScriptMeshSelectionTypeUGeometryScriptDebug *   GeometryScript/MeshSpatialFunctions.h  
Debug FVectorFVectorFGeometryScriptSpatialQueryOptionsFGeometryScriptRayHitResultEGeometryScriptSearchOutcomePinsUGeometryScriptDebug *   GeometryScript/MeshSpatialFunctions.h  
Debug FVectorFGeometryScriptSpatialQueryOptionsFGeometryScriptTrianglePointEGeometryScriptSearchOutcomePinsUGeometryScriptDebug *   GeometryScript/MeshSpatialFunctions.h  
Debug FVectorFGeometryScriptSpatialQueryOptions bool EGeometryScriptContainmentOutcomePinsUGeometryScriptDebug *   GeometryScript/MeshSpatialFunctions.h  
HitResult FVectorFVectorFGeometryScriptSpatialQueryOptionsFGeometryScriptRayHitResult &   GeometryScript/MeshSpatialFunctions.h  
NearestResult FVectorFGeometryScriptSpatialQueryOptionsFGeometryScriptTrianglePoint &   GeometryScript/MeshSpatialFunctions.h  
Options FVectorFVectorFGeometryScriptSpatialQueryOptions   GeometryScript/MeshSpatialFunctions.h  
Options FVectorFGeometryScriptSpatialQueryOptions   GeometryScript/MeshSpatialFunctions.h  
Options FBoxFGeometryScriptSpatialQueryOptions   GeometryScript/MeshSpatialFunctions.h  
Outcome FVectorFGeometryScriptSpatialQueryOptions bool EGeometryScriptContainmentOutcomePins &   GeometryScript/MeshSpatialFunctions.h  
Outcome FVectorFVectorFGeometryScriptSpatialQueryOptionsFGeometryScriptRayHitResultEGeometryScriptSearchOutcomePins &   GeometryScript/MeshSpatialFunctions.h  
Outcome FVectorFGeometryScriptSpatialQueryOptionsFGeometryScriptTrianglePointEGeometryScriptSearchOutcomePins &   GeometryScript/MeshSpatialFunctions.h  
OutputBVH FGeometryScriptDynamicMeshBVH &   GeometryScript/MeshSpatialFunctions.h  
QueryBox FBox   GeometryScript/MeshSpatialFunctions.h  
QueryPoint FVector   GeometryScript/MeshSpatialFunctions.h  
RayDirection FVectorFVector   GeometryScript/MeshSpatialFunctions.h  
RayOrigin FVector   GeometryScript/MeshSpatialFunctions.h  
Selection FBoxFGeometryScriptSpatialQueryOptionsFGeometryScriptMeshSelection &   GeometryScript/MeshSpatialFunctions.h  
SelectionType FBoxFGeometryScriptSpatialQueryOptionsFGeometryScriptMeshSelectionEGeometryScriptMeshSelectionType   GeometryScript/MeshSpatialFunctions.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

static UPARAM ( ref
) const

   GeometryScript/MeshSpatialFunctions.h  

static UPARAM ( ref
)

   GeometryScript/MeshSpatialFunctions.h  

static UPARAM ( ref
) const

   GeometryScript/MeshSpatialFunctions.h  

static UPARAM ( ref
) const

   GeometryScript/MeshSpatialFunctions.h  

static UPARAM ( ref
) const

   GeometryScript/MeshSpatialFunctions.h  

static UPARAM ( ref
) const

   GeometryScript/MeshSpatialFunctions.h  
  GeometryScript/MeshSpatialFunctions.h  

Static

Name Remarks Include Path Unreal Specifiers

static void ResetBVH ( UPARAM(ref) FGeometryScriptDynamicMeshBVH& ResetBVH
)

 Reset the Bounding Volume Hierarchy (BVH) by clearing all the internal data. GeometryScript/MeshSpatialFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Spatial"
  • Meta=(ScriptMethod)

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
  • BlueprintCallable
  • Category="GeometryScript|Spatial"
  • Meta=(ScriptMethod, DisplayName="Build BVH For Mesh")

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
  • BlueprintCallable
  • Category="GeometryScript|Spatial"
  • Meta=(ScriptMethod, DisplayName="Is BVH Valid For Mesh")

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
  • BlueprintCallable
  • Category="GeometryScript|Spatial"
  • Meta=(ScriptMethod, DisplayName="Rebuild BVH For Mesh")

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
  • BlueprintCallable
  • Category="GeometryScript|Spatial"
  • Meta=(ScriptMethod, ExpandEnumAsExecs="Outcome")

static static UPARAM ( DisplayName
)

 Finds the nearest intersection of a 3D ray with the mesh by using the Query BVH. GeometryScript/MeshSpatialFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Spatial"
  • Meta=(ScriptMethod, ExpandEnumAsExecs="Outcome")

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
  • BlueprintCallable
  • Category="GeometryScript|Spatial"
  • Meta=(ScriptMethod, ExpandEnumAsExecs="Outcome")

static static UPARAM ( DisplayName
)

 Create Mesh Selection of mesh elements in TargetMesh contained by QueryBox, using QueryBVH to accellerate the computation. GeometryScript/MeshSpatialFunctions.h
  • BlueprintCallable
  • Category="GeometryScript|Spatial"
  • Meta=(ScriptMethod, AdvancedDisplay="MinNumTrianglePoints")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page