Node class

Inheritance

• Object
• WorldTransformComponentBase
• WorldTransformComponent
• TransformComponentBase
• TransformComponent
• NodeBase
• Node

Implementers

• ImageBase
• NestedArtboardBase
• ShapeBase

Constructors

Node()

Properties

artboard → Artboard?

The artboard this component belongs to.

no setter, inherited

canBeOrphaned → bool

Override to true if you want some object inheriting from Component to not have a parent. Most objects will validate that they have a parent during the onAdded callback otherwise they are considered invalid and are culled from core.

no setter, inherited

childOpacity → double

no setter, inherited

children → ContainerChildren

final, inherited

clippingShapes → Iterable<ClippingShape>

no setter, inherited

constraintBounds → AABB

Bounds to use for constraining to object space.

no setter, inherited

constraints → Iterable<Constraint>

no setter, inherited

context ↔ RuntimeArtboard

covariant, getter/setter pair, inherited

coreType → int

no setter, inherited

coreTypes → Set<int>

no setter, inherited

dependencies → Set<Component>

no setter, inherited

dependencyRoot ↔ Artboard?

getter/setter pair, inherited

dependents → Set<Component>

no setter, inherited

dirt ↔ int

getter/setter pair, inherited

drawRules → DrawRules?

no setter, inherited

graphOrder ↔ int

getter/setter pair, inherited

hashCode → int

The hash code for this object.

no setter, inherited

hasValidated → bool

no setter, inherited

id ↔ int

getter/setter pair, inherited

isCollapsed → bool

Whether this Component's update processes at all.

no setter, inherited

isConstrained → bool

no setter, inherited

localBounds → AABB

no setter, inherited

name ↔ String

Non-unique identifier, used to give friendly names to elements in the hierarchy. Runtimes provide an API for finding components by this name.

getter/setter pair, inherited

opacity ↔ double

Change the _opacity field value. opacityChanged will be invoked only if the field's value has changed.

getter/setter pair, inherited

parent ↔ ContainerComponent?

getter/setter pair, inherited

parentId ↔ int

Identifier used to track parent ContainerComponent.

getter/setter pair, inherited

parentWorldTransform → Mat2D

Returns the world transform of the parent component. Returns the identity if there is no parent (the artboard should be the only case here).

no setter, inherited

renderOpacity → double

no setter, inherited

rotation ↔ double

Change the _rotation field value. rotationChanged will be invoked only if the field's value has changed.

getter/setter pair, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

scale ↔ Vec2D

getter/setter pair, inherited

scaleX ↔ double

Change the _scaleX field value. scaleXChanged will be invoked only if the field's value has changed.

getter/setter pair, inherited

scaleY ↔ double

Change the _scaleY field value. scaleYChanged will be invoked only if the field's value has changed.

getter/setter pair, inherited

transform → Mat2D

final, inherited

translation ↔ Vec2D

Sets the position of the Node

getter/setter pair, inherited-getter

userData ↔ dynamic

getter/setter pair, inherited

worldTransform → Mat2D

final, inherited

worldTranslation → Vec2D

no setter, inherited

x ↔ double

Change the _x field value. xChanged will be invoked only if the field's value has changed.

getter/setter pair, inherited

y ↔ double

Change the _y field value. yChanged will be invoked only if the field's value has changed.

getter/setter pair, inherited

Methods

addDependent(Component dependent, {Component? via}) → bool

Mark dependent as a component which must update after this. Provide via as the Component registering the dependency when it is not dependent itself. At edit time this allows the editor to rebuild both dependent and via when dependent has its dependencies cleared.

inherited

addDirt(int value, {bool recurse = false}) → bool

inherited

allDependencies(Set<Component> dependencies) → void

inherited

appendChild(Component child) → void

Adds the child to the children list and re-wires the parent reference of the child to the parent. Effectively detach and append.

inherited

buildDependencies() → void

inherited

buildDrawOrder(List<Drawable> drawables, DrawRules? rules, List<DrawRules> allRules) → void

inherited

calculateWorldTransform() → void

inherited

changeArtboard(Artboard? value) → void

inherited

childAdded(Component child) → void

inherited

childRemoved(Component child) → void

inherited

clearDependencies() → void

inherited

clone<K extends Core<CoreContext>>() → K?

Make a duplicate of this core object, N.B. that all properties excluding object id are copied.

inherited

copy(covariant Core<CoreContext> source) → void

Copies property values, currently doesn't trigger change callbacks. It's meant to be a helper for clone.

inherited

forAll(DescentCallback cb) → bool

inherited

forEachChild(DescentCallback cb) → void

inherited

import(ImportStack stack) → bool

inherited

isValidParent(Component parent) → bool

inherited

markDirtyIfConstrained() → void

inherited

markRebuildDependencies() → void

inherited

markTransformDirty() → void

inherited

markWorldTransformDirty() → void

inherited

nameChanged(String from, String to) → void

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

onAdded() → void

inherited

onAddedDirty() → void

inherited

onDependencyRemoved(Component dependent) → void

Something we depend on has been removed. It's important to clear out any stored references to that dependency so it can be garbage collected (if necessary).

inherited

onDirty(int mask) → void

inherited

onRemoved() → void

When a component has been removed from the Core Context, we clean up any dangling references left on the parent and on any other dependent component. It's important for specialization of Component to respond to override onDependencyRemoved and clean up any further stored references to that component (for example the target of a Constraint).

inherited

opacityChanged(double from, double to) → void

inherited

parentChanged(ContainerComponent? from, ContainerComponent? to) → void

inherited

parentIdChanged(int from, int to) → void

inherited

prependChild(Component child) → void

inherited

propagateCollapse(bool collapse) → bool

inherited

propagateCollapseToChildren(bool collapse) → void

inherited

remove() → void

inherited

removeRecursive() → void

Recursive version of Component.remove. This should only be called when you know this is the only part of the branch you are removing in your operation. If your operation could remove items from the same branch multiple times, you should consider building up a list of the individual items to remove and then remove them individually to avoid calling remove multiple times on children.

inherited

resolveArtboard() → bool

Find the artboard in the hierarchy.

inherited

rotationChanged(double from, double to) → void

inherited

scaleXChanged(double from, double to) → void

inherited

scaleYChanged(double from, double to) → void

inherited

toString() → String

A string representation of this object.

inherited

update(int dirt) → void

inherited

updateTransform() → void

inherited

updateWorldTransform() → void

inherited

userDataChanged(dynamic from, dynamic to) → void

inherited

validate() → bool

inherited

visitAncestor(Component ancestor) → void

Called whenever we're resolving the artboard, we piggy back on that process to visit ancestors in the tree. This is a good opportunity to check if we have an ancestor of a specific type. For example, a Path needs to know which Shape it's within.

inherited

xChanged(double from, double to) → void

override

yChanged(double from, double to) → void

override

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Properties

unknown → Node

final