1. Epic GamesDeveloper
  3. UGeometryScriptLibrary_BoxFunctions

UGeometryScriptLibrary_BoxFunctions

API > API/Plugins > API/Plugins/GeometryScriptingCore

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

Syntax

UCLASS (MinimalAPI, Meta=(ScriptName="GeometryScript_Box"))  
class UGeometryScriptLibrary_BoxFunctions : public UBlueprintFunctionLibrary

Inheritance Hierarchy

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bConsiderOnBoxAsInside FVector bool   GeometryScript/ShapeFunctions.h  
bIsInside FVector bool &   GeometryScript/ShapeFunctions.h  
bIsIntersecting FBox bool &   GeometryScript/ShapeFunctions.h  
Box2 FBox   GeometryScript/ShapeFunctions.h  
CornerIndex int   GeometryScript/ShapeFunctions.h  
Dimensions FVector   GeometryScript/ShapeFunctions.h  
ExpandBy FVector   GeometryScript/ShapeFunctions.h  
Extents FVector   GeometryScript/ShapeFunctions.h  
FaceIndex int   GeometryScript/ShapeFunctions.h  
FaceNormal int FVector &   GeometryScript/ShapeFunctions.h  
Point FVector   GeometryScript/ShapeFunctions.h  
SphereCenter FVector   GeometryScript/ShapeFunctions.h  
SphereRadius FVector double   GeometryScript/ShapeFunctions.h  
Transform FTransform   GeometryScript/ShapeFunctions.h  

Functions

Static

Name Remarks Include Path Unreal Specifiers

static void GetBoxCenterSize ( FBox Box,
FVector& Center,
FVector& Dimensions
)

 Get the Center point and X/Y/Z Dimensions of a Box (full dimensions, not Extents) GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Box"
  • Meta=(ScriptMethod)

static void GetBoxVolumeArea ( FBox Box,
double& Volume,
double& SurfaceArea
)

 Get the Volume and Surface Area of a Box GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Box"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Create a Box from a Center point and X/Y/Z Dimensions (not Extents, which are half-dimensions) GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Box"

static static UPARAM ( DisplayName
)

 Create a Box from a Center point and X/Y/Z Extents (Extents are half-dimensions) GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Box"

static static UPARAM ( DisplayName
)

 Get the position of a corner of the Box. GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Box"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Get the position of the center of a face of the Box. GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Box"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Get the input Box expanded by adding the ExpandBy parameter to both the Min and Max. GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Box"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Apply the input Transform to the corners of the input Box, and return the new Box containing those points GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Box"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Test if Box1 and Box2 intersect GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Box"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Find the Box formed by the intersection of Box1 and Box2 GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Box"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Calculate the minimum distance between Box1 and Box2 GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Box"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Test if a Point is inside the Box, returning true if so, otherwise false GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Box"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Find the point on the faces of the Box that is closest to the input Point. GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Box"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Calculate the minimum distance between the Box and the Point GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Box"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Check if the Box intersects a Sphere defined by the SphereCenter and SphereRadius GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Box"
  • Meta=(ScriptMethod)

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page