SoNodeDependencies.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-2024 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : T. ANDRIEU (AUG 2014)
**=======================================================================*/
 
 
#ifndef  _SO_CACHE_OBJECT
#define  _SO_CACHE_OBJECT
 
#include <Inventor/caches/SoCache.h>
#include <Inventor/misc/SoRefCounter.h>
#include <Inventor/sensors/SoFieldSensor.h>
 
#if defined(_WIN32)
#pragma warning(push)
#pragma warning(disable: 4251) // 'identifier' : class 'type' needs to have dll-interface to be used by clients of class 'type2'
#endif

class  SoNodeDependencies : public SoRefCounter
{
public:
  SoNodeDependencies();
 
  ~SoNodeDependencies();

  bool isValid(SoState* state) const;

  void updateCache(SoState* state);

  void invalidate();

  template <typename SO_ELEMENT>
  void addDependency()
  {
    addDependency( SO_ELEMENT::getClassTypeId(), SO_ELEMENT::getClassStackIndex() );
  }

  void addDependency( SoField& field );

  void addDependency(SoType type, int classStackIndex);
 
private:
  struct CachedElement
  {
    CachedElement(SoType& type_, int classStackIndex_) : type(type_), classStackIndex(classStackIndex_) {}
    SoType type; // type of element
    int classStackIndex; // stackIndex of element in state cache stack.
  };

  std::vector<CachedElement> m_elementsDependencies;

  std::vector<SoFieldSensor*> m_fieldSensors;

  bool m_fieldsValid;

  static void fieldSensorCB( void* data, SoSensor* sensor );
 
  SoRef<SoCache> m_cache;
 
  mutable SbThreadSpinlock m_mutex;
};
 
#if defined(_WIN32)
#pragma warning(pop)
#endif
 
#endif /* _SO_CACHE_OBJECT */