Spline Helpers

Mon, 01 Jan 0001 00:00:00 +0000

The SplineUtility namespace (GS_Core::SplineUtility) provides free functions for querying the closest point on an O3DE spline component attached to an entity. All functions take an entity ID and a position in world or local space.

Used by: PathTo_DialoguePerformance (gs_cinematics), any system that guides an entity along a spline path.

For usage guides and setup examples, see The Basics: GS_Core.

API Reference
Usage Example
See Also

API Reference

Function	Parameters	Description
`FindClosestWorldPoint`	`AZ::EntityId entityId`, `AZ::Vector3 worldPos`	Returns the closest world-space point on the spline attached to `entityId`
`FindClosestLocalPoint`	`AZ::EntityId entityId`, `AZ::Vector3 localPos`	Returns the closest point in local spline space
`FindClosestFraction`	`AZ::EntityId entityId`, `AZ::Vector3 worldPos`	Returns the normalized [0, 1] fraction along the spline of the closest point to `worldPos`

Usage Example

#include <GS_Core/Utility/SplineUtility.h>

// Find how far along a path the player is (0 = start, 1 = end)
AZ::Vector3 playerPos = GetPlayerWorldPosition();
float fraction = GS_Core::SplineUtility::FindClosestFraction(splineEntityId, playerPos);

// Get the actual closest world position on the path
AZ::Vector3 closestPoint = GS_Core::SplineUtility::FindClosestWorldPoint(splineEntityId, playerPos);

Spline on GS_Play Gameplay Framework

Spline Helpers

Contents

API Reference

Usage Example

See Also