Copyright © 2021 by K4.org
  (v.0.48.124)

BaseModel (d.1.0)

Mixins: None

The minimal content for an object to participate in the system. This is mixed into every model. Note that this does not support children. Use BaseAssembly or BaseNode to support children.

Index

Rules

children

children: Array

Always an empty array. Use BaseAssembly or BaseNode to support children.

Flags : Cached (Note this is uncached)

Expression : []

design

design: Any

The Design object (not the name) for this model.

Flags : Cached (Note this is uncached)

Expression : this[R.symbols.design]

designName

designName: String

The name of the Design which this model is an instance of.

Flags : Cached (Note this is uncached)

Expression : this[R.symbols.designName]

inTree

inTree: Boolean

Set to false if you do not want this model to appear in the model tree. It will still exist.

Flags : Cached, Parameter (Note this is uncached)

Expression : true

index

index: Integer

The numeric 0-based index of this child in its group.

Flags : Cached (Note this is uncached)

Expression : this[R.symbols.index]

name

name: String

The name of this model.

Flags : Cached (Note this is uncached)

Expression : this[R.symbols.name]

nha

nha: Model

The Next Higher Assembly. This ignores 'Group' levels.

Flags : Cached (Note this is uncached)

Expression : R.nha(this)

parent

parent: Model

The immediate parent of this model. Use nha instead for 'normal' usage.

Flags : Cached (Note this is uncached)

Expression : this[R.symbols.parent]

realChildren

realChildren: Array

Returns the actual children of this node, filtering out intermediate 'Group' level nodes.

Flags : Cached (Note this is uncached)

Expression : const realChildren = []; this.children.forEach(c => { const isGroup = c.isKindOf('__Group'); if (isGroup) { c.children.forEach(gc => realChildren.push(gc)); } else { realChildren.push(c)} }); return realChildren;

refChain

refChain: String

The canonical reference chain from the world to this model.

Flags : Cached (Note this is uncached)

Expression : this[R.symbols.refChain]

suppressUpdate

suppressUpdate: Boolean

If true, automatic updates on this branch will be prevented.

Flags : Cached, Parameter (Note this is uncached)

Expression : R.asleep(this)

treeLabel

treeLabel: String

The text to be used for this model in the model tree.

Flags : Cached, Parameter (Note this is uncached)

Expression : this[R.symbols.name]

update

update: Any

The standard update driver.

Flags : None. (Note this is uncached)

Expression : if (this.suppressUpdate) { R.demandChildren(this, true); } else { R.update(this); this.children.forEach(node => node.update); } return undefined;