SceneConfig class
Configuration class used to define the properties and behavior of a GraphX Scene.
Constructors
- SceneConfig({bool rebuildOnHotReload = true, bool useKeyboard = false, bool usePointer = false, bool useTicker = false, bool isPersistent = false, bool autoUpdateRender = true, bool painterWillChange = true})
- Creates a new SceneConfig instance.
Properties
- autoUpdateRender ↔ bool
-
Default flag to make the engine update() the Stage and all
his children (onEnterFrame), needed by GTween to run the tweens.
GMovieClip and GSimpleParticleSystem also makes use of this.
Same applies to basic "mouse out" feature detection (when mouse doesn't
move but objects changed position).
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- isPersistent ↔ bool
-
Avoids the scene from being disposed by the Widget.
Meant to be used with
ScenePainter.useOwnCanvas=true
where a ScenePainter captures it's own drawing to be used as Picture (or Image eventually) by other ScenePainters. Warning: Experimentalgetter/setter pair - painterWillChange ↔ bool
-
See CustomPaint.willChange.
getter/setter pair
- rebuildOnHotReload ↔ bool
-
Re-builds the SceneController (the ScenePainter and the scene class).
disposes and initializes all the scene.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- useKeyboard ↔ bool
-
If the GraphX SceneController will use keyboard events.
getter/setter pair
- usePointer ↔ bool
-
If this GraphX SceneController will use pointer (touch/mouse) events.
getter/setter pair
- useTicker ↔ bool
-
Will be overwritten to
true
if autoUpdateRender is set on any ScenePainter layer.getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
painterMightChange(
) → bool -
Utility method used by the SceneBuilderWidget to set the flag
CustomPaint.willChange
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- autoRender → SceneConfig
-
autoRender configuration:
Basic configuration to auto manage the update and rendering of the Scene.
with no input support. Might be useful for external control of the layers,
animated backgrounds, etc.
final
- defaultConfig ↔ SceneConfig
-
Property defines the default configuration to be used if no other
configuration is specified.
getter/setter pair
- games → SceneConfig
-
games configuration, setup this GraphX Widget to render
with full support for auto rendering, updates, mouse and keyboard.
final
- interactive → SceneConfig
-
interactive configuration:
Useful for mobile interactions or custom UI components, runs with all
features except useKeyboard.
final
- static → SceneConfig
-
static drawing configuration, this tells the SceneController that
this GraphX Scene will not change (although you might invalidate it
internally with code, but is error prone).
This is the lightest GraphX instance you can build.
Only to make custom drawings.
final
- tools → SceneConfig
-
tools configuration, is shortcut for games.
If you plan to make a custom graphics editor, or some complex desktop tool
that requires keystroke shortcuts, and mouse capture.
final