Skip to content
pixi-silk
GitHub repository
Entry point

pixi-silk/ui/radial

RadialMenu and bindRadialTrigger: a ring menu with submenus.

import { RadialMenu, bindRadialTrigger } from 'pixi-silk/ui/radial';

Classes#

ClassDescription
RadialMenuPie / marking menu, the compact kind used in 3D, paint and modelling tools.

Interfaces#

InterfaceDescription
RadialBoundsArea the menu must stay inside, in its parent’s coordinates.
RadialItemOne entry of a RadialMenu. Entries with children open another ring around themselves.
RadialMenuOptionsOptions of RadialMenu. Distances are design units, scaled per input kind by the profile.
RadialStateThe reactive state of a RadialMenu.
RadialThemeColours of a RadialMenu (any Pixi colour).
RadialTriggerOptionsOptions of bindRadialTrigger.

Type Aliases#

Type AliasDescription
RadialPhaseLifecycle of a RadialMenu.
RadialPointerWhat RadialMenu.openAt needs from the pointer event that opened it.

Variables#

VariableDescription
RADIAL_THEMEDefault theme: light segments with dark icons and a blue accent, meant for dark scenes.

Functions#

FunctionDescription
bindRadialTriggerMakes target open menu (which must already be on the stage). Sets the target’s eventMode to static when it was not interactive. Returns a function that unbinds it.

References#

angleDelta#

Re-exports angleDelta