This is a wrapper that treats an IArcLengthCurve as a Unity Spline. Here we mimic all of the functionality of Unity Splines but using the ArcFrame IArcLengthCurve on the backend. We do this so that we can leverage ArcFrame tools such as curvature continuity, native bishop frame integration, curve constraint solving methods, and more. More...

Classes
struct	SegmentBuildState
	Keep track of previous segment states in case the user wants to add a custom curve spec. More...
struct	MutatorEntry
class	MutatorEntryComparer

Public Member Functions
bool	IsDrivenKnotPosition (int knotIndex)
	If true, the knot position and end frame is driven by a curve spec (k, t, dk, and dt) AKA this segement was EXTRAPOLATED and not INTERPOLATED.
bool	RegisterMutator (IPolylineMutator mutator, bool markDirty=true)
	Register a mutator. Returns true if it was added, false if it was already registered or null. Call from OnEnable of the consumer script, and Unregister in OnDisable.
bool	UnregisterMutator (IPolylineMutator mutator, bool markDirty=true)
	Unregister a mutator. Returns true if removed, false if not found or null.
void	EnsureBuilt ()
	Ensure we have a current built curve to reference.
delegate void	PolylineMutator (ref ChordErrorSampler.Polyline poly)
Vector3	EvaluatePosition (float t)
	Evaluate a position along the spline given parameter t in [0, 1].
TrackFlowSample[]	GetAutoSamples ()
	Get a number of evenly spaced samples along the curve based on the quality settings.
TrackFlowSample	Evaluate (float t)
	Evaluate a normalized arc length between 0 and 1.
void	BuildCurve (bool includeForcePreview=true)
void	PopulateForcePreviewSpeedProfileWithKnotKeyframes ()
List< int >	BuildTrackSampleIndex (ChordErrorSampler.Polyline poly)
	Build knotSampleIndex for whole-track modifiers. Each entry is the sample index where knot i starts. For closed tracks we also push a final 0 so the last segment is treated as going back to the start.
bool	TryGetInheritedCurveSpecStart (int knotIndex, out double inheritedK0, out double inheritedTau0)
	Get curvature and torsion values for driven knot endpoints.
void	CullSamples (ref ChordErrorSampler.Polyline sampledCurve, int cullSamples=1)
	Cull last few samples from a polyline, in case we want to ensure no duplicates exist at knot locations.
void	AddControlPoint ()
void	RemoveControlPointAt (int index)
void	SeverMesh ()
void	OnDestroy ()
Vector3	KnotLocalToWorld (Vector3 localPos)
Vector3	KnotWorldToLocal (Vector3 worldPos)
void	MarkDirty ()
void	RebuildNow (bool includeForcePreview=true)
	Force an immediate rebuild and clear the internal editor dirty flags. This avoids double-rebuilds when autoRebuildInEditor is enabled.

Public Attributes
ForceComputeSettings	forceComputeSettings = ForceComputeSettings.Default(5f)
ForcePreviewSettings	forcePreview = new()
int	SplineRebuildRequests = 0
bool	autoRebuildInEditor = true
	Auto rebuild using the rebuild interval in the editor.
float	autoRebuildInterval = 0.2f
float	Quality = 0.3f
	Quality of the sampling mechanism.
bool	Closed = false
	Close the curve.
bool	useSpline = true
	Use spline mode instead of segment mode.
SplineOptions	spline = new()
	Spline mode options.
TrackModifierOptions	trackModOptions = new()
	Track modifier options. This controls rotation minimizing frame generation, roll profiles, offsets and orientations, etc.
List< TrackFlowKnot >	ControlPoints = new()
	Track control points.

Package Functions
PolylineMutatorFlags	ApplyMutators (ref ChordErrorSampler.Polyline poly, in TrackContext trackCtx)
	Applies all registered external mutators to the given polyline (in-place). Returns combined flags that describe what changed / what caches should be rebuilt.
IArcLengthCurve	BuildSegment (int index, TrackFlowKnot sKnot, TrackFlowKnot eKnot, ref SegmentBuildState state, bool syncDrivenEndKnot=true)
	Build an ArcFrame segment between two TrackFlowKnot.

Properties
float	Length `[get]`
	Curve length.
Vector3[]	AutoPositions `[get]`
	A cached list of automatically generated spline positions built with GetAutoPositions(). For visualization in the editor.
ChordErrorSampler.Polyline	BasePolyline `[get]`
	The polyline with no external mutators applied.
ChordErrorSampler.Polyline	CurrentPolyline `[get]`
	The polyline with all applied mutators.
TrackContext	CurrentTrackContext `[get]`
bool	IsBuilt `[get]`
	Current curve is built and accurate.
bool	WantsHeavyPreview `[get]`
bool	IsDirty `[get]`
	Editor-only: indicates whether the spline has pending changes that haven't been rebuilt.

Events
EventHandler	OnSplineRebuilt
	Subscribable event for when the spline is rebuilt, this is called after:

Private Member Functions
Vector3[]	BuildPreviewPositionsFromPolyline ()
	Copy the polyline for previewing.
void	RefreshPreviewPositionsFromPolyline ()
TrackFlowSample[]	GetSamples (int numSamples)
Vector3[]	GetPositions (int numSamples)
void	EnsureSplineBuffers (int count)
void	ClearBuiltState (bool clearForcePreview=true)
void	ResolveCurveSpecConstructionFrame (TrackFlowKnot sKnot, CurveSpecOptions opts, out Vector3 T0, out Vector3 N0, out Vector3 B0)
	Figure out which plane to apply curvature to.
void	UpdateSegmentBuildState (IArcLengthCurve curve, ref SegmentBuildState state)
void	SyncDrivenEndKnotGeometry (TrackFlowKnot startKnot, TrackFlowKnot drivenKnot, IArcLengthCurve curve)
	Sync the geometry of an intrinsic curve knot to the knot object. Do this because we can't control all aspects of the end frame when using Intrinsic Curves (Curve Spec segments).
void	SyncDrivenEndKnotSolvedDisplayFrame (TrackFlowKnot drivenKnot, IArcLengthCurve curve)
	Sync the display frame of the driven end knot to the knot object.
void	OnValidate ()
void	Update ()
void	Start ()
void	RebuiltEvent ()
int	CatmullRomControlPoints (int knotCount, bool closed)
void	PrepareCatmullRomPoints3DFromKnots (IReadOnlyList< TrackFlowKnot > knots, bool closed, ref double[][] result)
int	BezierControlPoints (int knotCount, bool closed)
double[][]	PrepareBezierPoints3DFromKnots (IReadOnlyList< TrackFlowKnot > knots, bool closed, BezierOptions opts, ref double[][] result)
int	BSplineControlPoints (int knotCount, bool closed, int degree)
void	PrepareBSplinePoints3DFromKnots (IReadOnlyList< TrackFlowKnot > knots, bool closed, int degree, ref double[][] result)
	Prepare control points for a B-spline track. For open curves, we build a clamped control net by repeating endpoints "degree" times. For closed curves, we append the first "degree" control points at the end for a periodic spline.
int	HermiteControlPoints (int knotCount, bool closed)
void	PrepareHermitePoints3DFromKnots (IReadOnlyList< TrackFlowKnot > knots, bool closed, ref double[][] positions, ref double[][] tangents)
	Prepare position and tangent arrays for a Hermite spline using all control points. For closed tracks, we duplicate the first point and tangent at the end so the curve can loop.

Static Private Member Functions
static bool	AnimationCurveEquivalent (AnimationCurve a, AnimationCurve b)
static bool	ForceSettingsEquivalent (in ForceComputeSettings a, in ForceComputeSettings b)
static bool	CanReuseForceSamples (in ChordErrorSampler.Polyline prev, in ChordErrorSampler.Polyline curr, bool hasPrevSettings, in ForceComputeSettings prevSettings, in ForceComputeSettings currSettings)
static Quaternion	MinimalRotation (Vector3 fromT, Vector3 toT, Vector3 fallbackAxisHint)

Private Attributes
bool	_hasCachedForceSettings
ForceComputeSettings	_cachedForceSettings
double[][]	_splinePositions
	reusable buffers for spline control points. may be redundant
double[][]	_splineTangents
	reusable buffers for spline tangents.
bool	_dirty
int	_dirtyVersion
int	_lastBuiltVersion
float	_lastAutoRebuildTime
Vector3[]	_autoPositions = Array.Empty<Vector3>()
	A cached list of automatically generated spline positions built with GetAutoPositions(). For visualization in the editor.
readonly List< double >	_prefixes = new()
	Each index contains the value of the arc length up to that knot index along the curve.
readonly List< IArcLengthCurve >	_inners = new()
	This holds our internal generated curves.
List< SegmentContext >	currentSegmentContexts
TrackContext	currentTrackContext
ChordErrorSampler.Polyline	_finalPolyline
	polyline with internal frame modifications + external mutators
ChordErrorSampler.Polyline	_basePolyline
	polyline with internal frame modifications
readonly List< MutatorEntry >	_externalMutators = new(8)
int	_mutatorSequence
bool	_mutatorsNeedSort
bool	_isApplyingMutators
uint	_mutatorListVersion

Detailed Description

This is a wrapper that treats an IArcLengthCurve as a Unity Spline. Here we mimic all of the functionality of Unity Splines but using the ArcFrame IArcLengthCurve on the backend. We do this so that we can leverage ArcFrame tools such as curvature continuity, native bishop frame integration, curve constraint solving methods, and more.

Native Unity Splines only give you a BezierCurve between each knot,

in either linear, quadratic and cubic form, 3 choices. ArcFrame can give you Nth degree Bezier, as well as CatmullRom, B-Splines, Hermite Splines. ArcFrame does not just give you basis matrix splines either, it can give you any curve that can be described with a function in any dimension. For example ArcFrame can generate clothoids, aka Euler-spirals which are used extensively in real world road and track design. Now you can see why ArcFrame is a powerful tool compared to built in Splines. Since now you can design tracks with real world curvature aware banking adjustments, or drop a cube in the world and watch as the ArcFrameSpline automatically adjusts itself to avoid collision. <- can't do that yet but thats my goal

Member Function Documentation

◆ AddControlPoint()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.AddControlPoint ( )

◆ AnimationCurveEquivalent()

bool TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.AnimationCurveEquivalent	(	AnimationCurve	a,
		AnimationCurve	b )

staticprivate

◆ ApplyMutators()

PolylineMutatorFlags TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.ApplyMutators	(	ref ChordErrorSampler.Polyline	poly,
		in TrackContext	trackCtx )

package

Applies all registered external mutators to the given polyline (in-place). Returns combined flags that describe what changed / what caches should be rebuilt.

◆ BezierControlPoints()

int TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.BezierControlPoints	(	int	knotCount,
		bool	closed )

private

◆ BSplineControlPoints()

int TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.BSplineControlPoints	(	int	knotCount,
		bool	closed,
		int	degree )

private

◆ BuildCurve()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.BuildCurve ( bool includeForcePreview = true )

◆ BuildPreviewPositionsFromPolyline()

Vector3[] TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.BuildPreviewPositionsFromPolyline ( )

private

Copy the polyline for previewing.

Returns

◆ BuildSegment()

IArcLengthCurve TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.BuildSegment	(	int	index,
		TrackFlowKnot	sKnot,
		TrackFlowKnot	eKnot,
		ref SegmentBuildState	state,
		bool	syncDrivenEndKnot = true )

package

Build an ArcFrame segment between two TrackFlowKnot.

Parameters

sKnot
eKnot

◆ BuildTrackSampleIndex()

List< int > TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.BuildTrackSampleIndex ( ChordErrorSampler.Polyline poly )

Build knotSampleIndex for whole-track modifiers. Each entry is the sample index where knot i starts. For closed tracks we also push a final 0 so the last segment is treated as going back to the start.

Parameters

poly

Returns

◆ CanReuseForceSamples()

bool TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.CanReuseForceSamples	(	in ChordErrorSampler.Polyline	prev,
		in ChordErrorSampler.Polyline	curr,
		bool	hasPrevSettings,
		in ForceComputeSettings	prevSettings,
		in ForceComputeSettings	currSettings )

staticprivate

◆ CatmullRomControlPoints()

int TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.CatmullRomControlPoints	(	int	knotCount,
		bool	closed )

private

◆ ClearBuiltState()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.ClearBuiltState ( bool clearForcePreview = true )

private

◆ CullSamples()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.CullSamples	(	ref ChordErrorSampler.Polyline	sampledCurve,
		int	cullSamples = 1 )

Cull last few samples from a polyline, in case we want to ensure no duplicates exist at knot locations.

Parameters

sampledCurve

◆ EnsureBuilt()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.EnsureBuilt ( )

Ensure we have a current built curve to reference.

◆ EnsureSplineBuffers()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.EnsureSplineBuffers ( int count )

private

◆ Evaluate()

TrackFlowSample TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.Evaluate ( float t )

Evaluate a normalized arc length between 0 and 1.

Parameters

t

Returns

◆ EvaluatePosition()

Vector3 TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.EvaluatePosition ( float t )

Evaluate a position along the spline given parameter t in [0, 1].

Parameters

t	A float in [0, 1]

Returns

◆ ForceSettingsEquivalent()

bool TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.ForceSettingsEquivalent	(	in ForceComputeSettings	a,
		in ForceComputeSettings	b )

staticprivate

◆ GetAutoSamples()

TrackFlowSample[] TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.GetAutoSamples ( )

Get a number of evenly spaced samples along the curve based on the quality settings.

Returns

◆ GetPositions()

Vector3[] TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.GetPositions ( int numSamples )

private

◆ GetSamples()

TrackFlowSample[] TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.GetSamples ( int numSamples )

private

◆ HermiteControlPoints()

int TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.HermiteControlPoints	(	int	knotCount,
		bool	closed )

private

◆ IsDrivenKnotPosition()

bool TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.IsDrivenKnotPosition ( int knotIndex )

If true, the knot position and end frame is driven by a curve spec (k, t, dk, and dt) AKA this segement was EXTRAPOLATED and not INTERPOLATED.

Parameters

knotIndex

Returns

◆ KnotLocalToWorld()

Vector3 TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.KnotLocalToWorld ( Vector3 localPos )

◆ KnotWorldToLocal()

Vector3 TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.KnotWorldToLocal ( Vector3 worldPos )

◆ MarkDirty()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.MarkDirty ( )

◆ MinimalRotation()

Quaternion TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.MinimalRotation	(	Vector3	fromT,
		Vector3	toT,
		Vector3	fallbackAxisHint )

staticprivate

◆ OnDestroy()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.OnDestroy ( )

◆ OnValidate()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.OnValidate ( )

private

◆ PolylineMutator()

delegate void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.PolylineMutator ( ref ChordErrorSampler.Polyline poly )

◆ PopulateForcePreviewSpeedProfileWithKnotKeyframes()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.PopulateForcePreviewSpeedProfileWithKnotKeyframes ( )

◆ PrepareBezierPoints3DFromKnots()

double[][] TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.PrepareBezierPoints3DFromKnots	(	IReadOnlyList< TrackFlowKnot >	knots,
		bool	closed,
		BezierOptions	opts,
		ref double	result[][] )

private

◆ PrepareBSplinePoints3DFromKnots()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.PrepareBSplinePoints3DFromKnots	(	IReadOnlyList< TrackFlowKnot >	knots,
		bool	closed,
		int	degree,
		ref double	result[][] )

private

Prepare control points for a B-spline track. For open curves, we build a clamped control net by repeating endpoints "degree" times. For closed curves, we append the first "degree" control points at the end for a periodic spline.

◆ PrepareCatmullRomPoints3DFromKnots()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.PrepareCatmullRomPoints3DFromKnots	(	IReadOnlyList< TrackFlowKnot >	knots,
		bool	closed,
		ref double	result[][] )

private

Parameters

pts
closed

Returns

◆ PrepareHermitePoints3DFromKnots()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.PrepareHermitePoints3DFromKnots	(	IReadOnlyList< TrackFlowKnot >	knots,
		bool	closed,
		ref double	positions[][],
		ref double	tangents[][] )

private

Prepare position and tangent arrays for a Hermite spline using all control points. For closed tracks, we duplicate the first point and tangent at the end so the curve can loop.

◆ RebuildNow()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.RebuildNow ( bool includeForcePreview = true )

Force an immediate rebuild and clear the internal editor dirty flags. This avoids double-rebuilds when autoRebuildInEditor is enabled.

◆ RebuiltEvent()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.RebuiltEvent ( )

private

◆ RefreshPreviewPositionsFromPolyline()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.RefreshPreviewPositionsFromPolyline ( )

private

◆ RegisterMutator()

bool TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.RegisterMutator	(	IPolylineMutator	mutator,
		bool	markDirty = true )

Register a mutator. Returns true if it was added, false if it was already registered or null. Call from OnEnable of the consumer script, and Unregister in OnDisable.

◆ RemoveControlPointAt()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.RemoveControlPointAt ( int index )

◆ ResolveCurveSpecConstructionFrame()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.ResolveCurveSpecConstructionFrame	(	TrackFlowKnot	sKnot,
		CurveSpecOptions	opts,
		out Vector3	T0,
		out Vector3	N0,
		out Vector3	B0 )

private

Figure out which plane to apply curvature to.

Parameters

sKnot
opts
T0
N0
B0

◆ SeverMesh()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.SeverMesh ( )

◆ Start()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.Start ( )

private

◆ SyncDrivenEndKnotGeometry()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.SyncDrivenEndKnotGeometry	(	TrackFlowKnot	startKnot,
		TrackFlowKnot	drivenKnot,
		IArcLengthCurve	curve )

private

Sync the geometry of an intrinsic curve knot to the knot object. Do this because we can't control all aspects of the end frame when using Intrinsic Curves (Curve Spec segments).

Parameters

drivenKnot
curve

◆ SyncDrivenEndKnotSolvedDisplayFrame()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.SyncDrivenEndKnotSolvedDisplayFrame	(	TrackFlowKnot	drivenKnot,
		IArcLengthCurve	curve )

private

Sync the display frame of the driven end knot to the knot object.

Parameters

drivenKnot
curve

◆ TryGetInheritedCurveSpecStart()

bool TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.TryGetInheritedCurveSpecStart	(	int	knotIndex,
		out double	inheritedK0,
		out double	inheritedTau0 )

Get curvature and torsion values for driven knot endpoints.

Parameters

knotIndex
inheritedK0
inheritedTau0

Returns

◆ UnregisterMutator()

bool TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.UnregisterMutator	(	IPolylineMutator	mutator,
		bool	markDirty = true )

Unregister a mutator. Returns true if removed, false if not found or null.

◆ Update()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.Update ( )

private

◆ UpdateSegmentBuildState()

void TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.UpdateSegmentBuildState	(	IArcLengthCurve	curve,
		ref SegmentBuildState	state )

private

Member Data Documentation

◆ _autoPositions

Vector3 [] TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline._autoPositions = Array.Empty<Vector3>()

private

A cached list of automatically generated spline positions built with GetAutoPositions(). For visualization in the editor.

◆ _basePolyline

ChordErrorSampler.Polyline TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline._basePolyline

private

polyline with internal frame modifications

◆ _cachedForceSettings

ForceComputeSettings TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline._cachedForceSettings

private

◆ _dirty

bool TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline._dirty

private

◆ _dirtyVersion

int TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline._dirtyVersion

private

◆ _externalMutators

readonly List<MutatorEntry> TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline._externalMutators = new(8)

private

◆ _finalPolyline

ChordErrorSampler.Polyline TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline._finalPolyline

private

polyline with internal frame modifications + external mutators

◆ _hasCachedForceSettings

bool TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline._hasCachedForceSettings

private

◆ _inners

readonly List<IArcLengthCurve> TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline._inners = new()

private

This holds our internal generated curves.

◆ _isApplyingMutators

bool TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline._isApplyingMutators

private

◆ _lastAutoRebuildTime

float TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline._lastAutoRebuildTime

private

◆ _lastBuiltVersion

int TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline._lastBuiltVersion

private

◆ _mutatorListVersion

uint TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline._mutatorListVersion

private

◆ _mutatorSequence

int TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline._mutatorSequence

private

◆ _mutatorsNeedSort

bool TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline._mutatorsNeedSort

private

◆ _prefixes

readonly List<double> TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline._prefixes = new()

private

Each index contains the value of the arc length up to that knot index along the curve.

◆ _splinePositions

double [][] TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline._splinePositions

private

reusable buffers for spline control points. may be redundant

◆ _splineTangents

double [][] TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline._splineTangents

private

reusable buffers for spline tangents.

◆ autoRebuildInEditor

bool TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.autoRebuildInEditor = true

Auto rebuild using the rebuild interval in the editor.

◆ autoRebuildInterval

float TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.autoRebuildInterval = 0.2f

◆ Closed

bool TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.Closed = false

Close the curve.

◆ ControlPoints

List<TrackFlowKnot> TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.ControlPoints = new()

Track control points.

◆ currentSegmentContexts

List<SegmentContext> TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.currentSegmentContexts

private

◆ currentTrackContext

TrackContext TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.currentTrackContext

private

◆ forceComputeSettings

ForceComputeSettings TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.forceComputeSettings = ForceComputeSettings.Default(5f)

◆ forcePreview

ForcePreviewSettings TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.forcePreview = new()

◆ Quality

float TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.Quality = 0.3f

Quality of the sampling mechanism.

◆ spline

SplineOptions TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.spline = new()

Spline mode options.

◆ SplineRebuildRequests

int TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.SplineRebuildRequests = 0

◆ trackModOptions

TrackModifierOptions TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.trackModOptions = new()

Track modifier options. This controls rotation minimizing frame generation, roll profiles, offsets and orientations, etc.

◆ useSpline

bool TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.useSpline = true

Use spline mode instead of segment mode.

Property Documentation

◆ AutoPositions

Vector3 [] TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.AutoPositions

get

A cached list of automatically generated spline positions built with GetAutoPositions(). For visualization in the editor.

◆ BasePolyline

ChordErrorSampler.Polyline TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.BasePolyline

get

The polyline with no external mutators applied.

◆ CurrentPolyline

ChordErrorSampler.Polyline TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.CurrentPolyline

get

The polyline with all applied mutators.

◆ CurrentTrackContext

TrackContext TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.CurrentTrackContext

get

◆ IsBuilt

bool TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.IsBuilt

get

Current curve is built and accurate.

◆ IsDirty

bool TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.IsDirty

get

Editor-only: indicates whether the spline has pending changes that haven't been rebuilt.

◆ Length

float TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.Length

get

Curve length.

◆ WantsHeavyPreview

bool TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.WantsHeavyPreview

get

Event Documentation

◆ OnSplineRebuilt

EventHandler TrackFlowPro.Runtime.Core.Curves.TrackFlowSpline.OnSplineRebuilt

Subscribable event for when the spline is rebuilt, this is called after:

Inner IArcLengthCurve list regenerated
ChordErrorSampler.Polyline resampled (if enabled)
All ITrackFrameModifier and IFrameModifiers applied
Basic mesh regenerated (road or pipe)

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

Z:/Runtime/Core/Curves/TrackFlowSpline.cs

Classes

Public Member Functions

Public Attributes

Package Functions

Properties

Events

Private Member Functions

Static Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ AddControlPoint()

◆ AnimationCurveEquivalent()

◆ ApplyMutators()

◆ BezierControlPoints()

◆ BSplineControlPoints()

◆ BuildCurve()

◆ BuildPreviewPositionsFromPolyline()

◆ BuildSegment()

◆ BuildTrackSampleIndex()

◆ CanReuseForceSamples()

◆ CatmullRomControlPoints()

◆ ClearBuiltState()

◆ CullSamples()

◆ EnsureBuilt()

◆ EnsureSplineBuffers()

◆ Evaluate()

◆ EvaluatePosition()

◆ ForceSettingsEquivalent()

◆ GetAutoSamples()

◆ GetPositions()

◆ GetSamples()

◆ HermiteControlPoints()

◆ IsDrivenKnotPosition()

◆ KnotLocalToWorld()

◆ KnotWorldToLocal()

◆ MarkDirty()

◆ MinimalRotation()

◆ OnDestroy()

◆ OnValidate()

◆ PolylineMutator()

◆ PopulateForcePreviewSpeedProfileWithKnotKeyframes()

◆ PrepareBezierPoints3DFromKnots()

◆ PrepareBSplinePoints3DFromKnots()

◆ PrepareCatmullRomPoints3DFromKnots()

◆ PrepareHermitePoints3DFromKnots()

◆ RebuildNow()

◆ RebuiltEvent()

◆ RefreshPreviewPositionsFromPolyline()

◆ RegisterMutator()

◆ RemoveControlPointAt()

◆ ResolveCurveSpecConstructionFrame()

◆ SeverMesh()

◆ Start()

◆ SyncDrivenEndKnotGeometry()

◆ SyncDrivenEndKnotSolvedDisplayFrame()

◆ TryGetInheritedCurveSpecStart()

◆ UnregisterMutator()

◆ Update()

◆ UpdateSegmentBuildState()

Member Data Documentation

◆ _autoPositions

◆ _basePolyline

◆ _cachedForceSettings

◆ _dirty

◆ _dirtyVersion

◆ _externalMutators

◆ _finalPolyline

◆ _hasCachedForceSettings

◆ _inners

◆ _isApplyingMutators

◆ _lastAutoRebuildTime

◆ _lastBuiltVersion

◆ _mutatorListVersion

◆ _mutatorSequence

◆ _mutatorsNeedSort

◆ _prefixes

◆ _splinePositions

◆ _splineTangents

◆ autoRebuildInEditor