Back to: Class List
//=====================================
		class Overlay
//=====================================
>> The class that represents all Graphical overlays.

----------------------------
Type: Refrence | No Instance
----------------------------

-------------
Group: Client
-------------

-------------
Constructors:
-------------
	N/A

--------
Methods:
--------
	void addOverlay( Overlay@ overlay );

		Function: Add a graphical overlay

		Arguments: Overlay@ - Object Handle to the Overlay to be added

		Returns: N/A

	bool removeOverlay( Overlay@ overlay );

		Function: Remove a graphical overlay
					
		Arguments: Overlay@ - Object Handle to the Overlay to be removed
		
		Returns: bool - true: The overlay was found and removed
				false: The overlay was not found

	float x() const;

		Function: Get the x coordinate of the position in the world
					
		Arguments: N/A
		
		Returns: float - the x coordinate
		
	float y() const;

		Function: Get the y coordinate of the position in the world
					
		Arguments: N/A
		
		Returns: float - the y coordinate

	void position( float x, float y );

		Function: Set the x and y coordinates for this overlay
					
		Arguments:	float - the new y coordinate
					float - the new x coordinate
		
		Returns: N/A
		
	void position( const Vector2d );

		Function: Set the position coordinates
					
		Arguments:	Vector2d - the new position
		
		Returns: N/A

	Vector2d position();

		Function: Get the position coordinates
					
		Arguments: N/A
		
		Returns: Vector2d - the object's position
		
	float rotation() const;

		Function: Get the rotation of this overlay
					
		Arguments: N/A
		
		Returns: float - the overlays rotation
		
	void rotation( float );

		Function: Set the rotation of this overlay
					
		Arguments: float - the overlays new rotation
		
		Returns: N/A