tmxlite
lightweight Tiled tmx map parser for C++
Public Member Functions | List of all members
tmx::ImageLayer Class Referencefinal

Image layers contain a single image which make up that layer. The parser contains the fully resolved path to the image relative to the working directory. More...

#include <ImageLayer.hpp>

Inheritance diagram for tmx::ImageLayer:
tmx::Layer

Public Member Functions

 ImageLayer (const std::string &)
 
Type getType () const override
 Returns a Type value representing the concrete type.
 
void parse (const pugi::xml_node &) override
 Attempts to parse the specific node layer type.
 
const std::string & getImagePath () const
 Returns the path, relative to the working directory, of the image used by the image layer.
 
const ColourgetTransparencyColour () const
 Returns the colour used by the image to represent transparent pixels. By default this is (0, 0, 0, 0)
 
bool hasTransparency () const
 Returns true if the image used by this layer specifically states a colour to use as transparency.
 
const Vector2ugetImageSize () const
 Returns the size of the image of the image layer in pixels.
 
- Public Member Functions inherited from tmx::Layer
const std::string & getName () const
 Returns the name of the layer.
 
float getOpacity () const
 Returns the opacity value for the layer.
 
bool getVisible () const
 Returns whether this layer is visible or not.
 
const Vector2igetOffset () const
 Returns the offset from the top left corner of the layer, in pixels.
 
const std::vector< Property > & getProperties () const
 Returns the list of properties of this layer.
 

Additional Inherited Members

- Public Types inherited from tmx::Layer
enum  Type { Tile, Object, Image }
 
using Ptr = std::unique_ptr< Layer >
 
- Protected Member Functions inherited from tmx::Layer
void setName (const std::string &name)
 
void setOpacity (float opacity)
 
void setVisible (bool visible)
 
void setOffset (std::int32_t x, std::int32_t y)
 
void addProperty (const pugi::xml_node &node)
 

Detailed Description

Image layers contain a single image which make up that layer. The parser contains the fully resolved path to the image relative to the working directory.


The documentation for this class was generated from the following file: