blender/source/gameengine/SceneGraph/SG_Tree.h

164 lines
3.4 KiB
C
Raw Normal View History

/*
* ***** BEGIN GPL LICENSE BLOCK *****
2004-05-16 12:54:44 +00:00
*
* This program 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.
2004-05-16 12:54:44 +00:00
*
* This program 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 this program; if not, write to the Free Software Foundation,
2010-02-12 13:34:04 +00:00
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
2004-05-16 12:54:44 +00:00
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*
* The Original Code is: all of this file.
*
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SG_Tree.h
* \ingroup bgesg
2004-05-16 12:54:44 +00:00
*/
#ifndef __SG_TREE_H__
#define __SG_TREE_H__
#include "MT_Point3.h"
#include "SG_BBox.h"
#include <set>
2004-05-16 12:54:44 +00:00
class SG_Node;
/**
* SG_Tree.
* Holds a binary tree of SG_Nodes.
*/
class SG_Tree
{
SG_Tree* m_left;
SG_Tree* m_right;
SG_Tree* m_parent;
SG_BBox m_bbox;
MT_Point3 m_center;
MT_Scalar m_radius;
2004-05-16 12:54:44 +00:00
SG_Node* m_client_object;
public:
SG_Tree();
SG_Tree(SG_Tree* left, SG_Tree* right);
SG_Tree(SG_Node* client);
~SG_Tree();
/**
* Computes the volume of the bounding box.
*/
MT_Scalar volume() const;
/**
* Prints the tree (for debugging.)
*/
void dump() const;
/**
* Returns the left node.
*/
SG_Tree *Left() const;
SG_Tree *Right() const;
SG_Node *Client() const;
SG_Tree* Find(SG_Node *node);
/**
* Gets the eight corners of this treenode's bounding box,
* in world coordinates.
* \param box: an array of 8 MT_Point3
* \example MT_Point3 box[8];
2004-05-16 12:54:44 +00:00
* treenode->get(box);
*/
void get(MT_Point3 *box) const;
/**
* Get the tree node's bounding box.
*/
const SG_BBox& BBox() const;
/**
* Test if the given bounding box is inside this bounding box.
*/
bool inside(const MT_Point3 &point) const;
void SetLeft(SG_Tree *left);
void SetRight(SG_Tree *right);
2004-05-16 12:54:44 +00:00
MT_Point3 Center() const { return m_center; }
MT_Scalar Radius() { return m_radius; }
//friend class SG_TreeFactory;
struct greater
{
bool operator()(const SG_Tree *a, const SG_Tree *b)
{
return a->volume() > b->volume();
}
};
#ifdef WITH_CXX_GUARDEDALLOC
MEM_CXX_CLASS_ALLOC_FUNCS("GE:SG_Tree")
#endif
2004-05-16 12:54:44 +00:00
};
/**
* SG_TreeFactory generates an SG_Tree from a list of SG_Nodes.
2012-07-04 15:04:38 +00:00
* It joins pairs of SG_Nodes to minimize the size of the resultant
2004-05-16 12:54:44 +00:00
* bounding box.
* cf building an optimized Huffman tree.
* \warning O(n^3)!!!
2004-05-16 12:54:44 +00:00
*/
class SG_TreeFactory
{
typedef std::multiset<SG_Tree*, SG_Tree::greater> TreeSet;
TreeSet m_objects;
2004-05-16 12:54:44 +00:00
public:
SG_TreeFactory();
~SG_TreeFactory();
/**
* Add a node to be added to the tree.
*/
void Add(SG_Node* client);
void Add(SG_Tree* tree);
2004-05-16 12:54:44 +00:00
/**
* Build the tree from the set of nodes added by
* the Add method.
*/
SG_Tree* MakeTreeUp();
/**
* Build the tree from the set of nodes top down.
*/
SG_Tree* MakeTreeDown(SG_BBox &bbox);
2004-05-16 12:54:44 +00:00
SG_Tree* MakeTree();
#ifdef WITH_CXX_GUARDEDALLOC
MEM_CXX_CLASS_ALLOC_FUNCS("GE:SG_TreeFactory")
#endif
2004-05-16 12:54:44 +00:00
};
#endif /* __SG_BBOX_H__ */