MapDocument

Individual document for parallel editing

class MapDocument : MouseEventReceptor {

UndoableStack events;

MapFormat mainDoc;

Color[] delegate(MapDocument sender) paletteReturnFunc;

int selectedLayer;

Box mapSelection;

Box areaSelection;

RasterWindow outputWindow;

EditMode mode;

LayerInfo[] layerList;

string filename;

int prevMouseX;

int prevMouseY;

int sXAmount;

int sYAmount;

protected static

enum VOIDFILL_EN;

protected static

enum LAYER_SCROLL;

protected static

enum PLACEMENT;

MappingElement selectedMappingElement;

this(string filename);

this(string docName, int resX, int resY);

int nextLayerNumber();

void addTileSet(int layer, ABitmap[ushort] tiles);

void addTileSet(int layer, ABitmap[] tiles);

void scrollSelectedLayer(int x, int y);

void setContScroll(int x, int y);

void updateSelection();

void contScrollLayer();

void updateMaterialList();

void updateLayerList();

void onSelection();

void tileMaterial_FlipHorizontal(bool pos);

void tileMaterial_FlipVertical(bool pos);

void tileMaterial_Select(wchar id);

ushort tileMaterial_PaletteUp();

ushort tileMaterial_PaletteDown();

bool voidfill [@property getter];

bool voidfill [@property setter];

void passMCE(MouseEventCommons mec, MouseClickEvent mce);

void passMME(MouseEventCommons mec, MouseMotionEvent mme);

void passMWE(MouseEventCommons mec, MouseWheelEvent mwe);

LayerInfo getLayerInfo(int pri);

}

Constructors

this this(string filename): Loads the document from disk.
this this(string docName, int resX, int resY): New from scratch

Members

Enums

EditMode enum EditMode: Specifies the current edit mode

Functions

addTileSet void addTileSet(int layer, ABitmap[ushort] tiles)
void addTileSet(int layer, ABitmap[] tiles): Puts the loaded tiles onto a TileLayer
contScrollLayer void contScrollLayer(): Scrolls the selected layer by the amount set. Should be called for every frame.
getLayerInfo LayerInfo getLayerInfo(int pri): Undocumented in source. Be warned that the author may not have intended to support it.
nextLayerNumber int nextLayerNumber(): Returns the next available layer number.
onSelection void onSelection(): Undocumented in source. Be warned that the author may not have intended to support it.
passMCE void passMCE(MouseEventCommons mec, MouseClickEvent mce): Undocumented in source. Be warned that the author may not have intended to support it.
passMME void passMME(MouseEventCommons mec, MouseMotionEvent mme): Undocumented in source. Be warned that the author may not have intended to support it.
passMWE void passMWE(MouseEventCommons mec, MouseWheelEvent mwe): Undocumented in source. Be warned that the author may not have intended to support it.
scrollSelectedLayer void scrollSelectedLayer(int x, int y): Scrolls the selected layer by a given amount.
setContScroll void setContScroll(int x, int y): Sets the continuous scroll amounts.
tileMaterial_FlipHorizontal void tileMaterial_FlipHorizontal(bool pos): Undocumented in source. Be warned that the author may not have intended to support it.
tileMaterial_FlipVertical void tileMaterial_FlipVertical(bool pos): Undocumented in source. Be warned that the author may not have intended to support it.
tileMaterial_PaletteDown ushort tileMaterial_PaletteDown(): Undocumented in source. Be warned that the author may not have intended to support it.
tileMaterial_PaletteUp ushort tileMaterial_PaletteUp(): Undocumented in source. Be warned that the author may not have intended to support it.
tileMaterial_Select void tileMaterial_Select(wchar id): Undocumented in source. Be warned that the author may not have intended to support it.
updateLayerList void updateLayerList(): Updates the layers for this document.
updateMaterialList void updateMaterialList(): Updates the material list for the selected layer.
updateSelection void updateSelection(): Updates the selection on the raster window.

Properties

voidfill bool voidfill [@property getter]: Undocumented in source. Be warned that the author may not have intended to support it.
voidfill bool voidfill [@property setter]: Undocumented in source. Be warned that the author may not have intended to support it.

Static variables

LAYER_SCROLL enum LAYER_SCROLL;: If set, then layer is being scrolled.
PLACEMENT enum PLACEMENT;: To solve some "debounce" issues around mouse click releases
VOIDFILL_EN enum VOIDFILL_EN;: If set, tilePlacement overrides only transparent (0xFFFF) tiles.

Variables

areaSelection Box areaSelection;: Contains the selected layer area parameters
events UndoableStack events;: Per document event stack
filename string filename;: Null if not yet saved, otherwise name of the target file
flags uint flags;: Various status flags combined into one.
layerList LayerInfo[] layerList;: Local layerinfo for data lookup
mainDoc MapFormat mainDoc;: Used to reduce duplicate data as much as possible
mapSelection Box mapSelection;: Contains the selected map area parameters
mode EditMode mode;: Mose event mode selector
outputWindow RasterWindow outputWindow;: Window used to output the screen data
paletteReturnFunc Color[] delegate(MapDocument sender) paletteReturnFunc;: Used for adding the palette for the document
prevMouseX int prevMouseX;: Previous mouse X position
prevMouseY int prevMouseY;: Previous mouse Y position
sXAmount int sXAmount;: Continuous X scroll amount
sYAmount int sYAmount;: Continuous Y scroll amount
selectedLayer int selectedLayer;: Indicates the currently selected layer
selectedMappingElement MappingElement selectedMappingElement;: Currently selected mapping element to write, including mirroring properties, palette selection, and priority attributes

Inherited Members

From MouseEventReceptor

passMCE void passMCE(MouseEventCommons mec, MouseClickEvent mce): Passes mouse click event
passMME void passMME(MouseEventCommons mec, MouseMotionEvent mme): Passes mouse move event
passMWE void passMWE(MouseEventCommons mec, MouseWheelEvent mwe): Passes mouse scroll event

Meta

Source

See Implementation

document classes

MapDocument