Documentation / @ripl/3d / Shape3DState

Interface: Shape3DState

Defined in: 3d/src/core/shape.ts:208

State interface for a 3D shape, defining position and rotation around each axis.

Extends

• BaseElementState

Extended by

• CubeState
• SphereState
• CylinderState
• ConeState
• PlaneState
• TorusState
• MeshState
• ParametricState
• BezierSurfaceState

Properties

Property	Type	Description	Inherited from	Defined in
direction?	Direction	Directionality used when rendering text.	BaseElementState.direction	core/src/context/types.ts:229
fill?	string	Fill style (CSS color, gradient, or pattern) used to paint filled regions.	BaseElementState.fill	core/src/context/types.ts:225
filter?	string	CSS filter string applied to subsequent drawing operations (e.g. blur(4px)).	BaseElementState.filter	core/src/context/types.ts:227
font?	string	CSS font shorthand used when rendering text.	BaseElementState.font	core/src/context/types.ts:231
fontKerning?	FontKerning	Whether font kerning is applied when rendering text.	BaseElementState.fontKerning	core/src/context/types.ts:233
globalCompositeOperation?	unknown	Compositing operation controlling how new drawing is blended with existing content.	BaseElementState.globalCompositeOperation	core/src/context/types.ts:237
lineCap?	LineCap	Cap style drawn at the endpoints of stroked lines.	BaseElementState.lineCap	core/src/context/types.ts:239
lineDash?	number[]	Dash pattern as alternating stroke and gap lengths; empty for a solid line.	BaseElementState.lineDash	core/src/context/types.ts:241
lineDashOffset?	number	Distance into the line dash pattern at which dashing begins.	BaseElementState.lineDashOffset	core/src/context/types.ts:243
lineJoin?	LineJoin	Join style drawn where two stroked segments meet.	BaseElementState.lineJoin	core/src/context/types.ts:245
lineWidth?	number	Width, in pixels, of stroked lines.	BaseElementState.lineWidth	core/src/context/types.ts:247
material?	Material	How the surface responds to light. When omitted, the element shades from its fill alone.	-	3d/src/core/shape.ts:228
miterLimit?	number	Miter length limit ratio applied to miter line joins.	BaseElementState.miterLimit	core/src/context/types.ts:249
opacity?	number	Global alpha applied to everything drawn, from 0 to 1.	BaseElementState.opacity	core/src/context/types.ts:235
rotation?	Rotation	Rotation applied to the element's transform, as radians or a deg/rad string.	BaseElementState.rotation	core/src/context/types.ts:275
rotationX	number	The rotation around the X axis, in radians.	-	3d/src/core/shape.ts:216
rotationY	number	The rotation around the Y axis, in radians.	-	3d/src/core/shape.ts:218
rotationZ	number	The rotation around the Z axis, in radians.	-	3d/src/core/shape.ts:220
scaleX	number	The scale along the X axis.	-	3d/src/core/shape.ts:222
scaleY	number	The scale along the Y axis.	-	3d/src/core/shape.ts:224
scaleZ	number	The scale along the Z axis.	-	3d/src/core/shape.ts:226
shadowBlur?	number	Gaussian blur radius applied to drawn shadows.	BaseElementState.shadowBlur	core/src/context/types.ts:251
shadowColor?	string	Color of drawn shadows.	BaseElementState.shadowColor	core/src/context/types.ts:253
shadowOffsetX?	number	Horizontal offset, in pixels, of drawn shadows.	BaseElementState.shadowOffsetX	core/src/context/types.ts:255
shadowOffsetY?	number	Vertical offset, in pixels, of drawn shadows.	BaseElementState.shadowOffsetY	core/src/context/types.ts:257
stroke?	string	Stroke style (CSS color, gradient, or pattern) used to paint outlines.	BaseElementState.stroke	core/src/context/types.ts:259
textAlign?	TextAlignment	Horizontal alignment of text relative to the drawing position.	BaseElementState.textAlign	core/src/context/types.ts:261
textBaseline?	TextBaseline	Vertical baseline used when positioning text.	BaseElementState.textBaseline	core/src/context/types.ts:263
transformOriginX?	TransformOrigin	Horizontal origin about which rotation and scaling are applied.	BaseElementState.transformOriginX	core/src/context/types.ts:277
transformOriginY?	TransformOrigin	Vertical origin about which rotation and scaling are applied.	BaseElementState.transformOriginY	core/src/context/types.ts:279
transformScaleX?	number	Horizontal scale factor applied to the element's transform.	BaseElementState.transformScaleX	core/src/context/types.ts:271
transformScaleY?	number	Vertical scale factor applied to the element's transform.	BaseElementState.transformScaleY	core/src/context/types.ts:273
translateX?	number	Horizontal translation, in pixels, applied to the element's transform.	BaseElementState.translateX	core/src/context/types.ts:267
translateY?	number	Vertical translation, in pixels, applied to the element's transform.	BaseElementState.translateY	core/src/context/types.ts:269
x	number	The X position of the shape's origin in world space.	-	3d/src/core/shape.ts:210
y	number	The Y position of the shape's origin in world space.	-	3d/src/core/shape.ts:212
z	number	The Z position of the shape's origin in world space.	-	3d/src/core/shape.ts:214
zIndex?	number	Stacking order used to sort elements during rendering; higher values draw on top.	BaseElementState.zIndex	core/src/context/types.ts:265