MeepMeep/org.rowlandhall.meepmeep/MeepMeep

MeepMeep

class MeepMeep @JvmOverloads constructor(windowX: Int, windowY: Int, fps: Int = 60)

The MeepMeep class is the main entry point for the Meep Meep application. It handles the initialization and management of the application window, rendering, and entity management.

Constructors

MeepMeep

constructor(windowSize: Int)

@JvmOverloads

constructor(windowX: Int, windowY: Int, fps: Int = 60)

Creates a MeepMeep instance with specified window

Types

Background

enum Background : Enum<MeepMeep.Background>

Enum class representing various background options for the MeepMeep application.

Companion

object Companion

Companion object to hold default entities and fonts used in the MeepMeep application.

CompassImage

enum CompassImage : Enum<MeepMeep.CompassImage>

Enum class representing various compass image options for the MeepMeep application.

Properties

canvas

val canvas: MainCanvas

The canvas where all rendering occurs.

canvasHeight

val canvasHeight: Int

The height of the canvas, publicly accessible.

canvasWidth

val canvasWidth: Int

The width of the canvas, publicly accessible.

colorManager

val colorManager: ColorManager

Manages the color scheme of the application.

windowFrame

val windowFrame: WindowFrame

The main application window frame.

Functions

addEntity

fun addEntity(entity: Entity): MeepMeep

Adds an Entity to the MeepMeep application.

exportTrajectoryImage

fun exportTrajectoryImage(filePath: String): MeepMeep

Exports the current trajectory as an image for use in posters, portfolios, etc.

removeEntity

fun removeEntity(entity: Entity): MeepMeep

Removes an Entity from the MeepMeep application.

requestToAddEntity

fun requestToAddEntity(entity: Entity): MeepMeep

Requests to add an Entity to the MeepMeep application.

requestToRemoveEntity

fun requestToRemoveEntity(entity: Entity): MeepMeep

Requests to remove an Entity from the MeepMeep application.

setAxesInterval

fun setAxesInterval(interval: Int): MeepMeep

Sets the interval for the AxesEntity in the entityList.

setBackground

fun setBackground(image: Image): MeepMeep

Sets the background image for the MeepMeep application.

fun setBackground(background: MeepMeep.Background): MeepMeep

Sets the background of the MeepMeep application.

setBackgroundAlpha

fun setBackgroundAlpha(alpha: Float): MeepMeep

Sets the alpha transparency level for the background image.

setCompassImage

fun setCompassImage(image: Image): MeepMeep

fun setCompassImage(compassImage: MeepMeep.CompassImage): MeepMeep

Sets the compass image for the MeepMeep application.

setDarkMode

fun setDarkMode(isDarkMode: Boolean): MeepMeep

Sets the dark mode for the MeepMeep application.

setMouseCoordinateDisplayPosition

fun setMouseCoordinateDisplayPosition(x: Int, y: Int)

Sets the display position for the mouse coordinates on the canvas.

setShowFPS

fun setShowFPS(showFPS: Boolean): MeepMeep

Sets the visibility of the FPS display.

setTheme

@JvmOverloads

fun setTheme(schemeLight: ColorScheme, schemeDark: ColorScheme = schemeLight): MeepMeep

Sets the theme for the MeepMeep application.

start

fun start(): MeepMeep

Starts the MeepMeep application.

MeepMeep

See also

Constructors

Types

Properties

Functions