@huukhanhnguyen/model / nodes/OptionNode
nodes/OptionNode
OptionNode
Extends
Constructors
Constructor
new OptionNode(
parent,label,expr?):OptionNode
Parameters
parent
unknown
label
string
expr?
string = "''"
Returns
Overrides
_dependents
_dependents:
Set<BaseNode>
Inherited from
_epoch
_epoch:
number=0
Bumped on every dirty (see setDirty/markDirty) — a stale async settle compares its captured epoch against the current one and discards itself on mismatch (a newer edit superseded it while it was in flight).
Inherited from
_evaluating
static_evaluating:Set<ExpressionNode>
Inherited from
_hooks?
optional_hooks?:NodeHooks
Lifecycle observers attached to THIS node — see nodes/hooks.ts. Also carried by an DataDefinition, the declaration surface a node's hooks can be attached to before the node exists.
Inherited from
_reads
_reads:
Set<BaseNode>
Reverse index of nodes this node currently reads (static expression refs + dynamic dependOn edges). Cleared at the start of every dirty recompute and on dispose so a dropped Table.get/sampleTexture edge stops cascading markDirty (and a disposed node is not retained).
Inherited from
_valueType
_valueType:
string
Inherited from
attributes
attributes:
Record<string,unknown> ={}
Inherited from
collection
collection:
BaseCollection
Inherited from
error?
optionalerror?:string=""
Last error message; empty string when valid, undefined after a successful eval.
Inherited from
expression
expression:
string
The raw JS expression string that this node evaluates.
Inherited from
id
id:
string
Inherited from
isDirty
isDirty:
boolean=true
True when the node needs re-evaluation before its value can be trusted.
Inherited from
label
label:
string
Display label shown in the UI for this select option.
locals?
optionallocals?:Record<string,unknown>
Extra names visible to THIS expression only, layered on top of the owning collection's keys. A CHAIN-LOCAL parameter (a texture chain's own parameters) is not a graph node, so it never appears in keyedNodes() — an editor rendering a chain STEP sets this to the chain's resolved parameter values so imageWidth reads the same way it does inside the chain's own evaluator. ponytail: layered ON TOP of the root names rather than REPLACING them — a chain scope is isolated in the engine, so an editor field naming a root parameter still previews a value the engine would reject. Swap the merge for a replace when the editor needs full isolation fidelity.
Inherited from
name
name:
string
Inherited from
parent?
optionalparent?:any
Inherited from
pending
pending:
boolean=false
True while an async compute() is in flight (its result hasn't settled yet).
Inherited from
sourceId
sourceId:
string=""
Inherited from
value
value:
unknown=undefined
Cached evaluated value; undefined when the node is in an error state.
Inherited from
Accessors
dependents
Get Signature
get dependents():
Set<any>
Returns
Set<any>
Overrides
errorLogPrefix
Get Signature
get
protectederrorLogPrefix():string
console.error prefix on a compute failure — override to match a subclass's existing log message (includes node-specific context).
Returns
string
Inherited from
model
Get Signature
get model():
any
Returns
any
Inherited from
owner
Get Signature
get owner():
any
Walk up to the nearest owner that has a nodes collection (ModelScope).
Returns
any
Inherited from
ownerNodes
Get Signature
get ownerNodes(): {
elements?:unknown;evaluate: () =>void;notify?: (event,value) =>void; } |undefined
The owning node collection (the ModelScope's nodes), or undefined when this expression isn't mounted under an owner yet. UI uses this only to re-evaluate the graph after an edit (see requestEvaluate).
Returns
{ elements?: unknown; evaluate: () => void; notify?: (event, value) => void; } | undefined
Inherited from
symbol
Get Signature
get symbol():
string
Returns
string
Inherited from
valueType
Get Signature
get valueType():
string
Returns
string
Overrides
Methods
_commit()
protected_commit(raw,isAsync,settle?):void
Protected (not private): ExpressionNode/ContainerNode's evaluate() overrides call this directly to reuse the exact same commit path for a volatile step that bypasses the isDirty gate.
Parameters
raw
unknown
isAsync
boolean
settle?
Returns
void
Inherited from
_dispose()
_dispose():
void
Returns
void
Inherited from
_fail()
protected_fail(err,isAsync,settle?):void
Protected (not private) — see _commit's doc.
Parameters
err
unknown
isAsync
boolean
settle?
Returns
void
Inherited from
addListener()
addListener(
event,listener): () =>void
Parameters
event
string
listener
Returns
() => void
Inherited from
buildContext()
buildContext():
EvalContext
Public eval scope for this expression (the same scope compute() uses).
Returns
Inherited from
compute()
compute():
unknown
Compute the raw value for this node; override in subclasses to produce actual output.
Returns
unknown
Inherited from
copy()
copy():
OptionNode
Duplicate this node in its collection, inserting it right after the original.
Returns
Overrides
display()
display(
listener?):string
Return the human-readable display string for this node's value (or its error message).
Parameters
listener?
() => void
Returns
string
Inherited from
errorValue()
protectederrorValue():unknown
Value to fall back to when compute()/postCompute() throws. Override for a node whose "empty" isn't undefined (ContainerNode: []).
Returns
unknown
Inherited from
evaluate()
evaluate(
listener?):unknown
Evaluate this node, cache the result, and notify dependents; returns the cached value. When compute() returns a thenable, this returns the prior (stale) value synchronously and settles later — see core/maybeAsync.ts.
Parameters
listener?
() => void
Returns
unknown
Inherited from
finishInit()
finishInit():
void
Assembly is complete: this node has its full structure and its children. Every assembly path calls it at the point wiring is genuinely done, which is NOT one line:
- the classes that take everything as constructor parameters (the LaneNode family, ExpressionNode, OptionNode, ArgumentNode) call it at the end of their own constructor;
DataNodecalls it after its args are pushed —fromRegistryandcopy, never its constructor, which sets only method+definition;ContainerNodeafter its children are attached,ParameterNodeafter its args are wired (NodeCollection: createFromJSON, addContainer, addEntry).
Guarded to fire at most once. That is what makes NESTED assembly safe — createFromJSON delegates to fromRegistry, and one node must see one init, not two — and makes a redundant call harmless rather than wrong.
Returns
void
Inherited from
getError()
getError(
listener?):string|undefined
Parameters
listener?
() => void
Returns
string | undefined
Inherited from
getInput()
getInput(
listener?):string
Parameters
listener?
(...args) => void
Returns
string
Inherited from
getOverride()
getOverride():
string|null
Live override currently applied for evaluation, or null when none.
Returns
string | null
Inherited from
isPending()
isPending(
listener?):boolean
True while an async compute() is still settling (see pending).
Parameters
listener?
() => void
Returns
boolean
Inherited from
isValid()
isValid(
listener?):boolean
Parameters
listener?
() => void
Returns
boolean
Inherited from
notify()
notify(
event, ...args):void
Parameters
event
string
args
...unknown[]
Returns
void
Inherited from
postCompute()
protectedpostCompute(raw):unknown
Post-process compute()'s raw result into this.value; throw to signal a failure (caught by evaluate()'s template, same as a compute() throw). Override for a node whose value isn't a sanitizer-typed scalar: ContainerNode returns the data list as-is; ArgumentNode routes through the domain coercion pipeline (nodeMethods/parameter.ts + data/ asset resolution) instead of convert/validate.
Parameters
raw
unknown
Returns
unknown
Inherited from
remove()
remove():
void
The removal door. BaseObject.remove() detaches from the collection and notifies "remove"; the pair brackets that, so beforeRemove still sees the node in its collection with its read edges intact.
afterRemove means "AFTER THE NODE LEFT ITS COLLECTION" — it does NOT promise the node's read edges are gone. Deliberately does not retractReads(): removing a node does not retract its edges today, only the disposal call sites do (tables.ts), and adding it here would be a behaviour change rather than an observation point.
Not anchored at retractReads() — that runs on EVERY dirty recompute (3 of its 6 call sites: evaluate, LaneNode.pull, evaluateStep), so hooks there would report a live node as removed on every evaluate.
Returns
void
Inherited from
removeListener()
removeListener(
event,listener):void
Parameters
event
string
listener
Returns
void
Inherited from
requestEvaluate()
requestEvaluate():
void
Re-evaluate the whole owning graph. Called by the UI after it writes a new expression (field blur / array row edit) so dependent nodes + geometry refresh. No-op when not yet mounted under an owner.
evaluate() alone is NOT enough for a ROOT-LEVEL operation step: DataNode.evaluate() deliberately returns its cached value (the owning fold pulls the step through evaluateStep), so the per-element loop re-runs nothing and nothing notifies. The root fold only runs from the render collect (Model.ts's rootFoldSlices), and that collect is scheduled by the collection's own "change" — so an edit to e.g. faceMaterial/applyVisible at the root used to land in the document and then sit there invisible until some unrelated edit forced a resync. Firing that "change" here is the same signal the lane editors already send through touch(owner).
Returns
void
Inherited from
ExpressionNode.requestEvaluate
resolveNodeValue()
staticresolveNodeValue(node):unknown
Shared with NodeCollection.sharedEvalContext getters.
Parameters
node
evaluate
() => unknown
return?
string | null
Returns
unknown
Inherited from
ExpressionNode.resolveNodeValue
retractReads()
retractReads():
void
Drop every reverse read edge recorded in _reads.
Returns
void
Inherited from
setError()
setError(
message):void
Set an error message on this node and notify listeners. Fires "error" (specific) and "change" (the universal event — see ParameterNode.setKey's doc).
Parameters
message
string
Returns
void
Inherited from
setInput()
setInput(
expr):void
Update the expression string and propagate dirty flags to all dependents.
Parameters
expr
string
Returns
void
Inherited from
setOverride()
setOverride(
expr):void
Set or clear a live evaluation override. Marks dirty like setInput so dependents re-evaluate; does NOT touch the stored expression string.
Parameters
expr
string | null
Returns
void
Inherited from
toJSON()
toJSON(): {
attributes:Record<string,unknown>;id:string;input:string;label:string; }
Returns
{ attributes: Record<string, unknown>; id: string; input: string; label: string; }
attributes
attributes:
Record<string,unknown>
id
id:
string
input
input:
string
label
label:
string