Skip to content

[vector_math] Document SphereGenerator API #42

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
mahaamimran wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −5
Open

[vector_math] Document SphereGenerator API #42

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

* Documents the public `SphereGenerator` API.

## 2.4.4

* Replaces dynamic multiplication in `TransformFilter.filterInplace` with `Matrix4.transform3` to fix an analyzer error on newer Dart SDKs.
Expand Down
14 changes: 10 additions & 4 deletions packages/vector_math/lib/src/vector_math_geometry/generators/sphere_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 UV sphere mesh centered at the origin, with its poles on the
/// Y axis.
class SphereGenerator extends GeometryGenerator {
late double _radius;
late int _latSegments;
Expand All @@ -19,6 +17,14 @@ class SphereGenerator extends GeometryGenerator {
@override
int get indexCount => 6 * _lonSegments * _latSegments;

/// Creates a sphere mesh of the given [radius].
///
/// The [latSegments] parameter controls how many bands the sphere is divided
/// into from pole to pole, and [lonSegments] controls how many segments are
/// used around the Y axis.
///
/// The [flags] parameter configures which vertex attributes to generate, and
/// [filters] specifies any mesh transformations to apply after generation.
MeshGeometry createSphere(
num radius, {
int latSegments = 16,
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.4
version: 2.4.5

environment:
sdk: ^3.10.0
Expand Down
Loading