Skip to content

[vector_math] Document RingGenerator API #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
XXX1694 wants to merge 1 commit into
base: main
Choose a base branch
from
+20 −5
Draft

[vector_math] Document RingGenerator API #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions packages/vector_math/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 2.4.4

* Documents the public `RingGenerator` API.

## 2.4.3

* Documents the public `CircleGenerator` API.
Expand Down
19 changes: 15 additions & 4 deletions packages/vector_math/lib/src/vector_math_geometry/generators/ring_generator.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,10 @@
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// TODO(stuartmorgan): Remove this and fix violations. See
// https://github.com/flutter/flutter/issues/186827
// ignore_for_file: public_member_api_docs

part of '../../../vector_math_geometry.dart';

/// Generates a flat ring (annulus) or partial-ring mesh in the XZ plane,
/// centered at the origin.
class RingGenerator extends GeometryGenerator {
late double _innerRadius;
late double _outerRadius;
Expand All @@ -22,6 +20,19 @@ class RingGenerator extends GeometryGenerator {
@override
int get indexCount => _segments * 3 * 2;

/// Creates a ring mesh between [innerRadius] and [outerRadius].
///
/// The [segments] parameter controls how many quads are used around the
/// ring. The [thetaStart] and [thetaLength] parameters can be used to
/// generate only an arc of the ring, both given in radians.
///
/// If [stripTextureCoordinates] is true, texture coordinates are mapped as
/// a strip: u goes from 0.0 on the inner edge to 1.0 on the outer edge, and
/// v goes from 0.0 to 1.0 along the ring. Otherwise, the vertex positions
/// are projected onto the texture from above.
///
/// The [flags] parameter configures which vertex attributes to generate, and
/// [filters] specifies any mesh transformations to apply after generation.
MeshGeometry createRing(
double innerRadius,
double outerRadius, {
Expand Down
2 changes: 1 addition & 1 deletion packages/vector_math/pubspec.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ name: vector_math
description: A vector math library for 2D and 3D applications, supporting 2D, 3D, and 4D matrices.
repository: https://github.com/flutter/core-packages/tree/main/packages/vector_math
issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+vector_math%22
version: 2.4.3
version: 2.4.4

environment:
sdk: ^3.10.0
Expand Down
Loading