PhosphorAnimation::ProfilePaths Namespace Reference

Dot-path constants for well-known animation events. More...

Functions
PHOSPHORANIMATION_EXPORT QString	eventClassForPath (const QString &path)
	Classify path into an event class, or empty string when the path has no single class (a mixed ancestor like window, or a path outside the window/OSD/popup families — editor / panel / widget / cursor / shader / global).
PHOSPHORANIMATION_EXPORT QStringList	allBuiltInPaths ()
	Full list of built-in paths in taxonomy order.
PHOSPHORANIMATION_EXPORT QString	parentPath (const QString &path)
	Walk path up one level ("window.open" -> "window" -> "global" -> "").
PHOSPHORANIMATION_EXPORT QString	defaultShaderEffectIdForPath (const QString &path)
	Built-in default shader effect id for an event path, or empty for none.

Variables
PHOSPHORANIMATION_EXPORT const QString	Global
PHOSPHORANIMATION_EXPORT const QString	Window
PHOSPHORANIMATION_EXPORT const QString	WindowOpen
PHOSPHORANIMATION_EXPORT const QString	WindowClose
PHOSPHORANIMATION_EXPORT const QString	WindowMinimize
PHOSPHORANIMATION_EXPORT const QString	WindowMaximize
PHOSPHORANIMATION_EXPORT const QString	WindowMove
PHOSPHORANIMATION_EXPORT const QString	WindowResize
PHOSPHORANIMATION_EXPORT const QString	WindowFocus
PHOSPHORANIMATION_EXPORT const QString	WindowSnapIn
PHOSPHORANIMATION_EXPORT const QString	WindowSnapOut
PHOSPHORANIMATION_EXPORT const QString	WindowSnapResize
PHOSPHORANIMATION_EXPORT const QString	WindowLayoutSwitch
PHOSPHORANIMATION_EXPORT const QString	Editor
PHOSPHORANIMATION_EXPORT const QString	EditorSnapIn
PHOSPHORANIMATION_EXPORT const QString	EditorSnapOut
PHOSPHORANIMATION_EXPORT const QString	EditorSnapResize
PHOSPHORANIMATION_EXPORT const QString	Osd
PHOSPHORANIMATION_EXPORT const QString	OsdShow
PHOSPHORANIMATION_EXPORT const QString	OsdPop
PHOSPHORANIMATION_EXPORT const QString	OsdHide
PHOSPHORANIMATION_EXPORT const QString	Popup
PHOSPHORANIMATION_EXPORT const QString	PopupZoneSelector
PHOSPHORANIMATION_EXPORT const QString	PopupZoneSelectorShow
PHOSPHORANIMATION_EXPORT const QString	PopupZoneSelectorHide
PHOSPHORANIMATION_EXPORT const QString	PopupLayoutPicker
PHOSPHORANIMATION_EXPORT const QString	PopupLayoutPickerShow
PHOSPHORANIMATION_EXPORT const QString	PopupLayoutPickerHide
PHOSPHORANIMATION_EXPORT const QString	PopupSnapAssist
PHOSPHORANIMATION_EXPORT const QString	PopupSnapAssistShow
PHOSPHORANIMATION_EXPORT const QString	PopupSnapAssistHide
PHOSPHORANIMATION_EXPORT const QString	Panel
PHOSPHORANIMATION_EXPORT const QString	PanelSlideIn
PHOSPHORANIMATION_EXPORT const QString	PanelSlideOut
PHOSPHORANIMATION_EXPORT const QString	PanelFadeIn
PHOSPHORANIMATION_EXPORT const QString	PanelFadeOut
PHOSPHORANIMATION_EXPORT const QString	Cursor
PHOSPHORANIMATION_EXPORT const QString	CursorHover
PHOSPHORANIMATION_EXPORT const QString	CursorClick
PHOSPHORANIMATION_EXPORT const QString	Shader
PHOSPHORANIMATION_EXPORT const QString	ShaderOpen
PHOSPHORANIMATION_EXPORT const QString	ShaderClose
PHOSPHORANIMATION_EXPORT const QString	ShaderSwitch
PHOSPHORANIMATION_EXPORT const QString	Widget
PHOSPHORANIMATION_EXPORT const QString	WidgetHover
	150 ms OutCubic
PHOSPHORANIMATION_EXPORT const QString	WidgetPress
	100 ms OutCubic
PHOSPHORANIMATION_EXPORT const QString	WidgetDim
	200 ms OutCubic
PHOSPHORANIMATION_EXPORT const QString	WidgetTint
	300 ms Linear (family root)
PHOSPHORANIMATION_EXPORT const QString	WidgetTintFast
	120 ms (variant)
PHOSPHORANIMATION_EXPORT const QString	WidgetToggleOn
	250 ms OutBack (spring feel)
PHOSPHORANIMATION_EXPORT const QString	WidgetToggleOff
	250 ms OutBack
PHOSPHORANIMATION_EXPORT const QString	WidgetBadgeShow
	200 ms OutBack
PHOSPHORANIMATION_EXPORT const QString	WidgetBadgeHide
	150 ms InCubic
PHOSPHORANIMATION_EXPORT const QString	WidgetBadgePulse
	400 ms count-change pulse
PHOSPHORANIMATION_EXPORT const QString	WidgetAccordionExpand
	250 ms OutCubic
PHOSPHORANIMATION_EXPORT const QString	WidgetAccordionCollapse
	180 ms InCubic
PHOSPHORANIMATION_EXPORT const QString	WidgetFadeIn
	200 ms OutCubic
PHOSPHORANIMATION_EXPORT const QString	WidgetFadeOut
	400 ms InCubic
PHOSPHORANIMATION_EXPORT const QString	WidgetReorder
	200 ms OutCubic
PHOSPHORANIMATION_EXPORT const QString	WidgetProgress
	200 ms OutCubic
PHOSPHORANIMATION_EXPORT const QString	WidgetPulse
	1000 ms sinusoidal (family root)
PHOSPHORANIMATION_EXPORT const QString	WidgetPulseFast
	500 ms
PHOSPHORANIMATION_EXPORT const QString	WidgetPulseSlow
	1500 ms
PHOSPHORANIMATION_EXPORT const QString	WidgetZoneHighlight
PHOSPHORANIMATION_EXPORT const QString	WidgetZoneHighlightPop
PHOSPHORANIMATION_EXPORT const QString	WidgetZoneHighlightBorder
PHOSPHORANIMATION_EXPORT const QString	WidgetZoneOverlayFlash
PHOSPHORANIMATION_EXPORT const QString	EventClassGeometry
	Geometry transitions: move, resize, snapIn/snapOut/snapResize, layoutSwitch, maximize — every leg that carries an old and new rect.
PHOSPHORANIMATION_EXPORT const QString	EventClassAppearance
	Appearance transitions: open, close, minimize, focus, and every OSD / popup show/hide — a single surface materialising or dissolving.

Detailed Description

Dot-path constants for well-known animation events.

ProfileTree::resolve() walks segments right-to-left for inheritance. Plugins add paths freely (e.g. "widget.toast.slideIn") without library changes.

Naming convention (apply to new paths): show / hide — ephemeral surfaces (osd, popup, badge) open / close — persistent surfaces with a stateful open/closed <verb>In / <verb>Out — directional motion (slideIn, snapIn, switchIn, fadeIn, layoutSwitchIn …) expand / collapse — size reveal of inline content (accordion) on / off — bistable controls (toggle) <event>.<variant> — speed/intensity variants (pulse.fast, tint.fast)

Function Documentation

allBuiltInPaths()

PHOSPHORANIMATION_EXPORT QStringList PhosphorAnimation::ProfilePaths::allBuiltInPaths

(

)

Full list of built-in paths in taxonomy order.

defaultShaderEffectIdForPath()

PHOSPHORANIMATION_EXPORT QString PhosphorAnimation::ProfilePaths::defaultShaderEffectIdForPath

(

const QString &

path

)

Built-in default shader effect id for an event path, or empty for none.

SSOT for "what shader does this event animate with out of the box". Two families default to a shader: • Window MOVE/RESIZE (snap, tile, layout-switch, move, resize) → "window-morph" (geometry cross-fade), run by the kwin-effect. • Overlay show/hide leaves (osd.{show,hide}, popup.{zoneSelector,layoutPicker,snapAssist}.{show,hide}) → "fade" (fade-and-scale), run by the daemon SurfaceAnimator instead of its C++ opacity/scale legs. The category roots (osd, popup, osd.pop) carry no default. Every other event defaults to none. The default applies only when the user has set no override for the path or an ancestor (an explicit "None" is an override and is respected) — see resolveShaderWithDefault in ShaderProfileTree.h. Consumed by the kwin-effect resolution, the daemon overlay resolution (animation_config), and the settings UI so the default both plays at runtime and shows as the current value in settings.

eventClassForPath()

PHOSPHORANIMATION_EXPORT QString PhosphorAnimation::ProfilePaths::eventClassForPath

(

const QString &

path

)

Classify path into an event class, or empty string when the path has no single class (a mixed ancestor like window, or a path outside the window/OSD/popup families — editor / panel / widget / cursor / shader / global).

Resolution is leaf-aware: the OSD and popup roots and all their descendants are appearance; the window leaves split by motion-vs-lifecycle; the window root itself is mixed → empty.

parentPath()

PHOSPHORANIMATION_EXPORT QString PhosphorAnimation::ProfilePaths::parentPath

(

const QString &

path

)

Walk path up one level ("window.open" -> "window" -> "global" -> "").

Variable Documentation

Cursor

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::Cursor

extern

CursorClick

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::CursorClick

extern

CursorHover

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::CursorHover

extern

Editor

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::Editor

extern

EditorSnapIn

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::EditorSnapIn

extern

EditorSnapOut

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::EditorSnapOut

extern

EditorSnapResize

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::EditorSnapResize

extern

EventClassAppearance

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::EventClassAppearance

extern

Appearance transitions: open, close, minimize, focus, and every OSD / popup show/hide — a single surface materialising or dissolving.

EventClassGeometry

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::EventClassGeometry

extern

Geometry transitions: move, resize, snapIn/snapOut/snapResize, layoutSwitch, maximize — every leg that carries an old and new rect.

Global

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::Global

extern

Osd

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::Osd

extern

OsdHide

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::OsdHide

extern

OsdPop

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::OsdPop

extern

OsdShow

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::OsdShow

extern

Panel

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::Panel

extern

PanelFadeIn

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::PanelFadeIn

extern

PanelFadeOut

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::PanelFadeOut

extern

PanelSlideIn

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::PanelSlideIn

extern

PanelSlideOut

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::PanelSlideOut

extern

Popup

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::Popup

extern

PopupLayoutPicker

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::PopupLayoutPicker

extern

PopupLayoutPickerHide

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::PopupLayoutPickerHide

extern

PopupLayoutPickerShow

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::PopupLayoutPickerShow

extern

PopupSnapAssist

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::PopupSnapAssist

extern

PopupSnapAssistHide

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::PopupSnapAssistHide

extern

PopupSnapAssistShow

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::PopupSnapAssistShow

extern

PopupZoneSelector

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::PopupZoneSelector

extern

PopupZoneSelectorHide

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::PopupZoneSelectorHide

extern

PopupZoneSelectorShow

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::PopupZoneSelectorShow

extern

Shader

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::Shader

extern

ShaderClose

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::ShaderClose

extern

ShaderOpen

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::ShaderOpen

extern

ShaderSwitch

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::ShaderSwitch

extern

Widget

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::Widget

extern

WidgetAccordionCollapse

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetAccordionCollapse

extern

180 ms InCubic

WidgetAccordionExpand

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetAccordionExpand

extern

250 ms OutCubic

WidgetBadgeHide

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetBadgeHide

extern

150 ms InCubic

WidgetBadgePulse

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetBadgePulse

extern

400 ms count-change pulse

WidgetBadgeShow

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetBadgeShow

extern

200 ms OutBack

WidgetDim

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetDim

extern

200 ms OutCubic

WidgetFadeIn

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetFadeIn

extern

200 ms OutCubic

WidgetFadeOut

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetFadeOut

extern

400 ms InCubic

WidgetHover

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetHover

extern

150 ms OutCubic

WidgetPress

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetPress

extern

100 ms OutCubic

WidgetProgress

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetProgress

extern

200 ms OutCubic

WidgetPulse

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetPulse

extern

1000 ms sinusoidal (family root)

WidgetPulseFast

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetPulseFast

extern

500 ms

WidgetPulseSlow

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetPulseSlow

extern

1500 ms

WidgetReorder

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetReorder

extern

200 ms OutCubic

WidgetTint

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetTint

extern

300 ms Linear (family root)

WidgetTintFast

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetTintFast

extern

120 ms (variant)

WidgetToggleOff

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetToggleOff

extern

250 ms OutBack

WidgetToggleOn

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetToggleOn

extern

250 ms OutBack (spring feel)

WidgetZoneHighlight

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetZoneHighlight

extern

WidgetZoneHighlightBorder

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetZoneHighlightBorder

extern

WidgetZoneHighlightPop

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetZoneHighlightPop

extern

WidgetZoneOverlayFlash

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WidgetZoneOverlayFlash

extern

Window

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::Window

extern

WindowClose

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WindowClose

extern

WindowFocus

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WindowFocus

extern

WindowLayoutSwitch

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WindowLayoutSwitch

extern

WindowMaximize

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WindowMaximize

extern

WindowMinimize

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WindowMinimize

extern

WindowMove

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WindowMove

extern

WindowOpen

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WindowOpen

extern

WindowResize

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WindowResize

extern

WindowSnapIn

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WindowSnapIn

extern

WindowSnapOut

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WindowSnapOut

extern

WindowSnapResize

PHOSPHORANIMATION_EXPORT const QString PhosphorAnimation::ProfilePaths::WindowSnapResize

extern