svg2ild/ilda/__init__.py

68 lines
1.5 KiB
Python

# ilda/__init__.py
"""
ILDA - Image Laser Data Archive format handling for laser shows
This package provides functionality to convert SVG files to ILDA animation format
for laser show applications.
Main classes:
- Frame: Represents a single ILDA frame with points and colors
- Animation: Represents a sequence of frames for laser animation
Utilities:
- order_paths_greedy_with_2opt: Optimizes path ordering to minimize blank travel
- PathOrderResult: Container for ordered path results
"""
__version__ = "0.1.0"
__author__ = "miklo"
__email__ = "test@miklobit.com"
__description__ = "Converts SVG files to ILDA animation format for laser shows"
# Import main classes
from .frame import Frame
from .animation import Animation
# Import utility functions and classes
from .utils import order_paths_greedy_with_2opt, PathOrderResult
# Import commonly used constants and types
from .frame import (
DEFAULT_ilda_palette,
ILDA_CANVAS,
ILDA_HALF,
INT16_MIN,
INT16_MAX,
PointF,
PointI,
RGB
)
# Define what gets exported with "from ilda import *"
__all__ = [
# Main classes
"Frame",
"Animation",
# Utility functions
"order_paths_greedy_with_2opt",
"PathOrderResult",
# Constants
"DEFAULT_ilda_palette",
"ILDA_CANVAS",
"ILDA_HALF",
"INT16_MIN",
"INT16_MAX",
# Type aliases
"PointF",
"PointI",
"RGB",
# Package metadata
"__version__",
"__author__",
"__email__",
"__description__",
]