Skip to content

[vector_math] Document CircleGenerator API #37

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

Open
faisalansari0367 wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −5
Open

[vector_math] Document CircleGenerator API #37

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.3

* Documents the public `CircleGenerator` API.

## 2.4.2

* Documents the public geometry filter APIs.
Expand Down
11 changes: 7 additions & 4 deletions packages/vector_math/lib/src/vector_math_geometry/generators/circle_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, circular (or partial circle/pie-slice) mesh in the
/// XZ plane, centered at the origin.
Comment on lines +7 to +8

@dkwingsmt dkwingsmt Sep 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: "pie-slice" is a bit colloquial. Consider "circular sector" or "sector" instead:

/// Generates a flat circular or partial-circle (sector) mesh in the
/// XZ plane, centered at the origin.

class CircleGenerator extends GeometryGenerator {
late double _radius;
late int _segments;
Expand All @@ -20,6 +18,11 @@ class CircleGenerator extends GeometryGenerator {
@override
int get indexCount => _segments * 3;

/// Creates a circle mesh of the given [radius].
///
/// [segments] controls how many triangles are used around the
/// circumference. [thetaStart] and [thetaLength] can be used to generate
/// only a slice of the circle, both given in radians.
Comment on lines +21 to +25

@dkwingsmt dkwingsmt Sep 9, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I suggest the following change, so that the first word of each sentence to be capitalized per Flutter's style guide, and it also documents the other paramters.

Suggested change
/// Creates a circle mesh of the given [radius].
///
/// [segments] controls how many triangles are used around the
/// circumference. [thetaStart] and [thetaLength] can be used to generate
/// only a slice of the circle, both given in radians.
/// Creates a circle mesh of the given [radius].
///
/// The [segments] parameter controls how many triangles are used around the
/// circumference. The [thetaStart] and [thetaLength] parameters can be used
/// to generate only a slice of the circle, both given in radians.
///
/// The [flags] parameter configures which vertex attributes to generate, and
/// [filters] specifies any mesh transformations to apply after generation.

MeshGeometry createCircle(
double radius, {
GeometryGeneratorFlags? flags,
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.2
version: 2.4.3

environment:
sdk: ^3.10.0
Expand Down