raea/mesh

<Mesh3d> holds a shape and a material, as Bevy's Mesh3d and MeshMaterial3d do. The shapes are Bevy's primitives (Cuboid, Sphere, Cylinder, Capsule3d, Cone, Torus, Plane3d and the rest) with Bevy's fields. <BufferMesh> takes your own vertices; <Instances> and scatter draw many copies at once; Solid builds exact solids with booleans, for parts that must fit together.

import { Cuboid, Mesh3d } from "raea/mesh";
import { StandardMaterial } from "raea/pbr";
import { Transform } from "raea/transform";

const Box = () => (
  <Mesh3d transform={Transform.fromXyz(0, 0.5, 0)}>
    <Cuboid half_size={[0.5, 0.5, 0.5]} />
    <StandardMaterial base_color="#4a7ae8" />
  </Mesh3d>
);

import { ATTRIBUTE_COLOR, ATTRIBUTE_NORMAL, ATTRIBUTE_POSITION, ATTRIBUTE_TANGENT } from "raea/mesh"

raea/mesh exports 14 components, 1 function, 2 classes, 10 values, 24 types. Bevy's counterpart: bevy_mesh, bevy_shape. Source: sdk/raea/src/mesh.ts.

#Components

#BufferMesh

A mesh from its own vertex buffers, as the geometry of a (Bevy's Mesh built from attributes): a terrain from a height field, a procedural shape, a ribbon, an imported point list. Drawn as flat triangles, or with indices and normals as Bevy's indexed Mesh.

Bevy: bevy_mesh::mesh::Mesh.

Takes BufferMeshProps's props.

Used in: 3d/vertex_colors, shader_advanced/compute_mesh.

#Capsule

A capsule (Bevy's Capsule3d, three.js's CapsuleGeometry): [radius, length of the straight part], standing up (along y); its whole height is length + 2 x radius. A character's stand-in, a pill, a collider's look.

Also takes the props of CapsuleProps (args).

#Capsule3d

From Bevy's bevy_shape::Capsule3d: A 3D capsule primitive centered on the origin A three-dimensional capsule is defined as a surface at a distance (radius) from a line

Also takes the props of Capsule3dProps (radius, half_length, args).

#Cone

A cone: [radius, height], its point up (along y).

Bevy: bevy_shape::Cone.

Also takes the props of ConeProps (args, radius, height).

#ConicalFrustum

From Bevy's bevy_shape::ConicalFrustum: A conical frustum primitive. A conical frustum can be created by slicing off a section of a cone.

Also takes the props of ConicalFrustumProps (radius_top, radius_bottom, height, args).

#Cuboid

Bevy's Cuboid: <Cuboid half_size={[1, 0.5, 1]} /> is a Box of args [2, 1, 2].

Also takes the props of CuboidProps (half_size); BoxProps (args).

Used in: ui/render_ui_to_texture, ui/widgets/viewport_node, 3d/fog, 3d/transparency_3d, 3d/animated_material, 3d/two_passes, 3d/spotlight, 3d/orthographic, and 33 more.

#Cylinder

[radiusTop, radiusBottom, height], standing up (along y) as three.js has it.

Bevy: bevy_shape::Cylinder.

Also takes the props of CylinderProps (args, radius, half_height).

Used in: shader/shader_material_bindless.

#Instances

One glTF (or one mesh) drawn at many placements, loaded once and drawn by the GPU as instances: a meadow's grass and flowers, a forest, a suburb's houses. <Instances src={staticFile("daisy.glb")} at={scatter({...})} />. The copies share one surface and can't play a clip.

Bevy: bevy_pbr::render::mesh::MeshPipeline (automatic batching of entities sharing a mesh and material).

Takes InstancesProps's props.

#Mesh2d

Bevy's Mesh2d with its Transform, a primitive and a ColorMaterial: in Bevy's 2D world.

Takes Mesh2dProps's props.

#Mesh3d

Bevy's Mesh3d on an entity with its Transform: a shape (Cuboid, Sphere...) and a material inside, and any page element inside as a page layer in the world at it, or on it with layer="surface" (meshLayers).

Bevy: bevy_mesh::components::Mesh3d, bevy_pbr::mesh_material::MeshMaterial3d<bevy_pbr::pbr_material::StandardMaterial> castShadow={false} and receiveShadow={false} put Bevy's markers on it:, bevy_light::NotShadowCaster, bevy_light::NotShadowReceiver layers is its RenderLayers (a light's and a camera's too):, bevy_camera::visibility::render_layers::RenderLayers shadow="only" draws it with the shadow-only material (engine/render shadow_only.rs):, bevy_pbr::mesh_material::MeshMaterial3d<raea_render::engine::shadow_only::ShadowOnlyMaterial>.

Also takes the props of MeshProps (animate, name, pass, quaternion, allowOverlap, posed, shape, driven, shadow, material, castShadow, surface, receiveShadow, attributes, compressed, layers); PointerHandlers3d (onClick, onDrag, onDragEnd, onDragEnter, onDragLeave, onDragOver, onDragStart, onDrop, onPointerDown, onPointerMove, onPointerUp, onPointerEnter, onPointerLeave, onPointerOver, onPointerOut, onWheel).

Used in: ui/render_ui_to_texture, ui/widgets/viewport_node, 3d/fog, 3d/vertex_colors, 3d/rotate_environment_map, 3d/transparency_3d, 3d/spherical_area_lights, 3d/animated_material, and 53 more.

#MeshSequence

A baked simulation, one mesh a frame.

Takes MeshSequenceProps's props.

#Plane3d

From Bevy's bevy_shape::Plane3d: A bounded plane in 3D space. It forms a surface starting from the origin with a defined height and width.

Takes Plane3dProps's props.

Used in: 3d/vertex_colors, 3d/transparency_3d, 3d/spherical_area_lights, 3d/texture, 3d/shadow_caster_receiver, 3d/split_screen, 3d/two_passes, 3d/spotlight, and 16 more.

#Sphere

Also takes the props of SphereProps (args, radius, ico, uv).

Used in: 3d/fog, 3d/rotate_environment_map, 3d/transparency_3d, 3d/spherical_area_lights, 3d/shadow_caster_receiver, 3d/pbr, 3d/spotlight, 3d/rect_light, and 7 more.

#Torus

From Bevy's bevy_shape::Torus: A torus primitive, often representing a ring or donut shape The set of points some distance from a circle centered at the origin

Also takes the props of TorusProps (args, major_radius, minor_radius).

#Functions

#scatter

Points scattered over an area for an : seeded (the same layout every frame and every run), at least spacing apart, clear of avoid and clearOf, on the ground y gives, kept by density. A spatial hash keeps thousands quick. Call it once at module level, not per frame.

function scatter(o: ScatterOptions): Instance[]

#Classes

#CrossSection

A 2D shape (Manifold's CrossSection), held by value: its contours (counter-clockwise solid, clockwise holes), area and bounds. Offset, combine and move it, then extrude or revolve it into a Solid.

#Solid

A handle to a native solid. Free it when done with many (or let the run end).

#Values

#ATTRIBUTE_COLOR

Bevy's Mesh::ATTRIBUTE_COLOR: a vertex's linear RGBA colour (id 5, Float32x4)

#ATTRIBUTE_NORMAL

Bevy's Mesh::ATTRIBUTE_NORMAL: a vertex's normal (id 1, Float32x3)

#ATTRIBUTE_POSITION

Bevy's Mesh::ATTRIBUTE_* (ids 0 to 5), as a Material's vertex buffer names them.

Used in: shader_advanced/custom_vertex_attribute.

#ATTRIBUTE_TANGENT

Bevy's Mesh::ATTRIBUTE_TANGENT: a vertex's tangent, its w the bitangent's sign (id 4, Float32x4)

#ATTRIBUTE_UV_0

Bevy's Mesh::ATTRIBUTE_UV_0: a vertex's first texture coordinates (id 2, Float32x2)

#ATTRIBUTE_UV_1

Bevy's Mesh::ATTRIBUTE_UV_1: a vertex's second texture coordinates, as a lightmap's (id 3, Float32x2)

#crossSection

2D shapes as CrossSections, made natively.

#manifold

#MeshVertexAttribute

A vertex attribute: its name, its unique id (a high random one for your own, as Bevy asks, so it sorts after the built-in ones) and its format. MeshVertexAttribute.new("BlendColor", 988540917, "Float32x4") is Bevy's MeshVertexAttribute::new; Mesh's own are ATTRIBUTE_POSITION and the rest.

Bevy: bevy_mesh::MeshVertexAttribute.

Used in: shader_advanced/custom_vertex_attribute.

#outline

2D outlines for extrude and revolve.

#Types

#Animate3d

A 3D node's declared animation: tracks by property, or a move.

type Animate3d = Record<string, TrackSpec | TrackSpec[] | Keys> | Move

#Bounds

#BufferMeshProps

#Capsule3dProps

Bevy's Capsule3d: radius and half_length, the straight part's half (0.5 each by Bevy's default), standing up.

#CapsuleProps

#ConeProps

#ConicalFrustumProps

Bevy's ConicalFrustum: a cylinder whose ends differ, radius_top and radius_bottom (Bevy's 0.25 and 0.5) and its height (0.5), standing up: a tapered Cylinder of args [radius_top, radius_bottom, height].

#CuboidProps

Bevy's Cuboid: half its size along each axis ([0.5, 0.5, 0.5], a 1 m cube, as Bevy's default).

#CylinderProps

args, or Bevy's Cylinder fields: radius and half_height (0.5 each by Bevy's default).

#Instance

One copy's placement in an , in the Instances' own space (its position, rotation and scale move every copy together). Rotation in radians, XYZ order, as everywhere.

#InstancesProps

#Mesh2dProps

#Mesh3dProps

The props of Mesh3d, tabled there.

#MeshAttribute

One attribute's values on a mesh: one a vertex, each a number or a list of the format's size.

type MeshAttribute = [MeshVertexAttribute, (number | number[])[]]

#MeshSequenceProps

#PlanBox

A box on the plan (x, z, metres): the room SDK's Footprint, or any { min, max }.

#Plane3dProps

Bevy's Plane3d: a flat rectangle facing normal (Bevy's default +Y, a floor), half_size its half extent along its two axes ([0.5, 0.5]), laid out as Bevy's PlaneMeshBuilder does: facing +Z it is a Plane of args [2 x half_size]. The normal is along an axis; a tilted plane is a rotated Mesh3d.

#Polygons

A 2D outline: contours of [x, y] points (counter-clockwise for solid, clockwise for a hole).

type Polygons = [number, number][][]

#ScatterOptions

#Section

A cross-section of a solid at a height: its area, how many contours, and the contours themselves.

#SphereProps

args, or Bevy's Sphere field: radius (0.5 by Bevy's default). Its mesh is Bevy's Sphere::mesh(): an icosphere of 5 subdivisions, or ico of them (Bevy's .ico(n), 0 to 80), or a UV sphere of uv = [sectors, stacks] (.uv(s, t)).

#TorusProps

args, or Bevy's Torus fields: major_radius (0.75) and minor_radius (0.25), the tube's.

#Vec3

type Vec3 = [number, number, number]

#VertexFormat

A vertex attribute's format, as Bevy's VertexFormat names it.

type VertexFormat = "Float32" | "Float32x2" | "Float32x3" | "Float32x4" | "Uint32" | "Uint32x2" | "Uint32x3" | "Uint32x4" | "Sint32" | "Sint32x4"