angry-pixel 2.1.13 → 2.2.1

package/lib/index.d.ts

@@ -3282,6 +3282,19 @@ interface RenderData {
     layer: string;
 }
 
+declare enum GeometricShape {
+    Polygon = 0,
+    Circumference = 1,
+    Line = 2
+}
+interface GeometricRenderData extends RenderData {
+    color: string;
+    shape: GeometricShape;
+    vertexModel: Vector2[];
+    rotation: number;
+    radius: number;
+}
+
 /**
  * Mask shape: Rectangle or Circumference.
  * @category Components Configuration
@@ -3760,6 +3773,143 @@ declare class DarknessRenderer {
     constructor(options?: Partial<DarknessRendererOptions>);
 }
 
+/**
+ * GeometricRenderer component configuration
+ * @public
+ * @category Components Configuration
+ * @example
+ * ```js
+ * const outline = new GeometricRenderer({
+ *   shape: GeometricShape.Polygon,
+ *   color: "#00FF88",
+ *   layer: "Default",
+ *   vertexModel: [
+ *     new Vector2(-16, -16),
+ *     new Vector2(16, -16),
+ *     new Vector2(16, 16),
+ *     new Vector2(-16, 16),
+ *   ],
+ *   offset: new Vector2(0, 0),
+ *   rotation: 0,
+ * });
+ * ```
+ * @example
+ * ```js
+ * const segments = new GeometricRenderer({
+ *   shape: GeometricShape.Line,
+ *   color: "#FFFFFF",
+ *   layer: "Default",
+ *   vertexModel: [new Vector2(0, 0), new Vector2(100, 0)],
+ *   offset: new Vector2(0, 0),
+ *   rotation: 0,
+ * });
+ * ```
+ * @example
+ * ```js
+ * const ring = new GeometricRenderer({
+ *   shape: GeometricShape.Circumference,
+ *   color: "#FF6600",
+ *   layer: "Default",
+ *   radius: 32,
+ *   offset: new Vector2(0, 0),
+ *   rotation: 0,
+ * });
+ * ```
+ */
+interface GeometricRendererOptions {
+    /** Outline type: closed polygon, line segments, or circle */
+    shape: GeometricShape;
+    /** Stroke color as a hex string (e.g. `#RRGGBB`) */
+    color: string;
+    /** Render layer name; must match a layer seen by the {@link Camera} */
+    layer: string;
+    /**
+     * Vertices in local space relative to the entity.\
+     * For {@link GeometricShape.Polygon}, at least three points; drawn as a closed `LINE_LOOP`.\
+     * For {@link GeometricShape.Line}, an even number of points (pairs) for `GL_LINES`.\
+     * Ignored when `shape` is {@link GeometricShape.Circumference}.
+     */
+    vertexModel: Vector2[];
+    /** Radius in pixels when `shape` is {@link GeometricShape.Circumference} */
+    radius: number;
+    /** Offset from the entity position, scaled by the entity `Transform`'s scale like other renderers */
+    offset: Vector2;
+    /** Extra rotation in radians, added to the entity `Transform`'s rotation */
+    rotation: number;
+}
+/**
+ * The GeometricRenderer component draws hollow (stroke-only) 2D geometry: polygon outlines,\
+ * polylines, and circle outlines. It feeds the same path as debug collider drawing (`RenderDataType.Geometric`).\
+ *\
+ * The entity must have a {@link Transform}. World position is `Transform.localPosition` plus `offset` (with the\
+ * same rotated-offset behavior as {@link MaskRenderer}). `Transform.localScale` scales `vertexModel` and,\
+ * for circles, scales `radius` by the larger of `|scale.x|` and `|scale.y|`.\
+ *\
+ * Nothing is drawn if geometry is invalid: circumference requires `radius > 0`; polygon requires at least three\
+ * vertices; line mode requires at least two vertices and an even count.
+ * @public
+ * @category Components
+ * @example
+ * ```js
+ * const outline = new GeometricRenderer({
+ *   shape: GeometricShape.Polygon,
+ *   color: "#00FF88",
+ *   layer: "Default",
+ *   vertexModel: [
+ *     new Vector2(-16, -16),
+ *     new Vector2(16, -16),
+ *     new Vector2(16, 16),
+ *     new Vector2(-16, 16),
+ *   ],
+ *   offset: new Vector2(0, 0),
+ *   rotation: 0,
+ * });
+ * ```
+ * @example
+ * ```js
+ * const segments = new GeometricRenderer({
+ *   shape: GeometricShape.Line,
+ *   color: "#FFFFFF",
+ *   layer: "Default",
+ *   vertexModel: [new Vector2(0, 0), new Vector2(100, 0)],
+ *   offset: new Vector2(0, 0),
+ *   rotation: 0,
+ * });
+ * ```
+ * @example
+ * ```js
+ * const ring = new GeometricRenderer({
+ *   shape: GeometricShape.Circumference,
+ *   color: "#FF6600",
+ *   layer: "Default",
+ *   radius: 32,
+ *   offset: new Vector2(0, 0),
+ *   rotation: 0,
+ * });
+ * ```
+ */
+declare class GeometricRenderer {
+    /** Outline type: {@link GeometricShape.Polygon}, {@link GeometricShape.Line}, or {@link GeometricShape.Circumference} */
+    shape: GeometricShape;
+    /** Stroke color (hex) */
+    color: string;
+    /** Render layer */
+    layer: string;
+    /** Local-space vertices for polygon or line mode */
+    vertexModel: Vector2[];
+    /** Radius in pixels for {@link GeometricShape.Circumference} */
+    radius: number;
+    /** X/Y offset from the entity position */
+    offset: Vector2;
+    /** Additional rotation in radians (added to the Transform) */
+    rotation: number;
+    /** @internal */
+    _renderData: GeometricRenderData;
+    /** @internal */
+    static componentName: string;
+    constructor(options?: Partial<GeometricRendererOptions>);
+}
+
 /**
  * SpriteRenderer component configuration
  * @public
@@ -4940,4 +5090,4 @@ declare const SYMBOLS: {
     TimeManager: symbol;
 };
 
-export { Animation, type AnimationOptions, type AnimationSlice, Animator, type AnimatorOptions, type Archetype, AssetManager, AudioPlayer, type AudioPlayerAction, type AudioPlayerOptions, type AudioPlayerState, BallCollider, type BallColliderOptions, BoxCollider, type BoxColliderOptions, BroadPhaseMethods, Button, type ButtonOptions, ButtonShape, Camera, type CameraOptions, type Chunk, Circumference, type Collider, type Collision, type CollisionMatrix, CollisionMethods, CollisionRepository, type CollisionResolution, type Component, type ComponentType, DarknessRenderer, type DarknessRendererOptions, type DependencyName, type DependencyType, type DisabledComponent, EdgeCollider, type EdgeColliderOptions, type Entity, EntityManager, Game, type GameConfig, GameSystem, GamepadController, InputManager, type IntervalOptions, Keyboard, LightRenderer, type LightRendererOptions, MaskRenderer, type MaskRendererOptions, MaskShape, Mouse, type PlaySfxOptions, Polygon, PolygonCollider, type PolygonColliderOptions, type PropertyKey, Rectangle, RigidBody, type RigidBodyOptions, RigidBodyType, SYMBOLS, Scene, SceneManager, type SceneType, type SearchResult, type Shape, type Slice, SpriteRenderer, type SpriteRendererOptions, type System, type SystemGroup, SystemManager, type SystemType, TextAlignment, TextRenderer, type TextRendererOptions, type TiledChunk, type TiledLayer, type TiledObject, type TiledObjectLayer, type TiledProperty, type TiledTilemap, TiledWrapper, type TiledWrapperOptions, TilemapCollider, type TilemapColliderOptions, TilemapOrientation, TilemapRenderer, type TilemapRendererOptions, type Tileset, TimeManager, type TouchInteraction, TouchScreen, Transform, type TransformOptions, Vector2, type VibrationInput, VideoRenderer, type VideoRendererOptions, between, clamp, debugRenderLayer, decorate, defaultRenderLayer, defaultTextureAtlasOptions, degreesToRadians, disableComponent, fixedRound, gameLogicSystem, gamePhysicsSystem, gamePreRenderSystem, inject, injectable, playSfx, radiansToDegrees, randomFloat, randomInt, range, rgbToHex, stopSfx };
+export { Animation, type AnimationOptions, type AnimationSlice, Animator, type AnimatorOptions, type Archetype, AssetManager, AudioPlayer, type AudioPlayerAction, type AudioPlayerOptions, type AudioPlayerState, BallCollider, type BallColliderOptions, BoxCollider, type BoxColliderOptions, BroadPhaseMethods, Button, type ButtonOptions, ButtonShape, Camera, type CameraOptions, type Chunk, Circumference, type Collider, type Collision, type CollisionMatrix, CollisionMethods, CollisionRepository, type CollisionResolution, type Component, type ComponentType, DarknessRenderer, type DarknessRendererOptions, type DependencyName, type DependencyType, type DisabledComponent, EdgeCollider, type EdgeColliderOptions, type Entity, EntityManager, Game, type GameConfig, GameSystem, GamepadController, GeometricRenderer, type GeometricRendererOptions, GeometricShape, InputManager, type IntervalOptions, Keyboard, LightRenderer, type LightRendererOptions, MaskRenderer, type MaskRendererOptions, MaskShape, Mouse, type PlaySfxOptions, Polygon, PolygonCollider, type PolygonColliderOptions, type PropertyKey, Rectangle, RigidBody, type RigidBodyOptions, RigidBodyType, SYMBOLS, Scene, SceneManager, type SceneType, type SearchResult, type Shape, type Slice, SpriteRenderer, type SpriteRendererOptions, type System, type SystemGroup, SystemManager, type SystemType, TextAlignment, TextRenderer, type TextRendererOptions, type TiledChunk, type TiledLayer, type TiledObject, type TiledObjectLayer, type TiledProperty, type TiledTilemap, TiledWrapper, type TiledWrapperOptions, TilemapCollider, type TilemapColliderOptions, TilemapOrientation, TilemapRenderer, type TilemapRendererOptions, type Tileset, TimeManager, type TouchInteraction, TouchScreen, Transform, type TransformOptions, Vector2, type VibrationInput, VideoRenderer, type VideoRendererOptions, between, clamp, debugRenderLayer, decorate, defaultRenderLayer, defaultTextureAtlasOptions, degreesToRadians, disableComponent, fixedRound, gameLogicSystem, gamePhysicsSystem, gamePreRenderSystem, inject, injectable, playSfx, radiansToDegrees, randomFloat, randomInt, range, rgbToHex, stopSfx };