SoElement.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)
**=======================================================================*/
/*=======================================================================
 *** 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-2019 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifndef  _SO_ELEMENT
#define  _SO_ELEMENT
 
#include <Inventor/SbPImpl.h>
#include <Inventor/SoType.h>
#include <Inventor/SoTypedObject.h>
#include <Inventor/misc/SoState.h>
#include <Inventor/errors/SoDebugError.h>
#include <assert.h>
 
class SoNotList;
 
 
#ifndef HIDDEN_FROM_DOC
//Max expected key, smaller than full range to optimize use in bitset
#define SO_ELEMENT_MAX_KEY 512
#endif
 
SO_PIMPL_PUBLIC_DECLARATION(SoGLCacheList)
 
 
SoEXTENDER_Documented class  SoElement: public SoTypedObject {
 
 public:
 
  virtual void push(SoState *state);
 
  virtual void pop(SoState *state, const SoElement *prevTopElement);
 
  virtual void print(FILE *fp) const;
 
  static SoType getClassTypeId();
 
  virtual SoType getTypeId() const       { return typeId; }
 
private:
 
  virtual void commonInit();
 
  virtual void init(SoState *state);
 
  virtual SbBool matches(const SoElement* elt) const = 0;
 
  virtual SoElement* copyMatchInfo() const = 0;
 
  SoElement* getNextInStack() const { return nextInStack; }
 
 private:
  typedef uint16_t SoElementKeyType;
  // Create a new key
  static SoElementKeyType createElementKey();
 
  virtual SoElementKeyType getElementKey() const
  {
    return badElementKey();
  }
 
  static SoElementKeyType badElementKey();
 
  // Initialize ALL Inventor element classes
  static void initElements();
  static void exitElements();
 
  inline bool isTrackingSetterGetterNodes() const
  {
    return m_trackSetterGetterNodes;
  }
  
  virtual int getClassStackIndexInternal() const = 0;
 
  // Initializes the SoElement class
  static void initClass();
  static void exitClass();
 
  // get max element key value
  static int maxElementKey() { return s_nextElementKey; }
 
  // Returns the number of stack indices allocated
  static int getNumStackIndices();
 
  // Returns the id for the element with the given stack index
  static SoType getIdFromStackIndex(int stackIndex);
 
  // Returns the stack index for an element instance
  inline int getStackIndex() const   { return stackIndex; }
  
  // Sets stackIndex in instance
  void setStackIndex(int index)        { stackIndex = index; }
 
  // Sets stuff in an element instance
  void setDepth(int dpth)              { depth = dpth; }
  void setNext(SoElement *nxt)         { next = nxt; }
  void setNextInStack(SoElement *nxt)  { nextInStack = nxt; }
  void setNextFree(SoElement *nxt)     { nextFree = nxt; }
 
  // Returns stuff from element instance
  int getDepth() const               { return depth; }
  SoElement* getNext()  const        { return next; }
 
  static const SoElement* getStackElement(SoState *state, const SoType& type, int stackIndex);
 
  static const SoElement* getConstElement(SoState *state, const SoType& type, int stackIndex);
 
  template<typename T>
  static const T* getConstElement(SoState *state)
  {
    return static_cast<const T*>(getConstElement(state, T::getClassTypeId(), T::getClassStackIndex()));
  }
 
  // Sets/Gets the pop priority.
  // Higher priority will be popped first.
  void setPopPriority(unsigned short priority) {m_popPriority = priority ;}
  unsigned short getPopPriority() const { return m_popPriority ; }
 
  // Destructor
  virtual ~SoElement();
 
  // This is called when a referenced SoBase (path, field, node, whatever) is
  // deleted. All subclasses must implement this to do the right
  // thing in case of reference to any SoBase object.
  virtual void dyingReference() {} ;
 
  inline SoType getInstanceTypeId() const
  {
    // if this assert is triggered it means that SO_SUB_ELEMENT macro
    // are not use/defined correctly: setTypeId(classTypeId) has not
    // been called in element constructor (see constructor code above)
    assert(typeId!=SoType::badType());
    return typeId;
  }
 
#if 1             SoDEPRECATED
  static const SoElement* getConstElement(SoState *state, int stackIndex);
SoDEPRECATED
  static const SoElement* getStackElement(SoState *state, int stackIndex);
 
#endif 
 private:
  SoElement();
 
  template<typename T>
  static T* getElement(SoState *state)
  {
    return static_cast<T*>(getElement(state, T::getClassTypeId(), T::getClassStackIndex()));
  }
 
  static SoElement* getElement(SoState *state, const SoType& type, int stackIndex);
 
  // Does whatever is necessary in state to capture this element for
  // caching purposes. Should be called by subclasses whenever
  // any value in the element is accessed.
  void capture(SoState *state) const
  {
    if ( state->isCacheOpen() )
      captureThis(state);
  }
 
  // Really captures this element, once it has been determined that
  // a cache is open to capture it
  virtual void captureThis(SoState *state) const;
 
  // Sets typeId in instance
  void setTypeId(SoType id) { typeId = id; }
 
 
  // Returns next free element in a specific element stack
  SoElement* getNextFree() const { return nextFree; }
 
  inline void setPopped(SbBool flag) { m_popped = (flag == TRUE); }
  inline SbBool isPopped() const { return m_popped ; }
 
  static int getClassStackIndex();
 
#if 1             SoDEPRECATED
  static SoElement* getElement(SoState *state, int stackIndex);
 
#endif 
 SoINTERNAL private:
  // Creates and returns a new stack index
  // used internally whille registering an element in the database
  static int createStackIndex(const SoType& id);
 
  inline void trackSetterGetterNodes(bool flag)
  {
    m_trackSetterGetterNodes = flag;
  }
 
 private:
  SoElement* insertAtDepth(SoElement* elt, int depth);
 
  SoElement* replaceElement(SoState* state, SoElement* oldElt, SoElement* newElt);
 
  void updateNextInStackAndFree(SoElement* oldElt, SoElement* newElt);
 
  // nextInStack and nextFree are the pointers in a doubly-linked
  // list for each stack in the state.  nextInStack points toward
  // the bottom of the stack and nextFree points toward the top of
  // the stack.  Once a stack has been fully allocated, pushing
  // becomes simply following the nextFree pointer and popping
  // becomes following the nextInStack pointer.
 
  SoElement           *nextInStack;   // Next element of same type on stack
  SoElement           *nextFree;      // Next free element
  SoElement           *next;          // Next element in all-element
 
  static int         classStackIndex;  // Stack index for SoElement class
 
  // Stack index stuff
  static int         nextStackIndex;  // Next stack index to allocate
 
  static SoTypeList  *stackToType;    // Correlates stack index to type id
  int                 stackIndex;     // Stack index for instance
  int                 depth;          // Stack depth of element
 
  // Type identifier stuff
  static SoType      classTypeId;     // Type identifier for SoElement class
  SoType              typeId;         // Type identifier for instance
 
  // Other per-instance stuff
  // stack
  unsigned short    m_popPriority ; // Stores the pop priority.
  bool              m_popped ;      // Indicates if the element has been popped.
 
  bool m_trackSetterGetterNodes;
 
  friend class SoState;
  friend class SoCache;
  friend class SoBoundingBoxCache;
  friend class inventor::impl::SoGLCacheListImpl;
  friend class SoGLViewingMatrixElement;
 
  //Insure increment of key while initing element class
  static SoElementKeyType s_nextElementKey;
};
 
#endif /* _SO_ELEMENT */