SoEnabledElementsList.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 : Gavin Bell (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_ENABLED_ELEMENTS_LIST_H_
#define _SO_ENABLED_ELEMENTS_LIST_H_
 
//
//  Class: SoEnabledElementsList
//
//  Internal class.  A list of elements enabled for a given action
//  class. Lists of elements can be merged, allowing an action class
//  to inherit enabled elements from its parent class.
//
 
#ifndef HIDDEN_FROM_DOC
 
#include <Inventor/SoType.h>
 
 
{
 
 public:
  // Constructor
  SoEnabledElementsList(SoEnabledElementsList *parentList);
 
  // Returns list of elements.  This automatically merges the
  // elements with elements enabled in the parentList.
  const SoTypeList &  getElements() const;
 
  // Adds an element to the list if it's not already in it
  void enable(SoType elementType, int stackIndex);
 
  // Returns the current setting of the global counter used to
  // determine when lists are out of date.
  int getCounter() const
  { return counter; }
 
  // Reset the element counter to 0;
  void resetCounter()
  { counter = 0; }
 
 private:
  // This maintains a global counter used to determine when lists
  // are out of date. It is incremented whenever a new element is
  // added to a list.
  mutable int counter;
 
  // Used to protect access to the ststai counter variable.
  mutable SbThreadMutex counterMtx;
 
  // And a per-instance counter so we don't merge enabled elements
  // with the parent list unnecessarily.
  int setUpCounter;
 
  // This list holds type id's of enabled elements, indexed by the
  // stack index of the elements.
  SoTypeList elements;
 
  // Pointer to parent's list of enabled elements (NULL for
  // SoAction).
  SoEnabledElementsList *parent;
};
 
#endif
 
#endif // _SO_ENABLED_ELEMENTS_LIST_H_