Open Inventor Reference
SoGroup.h
Go to the documentation of this file.
1 /*
2  *
3  * Copyright (C) 2000 Silicon Graphics, Inc. All Rights Reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * Further, this software is distributed without any warranty that it is
16  * free of the rightful claim of any third person regarding infringement
17  * or the like. Any license provided herein, whether implied or
18  * otherwise, applies only to this software file. Patent licenses, if
19  * any, provided herein do not apply to combinations of this program with
20  * other software, or any other product whatsoever.
21  *
22  * You should have received a copy of the GNU Lesser General Public
23  * License along with this library; if not, write to the Free Software
24  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25  *
26  * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
27  * Mountain View, CA 94043, or:
28  *
29  * http://www.sgi.com
30  *
31  * For further information regarding this notice, see:
32  *
33  * http://oss.sgi.com/projects/GenInfo/NoticeExplan/
34  *
35  */
36 
37 
38 /*
39  * Copyright (C) 1990,91 Silicon Graphics, Inc.
40  *
41  _______________________________________________________________________
42  ______________ S I L I C O N G R A P H I C S I N C . ____________
43  |
44  | $Revision: 1.1.1.1 $
45  |
46  | Description:
47  | This file defines the SoGroup node class.
48  |
49  | Author(s) : Paul S. Strauss, Nick Thompson
50  |
51  ______________ S I L I C O N G R A P H I C S I N C . ____________
52  _______________________________________________________________________
53  */
54 
55 #ifndef _SO_GROUP_
56 #define _SO_GROUP_
57 
58 class SoChildList;
60 
61 
64 
103 
104 class INVENTOR_API SoGroup : public SoNode {
105 
107 
108  public:
109 
112 
116  SoGroup(int nChildren);
117 
119  void addChild(SoNode *child);
120 
122  void insertChild(SoNode *child, int newChildIndex);
123 
126  SoNode * getChild(int index) const;
127 
129  int findChild(const SoNode *child) const;
130 
132  int getNumChildren() const;
133 
135  void removeChild(int index);
136 
138  void removeChild(SoNode *child)
139  { removeChild(findChild(child)); }
140 
143 
145  void replaceChild(int index, SoNode *newChild);
146 
148  void replaceChild(SoNode *oldChild, SoNode *newChild)
149  { replaceChild(findChild(oldChild), newChild); }
150 
151  SoEXTENDER public:
153  virtual void doAction(SoAction *action);
154  virtual void callback(SoCallbackAction *action);
155  virtual void GLRender(SoGLRenderAction *action);
156  virtual void getBoundingBox(SoGetBoundingBoxAction *action);
157  virtual void getMatrix(SoGetMatrixAction *action);
158  virtual void handleEvent(SoHandleEventAction *action);
159  virtual void pick(SoPickAction *action);
160  virtual void search(SoSearchAction *action);
161  virtual void write(SoWriteAction *action);
162 
163  SoINTERNAL public:
164  static void initClass();
165 
167  virtual SoChildList *getChildren() const;
168 
169  protected:
171 
173  virtual bool readInstance(SoInput *in, unsigned short flags);
174 
176  virtual bool readChildren(SoInput *in);
177 
178  virtual ~SoGroup();
179 
181  virtual void copyContents(const SoFieldContainer *fromFC,
182  bool copyConnections);
183 };
184 
185 #endif /* _SO_GROUP_ */
#define SoEXTENDER
Provide inline template functions for abs, swap, min, max, and clamp.
Definition: SbBasic.h:154
#define SoINTERNAL
Definition: SbBasic.h:155
#define INVENTOR_API
Disable some annoying warnings on MSVC 6.
Definition: SbSystem.h:81
#define SO_NODE_HEADER(className)
Non-abstract classes have everything abstract classes have, plus a way to create an instance.
Definition: SoSubNode.h:170
Abstract base class for all actions.
Definition: SoAction.h:179
Performs a generic traversal of the scene graph.
This class maintains a list of child nodes for any node.
Definition: SoChildList.h:83
Abstract base class for objects that contain fields.
Renders a scene graph using OpenGL.
Computes bounding box of a scene.
Computes transformation matrix for subgraph.
Base class for all group nodes.
Definition: SoGroup.h:104
virtual void pick(SoPickAction *action)
int getNumChildren() const
Returns number of children.
void replaceChild(int index, SoNode *newChild)
Replaces child with given index with new child.
SoChildList * children
Definition: SoGroup.h:170
void insertChild(SoNode *child, int newChildIndex)
Adds a child so that it becomes the one with the given index.
void removeChild(int index)
Removes child with given index from group.
SoNode * getChild(int index) const
Returns pointer to child node with the given index.
void addChild(SoNode *child)
Adds a child as last one in group.
void replaceChild(SoNode *oldChild, SoNode *newChild)
Replaces first instance of given child with new child.
Definition: SoGroup.h:148
virtual ~SoGroup()
void removeChild(SoNode *child)
Removes first instance of given child from group.
Definition: SoGroup.h:138
virtual void getBoundingBox(SoGetBoundingBoxAction *action)
virtual void copyContents(const SoFieldContainer *fromFC, bool copyConnections)
Copies the contents of the given node into this instance.
virtual SoChildList * getChildren() const
Returns pointer to children.
SoGroup()
Creates an empty group node.
void removeAllChildren()
Removes all children from group.
virtual void search(SoSearchAction *action)
virtual bool readChildren(SoInput *in)
Reads just the children into instance of SoGroup. Returns FALSE on error.
virtual void getMatrix(SoGetMatrixAction *action)
int findChild(const SoNode *child) const
Finds index of given child within group. Returns -1 if not found.
virtual void doAction(SoAction *action)
Implement actions.
virtual void GLRender(SoGLRenderAction *action)
These virtual functions implement all of the actions for nodes, Most of the default implementations d...
virtual bool readInstance(SoInput *in, unsigned short flags)
Reads stuff into instance of SoGroup. Returns FALSE on error.
SoGroup(int nChildren)
Constructor that takes approximate number of children.
virtual void callback(SoCallbackAction *action)
virtual void handleEvent(SoHandleEventAction *action)
static void initClass()
virtual void write(SoWriteAction *action)
Allows nodes in a graph to receive input events.
Used to read Inventor data files.
Definition: SoInput.h:128
Abstract base class for all database nodes.
Definition: SoNode.h:103
Abstract base class for picking objects in a scene.
Definition: SoPickAction.h:77
Searches for nodes in a scene graph.
Writes a scene graph to a file.
Definition: SoWriteAction.h:80