Bezier
abstract class Bezier extends Curve
Extended by
Constructors
constructor
public new Bezierprops: CurveProps: Bezier
Parameters
Inherited fromCurve.constructor
Properties
absolutePosition
readonly public absolutePosition: SimpleVector2SignalBezier
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.
Curve.absolutePosition
absoluteRotation
readonly public absoluteRotation: SimpleSignalnumberBezier
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 fromCurve.absoluteRotation
absoluteScale
readonly public absoluteScale: SimpleVector2SignalBezier
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.
Curve.absoluteScale
alignContent
readonly public alignContent: SimpleSignalFlexContentBezier
Curve.alignContent
alignItems
readonly public alignItems: SimpleSignalFlexItemsBezier
Curve.alignItems
alignSelf
readonly public alignSelf: SimpleSignalFlexItemsBezier
Curve.alignSelf
antialiased
readonly public antialiased: SimpleSignalbooleanBezier
Curve.antialiased
arrowSize
readonly public arrowSize: SimpleSignalnumberBezier
Controls the size of the end and start arrows.
To make the arrows visible make sure to enable startArrow
and/or
endArrow
.
Curve.arrowSize
basis
readonly public basis: SimpleSignalFlexBasisBezier
Curve.basis
bottom
readonly public bottom: SimpleVector2SignalBezier
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 fromCurve.bottom
bottomLeft
readonly public bottomLeft: SimpleVector2SignalBezier
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 fromCurve.bottomLeft
bottomRight
readonly public bottomRight: SimpleVector2SignalBezier
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 fromCurve.bottomRight
cache
readonly public cache: SimpleSignalbooleanBezier
Curve.cache
cachePadding
readonly public cachePadding: SpacingSignalBezier
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
.
Curve.cachePadding
children
readonly public children: SignalComponentChildrenNode[]BezierSignalContextComponentChildrenNode[]Bezier
Curve.children
clip
readonly public clip: SimpleSignalbooleanBezier
Curve.clip
closed
readonly public closed: SimpleSignalbooleanBezier
Whether the curve should be closed.
Closed curves have their start and end points connected.
Inherited fromCurve.closed
composite
readonly public composite: SimpleSignalbooleanBezier
Curve.composite
compositeOperation
readonly public compositeOperation: SimpleSignalGlobalCompositeOperationBezier
Curve.compositeOperation
creationStack
readonly public creationStack?: string
Curve.creationStack
direction
readonly public direction: SimpleSignalFlexDirectionBezier
Curve.direction
element
public element: HTMLElement
Curve.element
end
readonly public end: SimpleSignalnumberBezier
A percentage from the start after which the curve should be clipped.
The portion of the curve that comes after the given percentage will be made invisible.
This property is usefully for animating the curve appearing on the screen.
The value of 0
means the very start of the curve (accounting for the
startOffset
) while 1
means the very end (accounting for the
endOffset
).
Curve.end
endArrow
readonly public endArrow: SimpleSignalbooleanBezier
Whether to display an arrow at the end of the visible curve.
Use arrowSize
to control the size of the arrow.
Curve.endArrow
endOffset
readonly public endOffset: SimpleSignalnumberBezier
The offset in pixels from the end of the curve.
This property lets you specify where along the defined curve the actual
visible portion ends. For example, setting it to 20
will make the last
20 pixels of the curve invisible.
This property is useful for trimming the curve using a fixed distance.
If you want to animate the curve appearing on the screen, use end
instead.
Curve.endOffset
fill
readonly public fill: CanvasStyleSignalBezier
Curve.fill
filters
readonly public filters: FiltersSignalBezier
Curve.filters
fontFamily
readonly public fontFamily: SimpleSignalstringBezier
Curve.fontFamily
fontSize
readonly public fontSize: SimpleSignalnumberBezier
Curve.fontSize
fontStyle
readonly public fontStyle: SimpleSignalstringBezier
Curve.fontStyle
fontWeight
readonly public fontWeight: SimpleSignalnumberBezier
Curve.fontWeight
gap
readonly public gap: Vector2LengthSignalBezier
Curve.gap
grow
readonly public grow: SimpleSignalnumberBezier
Curve.grow
isClass
public isClass: boolean
Curve.isClass
justifyContent
readonly public justifyContent: SimpleSignalFlexContentBezier
Curve.justifyContent
key
readonly public key: string
Curve.key
layout
readonly public layout: SimpleSignalLayoutModeBezier
Curve.layout
left
readonly public left: SimpleVector2SignalBezier
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 fromCurve.left
letterSpacing
readonly public letterSpacing: SimpleSignalnumberBezier
Curve.letterSpacing
lineCap
readonly public lineCap: SimpleSignalCanvasLineCapBezier
Curve.lineCap
lineDash
readonly public lineDash: SimpleSignalnumber[]Bezier
Curve.lineDash
lineDashOffset
readonly public lineDashOffset: SimpleSignalnumberBezier
Curve.lineDashOffset
lineHeight
readonly public lineHeight: SimpleSignalLengthBezier
Curve.lineHeight
lineJoin
readonly public lineJoin: SimpleSignalCanvasLineJoinBezier
Curve.lineJoin
lineWidth
readonly public lineWidth: SimpleSignalnumberBezier
Curve.lineWidth
margin
readonly public margin: SpacingSignalBezier
Curve.margin
maxHeight
readonly public maxHeight: SimpleSignalLengthLimitBezier
Curve.maxHeight
maxWidth
readonly public maxWidth: SimpleSignalLengthLimitBezier
Curve.maxWidth
middle
readonly public middle: SimpleVector2SignalBezier
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 fromCurve.middle
minHeight
readonly public minHeight: SimpleSignalLengthLimitBezier
Curve.minHeight
minWidth
readonly public minWidth: SimpleSignalLengthLimitBezier
Curve.minWidth
offset
readonly public offset: Vector2SignalBezier
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
Curve.offset
opacity
readonly public opacity: SimpleSignalnumberBezier
Represents the opacity of this node in the range 0-1.
The value is clamped to the range 0-1.
Inherited fromCurve.opacity
padding
readonly public padding: SpacingSignalBezier
Curve.padding
parent
readonly public parent: SimpleSignalnullNodevoid = ...
Curve.parent
position
readonly public position: Vector2SignalBezier
Represents the position of this node in local space of its parent.
Examples
Inherited fromCurve.position
properties
readonly public properties: RecordstringPropertyMetadataany = ...
Curve.properties
ratio
readonly public ratio: SimpleSignalnullnumberBezier
Curve.ratio
right
readonly public right: SimpleVector2SignalBezier
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 fromCurve.right
rotation
readonly public rotation: SimpleSignalnumberBezier
Represents the rotation (in degrees) of this node relative to its parent.
Inherited fromCurve.rotation
scale
readonly public scale: Vector2SignalBezier
Represents the scale of this node in local space of its parent.
Examples
Inherited fromCurve.scale
shaders
readonly public shaders: SignalPossibleShaderConfigShaderConfig[]BezierSignalContextPossibleShaderConfigShaderConfig[]Bezier
Curve.shaders
shadowBlur
readonly public shadowBlur: SimpleSignalnumberBezier
Curve.shadowBlur
shadowColor
readonly public shadowColor: ColorSignalBezier
Curve.shadowColor
shadowOffset
readonly public shadowOffset: Vector2SignalBezier
Curve.shadowOffset
shrink
readonly public shrink: SimpleSignalnumberBezier
Curve.shrink
size
readonly public size: Vector2LengthSignalBezier
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 fromCurve.size
skew
readonly public skew: Vector2SignalBezier
Represents the skew of this node in local space of its parent.
Examples
Inherited fromCurve.skew
start
readonly public start: SimpleSignalnumberBezier
A percentage from the start before which the curve should be clipped.
The portion of the curve that comes before the given percentage will be made invisible.
This property is usefully for animating the curve appearing on the screen.
The value of 0
means the very start of the curve (accounting for the
startOffset
) while 1
means the very end (accounting for the
endOffset
).
Curve.start
startArrow
readonly public startArrow: SimpleSignalbooleanBezier
Whether to display an arrow at the start of the visible curve.
Use arrowSize
to control the size of the arrow.
Curve.startArrow
startOffset
readonly public startOffset: SimpleSignalnumberBezier
The offset in pixels from the start of the curve.
This property lets you specify where along the defined curve the actual
visible portion starts. For example, setting it to 20
will make the first
20 pixels of the curve invisible.
This property is useful for trimming the curve using a fixed distance.
If you want to animate the curve appearing on the screen, use start
instead.
Curve.startOffset
stroke
readonly public stroke: CanvasStyleSignalBezier
Curve.stroke
strokeFirst
readonly public strokeFirst: SimpleSignalbooleanBezier
Curve.strokeFirst
styles
public styles: CSSStyleDeclaration
Curve.styles
textAlign
readonly public textAlign: SimpleSignalCanvasTextAlignBezier
Curve.textAlign
textDirection
readonly public textDirection: SimpleSignalCanvasDirectionBezier
Curve.textDirection
textWrap
readonly public textWrap: SimpleSignalTextWrapBezier
Curve.textWrap
top
readonly public top: SimpleVector2SignalBezier
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 fromCurve.top
topLeft
readonly public topLeft: SimpleVector2SignalBezier
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 fromCurve.topLeft
topRight
readonly public topRight: SimpleVector2SignalBezier
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 fromCurve.topRight
wrap
readonly public wrap: SimpleSignalFlexWrapBezier
Curve.wrap
zIndex
readonly public zIndex: SimpleSignalnumberBezier
Curve.zIndex
Accessors
columnGap
public get columnGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Curve.columnGap
height
public get height(): SignalLengthnumberthisSignalContextLengthnumberthis
Curve.height
rowGap
public get rowGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Curve.rowGap
width
public get width(): SignalLengthnumberthisSignalContextLengthnumberthis
Curve.width
x
public get x(): SimpleSignalnumberthis
Curve.x
y
public get y(): SimpleSignalnumberthis
Curve.y
Methods
[iterator]
public [iterator](): Generatorkey: stringmeta: PropertyMetadataanysignal: SimpleSignalanyvoidvoidunknown
Curve.[iterator]
absoluteOpacity
public absoluteOpacity(): number
Curve.absoluteOpacity
add
public addnode: ComponentChildren: Bezier
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: ComponentChildren
A node or an array of nodes to append.
Curve.add
anchorPosition
public anchorPosition(): Vector2
Curve.anchorPosition
applyState
public applyStatestate: NodeStateduration: numbertiming?: TimingFunction: ThreadGenerator
Apply the given state to the node, setting all matching signal values to the provided values.
Parameters
Inherited fromCurve.applyState
arcLength
public arcLength(): number
The visible arc length of this curve.
This arc length accounts for both the offset and the start
and
end
properties.
Curve.arcLength
baseArcLength
public baseArcLength(): number
The base arc length of this curve.
This is the entire length of this curve, not accounting for
the offsets
.
Curve.baseArcLength
cacheBBox
public cacheBBox(): BBox
Get a bounding box for the contents rendered by this node as well as its children.
Inherited fromCurve.cacheBBox
childAs
Get the nth children cast to the specified type.
Type Parameters
Parameters
index: number
The index of the child to retrieve.
Curve.childAs
childrenAs
Get the children array cast to the specified type.
Type Parameters
Inherited fromCurve.childrenAs
clone
public clonecustomProps: NodeState = {}: Bezier
Create a copy of this node.
Parameters
customProps: NodeState = {}
Properties to override.
Curve.clone
completion
public completion(): number
The percentage of the curve that's currently visible.
The returned value is the ratio between the visible length (as defined by
start
and end
) and the offset length of the curve.
Curve.completion
compositeToLocal
public compositeToLocal(): DOMMatrix
Curve.compositeToLocal
compositeToWorld
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 fromCurve.compositeToWorld
computedPosition
public computedPosition(): Vector2
Curve.computedPosition
dispose
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 fromCurve.dispose
distanceToPercentage
public distanceToPercentagevalue: number: number
Convert a distance along the curve to a percentage.
The distance should be given in relation to the full curve, not
accounting for startOffset
and endOffset
.
Parameters
value: number
The distance along the curve.
Curve.distanceToPercentage
drawOverlay
public override 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: CanvasRenderingContext2D
The context to draw with.
matrix: DOMMatrix
A local-to-screen matrix.
Curve.drawOverlay
findAll
Find all descendants of this node that match the given predicate.
Type Parameters
Parameters
Inherited fromCurve.findAll
findAncestor
Find the closest ancestor of this node that matches the given predicate.
Type Parameters
Parameters
Inherited fromCurve.findAncestor
findFirst
Find the first descendant of this node that matches the given predicate.
Type Parameters
Parameters
Inherited fromCurve.findFirst
findLast
Find the last descendant of this node that matches the given predicate.
Type Parameters
Parameters
Inherited fromCurve.findLast
getOriginDelta
Parameters
Inherited fromCurve.getOriginDelta
getPointAtPercentage
public getPointAtPercentagevalue: number: CurvePoint
Parameters
value: number
Curve.getPointAtPercentage
getState
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 fromCurve.getState
hit
Try to find a node intersecting the given position.
Parameters
Inherited fromCurve.hit
insert
public insertnode: ComponentChildrenindex: number = 0: Bezier
Insert the given node(s) at the specified index in the children list.
Examples
Parameters
node: ComponentChildren
A node or an array of nodes to insert.
index: number = 0
An index at which to insert the node(s).
Curve.insert
instantiate
Create an instance of this node's class.
Parameters
Inherited fromCurve.instantiate
isLayoutRoot
public isLayoutRoot(): boolean
Curve.isLayoutRoot
layoutEnabled
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).
Curve.layoutEnabled
localToParent
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 fromCurve.localToParent
localToWorld
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 fromCurve.localToWorld
lockSize
public lockSize(): void
Curve.lockSize
move
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 = 1
Number of places by which the node should be moved.
Curve.move
moveAbove
public moveAbovenode: NodedirectlyAbove: boolean = false: Bezier
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: Node
The sibling node below which to move.
directlyAbove: boolean = false
Whether the node should be positioned directly above the sibling. When true, will move the node even if it is already positioned above the sibling.
Curve.moveAbove
moveBelow
public moveBelownode: NodedirectlyBelow: boolean = false: Bezier
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: Node
The sibling node below which to move.
directlyBelow: boolean = false
Whether the node should be positioned directly below the sibling. When true, will move the node even if it is already positioned below the sibling.
Curve.moveBelow
moveDown
public moveDown(): Bezier
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 fromCurve.moveDown
moveOffset
Update the offset of this node and adjust the position to keep it in the same place.
Parameters
Inherited fromCurve.moveOffset
moveTo
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: number
The index to move the node to.
Curve.moveTo
moveToBottom
public moveToBottom(): Bezier
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 fromCurve.moveToBottom
moveToTop
public moveToTop(): Bezier
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 fromCurve.moveToTop
moveUp
public moveUp(): Bezier
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 fromCurve.moveUp
offsetArcLength
public offsetArcLength(): number
The offset arc length of this curve.
This is the length of the curve that accounts for
the offsets
.
Curve.offsetArcLength
parentAs
Get the parent cast to the specified type.
Type Parameters
Inherited fromCurve.parentAs
peekChildren
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.
Curve.peekChildren
percentageToDistance
public percentageToDistancevalue: number: number
Convert a percentage along the curve to a distance.
The returned distance is given in relation to the full curve, not
accounting for startOffset
and endOffset
.
Parameters
value: number
The percentage along the curve.
Curve.percentageToDistance
profile
public override profile(): CurveProfile
Curve.profile
reactiveClone
public reactiveClonecustomProps: NodeState = {}: Bezier
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.
Curve.reactiveClone
releaseSize
public releaseSize(): void
Curve.releaseSize
remove
public remove(): Bezier
Remove this node from the tree.
Inherited fromCurve.remove
removeChildren
public removeChildren(): void
Remove all children of this node.
Inherited fromCurve.removeChildren
render
public rendercontext: CanvasRenderingContext2D: Promisevoid
Render this node onto the given canvas.
Parameters
context: CanvasRenderingContext2D
The context to draw with.
Curve.render
reparent
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 fromCurve.reparent
restore
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 fromCurve.restore
ripple
public rippleduration: number = 1: GeneratorvoidThreadGeneratorPromiseanyPromisableanyvoidany
Parameters
duration: number = 1
Curve.ripple
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.
Curve.save
snapshotClone
public snapshotClonecustomProps: NodeState = {}: Bezier
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.
Curve.snapshotClone
toPromise
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 fromCurve.toPromise
view
public view(): View2D
Curve.view
worldToLocal
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 fromCurve.worldToLocal
worldToParent
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 fromCurve.worldToParent