forked from 0ad/0ad
Ykkrosh
cfae58928f
Add short-range vertex-based pathfinder. Integrate new pathfinder into unit motion code. Change obstruction system to get rid of circles, and differentiate structures from units. Make PositionChanged messages synchronous. Try to prevent some accidental float->int conversions. This was SVN commit r7484.
240 lines
9.0 KiB
C++
240 lines
9.0 KiB
C++
/* Copyright (C) 2010 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_ICMPOBSTRUCTIONMANAGER
|
|
#define INCLUDED_ICMPOBSTRUCTIONMANAGER
|
|
|
|
#include "simulation2/system/Interface.h"
|
|
|
|
#include "simulation2/helpers/Grid.h"
|
|
#include "simulation2/helpers/Position.h"
|
|
|
|
#include "maths/FixedVector2D.h"
|
|
|
|
class IObstructionTestFilter;
|
|
|
|
/**
|
|
* Obstruction manager: provides efficient spatial queries over objects in the world.
|
|
*
|
|
* The class deals with two types of shape:
|
|
* "static" shapes, typically representing buildings, which are rectangles with a given
|
|
* width and height and angle;
|
|
* and "unit" shapes, representing units that can move around the world, which have a
|
|
* radius and no rotation. (Units sometimes act as axis-aligned squares, sometimes
|
|
* as approximately circles, due to the algorithm used by the short pathfinder.)
|
|
*
|
|
* Other classes (particularly ICmpObstruction) register shapes with this interface
|
|
* and keep them updated.
|
|
*
|
|
* The @c Test functions provide exact collision tests.
|
|
* The edge of a shape counts as 'inside' the shape, for the purpose of collisions.
|
|
* The functions accept an IObstructionTestFilter argument, which can restrict the
|
|
* set of shapes that are counted as collisions.
|
|
*
|
|
* Units can be marked as either moving or stationary, which simply determines whether
|
|
* certain filters include or exclude them.
|
|
*
|
|
* The @c Rasterise function approximates the current set of shapes onto a 2D grid,
|
|
* for use with tile-based pathfinding.
|
|
*/
|
|
class ICmpObstructionManager : public IComponent
|
|
{
|
|
public:
|
|
/**
|
|
* External identifiers for shapes. Valid tags are guaranteed to be non-zero.
|
|
*/
|
|
typedef u32 tag_t;
|
|
|
|
/**
|
|
* Register a static shape.
|
|
* @param x X coordinate of center, in world space
|
|
* @param z Z coordinate of center, in world space
|
|
* @param a angle of rotation (clockwise from +Z direction)
|
|
* @param w width (size along X axis)
|
|
* @param h height (size along Z axis)
|
|
* @return a valid tag for manipulating the shape
|
|
*/
|
|
virtual tag_t AddStaticShape(entity_pos_t x, entity_pos_t z, entity_angle_t a, entity_pos_t w, entity_pos_t h) = 0;
|
|
|
|
/**
|
|
* Register a unit shape.
|
|
* @param x X coordinate of center, in world space
|
|
* @param z Z coordinate of center, in world space
|
|
* @param r radius (half the unit's width/height)
|
|
* @param moving whether the unit is currently moving through the world or is stationary
|
|
* @return a valid tag for manipulating the shape
|
|
*/
|
|
virtual tag_t AddUnitShape(entity_pos_t x, entity_pos_t z, entity_angle_t r, bool moving) = 0;
|
|
|
|
/**
|
|
* Adjust the position and angle of an existing shape.
|
|
* @param tag tag of shape (must be valid)
|
|
* @param x X coordinate of center, in world space
|
|
* @param z Z coordinate of center, in world space
|
|
* @param a angle of rotation (clockwise from +Z direction); ignored for unit shapes
|
|
*/
|
|
virtual void MoveShape(tag_t tag, entity_pos_t x, entity_pos_t z, entity_angle_t a) = 0;
|
|
|
|
/**
|
|
* Set whether a unit shape is moving or stationary.
|
|
* @param tag tag of shape (must be valid and a unit shape)
|
|
* @param moving whether the unit is currently moving through the world or is stationary
|
|
*/
|
|
virtual void SetUnitMovingFlag(tag_t tag, bool moving) = 0;
|
|
|
|
/**
|
|
* Remove an existing shape. The tag will be made invalid and must not be used after this.
|
|
* @param tag tag of shape (must be valid)
|
|
*/
|
|
virtual void RemoveShape(tag_t tag) = 0;
|
|
|
|
/**
|
|
* Collision test a flat-ended thick line against the current set of shapes.
|
|
* The line caps extend by @p r beyond the end points.
|
|
* Only intersections going from outside to inside a shape are counted.
|
|
* @param filter filter to restrict the shapes that are counted
|
|
* @param x0 X coordinate of line's first point
|
|
* @param z0 Z coordinate of line's first point
|
|
* @param x1 X coordinate of line's second point
|
|
* @param z1 Z coordinate of line's second point
|
|
* @param r radius (half width) of line
|
|
* @return true if there is a collision
|
|
*/
|
|
virtual bool TestLine(const IObstructionTestFilter& filter, entity_pos_t x0, entity_pos_t z0, entity_pos_t x1, entity_pos_t z1, entity_pos_t r) = 0;
|
|
|
|
/**
|
|
* Collision test a static square shape against the current set of shapes.
|
|
* @param filter filter to restrict the shapes that are counted
|
|
* @param x X coordinate of center
|
|
* @param z Z coordinate of center
|
|
* @param a angle of rotation (clockwise from +Z direction)
|
|
* @param w width (size along X axis)
|
|
* @param h height (size along Z axis)
|
|
* @return true if there is a collision
|
|
*/
|
|
virtual bool TestStaticShape(const IObstructionTestFilter& filter, entity_pos_t x, entity_pos_t z, entity_pos_t a, entity_pos_t w, entity_pos_t h) = 0;
|
|
|
|
/**
|
|
* Collision test a unit shape against the current set of shapes.
|
|
* @param filter filter to restrict the shapes that are counted
|
|
* @param x X coordinate of center
|
|
* @param z Z coordinate of center
|
|
* @param r radius (half the unit's width/height)
|
|
* @return true if there is a collision
|
|
*/
|
|
virtual bool TestUnitShape(const IObstructionTestFilter& filter, entity_pos_t x, entity_pos_t z, entity_pos_t r) = 0;
|
|
|
|
/**
|
|
* Convert the current set of shapes onto a grid.
|
|
* Tiles that are partially or completely intersected by a shape will be set to 1;
|
|
* others will be set to 0.
|
|
* This is very cheap if the grid has been rasterised before and the set of shapes has not changed.
|
|
* @param grid the grid to be updated
|
|
* @return true if any changes were made to the grid, false if it was already up-to-date
|
|
*/
|
|
virtual bool Rasterise(Grid<u8>& grid) = 0;
|
|
|
|
/**
|
|
* Standard representation for all types of shapes, for use with geometry processing code.
|
|
*/
|
|
struct ObstructionSquare
|
|
{
|
|
entity_pos_t x, z; // position of center
|
|
CFixedVector2D u, v; // 'horizontal' and 'vertical' orthogonal unit vectors, representing orientation
|
|
entity_pos_t hw, hh; // half width, half height of square
|
|
};
|
|
|
|
/**
|
|
* Find all the obstructions that are inside (or partially inside) the given range.
|
|
* @param filter filter to restrict the shapes that are counted
|
|
* @param x0 X coordinate of left edge of range
|
|
* @param z0 Z coordinate of bottom edge of range
|
|
* @param x1 X coordinate of right edge of range
|
|
* @param z1 Z coordinate of top edge of range
|
|
* @param squares output list of obstructions
|
|
*/
|
|
virtual void GetObstructionsInRange(const IObstructionTestFilter& filter, entity_pos_t x0, entity_pos_t z0, entity_pos_t x1, entity_pos_t z1, std::vector<ObstructionSquare>& squares) = 0;
|
|
|
|
/**
|
|
* Find a single obstruction that blocks a unit at the given point with the given radius.
|
|
* Static obstructions (buildings) are more important than unit obstructions, and
|
|
* obstructions that cover the given point are more important than those that only cover
|
|
* the point expanded by the radius.
|
|
*/
|
|
virtual bool FindMostImportantObstruction(entity_pos_t x, entity_pos_t z, entity_pos_t r, ObstructionSquare& square) = 0;
|
|
|
|
/**
|
|
* Get the obstruction square representing the given shape.
|
|
* @param tag tag of shape (must be valid)
|
|
*/
|
|
virtual ObstructionSquare GetObstruction(tag_t tag) = 0;
|
|
|
|
/**
|
|
* Toggle the rendering of debug info.
|
|
*/
|
|
virtual void SetDebugOverlay(bool enabled) = 0;
|
|
|
|
DECLARE_INTERFACE_TYPE(ObstructionManager)
|
|
};
|
|
|
|
/**
|
|
* Interface for ICmpObstructionManager @c Test functions to filter out unwanted shapes.
|
|
*/
|
|
class IObstructionTestFilter
|
|
{
|
|
public:
|
|
virtual ~IObstructionTestFilter() {}
|
|
|
|
/**
|
|
* Return true if the shape should be counted for collisions.
|
|
* This is called for all shapes that would collide, and also for some that wouldn't.
|
|
* @param tag tag of shape being tested
|
|
*/
|
|
virtual bool Allowed(ICmpObstructionManager::tag_t tag, bool moving) const = 0;
|
|
};
|
|
|
|
/**
|
|
* Obstruction test filter that accepts all shapes.
|
|
*/
|
|
class NullObstructionFilter : public IObstructionTestFilter
|
|
{
|
|
public:
|
|
virtual bool Allowed(ICmpObstructionManager::tag_t UNUSED(tag), bool UNUSED(moving)) const { return true; }
|
|
};
|
|
|
|
/**
|
|
* Obstruction test filter that accepts all non-moving shapes.
|
|
*/
|
|
class StationaryObstructionFilter : public IObstructionTestFilter
|
|
{
|
|
public:
|
|
virtual bool Allowed(ICmpObstructionManager::tag_t UNUSED(tag), bool moving) const { return !moving; }
|
|
};
|
|
|
|
/**
|
|
* Obstruction test filter that rejects a specific shape.
|
|
*/
|
|
class SkipTagObstructionFilter : public IObstructionTestFilter
|
|
{
|
|
ICmpObstructionManager::tag_t m_Tag;
|
|
public:
|
|
SkipTagObstructionFilter(ICmpObstructionManager::tag_t tag) : m_Tag(tag) {}
|
|
virtual bool Allowed(ICmpObstructionManager::tag_t tag, bool UNUSED(moving)) const { return tag != m_Tag; }
|
|
};
|
|
|
|
#endif // INCLUDED_ICMPOBSTRUCTIONMANAGER
|