CapsuleGradientField

A pill-shaped falloff around a segment — full weight near a capsule (a rod with rounded ends), fading with distance, the field for a smooth stadium of influence.

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

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

Remarks

This is the capsule 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 a line segment with hemispherical caps, so the influence is a smoothly rounded rod.

Key attributes. The capsule is a segment along the local axis with endpoints at ±height/2; distance is measured to the nearest point on that segment. inner-radius is the full-weight core (weight 1 within it), outer-radius is where the weight reaches 0, fading linearly between, and the inherited remap-curve can reshape the 0→1. Because the field is a scene-graph node, the capsule axis is its local Y axis — rotate the field to aim it, move it to place it. visualize draws the inner/outer shells.

Related. It shares the field="#id" model with every field: its closest relative is sk-cylinder-gradient-field (an axis segment measured the same way); other shapes include sk-spherical-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?: { innerRadius?: number; outerRadius?: number; height?: 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 CapsuleGradientField({
    id: 'capsule-zone',
    innerRadius: 2,
    outerRadius: 8,
    height: 6,
    visualize: true
});
scene.appendChild(field);

↑ Documentation home · ← All classes