Coin: SoNodeVisualize.h Source File

| Coin3D is Free Software, published under the BSD 3-clause license. | https://coin3d.github.io https://www.kongsberg.com/en/kogt/

SoNodeVisualize.h
1#ifndef COIN_SONODEVISUALIZE_H
2#define COIN_SONODEVISUALIZE_H
3
4/**************************************************************************\
5 * Copyright (c) Kongsberg Oil & Gas Technologies AS
6 * All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions are
10 * met:
11 *
12 * Redistributions of source code must retain the above copyright notice,
13 * this list of conditions and the following disclaimer.
14 *
15 * Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in the
17 * documentation and/or other materials provided with the distribution.
18 *
19 * Neither the name of the copyright holder nor the names of its
20 * contributors may be used to endorse or promote products derived from
21 * this software without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34\**************************************************************************/
35
36#include <Inventor/nodekits/SoBaseKit.h>
37#include <Inventor/nodes/SoSeparator.h>
38#include <Inventor/lists/SoNodeList.h>
39#include <Inventor/tools/SbPimplPtr.h>
40#include <Inventor/SbVec2s.h>
41#include <Inventor/SbVec3f.h>
42
43// *************************************************************************
44
45// FIXME: i don't like the name of this class. "SoScenegraphStructure"
46// or some such would be better. -mortene.
47
48class SoProfilerStats;
49
50 class COIN_DLL_API SoNodeVisualize : public SoBaseKit
51{
52 typedef SoBaseKit inherited;
53
54 SO_KIT_HEADER(SoNodeVisualize);
55 SO_KIT_CATALOG_ENTRY_HEADER(topSeparator);
56 SO_KIT_CATALOG_ENTRY_HEADER(childrenVisible);
57 SO_KIT_CATALOG_ENTRY_HEADER(color);
58 SO_KIT_CATALOG_ENTRY_HEADER(texture);
59 SO_KIT_CATALOG_ENTRY_HEADER(textureTransform);
60 SO_KIT_CATALOG_ENTRY_HEADER(shape);
61 SO_KIT_CATALOG_ENTRY_HEADER(rotSwitch);
62 SO_KIT_CATALOG_ENTRY_HEADER(rotation);
63 SO_KIT_CATALOG_ENTRY_HEADER(childGeometry);
64 SO_KIT_CATALOG_ENTRY_HEADER(translation);
65 SO_KIT_CATALOG_ENTRY_HEADER(lines);
66 SO_KIT_CATALOG_ENTRY_HEADER(lineSep);
67
68public:
69 static void initClass(void);
70 static void cleanClass(void);
71
72 SoNodeVisualize * visualize(SoNode *);
73 static SoNodeVisualize* visualizeTree(SoNode * node,int depth=-1);
74 bool clicked();
75 void setAlternate(bool alternating=true);
76 bool nodeHasChildren();
77 unsigned int nodeNumChildren();
78 bool isAlternating() const;
79
80 virtual void handleEvent(SoHandleEventAction * action);
81
82 void traverse(SoProfilerStats * stats);
83
84protected:
85 SoNodeVisualize(void);
86 virtual ~SoNodeVisualize();
87 SbVec2s getWidth() ;
88
89 void setupChildCatalog(SoNode * node, int depth);
90 void visualizeSubTree(SoNode * node,int depth=-1);
91 void recalculate();
92 SbVec2s recalculateWidth();
93 SoNodeVisualize* getSoNodeVisualizeRoot();
94 void internalAlternating(bool alternating, int direction);
95 void reset();
96 SoNodeList * getChildGeometry();
97
98 private:
99 SbPimplPtr<class SoNodeVisualizeP> pimpl;
100
101 // NOT IMPLEMENTED
102 SoNodeVisualize(const SoNodeVisualize &);
103 SoNodeVisualize & operator = (const SoNodeVisualize &);
104
105 bool dirty;
106 SbVec2s width;
107 SoNodeVisualize *parent;
108
109 SoNode *node;
110};
111
112#endif // !COIN_SONODEVISUALIZE_H
SbPimplPtr
Definition SbPimplPtr.h:55
SbVec2s
The SbVec2s class is a 2 dimensional vector with short integer coordinates.
Definition SbVec2s.h:51
SoBaseKit::initClass
static void initClass(void)
Definition SoBaseKit.cpp:678
SoBaseKit::SoBaseKit
SoBaseKit(void)
Definition SoBaseKit.cpp:630
SoBaseKit::handleEvent
virtual void handleEvent(SoHandleEventAction *action)
Definition SoBaseKit.cpp:1060
SoHandleEventAction
The SoHandleEventAction class distributes user events to the scene.
Definition SoHandleEventAction.h:46
SoNodeList
The SoNodeList class is a container for pointers to SoNode objects.
Definition SoNodeList.h:40
SoNodeVisualize::visualizeSubTree
void visualizeSubTree(SoNode *node, int depth=-1)
Definition SoNodeVisualize.cpp:417
SoNodeVisualize::SoNodeVisualize
SoNodeVisualize(void)
Definition SoNodeVisualize.cpp:202
SoNodeVisualize::nodeNumChildren
unsigned int nodeNumChildren()
Definition SoNodeVisualize.cpp:724
SoNodeVisualize::cleanClass
static void cleanClass(void)
Definition SoNodeVisualize.cpp:601
SoNodeVisualize::clicked
bool clicked()
Definition SoNodeVisualize.cpp:610
SoNodeVisualize::internalAlternating
void internalAlternating(bool alternating, int direction)
Definition SoNodeVisualize.cpp:694
SoNodeVisualize::nodeHasChildren
bool nodeHasChildren()
Definition SoNodeVisualize.cpp:716
SoNodeVisualize::recalculateWidth
SbVec2s recalculateWidth()
Definition SoNodeVisualize.cpp:519
SoNodeVisualize::setAlternate
void setAlternate(bool alternating=true)
Definition SoNodeVisualize.cpp:683
SoNodeVisualize::getSoNodeVisualizeRoot
SoNodeVisualize * getSoNodeVisualizeRoot()
Definition SoNodeVisualize.cpp:672
SoNodeVisualize::getWidth
SbVec2s getWidth()
Definition SoNodeVisualize.cpp:564
SoNodeVisualize::reset
void reset()
Definition SoNodeVisualize.cpp:737
SoNode::SoNode
SoNode(void)
Definition SoNode.cpp:417
SoProfilerStats
The SoProfilerStats class is a node for exposing profiling results gathered by SoProfilerElement.
Definition SoProfilerStats.h:47