The base concept for a geometry primitive: a solid, renderable shape — a sphere, cube, cylinder, and the rest.
Base class — has no declarative element of its own; subclasses inherit its members.
A geometry primitive is a scene node with an actual mesh surface. A few shape
parameters define it (a sphere's radius, a cube's size), and a paint gives it
appearance: a sk-surface-paint fills its faces, an sk-edge-paint
draws its wireframe. Like every scene node it can be positioned, rotated, scaled,
and animated.
Member elements: sk-sphere, sk-cube, sk-plane,
sk-cone, sk-cylinder, sk-torus, sk-arrow,
sk-capsule, and sk-disc are the built-in shapes; sk-meshloads an external polygon mesh from a file.
The example paints a cube's surface with a material.
Abstract base class — not instantiated directly. Construct one of its concrete subclasses; this class contributes the members below to them.
Inherited from: RenderableNode, SceneNode, SkenraAnimatable
— see those pages for inherited members.
| Property | Type | Default | Description | Declared by |
|---|---|---|---|---|
cullMode |
CullMode |
— | Alias for defaultCullMode under the name of the reflected |
AbstractMeshNode |
overlay |
boolean |
false |
Whether this node renders as an overlay with depth-aware translucency. | RenderableNode |
overlayOccludedOpacity |
number |
0.3 |
Alpha multiplier for overlay fragments occluded by scene geometry. | RenderableNode |
idconfig-only |
string |
— | Unique identifier for the node, reflected to the host id attribute. |
SceneNodeConfig |
xanimatable |
number |
0 |
Gets the X position component. | SceneNode |
yanimatable |
number |
0 |
Gets the Y position component. | SceneNode |
zanimatable |
number |
0 |
Gets the Z position component. | SceneNode |
hanimatable |
number |
0 |
Gets the heading (Y-axis) rotation in radians. | SceneNode |
panimatable |
number |
0 |
Gets the pitch (X-axis) rotation in radians. | SceneNode |
banimatable |
number |
0 |
Gets the bank (Z-axis) rotation in radians. | SceneNode |
quaternionanimatable |
Quaternion |
— | Gets the rotation as a quaternion. | SceneNode |
sxanimatable |
number |
1 |
Gets the X-axis scale factor. | SceneNode |
syanimatable |
number |
1 |
Gets the Y-axis scale factor. | SceneNode |
szanimatable |
number |
1 |
Gets the Z-axis scale factor. | SceneNode |
sconfig-only |
number |
— | Uniform scale factor for all axes (overrides sx, sy, sz if provided) | SceneNodeConfig |
classconfig-only |
string |
— | Standard HTML class applied to the node host at construction |
SceneNodeConfig |
styleconfig-only |
string |
— | Standard inline style applied to the node host at construction |
SceneNodeConfig |
| Property | Type | Default | Description | Declared by |
|---|---|---|---|---|
castShadowanimatable |
boolean |
true |
Gets whether this mesh casts shadows. | AbstractMeshNode |
defaultCullMode |
CullMode |
"back" |
Gets the default face culling mode for surface paints on this mesh. | AbstractMeshNode |
geometryread-only |
{ vertices: Float32Array<ArrayBufferLike>; normals: Float32Array<ArrayBufferLike>; uvs: Float32Array<ArrayBufferLike> | null; indices: Uint32Array<ArrayBufferLike>; edgeIndices: Uint32Array<ArrayBufferLike>; } |
— | Gets an object containing all geometry data for the mesh. | AbstractMeshNode |
pointsSourceread-only |
PointsSource |
— | Returns a PointsSource for use with Cloner. | AbstractMeshNode |
verticesread-only |
Float32Array<ArrayBufferLike> |
— | Gets the vertex positions of the mesh. | AbstractMeshNode |
normalsread-only |
Float32Array<ArrayBufferLike> |
— | Gets the vertex normals of the mesh. | AbstractMeshNode |
indicesread-only |
Uint32Array<ArrayBufferLike> |
— | Gets the triangle indices of the mesh. | AbstractMeshNode |
edgeIndicesread-only |
Uint32Array<ArrayBufferLike> |
— | Gets the edge indices of the mesh for wireframe rendering. | AbstractMeshNode |
uvsread-only |
Float32Array<ArrayBufferLike> | null |
— | Gets the per-vertex texture coordinates of the mesh. | AbstractMeshNode |
pointConstraintsread-only |
readonly PointConstraint[] |
[] |
Read-only view of the attached point constraints, exposed via the | AbstractMeshNode |
triangleCountread-only |
number |
— | The number of faces (triangles) this mesh emits — the exclusive upper bound | AbstractMeshNode |
hRad |
number |
0 |
Gets the heading (Y-axis) rotation in radians. | SceneNode |
pRad |
number |
0 |
Gets the pitch (X-axis) rotation in radians. | SceneNode |
bRad |
number |
0 |
Gets the bank (Z-axis) rotation in radians. | SceneNode |
hDeg |
number |
0 |
Gets the heading (Y-axis) rotation in degrees. | SceneNode |
pDeg |
number |
0 |
Gets the pitch (X-axis) rotation in degrees. | SceneNode |
bDeg |
number |
0 |
Gets the bank (Z-axis) rotation in degrees. | SceneNode |
xBasebase value |
number |
— | Gets the base (non-animated) value of X position. | SceneNode |
yBasebase value |
number |
— | Gets the base (non-animated) value of Y position. | SceneNode |
zBasebase value |
number |
— | Gets the base (non-animated) value of Z position. | SceneNode |
hBasebase value |
number |
0 |
Gets the base (non-animated) value of heading (Y-axis rotation). | SceneNode |
pBasebase value |
number |
0 |
Gets the base (non-animated) value of pitch (X-axis rotation). | SceneNode |
bBasebase value |
number |
0 |
Gets the base (non-animated) value of bank (Z-axis rotation). | SceneNode |
quaternionBasebase value |
Quaternion |
— | Gets the base (non-animated) quaternion rotation. | SceneNode |
sxBasebase value |
number |
— | Gets the base (non-animated) value of X-axis scale. | SceneNode |
syBasebase value |
number |
— | Gets the base (non-animated) value of Y-axis scale. | SceneNode |
szBasebase value |
number |
— | Gets the base (non-animated) value of Z-axis scale. | SceneNode |
draggable |
boolean |
false |
Gets whether this node can be dragged. | SceneNode |
parentread-only |
SceneNode | null |
— | The parent node in the scene graph, or null at the root. |
SceneNode |
sceneread-only |
any |
— | Gets the Scene this node belongs to, if any. | SceneNode |
posread-only |
Point3D |
— | Gets the world-space position of this node. | SceneNode |
matrixread-only |
Float32Array<ArrayBufferLike> |
— | Gets the computed 4x4 transformation matrix. | SceneNode |
animationsread-only |
SkenraAnimation[] |
— | Public getter for the animations affecting this target. | SkenraAnimatable |
| Method | Description | Declared by |
|---|---|---|
addPointConstraint(constraint: PointConstraint): void |
Add a PointConstraint to this mesh. |
AbstractMeshNode |
removePointConstraint(constraint: PointConstraint): boolean |
Remove a PointConstraint from this mesh. |
AbstractMeshNode |
resolveSelectionName(name: string): ResolvedSelection |
Resolves a mesh-local selection name against this mesh's registry. |
AbstractMeshNode |
resolveSelectionRef(ref: string): ResolvedSelection |
Resolves a #id selection reference against the scene, validating that the |
AbstractMeshNode |
getPredefinedSelections(): SelectionRegistryEntry[] |
The per-primitive predefined selections (documented defaults derived from the | AbstractMeshNode |
getBoundsInSpace(targetSpaceMatrix: Float32Array): { minX: number; maxX: number; minY: number; maxY: number; minZ: number; maxZ: number; } | null |
Computes the axis-aligned bounding box (AABB) of this mesh in a target coordinate space. | AbstractMeshNode |
getWorldBoundingSphere(): BoundingSphere | null |
Computes the world-space bounding sphere of this mesh. | AbstractMeshNode |
addMaterialPaint(material: Material, paintTarget: PaintTarget, options?: any): Paint |
Applies a material to this node for a specific paint target. | SceneNode |
getPaints(): ReadonlyMap<PaintTarget, Paint> |
— | SceneNode |
getOwnPaints(): readonly Paint[] |
Gets only the paints directly applied to this node (not inherited). | SceneNode |
removePaint(paint: Paint): void |
Removes a paint from this node. | SceneNode |
getWorldPosition(): number[] |
Returns this node’s origin in world space. | SceneNode |
getWorldMatrix(): Float32Array<ArrayBufferLike> |
Returns this node’s world transform — its local transform composed with all ancestor transforms. | SceneNode |
setViewportPosition(camera: AbstractCamera, x: number, y: number, z: number = 0.5): boolean |
Sets the node's local translation so that it appears at the specified viewport position. | SceneNode |
getViewportPosition(camera?: AbstractCamera): [number, number, number] | null |
Returns the node's current world position projected to viewport CSS pixel coordinates. | SceneNode |
setNDCPosition(camera: AbstractCamera, ndcX: number, ndcY: number, ndcZ: number = 0.5): boolean |
Sets the node's local translation so that it appears at the specified NDC position in the viewport. | SceneNode |
animate(firstArg: TypedKeyframe<this>[] | TypedPropertyIndexedKeyframes<this> | Record<string, any> | globalThis.Keyframe[] | globalThis.PropertyIndexedKeyframes | null, secondArg?: number | KeyframeAnimationOptions | globalThis.KeyframeAnimationOptions): SkenraAnimation & Animation |
Creates a new SkenraAnimation for this target per Web Animations API. | SkenraAnimatable |
removeAnimation(animation: SkenraAnimation): boolean |
Removes a specific animation from this object. | SkenraAnimatable |
constrain(type: K, config: ConstraintConfigMap[K]): ConstraintReturnMap[K] |
Creates a constraint on this Animatable using a fluent API. | SkenraAnimatable |
Serve these docs to run the live example.
WebGPU needs a secure context — open this page via grunt serve
rather than double-clicking the file. The Markup tab works from disk.
<sk-scene>
<sk-plain-material id="mat" base-color="#7fa8d8"></sk-plain-material>
<sk-cube size="2">
<sk-surface-paint material="#mat"></sk-surface-paint>
</sk-cube>
</sk-scene>