Skip to content

StarShape

Under Construction

This documentation is auto-generated, and is a work in progress. Please see the source code at https://github.com/phetsims/scenery-phet/blob/main/js/StarShape.ts for the most up-to-date information.

Overview

Star shape (full, 5-pointed)

@author Sam Reid (PhET Interactive Simulations)

Class StarShape

import { StarShape } from 'scenerystack/scenery-phet';

Constructor

new StarShape( providedOptions? : StarShapeOptions )

Instance Methods

Type StarShapeOptions

import type { StarShapeOptions } from 'scenerystack/scenery-phet';
  • outerRadius?: number
    Distance from the center to the tip of a star limb
  • innerRadius?: number
    Distance from the center to the closest point on the exterior of the star. Sets the "thickness" of the star limbs
  • numberStarPoints?: number
    Number of star points, must be an integer

Source Code

See the source for StarShape.ts in the scenery-phet repository.