Spline
class
Spline
extends
Curve
A node for drawing a smooth line through a number of points.
This node uses Bézier curves for drawing each segment of the spline.
Examples
Constructors
constructor
Parameters
-
props : SplineProps
Curve.constructor
Properties
absolutePosition
readonly
public
absolutePosition
:
SimpleVector2Signal
Spline
A helper signal for operating on the position in world space.
Retrieving the position using this signal returns the position in worldspace. Similarly, setting the position using this signal transforms thenew value to local space.
If the new value is a function, the position of this node will becontinuously 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 itfollow another node's position.
Unlike
position
, this signal is not compound - it doesn't containseparate signals for the
x
and
y
components.
Curve.absolutePosition
absoluteRotation
readonly
public
absoluteRotation
:
SimpleSignal
number
Spline
A helper signal for operating on the rotation in world space.
Retrieving the rotation using this signal returns the rotation in worldspace. Similarly, setting the rotation using this signal transforms thenew value to local space.
If the new value is a function, the rotation of this node will becontinuously updated to always match the rotation returned by the function.
Inherited from
Curve.absoluteRotation
absoluteScale
readonly
public
absoluteScale
:
SimpleVector2Signal
Spline
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 tolocal space.
If the new value is a function, the scale of this node will be continuouslyupdated to always match the position returned by the function.
Unlike
scale
, this signal is not compound - it doesn't containseparate signals for the
x
and
y
components.
Curve.absoluteScale
alignContent
readonly
public
alignContent
:
SimpleSignal
FlexContent
Spline
Curve.alignContent
alignItems
readonly
public
alignItems
:
SimpleSignal
FlexItems
Spline
Curve.alignItems
alignSelf
readonly
public
alignSelf
:
SimpleSignal
FlexItems
Spline
Curve.alignSelf
antialiased
readonly
public
antialiased
:
SimpleSignal
boolean
Spline
Curve.antialiased
arrowSize
readonly
public
arrowSize
:
SimpleSignal
number
Spline
Curve.arrowSize
basis
readonly
public
basis
:
SimpleSignal
FlexBasis
Spline
Curve.basis
cache
readonly
public
cache
:
SimpleSignal
boolean
Spline
Curve.cache
children
readonly
public
children
:
SimpleSignal
Node
[]
Spline
Curve.children
clip
readonly
public
clip
:
SimpleSignal
boolean
Spline
Curve.clip
closed
readonly
public
closed
:
SimpleSignal
boolean
Spline
Curve.closed
composite
readonly
public
composite
:
SimpleSignal
boolean
Spline
Curve.composite
compositeOperation
readonly
public
compositeOperation
:
SimpleSignal
GlobalCompositeOperation
Spline
Curve.compositeOperation
creationStack
readonly
public
creationStack
?:
string
Curve.creationStack
direction
readonly
public
direction
:
SimpleSignal
FlexDirection
Spline
Curve.direction
element
public
element
:
HTMLElement
Curve.element
end
readonly
public
end
:
SimpleSignal
number
Spline
Curve.end
endArrow
readonly
public
endArrow
:
SimpleSignal
boolean
Spline
Curve.endArrow
endOffset
readonly
public
endOffset
:
SimpleSignal
number
Spline
Curve.endOffset
fill
readonly
public
fill
:
CanvasStyleSignal
Spline
Curve.fill
filters
readonly
public
filters
:
FiltersSignal
Spline
Curve.filters
fontFamily
readonly
public
fontFamily
:
SimpleSignal
string
Spline
Curve.fontFamily
fontSize
readonly
public
fontSize
:
SimpleSignal
number
Spline
Curve.fontSize
fontStyle
readonly
public
fontStyle
:
SimpleSignal
string
Spline
Curve.fontStyle
fontWeight
readonly
public
fontWeight
:
SimpleSignal
number
Spline
Curve.fontWeight
gap
readonly
public
gap
:
Vector2LengthSignal
Spline
Curve.gap
grow
readonly
public
grow
:
SimpleSignal
number
Spline
Curve.grow
isClass
public
isClass
:
boolean
Curve.isClass
justifyContent
readonly
public
justifyContent
:
SimpleSignal
FlexContent
Spline
Curve.justifyContent
key
readonly
public
key
:
string
Curve.key
layout
readonly
public
layout
:
SimpleSignal
LayoutMode
Spline
Curve.layout
letterSpacing
readonly
public
letterSpacing
:
SimpleSignal
number
Spline
Curve.letterSpacing
lineCap
readonly
public
lineCap
:
SimpleSignal
CanvasLineCap
Spline
Curve.lineCap
lineDash
readonly
public
lineDash
:
SimpleSignal
number
[]
Spline
Curve.lineDash
lineDashOffset
readonly
public
lineDashOffset
:
SimpleSignal
number
Spline
Curve.lineDashOffset
lineHeight
readonly
public
lineHeight
:
SimpleSignal
Length
Spline
Curve.lineHeight
lineJoin
readonly
public
lineJoin
:
SimpleSignal
CanvasLineJoin
Spline
Curve.lineJoin
lineWidth
readonly
public
lineWidth
:
SimpleSignal
number
Spline
Curve.lineWidth
margin
readonly
public
margin
:
SpacingSignal
Spline
Curve.margin
maxHeight
readonly
public
maxHeight
:
SimpleSignal
LengthLimit
Spline
Curve.maxHeight
maxWidth
readonly
public
maxWidth
:
SimpleSignal
LengthLimit
Spline
Curve.maxWidth
minHeight
readonly
public
minHeight
:
SimpleSignal
LengthLimit
Spline
Curve.minHeight
minWidth
readonly
public
minWidth
:
SimpleSignal
LengthLimit
Spline
Curve.minWidth
offset
readonly
public
offset
:
Vector2Signal
Spline
Represents the offset of this node's origin.
By default, the origin of a node is located at its center. The originserves as the pivot point when rotating and scaling a node, but it doesn'taffect the placement of its children.
The value is relative to the size of this node. A value of
1
means as farto 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
:
SimpleSignal
number
Spline
Curve.opacity
padding
readonly
public
padding
:
SpacingSignal
Spline
Curve.padding
parent
readonly
public
parent
:
SimpleSignal
null
Node
void
=
...
Curve.parent
points
readonly
public
points
:
SimpleSignal
null
SignalValue
PossibleVector2
number
[]
Spline
position
readonly
public
position
:
Vector2Signal
Spline
Represents the position of this node in local space of its parent.
Examples
Inherited from
Curve.position
properties
readonly
public
properties
:
Record
string
PropertyMetadata
any
=
...
Curve.properties
ratio
readonly
public
ratio
:
SimpleSignal
null
number
Spline
Curve.ratio
rotation
readonly
public
rotation
:
SimpleSignal
number
Spline
Represents the rotation (in degrees) of this node relative to its parent.
Inherited from
Curve.rotation
scale
readonly
public
scale
:
Vector2Signal
Spline
Represents the scale of this node in local space of its parent.
Examples
Inherited from
Curve.scale
shadowBlur
readonly
public
shadowBlur
:
SimpleSignal
number
Spline
Curve.shadowBlur
shadowColor
readonly
public
shadowColor
:
ColorSignal
Spline
Curve.shadowColor
shadowOffset
readonly
public
shadowOffset
:
Vector2Signal
Spline
Curve.shadowOffset
shrink
readonly
public
shrink
:
SimpleSignal
number
Spline
Curve.shrink
size
readonly
public
size
:
Vector2LengthSignal
Spline
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 iseither:
-
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 thecurrent 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 percentsrefers to the size of the entire scene.
Examples
Inherited from
Curve.size
smoothness
readonly
public
smoothness
:
SimpleSignal
number
void
Determine the smoothness of the spline when using auto-calculated handles.
This property is only applied to knots that don't use explicit handles.
Default Value:0.4
start
readonly
public
start
:
SimpleSignal
number
Spline
Curve.start
startArrow
readonly
public
startArrow
:
SimpleSignal
boolean
Spline
Curve.startArrow
startOffset
readonly
public
startOffset
:
SimpleSignal
number
Spline
Curve.startOffset
stroke
readonly
public
stroke
:
CanvasStyleSignal
Spline
Curve.stroke
strokeFirst
readonly
public
strokeFirst
:
SimpleSignal
boolean
Spline
Curve.strokeFirst
styles
public
styles
:
CSSStyleDeclaration
Curve.styles
textAlign
readonly
public
textAlign
:
SimpleSignal
CanvasTextAlign
Spline
Curve.textAlign
textDirection
readonly
public
textDirection
:
SimpleSignal
CanvasDirection
Spline
Curve.textDirection
textWrap
readonly
public
textWrap
:
SimpleSignal
TextWrap
Spline
Curve.textWrap
wrap
readonly
public
wrap
:
SimpleSignal
FlexWrap
Spline
Curve.wrap
zIndex
readonly
public
zIndex
:
SimpleSignal
number
Spline
Curve.zIndex
Accessors
columnGap
Inherited from
Curve.columnGap
height
Inherited from
Curve.height
rowGap
Inherited from
Curve.rowGap
width
Inherited from
Curve.width
Methods
[iterator]
public
[iterator]
():
Generator
key
:
string
meta
:
PropertyMetadata
any
signal
:
SimpleSignal
any
void
void
unknown
Curve.__@iterator@68017
absoluteOpacity
public
absoluteOpacity
():
number
Curve.absoluteOpacity
add
public
add
node
:
ComponentChildren
:
Spline
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.
Curve.add
anchorPosition
public
anchorPosition
():
Vector2
Curve.anchorPosition
applyState
Apply the given state to the node, setting all matching signal values tothe provided values.
Parameters
Inherited from
Curve.applyState
cacheBBox
public
cacheBBox
():
BBox
Get a bounding box for the contents rendered by this node as wellas its children.
Inherited from
Curve.cacheBBox
clone
public
clone
customProps
:
NodeProps
=
{}
:
Spline
Create a copy of this node.
Parameters
-
customProps : NodeProps = {}Properties to override.
Curve.clone
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 effectappears relative to the closes composite root.
Inherited from
Curve.compositeToWorld
computedPosition
public
computedPosition
():
Vector2
Curve.computedPosition
dispose
public
dispose
():
void
Curve.dispose
drawOverlay
public
override
drawOverlay
context
:
CanvasRenderingContext2D
matrix
:
DOMMatrix
:
void
Parameters
Overwrites
Curve.drawOverlay
getOriginDelta
public
getOriginDelta
origin
:
Origin
:
Vector2
Parameters
-
origin : Origin
Curve.getOriginDelta
getPointAtPercentage
public
getPointAtPercentage
value
:
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 thenode at the time the method is called.
Inherited from
Curve.getState
hit
public
hit
position
:
Vector2
:
null
Node
Parameters
-
position : Vector2
Curve.hit
insert
public
insert
node
:
ComponentChildren
index
:
number
=
0
:
Spline
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).
Curve.insert
instantiate
public
instantiate
props
:
NodeProps
=
{}
:
Spline
Create an instance of this node's class.
Parameters
-
props : NodeProps = {}Properties to pass to the constructor.
Curve.instantiate
isLayoutRoot
public
isLayoutRoot
():
boolean
Curve.isLayoutRoot
knots
public
knots
():
KnotInfo
[]
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 (withoutinheritance).
Curve.layoutEnabled
localToParent
public
localToParent
():
DOMMatrix
Curve.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 worldspace.
Examples
Inherited from
Curve.localToWorld
lockSize
public
lockSize
():
void
Curve.lockSize
move
public
move
by
:
number
=
1
:
Spline
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 ofthe elements it has passed). Negative values move it down.
Parameters
-
by : number = 1Number of places by which the node should be moved.
Curve.move
moveAbove
public
moveAbove
node
:
Node
directlyAbove
:
boolean
=
false
:
Spline
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 berendered on top of it. By default, if the node is already positionedhigher 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 thesibling. When true, will move the node even if it isalready positioned above the sibling.
Curve.moveAbove
moveBelow
public
moveBelow
node
:
Node
directlyBelow
:
boolean
=
false
:
Spline
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 berendered below it. By default, if the node is already positioned lower thanthe 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 belowthe sibling. When true, will move the node even ifit is already positioned below the sibling.
Curve.moveBelow
moveDown
public
moveDown
():
Spline
Move the node down in relation to its siblings.
The node will exchange places with the sibling right below it (if any) andfrom then on will be rendered under it.
Inherited from
Curve.moveDown
moveOffset
public
moveOffset
offset
:
Vector2
:
void
Update the offset of this node and adjust the position to keep it in thesame place.
Parameters
-
offset : Vector2The new offset.
Curve.moveOffset
moveTo
public
moveTo
index
:
number
:
Spline
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 belowthe sibling that's currently at the provided index (if any).If the node is getting moved to a higher position, it will be placed abovethe sibling that's currently at the provided index (if any).
Parameters
-
index : numberThe index to move the node to.
Curve.moveTo
moveToBottom
public
moveToBottom
():
Spline
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 thenon will be rendered below all of its siblings.
Inherited from
Curve.moveToBottom
moveToTop
public
moveToTop
():
Spline
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 onwill be rendered on top of all of its siblings.
Inherited from
Curve.moveToTop
moveUp
public
moveUp
():
Spline
Move the node up in relation to its siblings.
The node will exchange places with the sibling right above it (if any) andfrom then on will be rendered on top of it.
Inherited from
Curve.moveUp
percentageToDistance
public
percentageToDistance
value
:
number
:
number
Parameters
-
value : number
Curve.percentageToDistance
profile
public
override
profile
():
CurveProfile
Curve.profile
reactiveClone
public
reactiveClone
customProps
:
NodeProps
=
{}
:
Spline
Create a reactive copy of this node.
A reactive copy has all its properties dynamically updated to match thesource node.
Parameters
-
customProps : NodeProps = {}Properties to override.
Curve.reactiveClone
releaseSize
public
releaseSize
():
void
Curve.releaseSize
remove
public
remove
():
Spline
Remove this node from the tree.
Inherited from
Curve.remove
removeChildren
public
removeChildren
():
void
Remove all children of this node.
Inherited from
Curve.removeChildren
render
public
render
context
:
CanvasRenderingContext2D
:
void
Render this node onto the given canvas.
Parameters
-
context : CanvasRenderingContext2DThe context to draw with.
Curve.render
reparent
public
reparent
newParent
:
Node
:
void
Change the parent of this node while keeping the absolute transform.
After performing this operation, the node will stay in the same placevisually, but its parent will be changed.
Parameters
-
newParent : NodeThe new parent of this node.
Curve.reparent
restore
public
restore
duration
:
number
timing
:
TimingFunction
=
easeInOutCubic
:
undefined
ThreadGenerator
Restore the node to its last saved state.
This method can be used together with the
save
method to restore anode to a previously saved state. Restoring a node to a previous stateremoves that state from the state stack.
Examples
Parameters
-
duration : numberThe duration of the transition
-
timing : TimingFunction = easeInOutCubicThe timing function to use for the transition
Curve.restore
ripple
public
ripple
duration
:
number
=
1
:
Generator
void
ThreadGenerator
Promise
any
Promisable
any
void
any
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 anode's current state and later restore it. It is possible to store morethan one state by calling
save
method multiple times.
Curve.save
snapshotClone
public
snapshotClone
customProps
:
NodeProps
=
{}
:
Spline
Create a copy of this node.
Unlike
clone
, a snapshot clone calculates any reactive propertiesat the moment of cloning and passes the raw values to the copy.
Parameters
-
customProps : NodeProps = {}Properties to override.
Curve.snapshotClone
toPromise
public
toPromise
():
Promise
Spline
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 loadingbefore continuing the animation.
Inherited from
Curve.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 thisnode.
Examples
Inherited from
Curve.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 thisnode's parent.
Inherited from
Curve.worldToParent