@revideo/2d

@revideo/2d / components / KnotProps

Interface: KnotProps

Defined in: 2d/src/lib/components/Knot.ts:21 

Extends

• NodeProps

Properties

auto?

optional auto?: SignalValue<PossibleKnotAuto>

Defined in: 2d/src/lib/components/Knot.ts:33 

How much to blend between the user-provided handles and the auto-calculated handles.

Remarks

This property has no effect if no explicit handles are provided for the knot.

cache?

optional cache?: SignalValue<boolean>

Defined in: 2d/src/lib/components/Node.ts:99 

Inherited from

NodeProps.cache

cachePadding?

optional cachePadding?: SignalValue<PossibleSpacing>

Defined in: 2d/src/lib/components/Node.ts:119 

Controls the padding of the cached canvas used by this node.

Remarks

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.

Inherited from

NodeProps.cachePadding

cachePaddingBottom?

optional cachePaddingBottom?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:107 

Controls the padding of the cached canvas used by this node.

Remarks

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.

Inherited from

NodeProps.cachePaddingBottom

cachePaddingLeft?

optional cachePaddingLeft?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:111 

Controls the padding of the cached canvas used by this node.

Remarks

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.

Inherited from

NodeProps.cachePaddingLeft

cachePaddingRight?

optional cachePaddingRight?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:115 

Controls the padding of the cached canvas used by this node.

Remarks

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.

Inherited from

NodeProps.cachePaddingRight

cachePaddingTop?

optional cachePaddingTop?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:103 

Controls the padding of the cached canvas used by this node.

Remarks

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.

Inherited from

NodeProps.cachePaddingTop

children?

optional children?: SignalValue<ComponentChildren>

Defined in: 2d/src/lib/components/Node.ts:71 

Inherited from

NodeProps.children

composite?

optional composite?: SignalValue<boolean>

Defined in: 2d/src/lib/components/Node.ts:121 

Inherited from

NodeProps.composite

compositeOperation?

optional compositeOperation?: SignalValue<GlobalCompositeOperation>

Defined in: 2d/src/lib/components/Node.ts:122 

Inherited from

NodeProps.compositeOperation

endHandle?

optional endHandle?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Knot.ts:29 

The position of the knot’s end handle. The position is provided relative to the knot’s position.

Remarks

By default, the position of the end handle will be the mirrored position of the startHandle.

If neither an end handle nor a start handle is provided, the positions of the handles gets calculated automatically to create smooth curve through the knot. The smoothness of the resulting curve can be controlled via the Spline.smoothness property.

It is also possible to blend between a user-defined position and the auto-calculated position by using the auto property.

endHandleAuto?

optional endHandleAuto?: SignalValue<number>

Defined in: 2d/src/lib/components/Knot.ts:35 

filters?

optional filters?: SignalValue<Filter[]>

Defined in: 2d/src/lib/components/Node.ts:91 

Inherited from

NodeProps.filters

key?

optional key?: string

Defined in: 2d/src/lib/components/Node.ts:76 

Inherited from

NodeProps.key

opacity?

optional opacity?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:90 

Inherited from

NodeProps.opacity

position?

optional position?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Node.ts:80 

Inherited from

NodeProps.position

ref?

optional ref?: ReferenceReceiver<any>

Defined in: 2d/src/lib/components/Node.ts:70 

Inherited from

NodeProps.ref

rotation?

optional rotation?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:81 

Inherited from

NodeProps.rotation

scale?

optional scale?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Node.ts:84 

Inherited from

NodeProps.scale

scaleX?

optional scaleX?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:82 

Inherited from

NodeProps.scaleX

scaleY?

optional scaleY?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:83 

Inherited from

NodeProps.scaleY

shaders?

optional shaders?: PossibleShaderConfig

Defined in: 2d/src/lib/components/Node.ts:126 

Experimental

Inherited from

NodeProps.shaders

shadowBlur?

optional shadowBlur?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:94 

Inherited from

NodeProps.shadowBlur

shadowColor?

optional shadowColor?: SignalValue<PossibleColor>

Defined in: 2d/src/lib/components/Node.ts:93 

Inherited from

NodeProps.shadowColor

shadowOffset?

optional shadowOffset?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Node.ts:97 

Inherited from

NodeProps.shadowOffset

shadowOffsetX?

optional shadowOffsetX?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:95 

Inherited from

NodeProps.shadowOffsetX

shadowOffsetY?

optional shadowOffsetY?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:96 

Inherited from

NodeProps.shadowOffsetY

skew?

optional skew?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Node.ts:87 

Inherited from

NodeProps.skew

skewX?

optional skewX?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:85 

Inherited from

NodeProps.skewX

skewY?

optional skewY?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:86 

Inherited from

NodeProps.skewY

spawner?

optional spawner?: SignalValue<ComponentChildren>

Defined in: 2d/src/lib/components/Node.ts:75 

Deprecated

Use children instead.

Inherited from

NodeProps.spawner

startHandle?

optional startHandle?: SignalValue<PossibleVector2>

Defined in: 2d/src/lib/components/Knot.ts:25 

The position of the knot’s start handle. The position is provided relative to the knot’s position.

Remarks

By default, the position of the start handle will be the mirrored position of the endHandle.

If neither an end handle nor a start handle is provided, the positions of the handles gets calculated automatically to create smooth curve through the knot. The smoothness of the resulting curve can be controlled via the Spline.smoothness property.

It is also possible to blend between a user-defined position and the auto-calculated position by using the auto property.

startHandleAuto?

optional startHandleAuto?: SignalValue<number>

Defined in: 2d/src/lib/components/Knot.ts:34 

x?

optional x?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:78 

Inherited from

NodeProps.x

y?

optional y?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:79 

Inherited from

NodeProps.y

zIndex?

optional zIndex?: SignalValue<number>

Defined in: 2d/src/lib/components/Node.ts:88 

Inherited from

NodeProps.zIndex