SphericalGradientField

A radial falloff around a point — weight fades from full at the centre to zero past an outer radius, the field for "strongest here, weaker with distance."

Declarative element: <sk-spherical-gradient-field>

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

Remarks

This is the spherical 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 depends only on distance from the field's centre, so it makes a soft sphere of influence.

Key attributes. inner-radius is the full-weight core (weight 1 inside it); outer-radius is where the weight reaches 0; between them it fades linearly, and the inherited remap-curve can reshape that 0→1 transition. Because the field is a scene-graph node, its centre is its own position — move, parent, or animate it and the sphere of influence follows; a non-uniform scale multiplies the effective radii (by the average of sx, sy, sz). visualize draws the inner/outer shells so the falloff is visible while composing.

Related. It shares the field="#id" model with every field: sibling shapes include sk-linear-gradient-field, sk-cube-gradient-field, and sk-torus-gradient-field; sk-noise-spatial-field shapes weight by noise instead of distance. 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?: { 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 field = new SphericalGradientField({
    id: 'proximity',
    innerRadius: 2,
    outerRadius: 8,
    visualize: true
});
field.x = 5;
scene.appendChild(field);

// Evaluate at some position
const weight = field.evaluate([7, 0, 0]); // distance=2, weight=1

↑ Documentation home · ← All classes