1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
// Geometric Tools, LLC
// Copyright (c) 1998-2014
// Distributed under the Boost Software License, Version 1.0.
// http://www.boost.org/LICENSE_1_0.txt
// http://www.geometrictools.com/License/Boost/LICENSE_1_0.txt
//
// File Version: 5.0.1 (2010/10/01)
#ifndef WM5NODE_H
#define WM5NODE_H
#include "Wm5GraphicsLIB.h"
#include "Wm5Spatial.h"
#include "Wm5Culler.h"
namespace Wm5
{
class WM5_GRAPHICS_ITEM Node : public Spatial
{
WM5_DECLARE_RTTI;
WM5_DECLARE_NAMES;
WM5_DECLARE_STREAM(Node);
public:
// Construction and destruction.
Node ();
virtual ~Node ();
// This is the current number of elements in the child array. These
// elements are not all guaranteed to be non-null. Thus, when you
// iterate over the array and access children with GetChild(...), you
// should test the return pointer to be non-null before dereferencing it.
inline int GetNumChildren () const;
// Attach a child to this node. If the function succeeds, the return
// value is the index i of the array where the child was stored, in which
// case 0 <= i < GetNumChildren(). The first available empty slot of the
// child array is used for storage. If all slots are filled, the child
// is appended to the array (potentially causing a reallocation of the
// array).
//
// The function fails when 'child' is null or when 'child' already has a
// parent, in which case the return value is -1. The nodes form a tree,
// not a more general directed acyclic graph. A consequence is that a
// node cannot have more than one parent. For example,
// Node* node0 = <some node>;
// Spatial* child = <some child>;
// int index = node0->AttachChild(child);
// Node* node1 = <some node>;
//
// // This asserts because 'child' already has a parent (node0).
// node1->AttachChild(child);
//
// // The following is the correct way to give 'child' a new parent.
// node0->DetachChild(child); // or node0->DetachChildAt(index);
// node1->AttachChild(child);
//
// // In the last example before the DetachChild call, if 'child' is
// // referenced only by node0, the detach will cause 'child' to be
// // deleted (Node internally reference counts its children). If
// // you want to keep 'child' around for later use, do the following.
// SpatialPtr saveChild = node0->GetChild(0);
// node0->DetachChild(saveChild);
// node1->AttachChild(saveChild);
int AttachChild (Spatial* child);
// Detach a child from this node. If the 'child' is non-null and in the
// array, the return value is the index in the array that had stored the
// child. Otherwise, the function returns -1.
int DetachChild (Spatial* child);
// Detach a child from this node. If 0 <= i < GetNumChildren(), the
// return value is the child at index i; otherwise, the function returns
// null.
SpatialPtr DetachChildAt (int i);
// The same comments for AttachChild apply here regarding the inability
// to have multiple parents. If 0 <= i < GetNumChildren(), the function
// succeeds and returns i. If i is out of range, the function *still*
// succeeds, appending the child to the end of the array. The return
// value is the previous child stored at index i.
SpatialPtr SetChild (int i, Spatial* child);
// Get the child at the specified index. If 0 <= i < GetNumChildren(),
// the function succeeds and returns the child at that index--keep in mind
// that child[i] could very well be null. If i is out of range, the
// function returns null.
SpatialPtr GetChild (int i);
protected:
// Support for the geometric update.
virtual void UpdateWorldData (double applicationTime);
virtual void UpdateWorldBound ();
// Support for hierarchical culling.
virtual void GetVisibleSet (Culler& culler, bool noCull);
// Child pointers.
std::vector<SpatialPtr> mChild;
};
WM5_REGISTER_STREAM(Node);
typedef Pointer0<Node> NodePtr;
#include "Wm5Node.inl"
}
#endif
|
