Images topic

The Images module provides a compact, SDK-focused set of types for working with visual assets in Magic Lane Maps for Flutter. Use this module to obtain, inspect, render and customize images that the SDK produces or manages — from simple raster icons to vector-based navigation cues such as turn arrows, lane guidance and signboards with variable size. It makes it easy to request image bytes or fully rendered images with dimensions, and to control appearance for vector assets via rendering settings.

• ImgBase: Abstract foundation for all SDK image types. Use it to check image metadata (validity, scaling support, unique id) and to obtain renderable image output that includes both bytes and final dimensions. It's the common interface implemented by all concrete image wrappers.
• Img: Raster image wrapper for encoded image data or asset-based images. Use it when you need a simple image backed by bytes with SDK-recommended size and aspect ratio. It provides factory constructors for byte data and for loading from app assets.
• RenderableImg: Container that packages rendered image bytes together with the actual width and height. Use this when you need to know final dimensions produced by the SDK (important for vector images and when automatic resizing may be applied).
• SizeAndFormat: Lightweight holder pairing a Size with an ImageFileFormat. Use it for API calls or SDK settings that require both a target size and a format together.
• AbstractGeometryImg : Vector image wrapper for abstract geometry turn/junction images. Use it to request schematic junction renderings that scale losslessly and to obtain either bytes or a RenderableImg with final dimensions. Can be customized via AbstractGeometryImageRenderSettings.
• AbstractGeometry: Structured model describing junction and turn geometries. Use it as the machine-readable source when rendering schematic junction images or when requesting an abstract geometry image from turn details.
• AbstractGeometryItem: Elementary geometry unit included in AbstractGeometry describing individual lanes, arrows or markers and their attachment to the junction anchor. Use these items to represent each drawable piece of a junction schematic.
• AbstractGeometryImageRenderSettings: Rendering configuration for abstract geometry/vector turn images. Use it to customize active/inactive inner and outer colors when requesting rendered abstract geometry images.
• LaneImg: Vector image wrapper for lane guidance. Use it to request lane graphics that scale losslessly and to obtain either bytes or a RenderableImg with final dimensions. Can be customized via LaneImageRenderSettings.
• LaneImageRenderSettings: Rendering configuration for lane guidance images. Use it to set background and lane colors for clearer lane guidance visuals.
• SignpostImg: Vector image wrapper for highway/directional sign visuals. Use it to obtain signpost renderings with customizable layout options. Can be customized via SignpostImageRenderSettings.
• SignpostImageRenderSettings: Rendering configuration for signpost images. Use it to control border size, corner rounding and row limits for directional sign rendering.
• RoadInfoImg: Vector image wrapper for road shields and route markers. Use it when you need road-number graphics or shields rendered to a specific size and background.
• GemIcon: SDK-built-in icon identifier enum for common marker icons. Use it where built-in icon IDs are required.
• EngineMisc: Additional engine icon identifiers used internally and available for SDK consumers.

Together these classes let you request, customize and display SDK-produced images in a predictable, platform-friendly way. The ImgBase abstraction centralizes metadata and rendering behavior while concrete implementers (raster and vector wrappers) expose format, sizing and render settings that control the final output. RenderableImg provides the exact bytes and dimensions you can feed straight into Flutter UI.

Prefer the concrete wrappers for common workflows: obtain an image, verify it is valid, then request either raw bytes for quick display or a RenderableImg when you need the final dimensions. When working with vector images, pass render settings to match your app theme and enable allowResize only when you want the SDK to choose an optimal aspect ratio.

Learn more about images: https://developer.magiclane.com/docs/flutter/guides/core/images