1
0
forked from 0ad/0ad
0ad/source/simulation2/components/ICmpRallyPointRenderer.h
Yves 1a66f510d0 Use const T& for parameters of some types in script-exposed native functions
Using references matches the C++ coding style better and should improve
performance a bit in theory. It avoids 2 copies of T in case of the
functions registered with RegisterFunction (mainy used in the GUI). It
should also avoid one or two copies in case of
DEFINE_INTERFACE_METHOD_X, which is used in the simulation, but I
haven't bothered to count it there exactly.
It is now predefined which types have to be passed by const reference
and which are passed by value. Note that references can't be used as
out-parameters (to return multiple values to JS). This hasn't worked
before either and probably never will.

This was SVN commit r17696.
2016-01-23 15:17:56 +00:00

57 lines
1.9 KiB
C++

/* Copyright (C) 2014 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* 0 A.D. is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef INCLUDED_ICMPRALLYPOINT
#define INCLUDED_ICMPRALLYPOINT
#include "maths/FixedVector2D.h"
#include "simulation2/helpers/Position.h"
#include "simulation2/system/Interface.h"
/**
* Rally Point.
* Holds the position of a unit's rally points, and renders them to screen.
*/
class ICmpRallyPointRenderer : public IComponent
{
public:
/// Sets whether the rally point marker and line should be displayed.
virtual void SetDisplayed(bool displayed) = 0;
/// Sets the position at which the rally point marker should be displayed.
/// Discards all previous positions
virtual void SetPosition(const CFixedVector2D& position) = 0;
/// Updates the position of one given rally point marker.
virtual void UpdatePosition(u32 rallyPointId, const CFixedVector2D& position) = 0;
/// Add another position at which a marker should be displayed, connected
/// to the previous one.
virtual void AddPosition_wrapper(const CFixedVector2D& position) = 0;
/// Reset the positions of this rally point marker
virtual void Reset() = 0;
/// Returns true if at least one display rally point is set
virtual bool IsSet() = 0;
DECLARE_INTERFACE_TYPE(RallyPointRenderer)
};
#endif // INCLUDED_ICMPRALLYPOINT