orx  stable
Portable Game Engine
OrxTree

Data Structures

struct  orxTREE
 
struct  orxTREE_NODE
 

Functions

orxDLLAPI orxSTATUS orxFASTCALL orxTree_AddChild (orxTREE_NODE *_pstRefNode, orxTREE_NODE *_pstNode)
 
orxDLLAPI orxSTATUS orxFASTCALL orxTree_AddParent (orxTREE_NODE *_pstRefNode, orxTREE_NODE *_pstNode)
 
orxDLLAPI orxSTATUS orxFASTCALL orxTree_AddRoot (orxTREE *_pstTree, orxTREE_NODE *_pstNode)
 
orxDLLAPI orxSTATUS orxFASTCALL orxTree_AddSibling (orxTREE_NODE *_pstRefNode, orxTREE_NODE *_pstNode)
 
orxDLLAPI orxSTATUS orxFASTCALL orxTree_Clean (orxTREE *_pstTree)
 
static orxINLINE orxTREE_NODEorxTree_GetChild (const orxTREE_NODE *_pstNode)
 
static orxINLINE orxU32 orxTree_GetCounter (const orxTREE *_pstTree)
 
static orxINLINE orxTREE_NODEorxTree_GetParent (const orxTREE_NODE *_pstNode)
 
static orxINLINE orxTREE_NODEorxTree_GetPrevious (const orxTREE_NODE *_pstNode)
 
static orxINLINE orxTREE_NODEorxTree_GetRoot (const orxTREE *_pstTree)
 
static orxINLINE orxTREE_NODEorxTree_GetSibling (const orxTREE_NODE *_pstNode)
 
static orxINLINE orxTREEorxTree_GetTree (const orxTREE_NODE *_pstNode)
 
orxDLLAPI orxSTATUS orxFASTCALL orxTree_MoveAsChild (orxTREE_NODE *_pstRefNode, orxTREE_NODE *_pstNode)
 
orxDLLAPI orxSTATUS orxFASTCALL orxTree_Remove (orxTREE_NODE *_pstNode)
 

Detailed Description

Tree module Module that handles trees

Function Documentation

orxDLLAPI orxSTATUS orxFASTCALL orxTree_AddChild ( orxTREE_NODE _pstRefNode,
orxTREE_NODE _pstNode 
)

Adds a node as a child of another one

Parameters
[in]_pstRefNodeReference node (add as a child of this one)
[in]_pstNodeNode to add
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxTree_AddParent ( orxTREE_NODE _pstRefNode,
orxTREE_NODE _pstNode 
)

Adds a node as a parent of another one

Parameters
[in]_pstRefNodeReference node (add as a parent of this one)
[in]_pstNodeNode to add
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxTree_AddRoot ( orxTREE _pstTree,
orxTREE_NODE _pstNode 
)

Adds a node at the root of a tree

Parameters
[in]_pstTreeConcerned tree
[in]_pstNodeNode to add
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxTree_AddSibling ( orxTREE_NODE _pstRefNode,
orxTREE_NODE _pstNode 
)

Adds a node as a sibling of another one

Parameters
[in]_pstRefNodeReference node (add as a sibling of this one)
[in]_pstNodeNode to add
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxTree_Clean ( orxTREE _pstTree)

Cleans a tree

Parameters
[in]_pstTreeConcerned tree
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
static orxINLINE orxTREE_NODE* orxTree_GetChild ( const orxTREE_NODE _pstNode)
static

Gets first child node

Parameters
[in]_pstNodeConcerned node
Returns
orxTREE_NODE / orxNULL

Definition at line 155 of file orxTree.h.

static orxINLINE orxU32 orxTree_GetCounter ( const orxTREE _pstTree)
static

Gets a tree counter

Parameters
[in]_pstTreeConcerned tree
Returns
Number of nodes in tree

Definition at line 208 of file orxTree.h.

static orxINLINE orxTREE_NODE* orxTree_GetParent ( const orxTREE_NODE _pstNode)
static

Gets parent node

Parameters
[in]_pstNodeConcerned node
Returns
orxTREE_NODE / orxNULL

Definition at line 142 of file orxTree.h.

static orxINLINE orxTREE_NODE* orxTree_GetPrevious ( const orxTREE_NODE _pstNode)
static

Gets previous sibling node

Parameters
[in]_pstNodeConcerned node
Returns
orxTREE_NODE / orxNULL

Definition at line 181 of file orxTree.h.

static orxINLINE orxTREE_NODE* orxTree_GetRoot ( const orxTREE _pstTree)
static

Gets a tree root

Parameters
[in]_pstTreeConcerned tree
Returns
orxTREE_NODE / orxNULL

Definition at line 195 of file orxTree.h.

static orxINLINE orxTREE_NODE* orxTree_GetSibling ( const orxTREE_NODE _pstNode)
static

Gets (next) sibling node

Parameters
[in]_pstNodeConcerned node
Returns
orxTREE_NODE / orxNULL

Definition at line 168 of file orxTree.h.

static orxINLINE orxTREE* orxTree_GetTree ( const orxTREE_NODE _pstNode)
static

Gets a node tree

Parameters
[in]_pstNodeConcerned node
Returns
orxTREE / orxNULL

Definition at line 129 of file orxTree.h.

orxDLLAPI orxSTATUS orxFASTCALL orxTree_MoveAsChild ( orxTREE_NODE _pstRefNode,
orxTREE_NODE _pstNode 
)

Moves a node as a child of another one of the same tree

Parameters
[in]_pstRefNodeReference node (move as a child of this one)
[in]_pstNodeNode to move
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxTree_Remove ( orxTREE_NODE _pstNode)

Removes a node from its tree

Parameters
[in]_pstNodeConcerned node
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Generated for orx by doxygen 1.5.6