Documentation / @ripl/3d / PlaneState
Interface: PlaneState
Defined in: 3d/src/elements/plane.ts:12
State interface for a plane, defining width and height.
Extends
Properties
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
direction? | Direction | Directionality used when rendering text. | Shape3DState.direction | core/src/context/types.ts:188 |
fill? | string | Fill style (CSS colour, gradient, or pattern) used to paint filled regions. | Shape3DState.fill | core/src/context/types.ts:184 |
filter? | string | CSS filter string applied to subsequent drawing operations (e.g. blur(4px)). | Shape3DState.filter | core/src/context/types.ts:186 |
font? | string | CSS font shorthand used when rendering text. | Shape3DState.font | core/src/context/types.ts:190 |
fontKerning? | FontKerning | Whether font kerning is applied when rendering text. | Shape3DState.fontKerning | core/src/context/types.ts:192 |
globalCompositeOperation? | unknown | Compositing operation controlling how new drawing is blended with existing content. | Shape3DState.globalCompositeOperation | core/src/context/types.ts:196 |
height | number | The height of the plane along the Y axis, in world units. | - | 3d/src/elements/plane.ts:16 |
lineCap? | LineCap | Cap style drawn at the endpoints of stroked lines. | Shape3DState.lineCap | core/src/context/types.ts:198 |
lineDash? | number[] | Dash pattern as alternating stroke and gap lengths; empty for a solid line. | Shape3DState.lineDash | core/src/context/types.ts:200 |
lineDashOffset? | number | Distance into the line dash pattern at which dashing begins. | Shape3DState.lineDashOffset | core/src/context/types.ts:202 |
lineJoin? | LineJoin | Join style drawn where two stroked segments meet. | Shape3DState.lineJoin | core/src/context/types.ts:204 |
lineWidth? | number | Width, in pixels, of stroked lines. | Shape3DState.lineWidth | core/src/context/types.ts:206 |
miterLimit? | number | Miter length limit ratio applied to miter line joins. | Shape3DState.miterLimit | core/src/context/types.ts:208 |
opacity? | number | Global alpha applied to everything drawn, from 0 to 1. | Shape3DState.opacity | core/src/context/types.ts:194 |
rotation? | Rotation | Rotation applied to the element's transform, as radians or a deg/rad string. | Shape3DState.rotation | core/src/context/types.ts:234 |
rotationX | number | The rotation around the X axis, in radians. | Shape3DState.rotationX | 3d/src/core/shape.ts:82 |
rotationY | number | The rotation around the Y axis, in radians. | Shape3DState.rotationY | 3d/src/core/shape.ts:84 |
rotationZ | number | The rotation around the Z axis, in radians. | Shape3DState.rotationZ | 3d/src/core/shape.ts:86 |
shadowBlur? | number | Gaussian blur radius applied to drawn shadows. | Shape3DState.shadowBlur | core/src/context/types.ts:210 |
shadowColor? | string | Colour of drawn shadows. | Shape3DState.shadowColor | core/src/context/types.ts:212 |
shadowOffsetX? | number | Horizontal offset, in pixels, of drawn shadows. | Shape3DState.shadowOffsetX | core/src/context/types.ts:214 |
shadowOffsetY? | number | Vertical offset, in pixels, of drawn shadows. | Shape3DState.shadowOffsetY | core/src/context/types.ts:216 |
stroke? | string | Stroke style (CSS colour, gradient, or pattern) used to paint outlines. | Shape3DState.stroke | core/src/context/types.ts:218 |
textAlign? | TextAlignment | Horizontal alignment of text relative to the drawing position. | Shape3DState.textAlign | core/src/context/types.ts:220 |
textBaseline? | TextBaseline | Vertical baseline used when positioning text. | Shape3DState.textBaseline | core/src/context/types.ts:222 |
transformOriginX? | TransformOrigin | Horizontal origin about which rotation and scaling are applied. | Shape3DState.transformOriginX | core/src/context/types.ts:236 |
transformOriginY? | TransformOrigin | Vertical origin about which rotation and scaling are applied. | Shape3DState.transformOriginY | core/src/context/types.ts:238 |
transformScaleX? | number | Horizontal scale factor applied to the element's transform. | Shape3DState.transformScaleX | core/src/context/types.ts:230 |
transformScaleY? | number | Vertical scale factor applied to the element's transform. | Shape3DState.transformScaleY | core/src/context/types.ts:232 |
translateX? | number | Horizontal translation, in pixels, applied to the element's transform. | Shape3DState.translateX | core/src/context/types.ts:226 |
translateY? | number | Vertical translation, in pixels, applied to the element's transform. | Shape3DState.translateY | core/src/context/types.ts:228 |
width | number | The width of the plane along the X axis, in world units. | - | 3d/src/elements/plane.ts:14 |
x | number | The X position of the shape's origin in world space. | Shape3DState.x | 3d/src/core/shape.ts:76 |
y | number | The Y position of the shape's origin in world space. | Shape3DState.y | 3d/src/core/shape.ts:78 |
z | number | The Z position of the shape's origin in world space. | Shape3DState.z | 3d/src/core/shape.ts:80 |
zIndex? | number | Stacking order used to sort elements during rendering; higher values draw on top. | Shape3DState.zIndex | core/src/context/types.ts:224 |