abstract class Bezier extends Curve
Extended by
CubicBezierQuadBezier
Constructors
constructor
Parameters
props: CurveProps
Curve.constructorProperties
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.absolutePositionabsoluteRotation
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.absoluteRotationabsoluteScale
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.absoluteScalealignContent
readonly public alignContent: SimpleSignalFlexContentBezier
Curve.alignContentalignItems
readonly public alignItems: SimpleSignalFlexItemsBezier
Curve.alignItemsalignSelf
readonly public alignSelf: SimpleSignalFlexItemsBezier
Curve.alignSelfantialiased
readonly public antialiased: SimpleSignalbooleanBezier
Curve.antialiasedarrowSize
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.arrowSizebasis
readonly public basis: SimpleSignalFlexBasisBezier
Curve.basisbottom
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.bottombottomLeft
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.bottomLeftbottomRight
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.bottomRightcache
readonly public cache: SimpleSignalbooleanBezier
Curve.cachecachePadding
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.cachePaddingchildren
readonly public children: SignalComponentChildrenNode[]BezierSignalContextComponentChildrenNode[]Bezier
Curve.childrenclip
readonly public clip: SimpleSignalbooleanBezier
Curve.clipclosed
readonly public closed: SimpleSignalbooleanBezier
Whether the curve should be closed.
Closed curves have their start and end points connected.
Inherited fromCurve.closedcomposite
readonly public composite: SimpleSignalbooleanBezier
Curve.compositecompositeOperation
readonly public compositeOperation: SimpleSignalGlobalCompositeOperationBezier
Curve.compositeOperationcreationStack
readonly public creationStack?: string
Curve.creationStackdirection
readonly public direction: SimpleSignalFlexDirectionBezier
Curve.directionelement
public element: HTMLElement
Curve.elementend
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.endendArrow
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.endArrowendOffset
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.endOffsetfill
readonly public fill: CanvasStyleSignalBezier
Curve.fillfilters
readonly public filters: FiltersSignalBezier
Curve.filtersfontFamily
readonly public fontFamily: SimpleSignalstringBezier
Curve.fontFamilyfontSize
readonly public fontSize: SimpleSignalnumberBezier
Curve.fontSizefontStyle
readonly public fontStyle: SimpleSignalstringBezier
Curve.fontStylefontWeight
readonly public fontWeight: SimpleSignalnumberBezier
Curve.fontWeightgap
readonly public gap: Vector2LengthSignalBezier
Curve.gapgrow
readonly public grow: SimpleSignalnumberBezier
Curve.growisClass
public isClass: boolean
Curve.isClassjustifyContent
readonly public justifyContent: SimpleSignalFlexContentBezier
Curve.justifyContentkey
readonly public key: string
Curve.keylayout
readonly public layout: SimpleSignalLayoutModeBezier
Curve.layoutleft
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.leftletterSpacing
readonly public letterSpacing: SimpleSignalnumberBezier
Curve.letterSpacinglineCap
readonly public lineCap: SimpleSignalCanvasLineCapBezier
Curve.lineCaplineDash
readonly public lineDash: SimpleSignalnumber[]Bezier
Curve.lineDashlineDashOffset
readonly public lineDashOffset: SimpleSignalnumberBezier
Curve.lineDashOffsetlineHeight
readonly public lineHeight: SimpleSignalLengthBezier
Curve.lineHeightlineJoin
readonly public lineJoin: SimpleSignalCanvasLineJoinBezier
Curve.lineJoinlineWidth
readonly public lineWidth: SimpleSignalnumberBezier
Curve.lineWidthmargin
readonly public margin: SpacingSignalBezier
Curve.marginmaxHeight
readonly public maxHeight: SimpleSignalLengthLimitBezier
Curve.maxHeightmaxWidth
readonly public maxWidth: SimpleSignalLengthLimitBezier
Curve.maxWidthmiddle
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.middleminHeight
readonly public minHeight: SimpleSignalLengthLimitBezier
Curve.minHeightminWidth
readonly public minWidth: SimpleSignalLengthLimitBezier
Curve.minWidthoffset
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.offsetopacity
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.opacitypadding
readonly public padding: SpacingSignalBezier
Curve.paddingparent
readonly public parent: SimpleSignalnullNodevoid = ...
Curve.parentposition
readonly public position: Vector2SignalBezier
Represents the position of this node in local space of its parent.
Examples
Inherited fromCurve.positionproperties
readonly public properties: RecordstringPropertyMetadataany = ...
Curve.propertiesratio
readonly public ratio: SimpleSignalnullnumberBezier
Curve.ratioright
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.rightrotation
readonly public rotation: SimpleSignalnumberBezier
Represents the rotation (in degrees) of this node relative to its parent.
Inherited fromCurve.rotationscale
readonly public scale: Vector2SignalBezier
Represents the scale of this node in local space of its parent.
Examples
Inherited fromCurve.scaleshaders
readonly public shaders: SignalPossibleShaderConfigShaderConfig[]BezierSignalContextPossibleShaderConfigShaderConfig[]Bezier
Curve.shadersshadowBlur
readonly public shadowBlur: SimpleSignalnumberBezier
Curve.shadowBlurshadowColor
readonly public shadowColor: ColorSignalBezier
Curve.shadowColorshadowOffset
readonly public shadowOffset: Vector2SignalBezier
Curve.shadowOffsetshrink
readonly public shrink: SimpleSignalnumberBezier
Curve.shrinksize
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.sizeskew
readonly public skew: Vector2SignalBezier
Represents the skew of this node in local space of its parent.
Examples
Inherited fromCurve.skewstart
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.startstartArrow
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.startArrowstartOffset
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.startOffsetstroke
readonly public stroke: CanvasStyleSignalBezier
Curve.strokestrokeFirst
readonly public strokeFirst: SimpleSignalbooleanBezier
Curve.strokeFirststyles
public styles: CSSStyleDeclaration
Curve.stylestextAlign
readonly public textAlign: SimpleSignalCanvasTextAlignBezier
Curve.textAligntextDirection
readonly public textDirection: SimpleSignalCanvasDirectionBezier
Curve.textDirectiontextWrap
readonly public textWrap: SimpleSignalTextWrapBezier
Curve.textWraptop
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.toptopLeft
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.topLefttopRight
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.topRightwrap
readonly public wrap: SimpleSignalFlexWrapBezier
Curve.wrapzIndex
readonly public zIndex: SimpleSignalnumberBezier
Curve.zIndexAccessors
columnGap
public get columnGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Curve.columnGapheight
public get height(): SignalLengthnumberthisSignalContextLengthnumberthis
Curve.heightrowGap
public get rowGap(): SignalLengthnumberthisSignalContextLengthnumberthis
Curve.rowGapwidth
public get width(): SignalLengthnumberthisSignalContextLengthnumberthis
Curve.widthx
public get x(): SimpleSignalnumberthis
Curve.xy
public get y(): SimpleSignalnumberthis
Curve.yMethods
[iterator]
public [iterator](): Generatorkey: stringmeta: PropertyMetadataanysignal: SimpleSignalanyvoidunknown
Curve.[iterator]absoluteOpacity
public absoluteOpacity(): number
Curve.absoluteOpacityadd
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: ComponentChildrenA node or an array of nodes to append.
Curve.addanchorPosition
public anchorPosition(): Vector2
Curve.anchorPositionapplyState
public applyStatestate: NodeState: void
public applyStatestate: NodeStateduration: numbertiming?: TimingFunction: ThreadGenerator
Apply the given state to the node, setting all matching signal values to the provided values.
Parameters
state: NodeStateThe state to apply to the node.
Curve.applyStatearcLength
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.arcLengthbaseArcLength
public baseArcLength(): number
The base arc length of this curve.
This is the entire length of this curve, not accounting for
the offsets.
Curve.baseArcLengthcacheBBox
public cacheBBox(): BBox
Get a bounding box for the contents rendered by this node as well as its children.
Inherited fromCurve.cacheBBoxcardinalPoint
public cardinalPointorigin: OriginDirection: SimpleVector2SignalBezier
Get the cardinal point corresponding to the given origin.
Parameters
Inherited fromCurve.cardinalPointchildAs
Get the nth children cast to the specified type.
Type Parameters
Parameters
index: numberThe index of the child to retrieve.
Curve.childAschildrenAs
Get the children array cast to the specified type.
Type Parameters
Inherited fromCurve.childrenAsclone
public clonecustomProps: NodeState = {}: Bezier
Create a copy of this node.
Parameters
customProps: NodeState = {}Properties to override.
Curve.clonecompletion
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.completioncompositeToLocal
public compositeToLocal(): DOMMatrix
Curve.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 fromCurve.compositeToWorldcomputedPosition
public computedPosition(): Vector2
Curve.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 fromCurve.disposedistanceToPercentage
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: numberThe distance along the curve.
Curve.distanceToPercentagedrawOverlay
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: CanvasRenderingContext2DThe context to draw with.
matrix: DOMMatrixA local-to-screen matrix.
Curve.drawOverlayfindAll
Find all descendants of this node that match the given predicate.
Type Parameters
Parameters
Inherited fromCurve.findAllfindAncestor
Find the closest ancestor of this node that matches the given predicate.
Type Parameters
Parameters
Inherited fromCurve.findAncestorfindFirst
Find the first descendant of this node that matches the given predicate.
Type Parameters
Parameters
Inherited fromCurve.findFirstfindLast
Find the last descendant of this node that matches the given predicate.
Type Parameters
Parameters
Inherited fromCurve.findLastgetOriginDelta
Parameters
Inherited fromCurve.getOriginDelta