PoBase.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-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
#ifndef  _PO_BASE_
#define  _PO_BASE_
 
class    PbBase ;
class    SoAction ;
class    SoFieldSensor ;
class    PbDataMapping ;
class    SoMaterial;
class    SoMaterialBinding;
class    SoQuadMesh;
class    SoIndexedTriangleStripSet;
class    SoIndexedFaceSet;
class    SoIndexedLineSet;
class    SoLineSet;
class    SoCache ;
class    SoShape;
 
#include <MeshViz/PoMeshViz.h>
#include <MeshViz/PbBasic.h>
#include <MeshViz/graph/PbDomain.h>
 
#include <Inventor/nodekits/SoBaseKit.h>
#include <Inventor/nodekits/SoAppearanceKit.h>
#include <Inventor/nodes/SoLightModel.h>
#include <Inventor/nodes/SoDrawStyle.h>
#include <Inventor/nodes/SoCallback.h>
#include <Inventor/caches/SoCache.h>
 
#define PO_KIT_ADD_FIELD(_fieldName,_defValue,_fieldList)\
        _fieldList.append(&_fieldName) ;\
        SO_KIT_ADD_FIELD(_fieldName, _defValue) ;
 
class  PoBase : public SoBaseKit {
 
  SO_KIT_ABSTRACT_HEADER(PoBase) ;
 
  SO_KIT_CATALOG_ENTRY_HEADER(catchActionCallback) ;
  SO_KIT_CATALOG_ENTRY_HEADER(alternateRep)   ;
  SO_KIT_CATALOG_ENTRY_HEADER(catchActionLevel2Callback) ;
  SO_KIT_CATALOG_ENTRY_HEADER(appearance)   ;
  SO_KIT_CATALOG_ENTRY_HEADER(domainTransform)   ;
 
 
 public:
 
 
 
  enum UpdateMethodType {
    UPDATE_METHOD_IMMEDIATE,
    UPDATE_METHOD_ON_ACTION
  } ;
 
  enum NodeWriteFormat {
    FOLD_NODE_WRITE_FORMAT,
    UNFOLD_NODE_WRITE_FORMAT
  } ;
 
  enum TextType {
    SO_TEXT3,
    SO_ANNO_TEXT3
  } ;
 
 
  typedef void PoRebuildCB(void *userData, PoBase *base) ;
 
  void setUpdateMethod(UpdateMethodType type) { m_updateMethodType = type ; }
 
  UpdateMethodType getUpdateMethod() const    { return m_updateMethodType ; }
 
  static void setNodeWriteFormat(NodeWriteFormat format);
 
  static NodeWriteFormat getNodeWriteFormat();
 
  void setDomain(PbDomain *dom) ;
 
  const PbDomain* getDomain() const ;
 
  void touchKit() ;
 
  SbBool isModified() const { return m_hasBeenModified ; }
 
  SbBool isBuilt() const
    { return m_isObjBuilt ; }
 
  virtual void  rebuild() {} ;
 
  void addPreRebuildCallback(PoRebuildCB *cb, void *data)  ;
 
  void addPostRebuildCallback(PoRebuildCB *cb, void *data) ;
 
 
  void removePreRebuildCallback(PoRebuildCB *cb, void *data=NULL)  ;
 
  void removePostRebuildCallback(PoRebuildCB *cb, void *data) ;
 
  static void setTextType(TextType type) ;
 
  static TextType getTextType();
 
  static void   setVRML2Mode(SbBool flag) ;
 
  static SbBool isVRML2Mode() ;
 
  virtual SoNode *copy(SbBool copyConnections = FALSE) const ;
 
  virtual SbBool affectsState() const ;
 
  /*----------------------------------------------------------------------------*/
 private:
 
  static void init() ;
    static void finish() ;
  static bool isInitialized();
 
  static void initClass() ;
    static void exitClass() ;
 
  // Overload the method write to store the current write action
  virtual void write(SoWriteAction *action) ;
 
  // Manage the connection with PbBase objects
  virtual void basicObjectChange(PbBase *basicObj) ;
 
  // Enable domain transform
  void enableDomainTransform(SbBool flag)
    { m_isDomainTrans = flag ; }
 
  SoShape* deleteTransparencyParts(const PbDataMapping *data_mapping, const SoMaterial *material, SoMaterialBinding *material_binding,
                               SoGroup *group);
  SoShape* deleteTransparencyParts(const PbDataMapping *data_mapping, const SoMaterial *material, SoMaterialBinding *material_binding,
                               SoQuadMesh *shape, SoGroup *father_of_shape, int child_index);
  SoShape* deleteTransparencyParts(const PbDataMapping *data_mapping, const SoMaterial *material, SoMaterialBinding *material_binding,
                               SoIndexedTriangleStripSet *shape, SoGroup *father_of_shape, int child_index);
  SoShape* deleteTransparencyParts(const PbDataMapping *data_mapping, const SoMaterial *material, SoMaterialBinding *material_binding,
                               SoIndexedFaceSet *shape, SoGroup *father_of_shape, int child_index);
  SoShape* deleteTransparencyParts(const PbDataMapping *data_mapping, const SoMaterial *material, SoMaterialBinding *material_binding,
                               SoIndexedLineSet *shape, SoGroup *father_of_shape, int child_index);
  SoShape* deleteTransparencyParts(const PbDataMapping *data_mapping, const SoMaterial *material, SoMaterialBinding *material_binding,
                               SoLineSet *shape, SoGroup *father_of_shape, int child_index);
 
  void setStateValid( bool isStateValid )
  {
    m_isStateValid = isStateValid;
  }
 
  // Store and Get the current state
  void     setState( SoAction* action );
  SoState* getState() const;
 
  private:
  // Implements actions
  virtual void        GLRender(SoGLRenderAction *action);
 
 private:
  // structure of a list of sensors
  struct FieldSensorList {
    int           numSensors ;
    SoFieldSensor **sensors ;
  } ;
 
  // Constructor and destructor
  // actionCallback is the callback function called
  // when the kit is traversed (callback of the node
  // SoCallback).
  PoBase(SoCallbackCB *actionCallback=NULL) ;
  virtual ~PoBase() ;
 
  // Methods
  virtual void  setDefaultOnNonWritingFields() ;
  virtual SbBool setUpConnections(SbBool onOff, SbBool doItAlways = FALSE) ;
 
   // Copies the contents of the given nodekit into this instance
  virtual void        copyContents(const SoFieldContainer *fromFC,
                                   SbBool copyConnections);
 
  // Change connection with a PbBase object
  void changeConnection(PbBase *oldObj, PbBase *newObj) ;
 
  // Called when a Pb object change
  virtual void manageBasicObjectChange(PbBase *basicObj, PbBase **obj) ;
 
  // Indicate if a field has changed
  SbBool isFieldHasChanged(const SoField *field) ;
 
  // Indicate if one of fields has changed
  SbBool isAnyFieldsHasChanged()
    { return m_someFieldsHasChanged ; }
 
  // Empty list of changed fields
  void emptyListFieldsChanged() { m_listFieldsChanged.truncate(0) ; }
 
  // Set a list of field at default value.
  void setListFieldsDefault(const SoFieldList &fieldLst) ;
 
  // Set domain scale transformation
  void setDomainTransform(PbDomain *domain) ;
 
  // Is domain scale transform
  SbBool isDomainTransformEnabled() const
    { return m_isDomainTrans ; }
 
  // Set domain used or not for rebuild
  void setDomainUsedForRebuild(SbBool flag)
    { m_isDomUseForRebuild = flag ; }
 
  // Is domain used for rebuild
  SbBool isDomainUsedForRebuild() const
    { return m_isDomUseForRebuild ; }
 
  // Method  which does somethings before rebuild a node
  virtual void preRebuild() ;
 
  // Method which does somethings after rebuild a node
  virtual void postRebuild() ;
 
  // Set light model for the part "appearence"
  void setLightModel(SoLightModel::Model model) ;
 
  // Set draw style (only field style) for am Appearence Kit
  void setDrawStyleAK(const SbString& partName, SoDrawStyle::Style style=SoDrawStyle::LINES) ;
 
  // Indicate if fields have changed must be stored
  // Not store by default
  void storeFieldsChanged(SbBool store)
    { needToStoreFieldsChanged = store ; }
 
  // Methods to handles list of sensors attached to fields
  // The method createFieldSensorList() must be called after all
  // field was created
  void createFieldSensorList(int numFields, FieldSensorList *sensorList) ;
  void deleteFieldSensorList(FieldSensorList *sensorList) ;
  void attachFieldSensorList(const FieldSensorList &sensorList,
                             const SoFieldList &fieldList) ;
  void detachFieldSensorList(const FieldSensorList &sensorList) ;
  static void fieldSensorCB(void *data, SoSensor *sensor) ;
 
  // Indicate if the state is valid that is we are
  // in a traversal
  SbBool isStateValid() const
    { return m_isStateValid ; }
 
  // Add an element in the cache for caching
  // Example of call : addElementCache(PoDomainElement::getClassStackIndex())
  template<typename T>
  void addElementCache()
  {
    if(isStateValid() && !isCacheValid())
      m_cache->addElement(getState()->template getConstElement<T>());
  }
 
 
  // Remove all elements in a cache
  // and rebuild it
  void rebuildCache(SoCache **cache) ;
 
  // Add all MeshViz used elements in all the cache
  // to be sure that a modification of one the them
  // will break the current cache
  virtual void addElementsAllCaches() ;
 
  // Indicate if the cache is rebuilt at each rebuild
  // even if the cache is valid.
  // That allows the user to manage the cache according to
  // the value of some fields.
  // FALSE by default
  void setCacheAlwaysRebuild(SbBool flag)
    { m_isCacheAlwaysRebuild = flag ; }
  SbBool isCacheAlwaysRebuild() const
    { return m_isCacheAlwaysRebuild ; }
 
 
  // Indicate if the cache if valid
  SbBool isCacheValid() const
    { return m_isCacheValid ; }
 
  // Vars
  SoFieldList      m_listFieldsChanged ;
  SbBool           needToStoreFieldsChanged ;
 
  // Indicate if the state is valid (only during an action)
  SbBool           m_isStateValid ;
 
 private:
  // Vars
  UpdateMethodType m_updateMethodType ;
  SbBool           m_hasBeenModified ;
  SbBool           m_isObjBuilt ;
  SbBool           m_isDomainTrans ;
  SbBool           m_isDomUseForRebuild ;
  SbBool           m_someFieldsHasChanged ;
  PbDomain         *m_domain, m_defaultDomain ;
  SoCallbackCB     *m_actionCallback ;
 
  SbBool           m_hasBeenBuilt ;
 
  // Indicate if the cache is rebuilt at each rebuild
  // even if the cache is valid.
  // That allows the user to manage the cache according to
  // the value of some fields.
  SbBool           m_isCacheAlwaysRebuild ;
 
  // Current state (update for each action)
  SoState          *m_currentState ;
 
  // Current cache for MeshViz elements
  SoCache          *m_cache ;
 
  // Current cache for domain
  SoCache          *m_domainCache ;
 
  // Indicate if the cache is valid
  SbBool           m_isCacheValid ;
 
  // Store the current write action
  SoWriteAction    *m_currentWriteAction ;
 
  PoRebuildCB      *m_preRebuildCB, *m_postRebuildCB ;
  void             *m_preRebuildData, *m_postRebuildData ;
 
  // Domain cache data
  SbBox3f m_domainBoxCache;
  PbDomain::TransformType m_domainTransformTypeCache;
 
  // Static Vars
  static NodeWriteFormat m_nodeWriteFormat ;
  static TextType        m_textType ;
  static SbBool          m_isVRML2Mode ;
 
  // Methods
  static void catchActionCB(void *, SoAction *) ;
  static void catchActionLevel2CB(void *, SoAction *) ;
 
  // Init/finish ref counter status
  static int s_initRefCount;
 
  static SbString s_soLdmValuationAction;
} ;
/*---------------------------------------------------------------------------*/
 
#endif /* _PO_BASE_ */