SceneProp class
One authorable property.
Constructors
-
SceneProp(String name, ScenePropKind kind, {required Object? read(SceneNode node), required void write(SceneNode node, Object? value), Object? defaultValue, String? wireKey, ScenePropOwner owner = ScenePropOwner.any, bool animatable = false, SceneChoices? choices, List<
String> ? sides, SceneQuad quad(Object? wire)?, bool byHand = false, String? kindName, String? unit, double? softMin, double? softMax, bool angular = false, double? identity, ScenePick? pick}) -
const
- SceneProp.value(String name, ScenePropKind kind, {required String of, Object? defaultValue, bool animatable = false, SceneChoices? choices, String? unit, double? softMin, double? softMax, bool angular = false, double? identity, ScenePick? pick})
-
A row of a registered kind (SceneKind), backed by the KindNode's
value map rather than a field: the one place a name meets a key.
factory
Properties
- angular → bool
-
final
- animatable → bool
-
Whether a motion track can write it — which also decides whether the
wire carries the composed value rather than the authored one.
final
- byHand → bool
-
The file and the wire spell this one themselves, so the walks that
emit, parse and encode by the table skip it.
final
- choices → SceneChoices?
-
For a ScenePropKind.choice.
final
- defaultValue → Object?
-
What a node holds when the file says nothing. A property at its
default is not written — to the file, to the JSON, to the wire.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasNamedParts → bool
-
Whether this row's value has named parts the table cannot list, so a
key reaches one through the row's own name:
args.headline,axes.wght.no setter - identity → double?
-
final
- key → String
-
no setter
- kind → ScenePropKind
-
final
- kindName → String?
-
For a row of a registered kind: the kind's name. Null for the rows
the hand-written kinds carry, which owner places.
final
- name → String
-
The file's named argument, the read plane's key, the motion's track
name when it animates.
final
- onWire → bool
-
Whether the wire and the authored JSON carry this row.
no setter
- owner → ScenePropOwner
-
final
- paramKind → SceneParamKind?
-
The parameter kind a binding to this property must have, or null when
no parameter can fill it — a choice, a list of sizes.
no setter
- pick → ScenePick?
-
What the editor offers for a string row that names something in the
project — a model file, a mesh in it, a clip in it. The row's value
stays a plain string; this says where the choices come from.
final
- quad → SceneQuad Function(Object? wire)?
-
For a ScenePropKind.edges: which quad it is, off the wire.
final
- read → Object? Function(SceneNode node)
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sides
→ List<
String> ? -
For a ScenePropKind.edges: the four file names of the parts, in the
quad's own order —
paddingLeft,paddingTop…;cornerTopLeft…final - softMax → double?
-
final
- softMin → double?
-
final
- unit → String?
-
Editing hints, when the row animates or is scrubbed: shown beside the
number, where a slider should sit, whether it is a dial, and where a
track should land.
final
- wireKey → String?
-
The key on the wire when it is not name —
wfor width.final - write → void Function(SceneNode node, Object? value)
-
final
Methods
-
appliesTo(
SceneNode node) → bool -
fromWire(
Object? raw) → Object? - The inverse of toWire; a missing or unreadable value is the default.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
toWire(
Object? value) → Object? - The value as the wire and the authored JSON carry it.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited