#include <Spline.h>

Inherits AZ::Spline.

Public Member Functions
	LinearSpline (const LinearSpline &spline)

	LinearSpline (const Spline &spline)

RaySplineQueryResult	GetNearestAddressRay (const Vector3 &localRaySrc, const Vector3 &localRayDir) const override

PositionSplineQueryResult	GetNearestAddressPosition (const Vector3 &localPos) const override

SplineAddress	GetAddressByDistance (float distance) const override

SplineAddress	GetAddressByFraction (float fraction) const override

Vector3	GetPosition (const SplineAddress &splineAddress) const override

Vector3	GetNormal (const SplineAddress &splineAddress) const override

Vector3	GetTangent (const SplineAddress &splineAddress) const override

float	GetLength (const SplineAddress &splineAddress) const override

float	GetSplineLength () const override

float	GetSegmentLength (size_t index) const override

size_t	GetSegmentCount () const override

void	GetAabb (Aabb &aabb, const Transform &transform=Transform::CreateIdentity()) const override

LinearSpline &	operator= (const LinearSpline &spline)=default

LinearSpline &	operator= (const Spline &spline)

Public Member Functions inherited from AZ::Spline
	Spline (const Spline &spline)

void	SetClosed (bool closed)

bool	IsClosed () const

size_t	GetVertexCount () const

const AZStd::vector< Vector3 > &	GetVertices () const

const Vector3 &	GetVertex (size_t index) const

void	SetCallbacks (const VoidFunction &onChangeElement, const VoidFunction &onChangeContainer, const BoolFunction &onOpenClose)

void	SetCallbacks (const IndexFunction &onAddVertex, const IndexFunction &onRemoveVertex, const IndexFunction &onUpdateVertex, const VoidFunction &onSetVertices, const VoidFunction &onClearVertices, const BoolFunction &onOpenClose)

virtual void	OnSplineChanged ()

Static Public Member Functions
static void	Reflect (SerializeContext &context)

Static Public Member Functions inherited from AZ::Spline
static void	Reflect (SerializeContext &context)

Protected Member Functions
u16	GetSegmentGranularity () const override

Protected Member Functions inherited from AZ::Spline
virtual void	OnVertexAdded (size_t index)
	Internal function to be overridden by derived spline spline to handle custom logic when a vertex is added.

virtual void	OnVerticesSet ()
	Internal function to be overridden by derived spline spline to handle custom logic when all vertices are set.

virtual void	OnVertexRemoved (size_t index)
	Internal function to be overridden by derived spline to handle custom logic when a vertex is removed.

virtual void	OnVerticesCleared ()
	Internal function to be overridden by derived spline to handle custom logic when spline is reset (vertices are cleared).

Additional Inherited Members
Public Attributes inherited from AZ::Spline
VertexContainer< Vector3 >	m_vertexContainer
	Vertices representing the spline.

Protected Attributes inherited from AZ::Spline
bool	m_closed = false
	Is the spline closed - default is not.

Static Protected Attributes inherited from AZ::Spline
static const float	s_splineEpsilon
	Epsilon value for splines to use to check approximate results.

Detailed Description

Linear spline implementation

Member Function Documentation

◆ GetAabb()

void AZ::LinearSpline::GetAabb	(	Aabb &	aabb,
		const Transform &	transform = `Transform::CreateIdentity()`
	)		const

overridevirtual

Gets the Aabb of the vertices in the spline.

Parameters

aabb	out param of filled aabb.

Implements AZ::Spline.

◆ GetAddressByDistance()

SplineAddress AZ::LinearSpline::GetAddressByDistance ( float distance ) const

overridevirtual

Return address at distance value - range [0, splineLength].

Parameters

distance Distance along the spline.

Returns: SplineAddress corresponding to distance.

Implements AZ::Spline.

◆ GetAddressByFraction()

SplineAddress AZ::LinearSpline::GetAddressByFraction ( float fraction ) const

overridevirtual

Return address at fractional value - range [0, 1].

Parameters

fraction fraction/proportion/percentage along the spline.

Returns: SplineAddress corresponding to fraction.

Implements AZ::Spline.

◆ GetLength()

float AZ::LinearSpline::GetLength ( const SplineAddress & splineAddress ) const

overridevirtual

Returns spline length from the beginning to the specific point.

Parameters

splineAddress Address of the point to get the distance to.

Returns: Distance to the address specified along the spline

Implements AZ::Spline.

◆ GetNearestAddressPosition()

PositionSplineQueryResult AZ::LinearSpline::GetNearestAddressPosition ( const Vector3 & localPos ) const

overridevirtual

Return nearest address on spline from position (local space).

Parameters

localPos Position in local space of spline (must be transformed prior to being passed).

Returns: SplineAddress closest to given position on spline.

Implements AZ::Spline.

◆ GetNearestAddressRay()

RaySplineQueryResult AZ::LinearSpline::GetNearestAddressRay	(	const Vector3 &	localRaySrc,
		const Vector3 &	localRayDir
	)		const

overridevirtual

Return nearest address on spline from ray (local space).

Parameters

localRaySrc	Position of ray in local space of spline (must be transformed prior to being passed).
localRayDir	Direction of ray in local space of spline (must be transformed prior to being passed).

Returns: SplineAddress closest to given ray on spline.

Implements AZ::Spline.

◆ GetNormal()

Vector3 AZ::LinearSpline::GetNormal ( const SplineAddress & splineAddress ) const

overridevirtual

Return normal at SplineAddress (local space).

Parameters

splineAddress Address representing a point on the spline.

Returns: Normal of given SplineAddress in local space.

Implements AZ::Spline.

◆ GetPosition()

Vector3 AZ::LinearSpline::GetPosition ( const SplineAddress & splineAddress ) const

overridevirtual

Return position at SplineAddress (local space).

Parameters

splineAddress Address representing a point on the spline.

Returns: Position of given SplineAddress in local space.

Implements AZ::Spline.

◆ GetSegmentCount()

size_t AZ::LinearSpline::GetSegmentCount ( ) const

overridevirtual

Return number of Segments along spline. Explicitly returns the number of valid/real segments in the spline Some splines technically have invalid segments (example: that lie in the range [0 - 1] and [vertexCount - 2, vertexCount -1] - these will be ignored in the segment count calculation).

Implements AZ::Spline.

◆ GetSegmentGranularity()

u16 AZ::LinearSpline::GetSegmentGranularity ( ) const

inlineoverrideprotectedvirtual

Return the number of parts (lines) that make up a segment (higher granularity - smoother curve).

Implements AZ::Spline.

◆ GetSegmentLength()

float AZ::LinearSpline::GetSegmentLength ( size_t index ) const

overridevirtual

Returns length the segment between vertices - [index, index + 1].

Implements AZ::Spline.

◆ GetSplineLength()

float AZ::LinearSpline::GetSplineLength ( ) const

overridevirtual

Returns total length of spline.

Implements AZ::Spline.

◆ GetTangent()

Vector3 AZ::LinearSpline::GetTangent ( const SplineAddress & splineAddress ) const

overridevirtual

Return tangent at SplineAddress (local space).

Parameters

splineAddress Address representing a point on the spline.

Returns: Tangent of given SplineAddress in local space.

Implements AZ::Spline.

The documentation for this class was generated from the following file:

Code/Framework/AzCore/AzCore/Math/Spline.h

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetAabb()

◆ GetAddressByDistance()

◆ GetAddressByFraction()

◆ GetLength()

◆ GetNearestAddressPosition()

◆ GetNearestAddressRay()

◆ GetNormal()

◆ GetPosition()

◆ GetSegmentCount()

◆ GetSegmentGranularity()

◆ GetSegmentLength()

◆ GetSplineLength()

◆ GetTangent()