SplineDistanceGradientField

A tube of influence around a curve — full weight near a spline, fading with distance, the field for "strongest along this path."

Declarative element: <sk-spline-distance-gradient-field>

Global: available as sk.SplineDistanceGradientField inside a scene <script>.

Remarks

This is the spline-distance member of the SpatialField family: like every field it turns where into how much — a scalar weight over space that consumers read by #id (field="#id") to vary an effect from place to place. Here the weight follows distance to the nearest point on a reference spline, so the influence wraps the curve as a tube.

Key attributes. spline-id names the sk-spline to measure from, by #id. inner-radius is the full-weight core hugging the curve (weight 1 within it) and outer-radius is where the weight reaches 0, fading linearly between, with an optional inherited remap-curve available to reshape the 0→1. visualize highlights the reference spline and draws the field's bounding box so its extent is clear.

Related. It shares the field="#id" model with every field. Its companion is sk-spline-progress-gradient-field (weight by progress along the spline rather than distance from it); the straight-tube analogue is sk-cylinder-gradient-field. Typical consumers are a sk-tonemap (mask the shading), a sk-simple-point-constraint (per-clone strength), and sk-field-constraint (drive one property).

Constructor

constructor(config?: { spline?: AbstractSpline | null; innerRadius?: number; outerRadius?: number; remapCurve?: SampledCurve; visualize?: boolean; interactiveControls?: boolean; visualizationMarkerSize?: number; visualizationColor?: string; visualizationZeroWeightColor?: string; visualizationSplineThickness?: number; visualizationSplineOccludedOpacity?: number; visualizationMarkerOpacity?: number; id?: string; x?: number; y?: number; z?: number; h?: number; p?: number; b?: number; quaternion?: Quaternion; sx?: number; sy?: number; sz?: number; s?: number; class?: string; style?: string })

Inherited from: SpatialField, VisualizableSceneNode, SceneNode, SkenraAnimatable — see those pages for inherited members.

Properties

Config Properties

Other Properties

Methods

Example

const spline = new PathSpline({ id: 'path', svg: 'M 0 0 C 5 10 10 -5 15 0' });
const field = new SplineDistanceGradientField({
    id: 'tube',
    spline,
    innerRadius: 1,
    outerRadius: 5,
    visualize: true,
});
scene.appendChild(field);

↑ Documentation home · ← All classes