tmx::Boxed Class Reference

A boxed object is a geometrical object that is defined by a box. More...

#include <tmx/Object.h>

Inheritance diagram for tmx::Boxed:

Public Member Functions
	Boxed (Kind kind, unsigned id, const std::string &name, const std::string &type, const Vector2u &origin, double rotation, bool visible, unsigned width, unsigned height)
	Boxed constructor. More...
unsigned	getWidth () const noexcept
	Get the width of the box. More...
unsigned	getHeight () const noexcept
	Get the height of the box. 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 Vector2u &	getOrigin () 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 boxed object is a geometrical object that is defined by a box.

There are two kinds of boxed objects: rectangles and ellipses.

Constructor & Destructor Documentation

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

inline

Boxed constructor.

Member Function Documentation

unsigned tmx::Boxed::getHeight ( ) const

inlinenoexcept

Get the height of the box.

Returns

the height of the box

unsigned tmx::Boxed::getWidth ( ) const

inlinenoexcept

Get the width of the box.

Returns

the width of the box