Public API Reference

                 

---

csKDTreeChild Class Reference

A child in the KD-tree (usually some object). More...

#include <kdtree.h>

List of all members.

Public Methods
void	AddLeaf (csKDTree *leaf)
	Physically add a leaf to this child. More...
void	RemoveLeaf (int idx)
	Physically remove a leaf from this child. More...
void	RemoveLeaf (csKDTree *leaf)
	Physically remove a leaf from this child. More...
void	ReplaceLeaf (csKDTree *old_leaf, csKDTree *new_leaf)
	Replace a leaf with another one. More...
int	FindLeaf (csKDTree *leaf)
	Find leaf. More...
const csBox3 &	GetBBox () const
	Get the bounding box of this object. More...
void *	GetObject () const
	Get the pointer to the black box object. More...
Friends
class	csKDTree

---

Detailed Description

A child in the KD-tree (usually some object).

Definition at line 59 of file kdtree.h.

---

Member Function Documentation

void csKDTreeChild::AddLeaf (  csKDTree *    leaf )

Physically add a leaf to this child.

int csKDTreeChild::FindLeaf (  csKDTree *    leaf )

Find leaf.

const csBox3& csKDTreeChild::GetBBox (    )  const [inline]

Get the bounding box of this object. Definition at line 99 of file kdtree.h.

void* csKDTreeChild::GetObject (    )  const [inline]

Get the pointer to the black box object. Definition at line 104 of file kdtree.h.

void csKDTreeChild::RemoveLeaf (  csKDTree *    leaf )

Physically remove a leaf from this child.

void csKDTreeChild::RemoveLeaf (  int    idx )

Physically remove a leaf from this child.

void csKDTreeChild::ReplaceLeaf (  csKDTree *    old_leaf, csKDTree *    new_leaf )

Replace a leaf with another one. This is more efficient than doing RemoveLeaf/AddLeaf and it is useful in many cases where you want to move a child in the tree.

---

The documentation for this class was generated from the following file:

• kdtree.h

---