class Polygon extends Curve
A node for drawing regular polygons.
This node can be used to render shapes such as: triangle, pentagon, hexagon and more.
Note that the polygon is inscribed in a circle defined by the height and width. If height and width are unequal, the polygon is inscribed in the resulting ellipse.
Since the polygon is inscribed in the circle, the actual displayed height and width may differ somewhat from the bounding rectangle. This will be particularly noticeable if the number of sides is low, e.g. for a triangle.
import ...
export default makeScene2D(function* (view) {
const ref = createRef<Polygon>();
view.add(
<Polygon
ref={ref}
sides={6}
size={160}
fill={'lightseagreen'}
/>
);
yield* ref().sides(3, 2).to(6, 2);
});
Constructors
constructor
Parameters
props: PolygonProps
Curve.constructorProperties
absolutePosition
readonly public absolutePosition: SimpleVector2SignalPolygon
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: SimpleSignalnumberPolygon
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: SimpleVector2SignalPolygon
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: SimpleSignalFlexContentPolygon
Curve.alignContentalignItems
readonly public alignItems: SimpleSignalFlexItemsPolygon
Curve.alignItemsalignSelf
readonly public alignSelf: SimpleSignalFlexItemsPolygon
Curve.alignSelfantialiased
readonly public antialiased: SimpleSignalbooleanPolygon
Curve.antialiasedarrowSize
readonly public arrowSize: SimpleSignalnumberPolygon
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: SimpleSignalFlexBasisPolygon
Curve.basisbottom
readonly public bottom: SimpleVector2SignalPolygon
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: SimpleVector2SignalPolygon
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: SimpleVector2SignalPolygon
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: SimpleSignalbooleanPolygon
Curve.cachecachePadding
readonly public cachePadding: SpacingSignalPolygon
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[]PolygonSignalContextComponentChildrenNode[]Polygon
Curve.childrenclip
readonly public clip: SimpleSignalbooleanPolygon
Curve.clipclosed
readonly public closed: SimpleSignalbooleanPolygon
Whether the curve should be closed.
Closed curves have their start and end points connected.
Inherited fromCurve.closedcomposite
readonly public composite: SimpleSignalbooleanPolygon
Curve.compositecompositeOperation
readonly public compositeOperation: SimpleSignalGlobalCompositeOperationPolygon
Curve.compositeOperationcreationStack
readonly public creationStack?: string
Curve.creationStackdirection
readonly public direction: SimpleSignalFlexDirectionPolygon
Curve.directionelement
public element: HTMLElement
Curve.elementend
readonly public end: SimpleSignalnumberPolygon
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: SimpleSignalbooleanPolygon
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: SimpleSignalnumberPolygon
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: CanvasStyleSignalPolygon
Curve.fillfilters
readonly public filters: FiltersSignalPolygon
Curve.filtersfontFamily
readonly public fontFamily: SimpleSignalstringPolygon
Curve.fontFamilyfontSize
readonly public fontSize: SimpleSignalnumberPolygon
Curve.fontSizefontStyle
readonly public fontStyle: SimpleSignalstringPolygon
Curve.fontStylefontWeight
readonly public fontWeight: SimpleSignalnumberPolygon
Curve.fontWeightgap
readonly public gap: Vector2LengthSignalPolygon
Curve.gapgrow
readonly public grow: SimpleSignalnumberPolygon
Curve.growisClass
public isClass: boolean
Curve.isClass