Antares::Map::Tool::ConnectionCreator Class Reference

Inheritance diagram for Antares::Map::Tool::ConnectionCreator:

Public Member Functions
	ConnectionCreator (Manager &manager)
virtual void	draw (DrawingContext &dc, const bool mouseDown, const wxPoint &position, const wxPoint &absolute) const override
	Draw the tool.
virtual bool	actionIsImmediate () const override
	Get if the action triggered by the tool is immediate.
virtual bool	onMouseUp (const int mx, const int my) override
	Event: The user has clicked on the tool.
Public Member Functions inherited from Antares::Map::Tool::Tool
	Tool (Manager &manager, const char *icon)
	Constructor.
virtual	~Tool ()
	Destructor.
Manager &	manager ()
const Manager &	manager () const
int	x () const
	Get the X-Coordinate of the tool.
void	x (const int v)
	Set the X-Coordinate of the tool.
int	y () const
	Get the Y-Coordinate of the tool.
void	y (const int v)
	Set the Y-Coordinate of the tool.
uint	width () const
	Get the width of the tool.
uint	height () const
	Get the height of the tool.
const wxBitmap *	icon () const
	Get the icon of the tool, NULL if not available.
void	icon (const char *filename)
	Set the icon representing the tool.
LifeSpan	lifeSpan () const
	Get the lifespan of the tool.
bool	contains (const int x, const int y) const
	Get if a point is insided the bounding box of the tool.

Additional Inherited Members
Protected Attributes inherited from Antares::Map::Tool::Tool
Manager &	pManager
	The parent manager.
int	pX
	The X-Coordinate.
int	pY
	The Y-Coordinate.
int	pWidth
	Width.
int	pHeight
	Height.
wxBitmap *	pIcon
	Icon.

Member Function Documentation

actionIsImmediate()

virtual bool Antares::Map::Tool::ConnectionCreator::actionIsImmediate ( ) const

inlineoverridevirtual

Get if the action triggered by the tool is immediate.

When the value is true, the action should be executed as soon as the user clicks on the tool. When equals to false, the action should be delayed until the next click.

Returns

True if the action triggered by the tool is immediate

Reimplemented from Antares::Map::Tool::Tool.

draw()

void Antares::Map::Tool::ConnectionCreator::draw ( DrawingContext & dc, const bool mouseDown, const wxPoint & position, const wxPoint & absolute ) const

overridevirtual

Draw the tool.

Parameters

dc	A drawing context
mouseDown	True if the mouse is down
position
absolute

Reimplemented from Antares::Map::Tool::Tool.

onMouseUp()

bool Antares::Map::Tool::ConnectionCreator::onMouseUp ( const int mx, const int my )

overridevirtual

Event: The user has clicked on the tool.

Returns

True to invalidate all tools (ex: some nodes have been removed, moved...)

Implements Antares::Map::Tool::Tool.

---

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

• src/ui/simulator/toolbox/components/map/tools/connectioncreator.h
• src/ui/simulator/toolbox/components/map/tools/connectioncreator.cpp