libtmx  0.4.0
an C++11 library for reading TMX files
Public Member Functions | List of all members
tmx::TileObject Class Reference

A tile object is an image put in the map. More...

#include <tmx/Object.h>

Inheritance diagram for tmx::TileObject:
Inheritance graph
[legend]

Public Member Functions

 TileObject (unsigned id, const std::string &name, const std::string &type, const Vector2u &origin, double rotation, bool visible, unsigned gid, bool hflip, bool vflip, bool dflip)
 TileObject constructor. More...
 
unsigned getGID () const noexcept
 Get the global id of the refering tile (if needed) More...
 
bool isHorizontallyFlipped () const noexcept
 Tell whether the tile object must be flipped horizontally. More...
 
bool isVerticallyFlipped () const noexcept
 Tell whether the tile object must be flipped vertically. More...
 
bool isDiagonallyFlipped () const noexcept
 Tell whether the tile object must be flipped diagonally. More...
 
- Public Member Functions inherited from tmx::Object
 Object (const Kind kind, unsigned id, const std::string &name, const std::string &type, const Vector2u &origin, double rotation, bool visible)
 Object constructor. More...
 
virtual ~Object ()
 Object destructor. More...
 
Kind getKind () const noexcept
 Get the kind of the object. More...
 
unsigned getId () const noexcept
 Get the id of the object. More...
 
const std::string & getName () const noexcept
 Get the name of the object. More...
 
const std::string & getType () const noexcept
 Get the type of the object. More...
 
unsigned getX () const noexcept
 Get the x coordinate of the origin. More...
 
unsigned getY () const noexcept
 Get the y coordinate of the origin. More...
 
const Vector2ugetOrigin () const noexcept
 Get the origin. More...
 
double getRotation () const noexcept
 Get the rotation of the object. More...
 
bool isVisible () const noexcept
 Tell whether this object is visible. More...
 
bool isRectangle () const noexcept
 Tell whether this object is a rectangle. More...
 
bool isEllipse () const noexcept
 Tell whether this object is an ellipse. More...
 
bool isChain () const noexcept
 Tell whether this object is a chain (polygon or polyline). More...
 
bool isPolyline () const noexcept
 Tell whether this object is a polyline. More...
 
bool isPolygon () const noexcept
 Tell whether this object is a polygon. More...
 
bool isTile () const noexcept
 Tell whether this object is a tile. More...
 
- Public Member Functions inherited from tmx::Component
bool hasProperty (const std::string &key) const noexcept
 Tell if the object has a given property. More...
 
const std::string & getProperty (const std::string &key, const std::string &def) const noexcept
 Get a property value. More...
 
bool addProperty (const std::string &key, const std::string &value)
 Add a property. More...
 

Additional Inherited Members

- Public Types inherited from tmx::Object
enum  Kind {
  RECTANGLE,
  ELLIPSE,
  POLYLINE,
  POLYGON,
  TILE
}
 A kind of geometrical object. More...
 

Detailed Description

A tile object is an image put in the map.

Constructor & Destructor Documentation

tmx::TileObject::TileObject ( unsigned  id,
const std::string &  name,
const std::string &  type,
const Vector2u origin,
double  rotation,
bool  visible,
unsigned  gid,
bool  hflip,
bool  vflip,
bool  dflip 
)
inline

TileObject constructor.

Member Function Documentation

unsigned tmx::TileObject::getGID ( ) const
inlinenoexcept

Get the global id of the refering tile (if needed)

Returns
the global id
bool tmx::TileObject::isDiagonallyFlipped ( ) const
inlinenoexcept

Tell whether the tile object must be flipped diagonally.

Returns
true if the tile object must be flipped diagonally
bool tmx::TileObject::isHorizontallyFlipped ( ) const
inlinenoexcept

Tell whether the tile object must be flipped horizontally.

Returns
true if the tile object must be flipped horizontally
bool tmx::TileObject::isVerticallyFlipped ( ) const
inlinenoexcept

Tell whether the tile object must be flipped vertically.

Returns
true if the tile object must be flipped vertically