Class TCastleTiledMapControl

Warning: this symbol is deprecated: set URL instead of calling LoadFromFile

Load given TMX file to memory and creates structures.

Detect tile under given position.

The interpretation of Position depends on ContainerCoordinates, and is similar to e.g. TCastleViewport.PositionToCameraPlane:

• When ContainerCoordinates = True, then Position is relative to the whole container (like TCastleWindow or TCastleControl).

  And it is expressed in real device coordinates, just like TInputPressRelease.Position when mouse is being clicked, or like TInputMotion.Position when mouse is moved.

• When ContainerCoordinates = False, then Position is relative to this UI control.

  And it is expressed in coordinates after UI scaling. IOW, if the size of this control is Width = 100, then Position.X between 0 and 100 reflects the visible range of this control.

Note that you can query the positions that are outside of this UI control, or even outside of the container. They will return correct map tiles, as if the map was rendered there. If you want to avoid this, you can e.g. check whether Position is inside the RenderRect (if it's a position in container coordinates, with ContainerCoordinates = True).

This method returns False if the position is outside of the map. Valid map tiles are from (0, 0) (lower-left) to (TTiledMap.Width - 1, TTiledMap.Height - 1) (upper-right).

Rectangle where the given map tile is rendered. Useful to render something over a TCastleTiledMapControl, e.g. a pawn in a game.

In some way, this method is an inverse of the PositionToTile method. It converts map (tile) coordinates back into coordinates useful to display something. The ContainerCoordinates value determines the coordinate system of the resulting rectangle. It's meaning is similar to the ContainerCoordinates parameter of the PositionToTile method.

• When ContainerCoordinates = True, the resulting rectangle is relative to the whole container (like TCastleWindow or TCastleControl). And is expressed in real device coordinates.

  These are the same coordinates as expressed by RenderRect method. You can pass the resulting rectangle straight to DrawRectangle, or TDrawableImage.Draw, or TSprite.Draw, to draw something over this tile.

• When ContainerCoordinates = False, the resulting rectangle is specified in local coordinates of this control, and is expressed in coordinates after UI scaling.

  These are the same coordinates as used by children controls (TCastleUserInterface) or the TCastleTiledMapControl. E.g. you can insert a TCastleImageControl as a child of TCastleTiledMapControl, and set it's position/size this way, to draw an image over this tile.

This method works for any TilePosition, even outside of valid map positions. Returns TFloatRectangle.Empty is Map not loaded (URL not set).

Some maps may use tilesets in which image size is different than map tile size. That is, TTiledMap.TTileset.TileWidth may be different than TTiledMap.TileWidth for some tilesets. The simpler version of this method, without ForceTileWidth/Height, just returns the size of the map tile looking at (TTiledMap.TileWidth, TTiledMap.TileHeight), since it doesn't know the tileset you use.

You can pass ForceTileWidth and ForceTileHeight to set particular size.

Origin determines the map position at control's left-bottom corner. Increasing Origin.X moves visually the map to the left, increasing Origin.Y moves it down.

Currently loaded map (from URL), if any. Nil if no map is loaded (when URL is empty). Read-only.

URL (or just filename) of the Tiled map file (TMX).

Show objects like polylines and points on the map.

How are images scaled (because of UI scaling, because of Scale). True means we use nice "bilinear" filter. False means we use pixelated "nearest" filter.

Beware that using True, and scaling the map, requires preparing the tileset (atlas of tile images) in a proper way. The space around each tile must have at least 1-pixel margin filled with the same color and alpha ("color bleeding"), otherwise bad colors will creep in because of bilinear filtering. Alternatively, you can use SmoothScalingSafeBorder.

In case of SmoothScaling, prevent the color outside of rendered frame from creeping in, by stretching the rendered frame a bit. See TSprite.SmoothScalingSafeBorder.

It is better to prepare the sprite (tileset) images with some spacing between tiles, and color bleeding, instead of using this property. This property workarounds the fact that some sprite (tileset) images lack proper spacing and color bleeding, but it distorts the image a bit, so it's no longer pixel-perfect.

Origin that can be visually edited in Castle Game Engine Editor, Lazarus and Delphi. Normal user code does not need to deal with this, instead read or write Origin directly.

See also

Origin

Origin determines the map position at control's left-bottom corner.