1. Epic GamesDeveloper
  3. UPARAM

UPARAM

Function Overloads

API > API/Plugins > API/Plugins/GeometryScriptingCore > API/Plugins/GeometryScriptingCore/UGeometryScriptLibrary_RayFuncti-

Overloads

Name Remarks Include Path Unreal Specifiers

static static UPARAM ( DisplayName
)

 Create a Ray from two points, placing the Origin at A and the Direction as Normalize(B-A) GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Ray"

static static UPARAM ( DisplayName
)

 Create a Ray from an Origin and Direction, with optionally non-normalized Direction GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Ray"

static static UPARAM ( DisplayName
)

 Apply the given Transform to the given Ray, or optionally the Transform Inverse, and return the new transformed Ray GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Ray"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Get a Point at the given Distance along the Ray (Origin + Distance*Direction) GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Ray"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Project the given Point onto the closest point along the Ray, and return the Ray Parameter/Distance at that Point GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Ray"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Get the distance from Point to the closest point on the Ray GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Ray"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Get the closest point on the Ray to the given Point GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Ray"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

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

static static UPARAM ( DisplayName
)

 Find the intersection of a Ray and a Box GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Ray"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Find the intersection of a Ray and a Plane GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Ray"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Compute the pair of closest points on a 3D Ray and Line. GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Ray"
  • Meta=(ScriptMethod)

static static UPARAM ( DisplayName
)

 Compute the pair of closest points on a 3D Ray and Line Segment The Line Segment is defined by its two Endpoints. GeometryScript/ShapeFunctions.h
  • BlueprintPure
  • Category="GeometryScript|Shapes|Ray"
  • Meta=(ScriptMethod)

UPARAM(DisplayName)

Description

Create a Ray from two points, placing the Origin at A and the Direction as Normalize(B-A)

   
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|Ray")  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Create a Ray from an Origin and Direction, with optionally non-normalized Direction

   
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|Ray")  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Apply the given Transform to the given Ray, or optionally the Transform Inverse, and return the new transformed Ray

   
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|Ray", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Get a Point at the given Distance along the Ray (Origin + Distance*Direction)

   
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|Ray", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Project the given Point onto the closest point along the Ray, and return the Ray Parameter/Distance at that 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|Ray", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Get the distance from Point to the closest point on the Ray

   
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|Ray", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Get the closest point on the Ray to the given 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|Ray", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

UPARAM(DisplayName)

Description

Check if the Ray intersects a Sphere defined by the SphereCenter and SphereRadius. This function returns two intersection distances (ray parameters). If the ray grazes the sphere, both distances will be the same, and if it misses, they will be MAX_FLOAT. Use the function GetRayPoint to convert the distances to points on the ray/sphere.

   
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|Ray", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

true if ray intersects sphere

Parameters

Name Remarks
Distance1 Distance along ray (Ray Parameter) to first/closer intersection point with sphere
Distance2 Distance along ray (Ray Parameter) to second/further intersection point with sphere

UPARAM(DisplayName)

Description

Find the intersection of a Ray and a Box

   
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|Ray", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

true if the ray hits the box, and false otherwise

Parameters

Name Remarks
HitDistance Distance along the ray (Ray Parameter) to first intersection point with the Box

UPARAM(DisplayName)

Description

Find the intersection of a Ray and a Plane

   
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|Ray", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

true if the ray hits the plane (only false if ray is parallel with plane)

Parameters

Name Remarks
HitDistance the returned Distance along the ray (Ray Parameter) to intersection point with the Plane

UPARAM(DisplayName)

Description

Compute the pair of closest points on a 3D Ray and Line. The Line is defined by an Origin and Direction (ie same as a Ray) but extends infinitely in both directions.

   
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|Ray", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

the minimum distance between the Ray and Line, ie between RayPoint and LinePoint

Parameters

Name Remarks
RayParameter the Ray Parameter of the closest point on the Ray (range 0, inf)
RayPoint the point on the Ray corresponding to RayParameter
LineParameter the Line parameter of the closest point on the Line (range -inf, inf)
LinePoint the point on the Line corresponding to LineParameter

UPARAM(DisplayName)

Description

Compute the pair of closest points on a 3D Ray and Line Segment The Line Segment is defined by its two Endpoints.

   
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|Ray", Meta=(ScriptMethod))  
static static UPARAM  
(  
    DisplayName  
)

the minimum distance between the Ray and Segment, ie between RayPoint and SegPoint

Parameters

Name Remarks
RayParameter the Ray Parameter of the closest point on the Ray (range 0, inf)
RayPoint the point on the Ray corresponding to RayParameter
SegPoint the point on the Segment

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page