SoNodeKitListPart.h

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : Paul Isaacs (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_NODE_KIT_LIST_PART_
#define  _SO_NODE_KIT_LIST_PART_
 
#include <Inventor/misc/SoChildList.h>
#include <Inventor/fields/SoSFName.h>
#include <Inventor/fields/SoMFName.h>
#include <Inventor/fields/SoSFNode.h>
#include <Inventor/nodes/SoNode.h>
#include <Inventor/nodes/SoNode.h>
#include <Inventor/nodekits/SoNodekitParts.h>
#include <Inventor/nodekits/SoBaseKit.h>
 
class SoGroup;
 
class SoGetMatrixAction;
class SoGLRenderAction;
class SoGetBoundingBoxAction;
class SoHandleEventAction;
class SoSearchAction;
class SoSearchAction;
class SoCallbackAction;
 
//    Class: SoNodeKitListPart
//
 
class  SoNodeKitListPart : public SoNode {
 
  SO_NODE_HEADER(SoNodeKitListPart);
 
 public:
 
  SoNodeKitListPart();
 
  SoType         getContainerType() const;
  void           setContainerType( SoType newContainerType );
 
  const SoTypeList &getChildTypes() const;
  void             addChildType( SoType typeToAdd );
 
  SbBool        isTypePermitted( SoType typeToCheck ) const;
  SbBool        isChildPermitted( const SoNode *child ) const;
 
  void containerSet( const SbString& fieldDataString );
 
 
  void   lockTypes(); 
  SbBool isTypeLocked() const { return areTypesLocked; }
 
  void                addChild(SoNode *child);
  void                insertChild(SoNode *child, int childIndex);
 
  SoNode              *getChild(int index) const;
  int                 findChild(const SoNode *child) const;
  int                 getNumChildren() const;
  void                removeChild(int index);
  void                removeChild(SoNode *child)
    { removeChild( findChild(child)); }
  void                replaceChild(int index, SoNode *newChild);
  void                replaceChild( SoNode *oldChild, SoNode *newChild)
    { replaceChild(findChild(oldChild), newChild); }
 
  // Depending on the type of the container, this may
  // or may not affect the state.
  virtual SbBool affectsState() const;
 
 
 private:
 
  // These functions implement all actions for nodekits.
  virtual void doAction( SoAction *action );
  virtual void callback( SoCallbackAction *action );
  virtual void GLRender( SoGLRenderAction *action );
  virtual void getBoundingBox( SoGetBoundingBoxAction *action );
  virtual void getMatrix(SoGetMatrixAction *action );
  virtual void handleEvent( SoHandleEventAction *action );
  virtual void pick( SoPickAction *action );
  virtual void search( SoSearchAction *action );
  virtual void getPrimitiveCount (SoGetPrimitiveCountAction *action);
 
 private:
  static void initClass();
  static void exitClass();
 
  // Returns pointer to children
  virtual SoChildList *getChildren() const;
 
  virtual bool affectsPath() const;
 
  // Copies the contents of the given nodekit into this instance
  virtual void        copyContents(const SoFieldContainer *fromFC,
                                   SbBool copyConnections);
 
 private:
 
  SoGroup *getContainerNode();
 
  // Reads in from file. Takes care of setting parts and stuff.
  virtual SbBool readInstance(SoInput *in, unsigned short flags);
 
  SoChildList *children;
 
 private:
  virtual ~SoNodeKitListPart();
 
 private:
  SoSFName containerTypeName;
  SoMFName childTypeNames;
  SoSFNode containerNode;
 
  SoTypeList childTypes;
 
  SbBool  areTypesLocked;
 
  friend class SoBaseKit;
 
};
 
#endif  /* _SO_NODE_KIT_LIST_PART_ */