SoBaseList.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 S. Strauss (MMM yyyy)
** Modified by : Nick Thompson (MMM yyyy)
** Modified by : David Mott (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_BASE_LIST_H
#define SO_BASE_LIST_H
 
#include <Inventor/SbPList.h>
#include <Inventor/misc/SoBase.h>
#include <Inventor/sensors/SoListSensor.h>
 
class  SoBaseList : public SbPList
{
 public:
  SoBaseList();
 
  SoBaseList(int size);
 
  SoBaseList(const SoBaseList &l);
 
  virtual ~SoBaseList();
 
  void append(SoBase* ptr);
 
  void insert(SoBase* ptr, int addBefore);
 
  virtual void remove(int which);
 
  virtual void truncate(int start);
 
  void copy(const SoBaseList &l);
 
  SoBaseList& operator =(const SoBaseList &l)
  { copy(l) ; return *this; }
 
  SoBase* operator [](int i) const
  { return ( static_cast<SoBase*> ( (*static_cast<const SbPList *>(this) ) [i] ) ); }
 
  void set(int i, SoBase *ptr);
 
  void addReferences(SbBool flag);
 
  void touch( int index = -1 );
 
   void addAuditor(void *auditor, SoNotRec::Type type);
 
   void removeAuditor(void *auditor, SoNotRec::Type type);
 
   const SoAuditorList* getAuditors() const
   { 
     if (m_notificationInfo)
       return m_notificationInfo->m_auditors;
     return NULL;
   }
 
   int getChangedIndex() const 
   { 
     if (m_notificationInfo)
       return m_notificationInfo->m_changedIndex;
     return -1;
   }
 
   SoListSensor::ChangeType getChangedType() const
   {
     if (m_notificationInfo)
       return m_notificationInfo->m_changedType;
     return SoListSensor::UNSPECIFIED;
   }
 
  void setNotificationInfo(const int changedIndex, const SoListSensor::ChangeType changedType)
  {
    if (m_notificationInfo)
    {
      m_notificationInfo->m_changedIndex = changedIndex;
      m_notificationInfo->m_changedType  = changedType;
    }
  }
 
private:
  // Really does a truncate. Flag indicates whether to notify.
  void truncate(int start, SbBool doNotify);
 
private:
  // Inner class that handle auditors notification infos.
  class SoNotificationInfo
  {
  public:
    // Constructor.
    SoNotificationInfo();
    // Destructor.
    ~SoNotificationInfo();
    // List of auditors: objects to pass notification to
    SoAuditorList *m_auditors;
    // changed element index
    int m_changedIndex;
    // type of change
    SoListSensor::ChangeType m_changedType;
  };
 
  // start notification.
  void startNotify();
 
  bool getAddReferencesStatus() { return addRefs; }
 
 private:
  // If TRUE (the default), this refs and unrefs things in the list
  bool addRefs;
 
  // Auditor notification infos
  SoNotificationInfo *m_notificationInfo;
};
 
#endif