2016-08-11 00:30:29 +03:00
|
|
|
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
|
|
|
|
* This Source Code Form is subject to the terms of the Mozilla Public
|
|
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
|
|
|
|
#ifndef MOZILLA_LAYERS_BSPTREE_H
|
|
|
|
#define MOZILLA_LAYERS_BSPTREE_H
|
|
|
|
|
2017-04-05 21:12:35 +03:00
|
|
|
#include "mozilla/ArenaAllocator.h"
|
2016-08-11 00:30:29 +03:00
|
|
|
#include "mozilla/gfx/Polygon.h"
|
2016-10-04 02:35:52 +03:00
|
|
|
#include "mozilla/Move.h"
|
2016-08-11 00:30:29 +03:00
|
|
|
#include "mozilla/UniquePtr.h"
|
|
|
|
#include "nsTArray.h"
|
|
|
|
|
2017-04-05 21:12:35 +03:00
|
|
|
#include <list>
|
2016-08-11 00:30:29 +03:00
|
|
|
|
|
|
|
namespace mozilla {
|
|
|
|
namespace layers {
|
|
|
|
|
2016-09-17 02:03:32 +03:00
|
|
|
class Layer;
|
2016-08-11 00:30:29 +03:00
|
|
|
|
2017-04-10 16:15:15 +03:00
|
|
|
// Represents a layer that might have a non-rectangular geometry.
|
2016-09-17 02:03:32 +03:00
|
|
|
struct LayerPolygon {
|
2017-04-10 16:15:15 +03:00
|
|
|
explicit LayerPolygon(Layer *aLayer)
|
2016-09-17 02:03:32 +03:00
|
|
|
: layer(aLayer) {}
|
|
|
|
|
2017-04-10 16:15:15 +03:00
|
|
|
LayerPolygon(Layer *aLayer,
|
2016-12-04 19:49:32 +03:00
|
|
|
gfx::Polygon&& aGeometry)
|
2017-04-05 21:12:35 +03:00
|
|
|
: layer(aLayer), geometry(Some(Move(aGeometry))) {}
|
2016-10-04 02:35:52 +03:00
|
|
|
|
2017-04-10 16:15:15 +03:00
|
|
|
LayerPolygon(Layer *aLayer,
|
2016-12-04 19:49:32 +03:00
|
|
|
nsTArray<gfx::Point4D>&& aPoints,
|
|
|
|
const gfx::Point4D& aNormal)
|
2017-04-05 21:12:35 +03:00
|
|
|
: layer(aLayer)
|
|
|
|
{
|
|
|
|
geometry.emplace(Move(aPoints), aNormal);
|
|
|
|
}
|
2016-10-04 02:35:52 +03:00
|
|
|
|
2017-04-10 16:15:15 +03:00
|
|
|
Layer *layer;
|
2016-12-04 19:49:32 +03:00
|
|
|
Maybe<gfx::Polygon> geometry;
|
2016-09-17 02:03:32 +03:00
|
|
|
};
|
|
|
|
|
2017-04-05 21:12:35 +03:00
|
|
|
/**
|
|
|
|
* Allocate BSPTreeNodes from a memory arena to improve performance with
|
|
|
|
* complex scenes.
|
|
|
|
* The arena size of 4096 bytes was selected as an arbitrary power of two.
|
|
|
|
* Depending on the platform, this size accommodates roughly 100 BSPTreeNodes.
|
|
|
|
*/
|
|
|
|
typedef mozilla::ArenaAllocator<4096, 8> BSPTreeArena;
|
2016-09-17 02:03:32 +03:00
|
|
|
|
2017-04-10 16:15:15 +03:00
|
|
|
// Represents a node in a BSP tree. The node contains at least one layer with
|
|
|
|
// associated geometry that is used as a splitting plane, and at most two child
|
|
|
|
// nodes that represent the splitting planes that further subdivide the space.
|
2016-08-11 00:30:29 +03:00
|
|
|
struct BSPTreeNode {
|
2017-04-05 21:12:35 +03:00
|
|
|
BSPTreeNode()
|
|
|
|
: front(nullptr), back(nullptr) {}
|
|
|
|
|
|
|
|
const gfx::Polygon& First() const
|
2016-08-11 00:30:29 +03:00
|
|
|
{
|
2017-04-05 21:12:35 +03:00
|
|
|
MOZ_ASSERT(!layers.empty());
|
|
|
|
MOZ_ASSERT(layers.front().geometry);
|
|
|
|
return *layers.front().geometry;
|
2016-08-11 00:30:29 +03:00
|
|
|
}
|
|
|
|
|
2017-04-05 21:12:35 +03:00
|
|
|
static void* operator new(size_t aSize, BSPTreeArena& mPool)
|
2016-08-11 00:30:29 +03:00
|
|
|
{
|
2017-04-05 21:12:35 +03:00
|
|
|
return mPool.Allocate(aSize);
|
2016-08-11 00:30:29 +03:00
|
|
|
}
|
|
|
|
|
2017-04-05 21:12:35 +03:00
|
|
|
BSPTreeNode* front;
|
|
|
|
BSPTreeNode* back;
|
|
|
|
std::list<LayerPolygon> layers;
|
2016-08-11 00:30:29 +03:00
|
|
|
};
|
|
|
|
|
2017-04-10 16:15:15 +03:00
|
|
|
// BSPTree class takes a list of layers as an input and uses binary space
|
|
|
|
// partitioning algorithm to create a tree structure that can be used for
|
|
|
|
// depth sorting.
|
|
|
|
//
|
|
|
|
// Sources for more information:
|
|
|
|
// https://en.wikipedia.org/wiki/Binary_space_partitioning
|
|
|
|
// ftp://ftp.sgi.com/other/bspfaq/faq/bspfaq.html
|
2016-08-11 00:30:29 +03:00
|
|
|
class BSPTree {
|
|
|
|
public:
|
2017-04-05 21:12:35 +03:00
|
|
|
/**
|
|
|
|
* The constructor modifies layers in the given list.
|
|
|
|
*/
|
|
|
|
explicit BSPTree(std::list<LayerPolygon>& aLayers)
|
2016-08-11 00:30:29 +03:00
|
|
|
{
|
2016-09-17 02:03:32 +03:00
|
|
|
MOZ_ASSERT(!aLayers.empty());
|
|
|
|
|
2017-04-05 21:12:35 +03:00
|
|
|
mRoot = new (mPool) BSPTreeNode();
|
2016-09-17 02:03:32 +03:00
|
|
|
BuildTree(mRoot, aLayers);
|
2016-08-11 00:30:29 +03:00
|
|
|
}
|
|
|
|
|
2017-04-10 16:15:15 +03:00
|
|
|
// Builds and returns the back-to-front draw order for the created BSP tree.
|
2016-09-17 02:03:32 +03:00
|
|
|
nsTArray<LayerPolygon> GetDrawOrder() const
|
2016-08-11 00:30:29 +03:00
|
|
|
{
|
2016-09-17 02:03:32 +03:00
|
|
|
nsTArray<LayerPolygon> layers;
|
|
|
|
BuildDrawOrder(mRoot, layers);
|
|
|
|
return layers;
|
2016-08-11 00:30:29 +03:00
|
|
|
}
|
|
|
|
|
|
|
|
private:
|
2017-04-05 21:12:35 +03:00
|
|
|
BSPTreeArena mPool;
|
|
|
|
BSPTreeNode* mRoot;
|
2016-08-11 00:30:29 +03:00
|
|
|
|
2017-04-10 16:15:15 +03:00
|
|
|
// BuildDrawOrder and BuildTree are called recursively. The depth of the
|
|
|
|
// recursion depends on the amount of polygons and their intersections.
|
2017-04-05 21:12:35 +03:00
|
|
|
void BuildDrawOrder(BSPTreeNode* aNode,
|
2016-09-17 02:03:32 +03:00
|
|
|
nsTArray<LayerPolygon>& aLayers) const;
|
2017-04-05 21:12:35 +03:00
|
|
|
|
|
|
|
void BuildTree(BSPTreeNode* aRoot,
|
|
|
|
std::list<LayerPolygon>& aLayers);
|
2016-08-11 00:30:29 +03:00
|
|
|
};
|
|
|
|
|
|
|
|
} // namespace layers
|
|
|
|
} // namespace mozilla
|
|
|
|
|
2016-08-16 21:01:06 +03:00
|
|
|
#endif /* MOZILLA_LAYERS_BSPTREE_H */
|