CelebrationScene class
Bundles a Preset with optional defaults — semantic types (ConfettiType), color themes (ConfettiColorTheme), or your own ConfettiCustomization.
Pass to ConfettiEngine.celebrate / ConfettiWidget as the scene
argument; explicit
preset and customization arguments are merged (your customization wins
on a per-field basis when provided).
- Annotations
Constructors
- CelebrationScene({required Preset preset, ConfettiCustomization? customization})
-
Creates a scene with optional base customization.
const
- CelebrationScene.compose({ConfettiType? confettiType, AnimationConfetti? animation, ConfettiColorTheme? colorTheme, ConfettiStyle? style, ConfettiDensity? density})
-
Composes optional catalog knobs (ConfettiType, AnimationConfetti,
ConfettiColorTheme, ConfettiStyle, ConfettiDensity) into one scene.
factory
- CelebrationScene.fromConfettiType(ConfettiType type)
-
Visual + motion defaults for ConfettiType (semantic celebration presets).
factory
- CelebrationScene.themed(ConfettiColorTheme theme, {Preset preset = Preset.nova})
-
Applies a named ConfettiColorTheme with an arbitrary
preset.factory
Properties
- customization → ConfettiCustomization?
-
Base customization merged under caller-supplied ConfettiCustomization.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- preset → Preset
-
Which built-in motion profile to run.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited