1. Epic GamesDeveloper
  3. UPARAM

UPARAM

Function Overloads

API > API/Plugins > API/Plugins/GeometryScriptingCore > API/Plugins/GeometryScriptingCore/UGeometryScriptLibrary_BoxFuncti-

Overloads

Name Remarks Include Path Unreal Specifiers

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)

UPARAM(DisplayName)

Description

Create a Box from a Center point and X/Y/Z Dimensions (not Extents, which are half-dimensions)

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/ShapeFunctions.h
Include Path #include "GeometryScript/ShapeFunctions.h" 
UFUNCTION (BlueprintPure, Category="GeometryScript|Shapes|Box")  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Create a Box from a Center point and X/Y/Z Extents (Extents are half-dimensions)

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/ShapeFunctions.h
Include Path #include "GeometryScript/ShapeFunctions.h" 
UFUNCTION (BlueprintPure, Category="GeometryScript|Shapes|Box")  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Get the position of a corner of the Box. Corners are indexed from 0 to 7, using an ordering where 0 is the Min corner, 1/2/3 are +Z/+Y/+X from the Min corner, 7 is the Max corner, and 4/5/6 are -Z/-Y/-X from the Max corner.

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

UPARAM(DisplayName)

Description

Get the position of the center of a face of the Box. Faces are indexed from 0 to 5, using an ordering where 0/1 are the MinZ/MaxZ faces, 2/3 are MinY/MaxY, and 4/5 are MinX/MaxX

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

Parameters

Name Remarks
FaceNormal returned Normal vector of the identified face

UPARAM(DisplayName)

Description

Get the input Box expanded by adding the ExpandBy parameter to both the Min and Max. Dimensions will be clamped to the center point if any of ExpandBy are larger than half the box size

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

UPARAM(DisplayName)

Description

Apply the input Transform to the corners of the input Box, and return the new Box containing those points

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

UPARAM(DisplayName)

Description

Test if Box1 and Box2 intersect

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

UPARAM(DisplayName)

Description

Find the Box formed by the intersection of Box1 and Box2

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

Parameters

Name Remarks
bIsIntersecting if the boxes do not intersect, this will be returned as false, otherwise true

UPARAM(DisplayName)

Description

Calculate the minimum distance between Box1 and Box2

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

UPARAM(DisplayName)

Description

Test if a Point is inside the Box, returning true if so, otherwise false

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

Parameters

Name Remarks
bConsiderOnBoxAsInside if true, a point lying on the box face is considered "inside", otherwise it is considered "outside"

UPARAM(DisplayName)

Description

Find the point on the faces of the Box that is closest to the input Point. If the Point is inside the Box, it is returned, ie points Inside do not project to the Box Faces

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

Parameters

Name Remarks
bIsInside if the Point is inside the Box, this will return as true, otherwise false

UPARAM(DisplayName)

Description

Calculate the minimum distance between the Box and the Point

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

UPARAM(DisplayName)

Description

Check if the Box intersects a Sphere defined by the SphereCenter and SphereRadius

   
Name UPARAM
Type function
Header File /Engine/Plugins/Runtime/GeometryScripting/Source/GeometryScriptingCore/Public/GeometryScript/ShapeFunctions.h
Include Path #include "GeometryScript/ShapeFunctions.h" 
UFUNCTION (BlueprintPure, Category="GeometryScript|Shapes|Box", 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