SoQtMaterialEditor.h

Go to the documentation of this file.

/*=======================================================================
 *** 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-2017 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : Alain Dumesny (MMM yyyy)
** Modified by : David Mott (MMM yyyy)
**=======================================================================*/
 
 
#ifndef _SO_QT_MATERIAL_EDITOR_
#define _SO_QT_MATERIAL_EDITOR_
 
#include <Inventor/Qt/OivQtCompat.h>
#include <Inventor/SbBasic.h>
#include <Inventor/misc/SoCallbackList.h>
#include <Inventor/Qt/SoQtComponent.h>
 
#include <QPointer>
class QMenu;
class QAction;
class SoBaseColor;
class SoQtColorEditor;
class QLabel;
class QRadioButton;
class QMenuBar;
class SoNodeSensor;
class SoSensor;
class SoDirectionalLight;
class SoMaterial;
class SoPathList;
class SoQtRenderArea;
class SoSelection;
class SoQtColorSlider;
class SoMFColor;
class SbColor;
class SoBase;
class SoSeparator;
class SoQtMaterialPalette;
 
class SoNode;           //ditto
class SoSFColor;        //ditto
 
// callback function prototypes
typedef void SoQtMaterialEditorCB(void *userData, const SoMaterial *mtl);
 
//
//  Class: SoQtMaterialEditor
//
//  This editor lets you interactively edit a material
//
 
class  SoQtMaterialEditor : public SoQtComponent {
  
  Q_OBJECT
    
public:
  enum UpdateFrequency {
    CONTINUOUS,
    AFTER_ACCEPT
  };
  
  SoQtMaterialEditor( QWidget *parent = qApp->activeWindow(),
                      const char *name = NULL, 
                      SbBool buildInsideParent = TRUE );
  ~SoQtMaterialEditor();
  
  void          attach( SoMaterial *material, int index = 0 );
 
  void          detach();
 
  SbBool                isAttached() { return (material != NULL); }
  
  inline void           addMaterialChangedCallback(
                                                   SoQtMaterialEditorCB *f, 
                                                   void *userData = NULL);
  inline void           removeMaterialChangedCallback(
                                                      SoQtMaterialEditorCB *f, 
                                                      void *userData = NULL);
  
  void  setUpdateFrequency(SoQtMaterialEditor::UpdateFrequency freq);
 
  SoQtMaterialEditor::UpdateFrequency getUpdateFrequency()
    { return updateFreq; }
  
  // Redefine these since there are multiple windows -
  // the color editor, directional light editor, and this component
  virtual void          show();
  virtual void          hide();
  
  void                  setMaterial(const SoMaterial &mtl);
 
  const SoMaterial     & getMaterial()     const { return *localMaterial; }
  
  SbBool alwaysOnTop;
 
  SoQtMaterialPalette * m_pMaterialPalette;   
 
 private:
  
  
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoQtMaterialEditor::buildWidget()
  // when they are ready for it to be built.
  SoEXTENDER
    SoQtMaterialEditor(
                       QWidget *parent,
                       const char *name, 
                       SbBool buildInsideParent, 
                       SbBool buildNow);
  
  // redefine these
  virtual SbString    getDefaultWidgetName() const;
  virtual SbString    getDefaultTitle() const;
  virtual SbString    getDefaultIconTitle() const;
 
  virtual bool eventFilter(QObject * object,QEvent *event);
  
 private:
  unsigned long nCurrEditId ;
  //unsigned long diamondButtonId[4];
  //unsigned long radioButtonId[4];
  QMenuBar *menubar ;
  
  
  // attach vars
  //SoMaterial          *material;  // material we are editing
  SoNode              *material;  // material we are editing
  SoMaterial          *imat;      // ditto
  int                 index;        // material index number
  SoNodeSensor        *sensor;
  SoCallbackList      *callbackList;
  QPointer<QRadioButton>        diamondButtons[4], radioButtons[4];
  QPointer<SoQtButton>          acceptButton;
  SoQtMaterialEditor::UpdateFrequency   updateFreq;
  
  // widgets to edit the material
  QPointer<QWidget>    mgrWidget;     // topmost widget
  SoQtColorEditor     *colorEditor;
  SoQtColorSlider     *sliders[6];
  SbBool              changedIt[6];
#ifdef NOTYET
  SoQtMaterialList      *materialList;
#endif
  SbBool                ignoreCallback; // TRUE while callback should be ignored
  SbBool                openMaterialList;
  
  // copy/paste support
  //SoQtClipboard               *clipboard;
  
  // local scene vars
  SoQtRenderArea        *renderArea;
  SoMaterial          *localMaterial;       // local copy of the material
  SoDirectionalLight    *light0;
  SoDirectionalLight    *light1;
  SoBaseColor           *tileColor;
  SoSeparator           *root;
  
  long          activeColor;        // field which color editor edits
  
  // update the sliders/colorEditor based on the local material
  void                  updateLocalComponents();
  
  // update the colorEditor based on the activeColor flag
  void                  updateColorEditor(SbBool updateTitle = FALSE);
  
  // update a color slider (amb/diff/spec/emiss) based of a material color
  // (split the base color from the intensity).
  void                  updateColorSlider(SoQtColorSlider *, const float rgb[3]);
  
  // update a material field when a color slider changes.
  void                  updateMaterialColor(
                                            SoMFColor   *editMtlColor,
                                            SoMFColor   *localMtlColor,
                                            const float *rgb,
                                            float       intensity);
  void                  updateMaterialColor(
                                            SoSFColor   *editMtlColor,
                                            SoMFColor   *localMtlColor,
                                            const float *rgb,
                                            float       intensity);
  
  // copies mat2 onto mat1
  //void                copyMaterial(SoMaterial *mat1, int index1, 
  //                         const SoMaterial *mat2, int index2);
  void                  copyMaterial(SoNode *mat1, int index1, 
                                     const SoNode *mat2, int index2);
  
  // For each of the 6 sliders (or sets of sliders) sets the ignore flag of 
  // the material node being editted to FALSE if it has been changed.
  void          undoIgnoresIfChanged();
  
  // copy/paste support
  //static void         pasteDone(void *userData, SoPathList *pathList);
  
  // Callback routines from components
  static void materialListCB(void *, const SoMaterial *);
  static void colorEditorCB(void *, const SbColor *);
  static void ambientSliderCB(void *, float);
  static void diffuseSliderCB(void *, float);
  static void specularSliderCB(void *, float);
  static void emissiveSliderCB(void *, float);
  static void shininessSliderCB(void *, float);
  static void transparencySliderCB(void *, float);
  static void paletteEditorClosedCB(void*, SoQtComponent*);
  static void colorEditorCloseCB(void* userData, SoQtComponent*);
  static void dialogCloseCB(void* userData, SoQtComponent*);
  
  // Callback routines from Xt/Motif
  void          menuPick(int id);
  void          menuDisplay(QWidget*, SoQtMaterialEditor *, XtPointer);
  void          radioButtonPick(QWidget*, int, XtPointer);
  void          diamondButtonPick(QWidget*, int, XtPointer);
  
  // Sensor callbacks
  static void           sensorCB(void *, SoSensor *);
  
  // Build routines
  QWidget*                    buildWidget(QWidget* parent);
  QMenuBar*         buildPulldownMenu(QWidget* parent);
  QWidget*              buildControls(QWidget* parent);
  QWidget*              buildSlidersForm(QWidget* parent);
  
  void        activate();               // connects the sensor
  void        deactivate();             // disconnects the sensor
  
  // this is called by both constructors
  void constructorCommon(SbBool buildNow);
  
  QPointer<QMenu> edit;
  QAction* acCon, *acMan;
  
  private Q_SLOTS:
  
    void visibilityChangeCB(SbBool visible);
  
  void slot_mat_pal();
  void slot_continuous();
  void slot_manual();
  
  void slot_radioButton0();
  void slot_radioButton1();
  void slot_radioButton2();
  void slot_radioButton3();
  
  void slot_diamondButton0();
  void slot_diamondButton1();
  void slot_diamondButton2();
  void slot_diamondButton3();
  
  void acceptButtonCB();
  
  void slot_help();
  
};
 
// Inline functions
void
SoQtMaterialEditor::addMaterialChangedCallback(
                                               SoQtMaterialEditorCB *f, 
                                               void *userData)
{ callbackList->addCallback((SoCallbackListCB *) f, userData); }
 
void
SoQtMaterialEditor::removeMaterialChangedCallback(
                                                  SoQtMaterialEditorCB *f, 
                                                  void *userData)
{ callbackList->removeCallback((SoCallbackListCB *) f, userData); }
 
 
#endif // _SO_QT_MATERIAL_EDITOR_