Skip to content

ExtrusionPathAsset

ClassTextStudio.ThreeDTextStudio.3D
public abstract class ExtrusionPathAsset : ScriptableObject, IExtrusionPath, IExtrusionPathCacheIdentity, IExtrusionPathFrameProfile

Serializable extrusion-path contract for reusable authoring assets. Implementations must expose a deterministic identity that changes whenever their sampled output changes.

Sample(float, out Vector3, out Vector3, out Vector3)

Section titled “Sample(float, out Vector3, out Vector3, out Vector3)”
public abstract void Sample(float t, out Vector3 position, out Vector3 forward, out Vector3 up)

Sample the path at normalised parameter t. t = 0 corresponds to the back face (z = 0 in Standard mode); t = 1 corresponds to the front face (z = −depth in Standard mode).

Parameters

Name Type Description
t System.Single Normalised parameter in [0, 1].
position UnityEngine.Vector3 Renderer-local position of the sampled frame.
forward UnityEngine.Vector3 Unit vector pointing along the path (replaces +Z).
up UnityEngine.Vector3 Unit vector orthogonal to forward (replaces +Y).
public virtual ExtrusionPathFrameSample SampleFrame(float t)

Samples authored rotation and cross-section scale at normalized distance.

Parameters

Name Type
t System.Single

Returns

TextStudio.ThreeD.ExtrusionPathFrameSample

protected ExtrusionPathAsset()

public abstract float ArcLength { get; }

Total arc length of the path in local units. Consumed by the generator to scale per-ring Z spacing so body steps are uniform along curved paths. Return 0 for an “infinitely” short path (collapsed to a single point).

Returns

System.Single

public abstract int SampleCount { get; }

Minimum axial segment count required to represent this path.

Returns

System.Int32

public abstract int Revision { get; }

Monotonic content revision owned by the path provider.

Returns

System.Int32

public abstract int CacheIdentity { get; }

Deterministic identity for the current immutable path snapshot.

Returns

System.Int32

public virtual bool IsClosed { get; }

Whether the path’s position, orientation, and profile are periodic at t = 0 and t = 1. Closed sweeps omit terminal caps, bevels, and trim and join their body rings instead.

Returns

System.Boolean