gwnavruntime/channel/bubblearraybuilder.h Source File

bubblearraybuilder.h
Go to the documentation of this file.
1 /*
2 * Copyright 2016 Autodesk, Inc. All rights reserved.
3 * Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
4 * or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
5 */
6 
7 #pragma once
8 
9 
11 
12 
13 namespace Kaim
14 {
15 
16 class DiagonalStrip;
17 
18 // This class helps to build a BubbleArray.
19 //
20 // It can be used either in static mode, to directly feed an array corresponding to a
21 // DiagonalStrip; or in Dynamic mode. In this last mode, the DiagonalStrip is used
22 // to populate an internal Bubble list that can be enriched with additional Bubbles
23 // before this completed list is converted to an array of Bubbles.
24 //
25 // In both cases, the Bubble array can then be used as input for a StringPuller.
26 class BubbleArrayBuilder
27 {
28 public:
29 // BubbleArrayBuilder() {}
30 // ~BubbleArrayBuilder() { Clear(); }
31 //
32 // void Clear();
33 
34  // ------------------------------ Static Bubble array construction ------------------------------
35 
36  static void ConvertDiagonalStripToBubbleArray(const DiagonalStrip& diagonalStrip, BubbleArray& bubbleArray);
37 
38 // // ------------------------------ Dynamic Bubble array construction ------------------------------
39 //
40 // /// Use this set of methods when building a Bubble array that will integrate iteratively
41 // /// additional Bubbles.
42 // /// The typical usage is:
43 // /// 1. Initialize the BubbleArrayBuilder with a DiagonalStrip
44 // /// 2. Insert the additional Bubbles
45 // /// 3. Convert the internal list into an array of Bubbles that can be used as StringPuller input.
46 //
47 // void Initialize(const DiagonalStrip& diagonalStrip);
48 // void PushBack(const Bubble& bubble);
49 // void ConvertToBubbleArray(BubbleArray& bubbleArray);
50 //
51 //private:
52 // class BubbleListNode: public ListNode<BubbleListNode>
53 // {
54 // public:
55 // BubbleListNode() {}
56 // BubbleListNode(const Bubble& bubble) : m_bubble(bubble) {}
57 // Bubble m_bubble;
58 // };
59 //
60 // KyArray<BubbleListNode> m_bubbleListNodeArray;
61 // List<BubbleListNode> m_bubbleList;
62 };
63 
64 } // namespace Kaim
65 
The Autodesk Navigation namespace.
Definition: gamekitcrowddispersion.cpp:17