TwoColorDitherColorMap

← prev index next →

Abstract base for dither color-maps that map a driver parameter to an interpolation between two colors. Owns the two-color plumbing so each concrete subclass declares only its dither-specific properties.

Animatable properties contributed by this base: lowColor, highColor.

Abstract base class — not instantiated directly. Construct one of its concrete subclasses; this class contributes the members below to them.

Properties

Config Properties

PropertyTypeDefaultDescriptionDeclared by
remapCurveanimatable RemapCurveInput Optional tone-response remap curve, mirroring the field family's ColorMap
lowColor ColorInput Color for low-value (dark / shadow / dot) bins. Animatable. Default: opaque black. TwoColorDitherColorMap
highColor ColorInput Color for high-value (bright / lit / background) bins. Animatable. Default: opaque white. TwoColorDitherColorMap
screenAnchor ScreenAnchorNode | null The node whose PROJECTED SCREEN POSITION re-origins the dither TwoColorDitherColorMap

Other Properties

PropertyTypeDefaultDescriptionDeclared by
baseLowColorread-only ColorBase TwoColorDitherColorMap
baseHighColorread-only ColorBase TwoColorDitherColorMap
fieldanimatable Field | null Gets the optional field that modulates this color-map's weight ColorMap
remapCurveSourceread-only string | null The descriptor the curve was authored from, or null (imperative/none). ColorMap
remapPhaseanimatable number 0 Horizontal remap phase — an animatable scalar that translates the tone ColorMap
sceneread-only any Gets the Scene this animatable belongs to, if any. SkenraAnimatable
animationsread-only SkenraAnimation[] Public getter for the animations affecting this target. SkenraAnimatable

Methods

MethodDescriptionDeclared by
animate(firstArg: TypedKeyframe<this>[] | TypedPropertyIndexedKeyframes<this> | Record<string, any> | globalThis.Keyframe[] | globalThis.PropertyIndexedKeyframes | null, secondArg?: number | KeyframeAnimationOptions | globalThis.KeyframeAnimationOptions): SkenraAnimation & Animation Creates a new SkenraAnimation for this target per Web Animations API. SkenraAnimatable
removeAnimation(animation: SkenraAnimation): boolean Removes a specific animation from this object. SkenraAnimatable
constrain(type: K, config: ConstraintConfigMap[K]): ConstraintReturnMap[K] Creates a constraint on this Animatable using a fluent API. SkenraAnimatable