SoMFFieldContainer.h

/*=======================================================================
 *** 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                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Nicolas DAGUISE (MMM yyyy)
**=======================================================================*/
 
 
#ifndef  _SO_MF_FIELDCONTAINER_
#define  _SO_MF_FIELDCONTAINER_
 
class SoFieldContainer;
 
#include <Inventor/fields/SoSubField.h>
 
//
//  SoMFFieldContainer subclass of SoMField. Each field value is a pointer to an
//  SoFieldContainer. The field automatically maintains references to the
//  fieldContainers it points to and propagates notification from the
//  fieldContainers.
//
 
class  SoMFFieldContainer : public SoMField {
  
  // Use standard field stuff
  SO_MFIELD_REQUIRED_HEADER(SoMFFieldContainer);
  SO_MFIELD_CONSTRUCTOR_HEADER(SoMFFieldContainer);
  SO_MFIELD_VALUE_HEADER(SoMFFieldContainer, SoFieldContainer *, SoFieldContainer *);
  SO_MFIELD_SETVALUESPOINTER_HEADER(SoFieldContainer *);
 
  void addFieldContainer(SoFieldContainer *fieldContainer);
 
  void insertFieldContainer(SoFieldContainer *fieldContainer, int newFieldContainerIndex);
  
  SoFieldContainer *getFieldContainer(int index) const;
  
  int findFieldContainer(const SoFieldContainer *fieldContainer) const;
  
  int getNumFieldContainers() const;
  
  void removeFieldContainer(int index);
  
  void removeFieldContainer(SoFieldContainer *fieldContainer)
    { removeFieldContainer(findFieldContainer(fieldContainer)); }
  
  void removeAllFieldContainers();
  
  void replaceFieldContainer(int index, SoFieldContainer *newFieldContainer);
  
  void replaceFieldContainer(SoFieldContainer *oldFieldContainer, SoFieldContainer *newFieldContainer)
    { replaceFieldContainer(findFieldContainer(oldFieldContainer), newFieldContainer); }
  
  SoFieldContainer** startEditing();
 
  void finishEditing();
  
  private:
  static void initClass();
  static void exitClass();
 
  // Update a copied field to use the copy of each fieldContainer if there is one
  virtual void fixCopy(SbBool copyConnections);
  
  // Override this to also check the stored fieldContainers
  virtual SbBool referencesCopy() const;
 
private:
  // Override this to maintain write-references in fieldContainers
  virtual void countWriteRefs(SoOutput *out) const;
  
  // Changes value in field without doing other notification stuff.
  // Keeps track of references and auditors.
  void setVal(int index, SoFieldContainer *newValue);
  
  SoFieldContainer** m_oldValues;
  int m_oldNum;
 
};
 
#endif // _SO_MF_FIELDCONTAINER_