Shape
abstract class Shape extends Layout
Extended by
Constructors
constructor
public override new Shapeprops: ShapeProps: Shape
Parameters
OverwritesLayout.constructorProperties
absolutePosition
readonly public absolutePosition: SimpleVector2SignalShape
A helper signal for operating on the position in world space.
Retrieving the position using this signal returns the position in world space. Similarly, setting the position using this signal transforms the new value to local space.
If the new value is a function, the position of this node will be continuously updated to always match the position returned by the function. This can be useful to "pin" the node in a specific place or to make it follow another node's position.
Unlike position, this signal is not compound - it doesn't contain
separate signals for the x and y components.
Layout.absolutePositionabsoluteRotation
readonly public absoluteRotation: SimpleSignalnumberShape
A helper signal for operating on the rotation in world space.
Retrieving the rotation using this signal returns the rotation in world space. Similarly, setting the rotation using this signal transforms the new value to local space.
If the new value is a function, the rotation of this node will be continuously updated to always match the rotation returned by the function.
Inherited fromLayout.absoluteRotationabsoluteScale
readonly public absoluteScale: SimpleVector2SignalShape
A helper signal for operating on the scale in world space.
Retrieving the scale using this signal returns the scale in world space. Similarly, setting the scale using this signal transforms the new value to local space.
If the new value is a function, the scale of this node will be continuously updated to always match the position returned by the function.
Unlike scale, this signal is not compound - it doesn't contain
separate signals for the x and y components.
Layout.absoluteScalealignContent
readonly public alignContent: SimpleSignalFlexContentShape
Layout.alignContentalignItems
readonly public alignItems: SimpleSignalFlexItemsShape
Layout.alignItemsalignSelf
readonly public alignSelf: SimpleSignalFlexItemsShape
Layout.alignSelfantialiased
readonly public antialiased: SimpleSignalbooleanShape
basis
readonly public basis: SimpleSignalFlexBasisShape
Layout.basisbottom
readonly public bottom: SimpleVector2SignalShape
The position of the bottom edge of this node.
When set, this shortcut property will modify the node's position so that the bottom edge ends up in the given place.
When retrieved, it will return the position of the bottom edge in the parent space.
Inherited fromLayout.bottombottomLeft
readonly public bottomLeft: SimpleVector2SignalShape
The position of the bottom left corner of this node.
When set, this shortcut property will modify the node's position so that the bottom left corner ends up in the given place.
When retrieved, it will return the position of the bottom left corner in the parent space.
Inherited fromLayout.bottomLeftbottomRight
readonly public bottomRight: SimpleVector2SignalShape
The position of the bottom right corner of this node.
When set, this shortcut property will modify the node's position so that the bottom right corner ends up in the given place.
When retrieved, it will return the position of the bottom right corner in the parent space.
Inherited fromLayout.bottomRightcache
readonly public cache: SimpleSignalbooleanShape
Layout.cachecachePadding
readonly public cachePadding: SpacingSignalShape
Controls the padding of the cached canvas used by this node.
By default, the size of the cache is determined based on the bounding box
of the node and its children. That includes effects such as stroke or
shadow. This property can be used to expand the cache area further.
Usually used to account for custom effects created by shaders.
Layout.cachePaddingchildren
readonly public children: SignalComponentChildrenNode[]ShapeSignalContextComponentChildrenNode[]Shape
Layout.childrenclip
readonly public clip: SimpleSignalbooleanShape
Layout.clipcomposite
readonly public composite: SimpleSignalbooleanShape
Layout.compositecompositeOperation
readonly public compositeOperation: SimpleSignalGlobalCompositeOperationShape
Layout.compositeOperationcreationStack
readonly public creationStack?: string
Layout.creationStackdirection
readonly public direction: SimpleSignalFlexDirectionShape
Layout.directionelement
public element: HTMLElement
Layout.elementfill
readonly public fill: CanvasStyleSignalShape
filters
readonly public filters: FiltersSignalShape
Layout.filtersfontFamily
readonly public fontFamily: SimpleSignalstringShape
Layout.fontFamilyfontSize
readonly public fontSize: SimpleSignalnumberShape
Layout.fontSizefontStyle
readonly public fontStyle: SimpleSignalstringShape
Layout.fontStylefontWeight
readonly public fontWeight: SimpleSignalnumberShape
Layout.fontWeightgap
readonly public gap: Vector2LengthSignalShape
Layout.gapgrow
readonly public grow: SimpleSignalnumberShape
Layout.growisClass
public isClass: boolean
Layout.isClassjustifyContent
readonly public justifyContent: SimpleSignalFlexContentShape
Layout.justifyContentkey
readonly public key: string
Layout.keylayout
readonly public layout: SimpleSignalLayoutModeShape
Layout.layoutleft
readonly public left: SimpleVector2SignalShape
The position of the left edge of this node.
When set, this shortcut property will modify the node's position so that the left edge ends up in the given place.
When retrieved, it will return the position of the left edge in the parent space.
Inherited fromLayout.leftletterSpacing
readonly public letterSpacing: SimpleSignalnumberShape
Layout.letterSpacinglineCap
readonly public lineCap: SimpleSignalCanvasLineCapShape
lineDash
readonly public lineDash: SimpleSignalnumber[]Shape
lineDashOffset
readonly public lineDashOffset: SimpleSignalnumberShape
lineHeight
readonly public lineHeight: SimpleSignalLengthShape
Layout.lineHeightlineJoin
readonly public lineJoin: SimpleSignalCanvasLineJoinShape
lineWidth
readonly public lineWidth: SimpleSignalnumberShape
margin
readonly public margin: SpacingSignalShape
Layout.marginmaxHeight
readonly public maxHeight: SimpleSignalLengthLimitShape
Layout.maxHeightmaxWidth
readonly public maxWidth: SimpleSignalLengthLimitShape
Layout.maxWidthmiddle
readonly public middle: SimpleVector2SignalShape
The position of the center of this node.
When set, this shortcut property will modify the node's position so that the center ends up in the given place.
If the offset has not been changed, this will be the same as the
position.
When retrieved, it will return the position of the center in the parent space.
Inherited fromLayout.middleminHeight
readonly public minHeight: SimpleSignalLengthLimitShape
Layout.minHeightminWidth
readonly public minWidth: SimpleSignalLengthLimitShape
Layout.minWidthoffset
readonly public offset: Vector2SignalShape
Represents the offset of this node's origin.
By default, the origin of a node is located at its center. The origin serves as the pivot point when rotating and scaling a node, but it doesn't affect the placement of its children.
The value is relative to the size of this node. A value of 1 means as far
to the right/bottom as possible. Here are a few examples of offsets:
[-1, -1]- top left corner[1, -1]- top right corner[0, 1]- bottom edge[-1, 1]- bottom left corner
Layout.offsetopacity
readonly public opacity: SimpleSignalnumberShape
Represents the opacity of this node in the range 0-1.
The value is clamped to the range 0-1.
Inherited fromLayout.opacitypadding
readonly public padding: SpacingSignalShape
Layout.paddingparent
readonly public parent: SimpleSignalnullNodevoid = ...
Layout.parentposition
readonly public position: Vector2SignalShape
Represents the position of this node in local space of its parent.
Examples
Inherited fromLayout.positionproperties
readonly public properties: RecordstringPropertyMetadataany = ...
Layout.propertiesratio
readonly public ratio: SimpleSignalnullnumberShape
Layout.ratioright
readonly public right: SimpleVector2SignalShape
The position of the right edge of this node.
When set, this shortcut property will modify the node's position so that the right edge ends up in the given place.
When retrieved, it will return the position of the right edge in the parent space.
Inherited fromLayout.rightrotation
readonly public rotation: SimpleSignalnumberShape
Represents the rotation (in degrees) of this node relative to its parent.
Inherited fromLayout.rotationscale
readonly public scale: Vector2SignalShape
Represents the scale of this node in local space of its parent.
Examples
Inherited fromLayout.scaleshaders
readonly public shaders: SignalPossibleShaderConfigShaderConfig[]ShapeSignalContextPossibleShaderConfigShaderConfig[]Shape
Layout.shadersshadowBlur
readonly public shadowBlur: SimpleSignalnumberShape
Layout.shadowBlurshadowColor
readonly public shadowColor: ColorSignalShape
Layout.shadowColorshadowOffset
readonly public shadowOffset: Vector2SignalShape
Layout.shadowOffsetshrink
readonly public shrink: SimpleSignalnumberShape
Layout.shrinksize
readonly public size: Vector2LengthSignalShape
Represents the size of this node.
A size is a two-dimensional vector, where x represents the width, and y
represents the height.
The value of both x and y is of type Length which is
either:
number- the desired length in pixels${number}%- a string with the desired length in percents, for example'50%'null- an automatic length
When retrieving the size, all units are converted to pixels, using the
current state of the layout. For example, retrieving the width set to
'50%', while the parent has a width of 200px will result in the number
100 being returned.
When the node is not part of the layout, setting its size using percents refers to the size of the entire scene.
Examples
Inherited fromLayout.sizeskew
readonly public skew: Vector2SignalShape
Represents the skew of this node in local space of its parent.
Examples
Inherited fromLayout.skewstroke
readonly public stroke: CanvasStyleSignalShape
strokeFirst
readonly public strokeFirst: SimpleSignalbooleanShape
styles
public styles: CSSStyleDeclaration
Layout.stylestextAlign
readonly public textAlign: SimpleSignalCanvasTextAlignShape
Layout.textAligntextDirection
readonly public textDirection: SimpleSignalCanvasDirectionShape
Layout.textDirectiontextWrap
readonly public textWrap: SimpleSignalTextWrapShape
Layout.textWraptop
readonly public top: SimpleVector2SignalShape
The position of the top edge of this node.
When set, this shortcut property will modify the node's position so that the top edge ends up in the given place.
When retrieved, it will return the position of the top edge in the parent space.
Inherited fromLayout.toptopLeft
readonly public topLeft: SimpleVector2SignalShape
The position of the top left corner of this node.
When set, this shortcut property will modify the node's position so that the top left corner ends up in the given place.
When retrieved, it will return the position of the top left corner in the parent space.
Inherited fromLayout.topLefttopRight
readonly public topRight: SimpleVector2SignalShape
The position of the top right corner of this node.
When set, this shortcut property will modify the node's position so that the top right corner ends up in the given place.
When retrieved, it will return the position of the top right corner in the parent space.
Inherited fromLayout.topRightwrap
readonly public wrap: SimpleSignalFlexWrapShape
Layout.wrapzIndex
readonly public zIndex: SimpleSignalnumberShape
Layout.zIndexAccessors
columnGap
public get columnGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Layout.columnGapheight
public get height(): SignalLengthnumberthisSignalContextLengthnumberthis
Layout.heightrowGap
public get rowGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Layout.rowGapwidth
public get width(): SignalLengthnumberthisSignalContextLengthnumberthis
Layout.widthx
public get x(): SimpleSignalnumberthis
Layout.xy
public get y(): SimpleSignalnumberthis
Layout.yMethods
[iterator]
public [iterator](): Generatorkey: stringmeta: PropertyMetadataanysignal: SimpleSignalanyvoidvoidunknown
Layout.[iterator]absoluteOpacity
public absoluteOpacity(): number
Layout.absoluteOpacityadd
public addnode: ComponentChildren: Shape
Add the given node(s) as the children of this node.
The nodes will be appended at the end of the children list.
Examples
Parameters
node: ComponentChildrenA node or an array of nodes to append.
Layout.addanchorPosition
public anchorPosition(): Vector2
Layout.anchorPositionapplyState
public applyStatestate: NodeStateduration: numbertiming?: TimingFunction: ThreadGenerator
Apply the given state to the node, setting all matching signal values to the provided values.
Parameters
Inherited fromLayout.applyStatecacheBBox
public cacheBBox(): BBox
Get a bounding box for the contents rendered by this node as well as its children.
Inherited fromLayout.cacheBBoxchildAs
Get the nth children cast to the specified type.
Type Parameters
Parameters
index: numberThe index of the child to retrieve.
Layout.childAschildrenAs
Get the children array cast to the specified type.
Type Parameters
Inherited fromLayout.childrenAsclone
public clonecustomProps: NodeState = {}: Shape
Create a copy of this node.
Parameters
customProps: NodeState = {}Properties to override.
Layout.clonecompositeToLocal
public compositeToLocal(): DOMMatrix
Layout.compositeToLocalcompositeToWorld
public compositeToWorld(): DOMMatrix
A matrix mapping composite space to world space.
Certain effects such as blur and shadows ignore the current transformation. This matrix can be used to transform their parameters so that the effect appears relative to the closest composite root.
Inherited fromLayout.compositeToWorldcomputedPosition
public computedPosition(): Vector2
Layout.computedPositiondispose
public dispose(): void
Prepare this node to be disposed of.
This method is called automatically when a scene is refreshed. It will be called even if the node is not currently attached to the tree.
The goal of this method is to clean any external references to allow the node to be garbage collected.
Inherited fromLayout.disposedrawOverlay
public drawOverlaycontext: CanvasRenderingContext2Dmatrix: DOMMatrix: void
Draw an overlay for this node.
The overlay for the currently inspected node is displayed on top of the canvas.
The provided context is in screen space. The local-to-screen matrix can be used to transform all shapes that need to be displayed. This approach allows to keep the line widths and gizmo sizes consistent, no matter how zoomed-in the view is.
Parameters
context: CanvasRenderingContext2DThe context to draw with.
matrix: DOMMatrixA local-to-screen matrix.
Layout.drawOverlayfindAll
Find all descendants of this node that match the given predicate.
Type Parameters
Parameters
Inherited fromLayout.findAllfindAncestor
Find the closest ancestor of this node that matches the given predicate.
Type Parameters
Parameters
Inherited fromLayout.findAncestorfindFirst
Find the first descendant of this node that matches the given predicate.
Type Parameters
Parameters
Inherited fromLayout.findFirstfindLast
Find the last descendant of this node that matches the given predicate.
Type Parameters
Parameters
Inherited fromLayout.findLastgetOriginDelta
Parameters
Inherited fromLayout.getOriginDeltagetState
public getState(): NodeState
Return a snapshot of the node's current signal values.
This method will calculate the values of any reactive properties of the node at the time the method is called.
Inherited fromLayout.getStatehit
Try to find a node intersecting the given position.
Parameters
Inherited fromLayout.hitinsert
public insertnode: ComponentChildrenindex: number = 0: Shape
Insert the given node(s) at the specified index in the children list.
Examples
Parameters
node: ComponentChildrenA node or an array of nodes to insert.
index: number = 0An index at which to insert the node(s).
Layout.insertinstantiate
Create an instance of this node's class.
Parameters
Inherited fromLayout.instantiateisLayoutRoot
public isLayoutRoot(): boolean
Layout.isLayoutRootlayoutEnabled
public layoutEnabled(): boolean
Get the resolved layout mode of this node.
When the mode is null, its value will be inherited from the parent.
Use layout to get the raw mode set for this node (without
inheritance).
Layout.layoutEnabledlocalToParent
public localToParent(): DOMMatrix
Get the local-to-parent matrix for this node.
This matrix transforms vectors from local space of this node to local space of this node's parent.
Inherited fromLayout.localToParentlocalToWorld
public localToWorld(): DOMMatrix
Get the local-to-world matrix for this node.
This matrix transforms vectors from local space of this node to world space.
Examples
Inherited fromLayout.localToWorldlockSize
public lockSize(): void
Layout.lockSizemove
Rearrange this node in relation to its siblings.
Children are rendered starting from the beginning of the children list. We can change the rendering order by rearranging said list.
A positive by arguments move the node up (it will be rendered on top of
the elements it has passed). Negative values move it down.
Parameters
by: number = 1Number of places by which the node should be moved.
Layout.movemoveAbove
public moveAbovenode: NodedirectlyAbove: boolean = false: Shape
Move the node above the provided node in the parent's layout.
The node will be moved above the provided node and from then on will be rendered on top of it. By default, if the node is already positioned higher than the sibling node, it will not get moved.
Parameters
node: NodeThe sibling node below which to move.
directlyAbove: boolean = falseWhether the node should be positioned directly above the sibling. When true, will move the node even if it is already positioned above the sibling.
Layout.moveAbovemoveBelow
public moveBelownode: NodedirectlyBelow: boolean = false: Shape
Move the node below the provided node in the parent's layout.
The node will be moved below the provided node and from then on will be rendered below it. By default, if the node is already positioned lower than the sibling node, it will not get moved.
Parameters
node: NodeThe sibling node below which to move.
directlyBelow: boolean = falseWhether the node should be positioned directly below the sibling. When true, will move the node even if it is already positioned below the sibling.
Layout.moveBelowmoveDown
public moveDown(): Shape
Move the node down in relation to its siblings.
The node will exchange places with the sibling right below it (if any) and from then on will be rendered under it.
Inherited fromLayout.moveDownmoveOffset
Update the offset of this node and adjust the position to keep it in the same place.
Parameters
Inherited fromLayout.moveOffsetmoveTo
Move the node to the provided position relative to its siblings.
If the node is getting moved to a lower position, it will be placed below the sibling that's currently at the provided index (if any). If the node is getting moved to a higher position, it will be placed above the sibling that's currently at the provided index (if any).
Parameters
index: numberThe index to move the node to.
Layout.moveTomoveToBottom
public moveToBottom(): Shape
Move the node to the bottom in relation to its siblings.
The node will be placed at the beginning of the children list and from then on will be rendered below all of its siblings.
Inherited fromLayout.moveToBottommoveToTop
public moveToTop(): Shape
Move the node to the top in relation to its siblings.
The node will be placed at the end of the children list and from then on will be rendered on top of all of its siblings.
Inherited fromLayout.moveToTopmoveUp
public moveUp(): Shape
Move the node up in relation to its siblings.
The node will exchange places with the sibling right above it (if any) and from then on will be rendered on top of it.
Inherited fromLayout.moveUpparentAs
Get the parent cast to the specified type.
Type Parameters
Inherited fromLayout.parentAspeekChildren
public peekChildren(): readonly Node[]
Get the current children of this node.
Unlike children, this method does not have any side effects.
It does not register the children signal as a dependency, and it does not
spawn any children. It can be used to safely retrieve the current state of
the scene graph for debugging purposes.
Layout.peekChildrenreactiveClone
public reactiveClonecustomProps: NodeState = {}: Shape
Create a reactive copy of this node.
A reactive copy has all its properties dynamically updated to match the source node.
Parameters
customProps: NodeState = {}Properties to override.
Layout.reactiveClonereleaseSize
public releaseSize(): void
Layout.releaseSizeremove
public remove(): Shape
Remove this node from the tree.
Inherited fromLayout.removeremoveChildren
public removeChildren(): void
Remove all children of this node.
Inherited fromLayout.removeChildrenrender
public rendercontext: CanvasRenderingContext2D: Promisevoid
Render this node onto the given canvas.
Parameters
context: CanvasRenderingContext2DThe context to draw with.
Layout.renderreparent
Change the parent of this node while keeping the absolute transform.
After performing this operation, the node will stay in the same place visually, but its parent will be changed.
Parameters
Inherited fromLayout.reparentrestore
public restore(): void
public restoreduration: numbertiming?: TimingFunction: ThreadGenerator
Restore the node to its last saved state.
This method can be used together with the save method to restore a
node to a previously saved state. Restoring a node to a previous state
removes that state from the state stack.
Examples
Inherited fromLayout.restoreripple
public rippleduration: number = 1: GeneratorvoidThreadGeneratorPromiseanyPromisableanyvoidany
Parameters
duration: number = 1
save
public save(): void
Push a snapshot of the node's current state onto the node's state stack.
This method can be used together with the restore method to save a
node's current state and later restore it. It is possible to store more
than one state by calling save method multiple times.
Layout.savesnapshotClone
public snapshotClonecustomProps: NodeState = {}: Shape
Create a copy of this node.
Unlike clone, a snapshot clone calculates any reactive properties
at the moment of cloning and passes the raw values to the copy.
Parameters
customProps: NodeState = {}Properties to override.
Layout.snapshotClonetoPromise
Wait for any asynchronous resources that this node or its children have.
Certain resources like images are always loaded asynchronously. Awaiting this method makes sure that all such resources are done loading before continuing the animation.
Inherited fromLayout.toPromiseview
public view(): View2D
Layout.viewworldToLocal
public worldToLocal(): DOMMatrix
Get the world-to-local matrix for this node.
This matrix transforms vectors from world space to local space of this node.
Examples
Inherited fromLayout.worldToLocalworldToParent
public worldToParent(): DOMMatrix
Get the world-to-parent matrix for this node.
This matrix transforms vectors from world space to local space of this node's parent.
Inherited fromLayout.worldToParent