TorusGradientField

A ring-shaped falloff — full weight near a circular tube, fading with distance, the field for a halo or ring of influence.

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

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

Remarks

This is the torus 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 from a ring, so the influence forms a circular halo rather than a solid blob.

Key attributes. major-radius is the ring size (centre to tube centre); inner-radius is the full-weight tube core (weight 1) and outer-radius is where the weight reaches 0, fading linearly between, with an optional inherited remap-curve available to reshape the 0→1. The ring lies in the field's local x-z plane; because the field is a scene-graph node, a quarter-turn of pitch stands the ring up, and moving the field places the halo. visualize draws the tube shells.

Related. It shares the field="#id" model with every field: other shapes include sk-spherical-gradient-field, sk-cylinder-gradient-field, and sk-cube-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?: { majorRadius?: number; 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 TorusGradientField({
    id: 'ring-zone',
    majorRadius: 5,
    innerRadius: 1,
    outerRadius: 3,
    visualize: true
});
scene.appendChild(field);

↑ Documentation home · ← All classes