Skip to content
pixi-silk
GitHub repository
Class

HueSquarePicker

import { HueSquarePicker } from 'pixi-silk/ui/color';

Hue ring with a saturation (left to right) / value (bottom to top) square inside.

Extends#

  • HueRingPicker

Constructors#

Constructor#

new HueSquarePicker(options?: HueRingOptions): HueSquarePicker;

Parameters#

ParameterType
optionsHueRingOptions

Returns#

HueSquarePicker

Overrides#

HueRingPicker.constructor

Properties#

PropertyModifierTypeDescriptionInherited fromDefined in
modelreadonlyColorModelThe colour this picker edits. Share it to link pickers.HueRingPicker.modelui/color/ColorPicker.ts:36
statereadonlyColorPickerStateSignals to read. See ColorPickerState.HueRingPicker.stateui/color/ColorPicker.ts:38

Accessors#

size#

Get Signature#

get size(): number;

Outer diameter in local units.

Returns

number

Inherited from#

HueRingPicker.size

Methods#

destroy()#

destroy(options?: DestroyOptions): void;

Stops the animation and unsubscribes from the model. The model stays usable. Destroys children by default.

Parameters#

ParameterType
options?DestroyOptions

Returns#

void

Inherited from#

HueRingPicker.destroy

tick()#

tick(dt: number): boolean;

Advances the animation by dt seconds (only needed with ticker: null). Returns true while moving.

Parameters#

ParameterType
dtnumber

Returns#

boolean

Inherited from#

HueRingPicker.tick