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

A chain is a base class for lines with multiple points. More...

#include <tmx/Object.h>

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

Public Types

typedef std::vector< Vector2i >::const_iterator const_iterator
 A point iterator. More...
 
- Public Types inherited from tmx::Object
enum  Kind {
  RECTANGLE,
  ELLIPSE,
  POLYLINE,
  POLYGON,
  TILE
}
 A kind of geometrical object. More...
 

Public Member Functions

 Chain (const Kind kind, unsigned id, const std::string &name, const std::string &type, const Vector2u &origin, double rotation, bool visible)
 Chain constructor. More...
 
void setPoints (std::vector< Vector2i > points)
 Set the points of the lines. More...
 
const_iterator begin () const noexcept
 Get the begin iterator on the points. More...
 
const_iterator end () const noexcept
 Get the end iterator on the points. 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...
 

Detailed Description

A chain is a base class for lines with multiple points.

There are two kinds of chain: polylines and polygons.

Member Typedef Documentation

A point iterator.

Constructor & Destructor Documentation

tmx::Chain::Chain ( const Kind  kind,
unsigned  id,
const std::string &  name,
const std::string &  type,
const Vector2u origin,
double  rotation,
bool  visible 
)
inline

Chain constructor.

Member Function Documentation

const_iterator tmx::Chain::begin ( ) const
inlinenoexcept

Get the begin iterator on the points.

Returns
the begin iterator
const_iterator tmx::Chain::end ( ) const
inlinenoexcept

Get the end iterator on the points.

Returns
the end iterator
void tmx::Chain::setPoints ( std::vector< Vector2i points)
inline

Set the points of the lines.

Parameters
pointsthe points