RibbonGeometry class Geometry

A flat strip of constant width swept along a ScenePath.

Useful for a route ribbon or a painted lane marking. The result is an ordinary triangle mesh that works with any material; texture coordinates run 0..1 across the width and by arc-length distance along the path.

Inheritance

Constructors

RibbonGeometry(ScenePath path, {double width = 1.0, int stations = 64, RibbonAlignment alignment = RibbonAlignment.ground, Vector3? up, GeometryStorage storage = GeometryStorage.fixed})
Sweeps a ribbon of the given width along path.
factory

Properties

hashCode → int
The hash code for this object.
no setterinherited
instancedVertexLayout → VertexLayout?
The explicit pipeline vertex layout this geometry's vertex shader expects, or null for the shader bundle's default interleaved layout.
no setterinherited
isUpdatable → bool
Whether this geometry can be updated in place.
no setterinherited
localBoundingSphere → Sphere?
Local-space bounding sphere paired with localBounds. Same nullability semantics.
no setterinherited
localBounds → Aabb3?
Local-space axis-aligned bounding box of this geometry's vertex positions, or null if bounds are unknown. Computed by uploadVertexData for procedural geometry, populated from baked scene-package bounds for imported geometry, and (for the advanced setVertices path where the caller manages its own GPU buffer) left null unless the caller assigns it via setLocalBounds.
no setterinherited
packedData → ({Uint8List? indexBytes, bool indices32Bit, Uint8List vertexBytes})
The packed interleaved vertex bytes (and packed index bytes with their width) as last uploaded, retained so the scene serializer can re-emit this geometry as payload chunks.
no setterinherited
primitiveType ↔ PrimitiveType
How the vertex/index data is assembled into primitives when drawn.
getter/setter pairinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
storage → GeometryStorage
How this geometry's GPU buffers are managed; see GeometryStorage.
finalinherited
vertexCount → int
The number of vertices currently drawn.
no setterinherited
vertexShader → Shader
The vertex shader used when rendering this geometry.
no setterinherited

Methods

bind(RenderPass pass, HostBuffer transientsBuffer, Matrix4 modelTransform, Matrix4 cameraTransform, Vector3 cameraPosition) → void
Binds vertex/index buffers and per-frame uniforms onto pass in preparation for a draw call.
inherited
draw(RenderPass pass, {int instanceCount = 1}) → void
Emits this geometry's draw call after bind has prepared the render pass.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
rebuild({required Float32List positions, Float32List? normals, Float32List? texCoords, Float32List? colors, List<int>? indices}) → void
Replaces all of this geometry's data, allowing the vertex and index counts to change.
inherited
setIndices(BufferView indices, IndexType indexType) → void
Binds an already-uploaded index buffer view, with element width determined by indexType.
inherited
setJointsTexture(Texture? texture, int width) → void
Hook for skinned geometries to receive the joints texture computed by Skin.getJointsTexture.
inherited
setLocalBounds(Aabb3? aabb, Sphere? sphere) → void
Override the bounds. Useful for callers driving setVertices from a caller-managed gpu.DeviceBuffer who want to participate in bounds-driven scene queries (e.g. frustum culling).
inherited
setVertexShader(Shader shader) → void
Assigns the vertex shader used when this geometry is drawn.
inherited
setVertices(BufferView vertices, int vertexCount) → void
Binds an already-uploaded vertex buffer view as this geometry's vertex source.
inherited
toString() → String
A string representation of this object.
inherited
updateColors(Float32List colors) → void
Replaces every vertex color, keeping the vertex count unchanged.
inherited
updateNormals(Float32List normals) → void
Replaces every vertex normal, keeping the vertex count unchanged.
inherited
updatePath(ScenePath path) → void
Re-sweeps the ribbon along path, reusing the GPU buffers.
updatePositions(Float32List positions) → void
Replaces every vertex position, keeping the vertex count unchanged.
inherited
updateTexCoords(Float32List texCoords) → void
Replaces every texture coordinate, keeping the vertex count unchanged.
inherited
uploadVertexData(ByteData vertices, int vertexCount, ByteData? indices, {IndexType indexType = gpu.IndexType.int16}) → void
Allocates a gpu.DeviceBuffer and uploads vertices (and optional indices) into it in one step.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited