SoWinMaterialEditor.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-2014 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
#ifndef _SO_WIN_MATERIAL_EDITOR_
#define _SO_WIN_MATERIAL_EDITOR_
 
#include <Inventor/Win/SoWinBeginStrict.h>
#include <Inventor/sys/port.h>
#include <Inventor/SbBasic.h>
#include <Inventor/misc/SoCallbackList.h>
#include <Inventor/Win/SoWinComponent.h>
 
class SoBaseColor;
class SoWinClipboard;
class SoWinColorEditor;
class SoNodeSensor;
class SoSensor;
class SoDirectionalLight;
class SoMaterial;
#ifdef NOTYET
class SoWinMaterialList;
#endif
class SoPathList;
class SoWinRenderArea;
class SoSelection;
class SoWinColorSlider;
class SoMFColor;
class SbColor;
class SoBase;
class SoSeparator;
class SoWinMaterialPalette;
 
class SoNode;           //ditto
class SoSFColor;        //ditto
 
// callback function prototypes
typedef void SoWinMaterialEditorCB(void *userData, const SoMaterial *mtl);
 
//
//  Class: SoWinMaterialEditor
//
//  This editor lets you interactively edit a material
//
 
class  SoWinMaterialEditor : public SoWinComponent {
 public:
   enum UpdateFrequency {
    CONTINUOUS,
    AFTER_ACCEPT,
  };
    
  SoWinMaterialEditor(
                      SoWidget parent = NULL,
                      const char *name = NULL, 
                      SbBool buildInsideParent = TRUE);
  virtual ~SoWinMaterialEditor();
    
  void                attach( SoMaterial *material, int index = 0 );
 
  void                detach();
  SbBool              isAttached() { return (material != NULL); }
    
  inline void         addMaterialChangedCallback(
                                                 SoWinMaterialEditorCB *f, 
                                                 void *userData = NULL);
  inline void         removeMaterialChangedCallback(
                                                    SoWinMaterialEditorCB *f, 
                                                    void *userData = NULL);
    
  void        setUpdateFrequency(SoWinMaterialEditor::UpdateFrequency freq);
  SoWinMaterialEditor::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;
  SoWinMaterialPalette * m_pMaterialPalette;    
 private:
 
 
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoWinMaterialEditor::buildWidget()
  // when they are ready for it to be built.
  SoEXTENDER
    SoWinMaterialEditor(
                        SoWidget parent,
                        const char *name, 
                        SbBool buildInsideParent, 
                        SbBool buildNow);
    
  // redefine these
  virtual SbString    getDefaultWidgetName() const;
  virtual SbString    getDefaultTitle() const;
  virtual SbString    getDefaultIconTitle() const;
    
 private:
  unsigned long nCurrEditId ;
  unsigned long diamondButtonId[4] ;
  unsigned long radioButtonId[4] ;
  HMENU menubar ;
 
  void layoutAccept() ;
 
  static WBOOL CALLBACK mgrDlgProc( Hwnd hdlg, UINT message,
                                    WPARAM wParam, LPARAM lParam );
  static void onCommand(
                        Hwnd hdlg,
                        int id,
                        Hwnd hCtrl,
                        UINT codeNotify ) ;
 
  void handleEdit(
                  int nSlider,
                  Hwnd hEdit,
                  UINT codeNotify) ;
 
  void handleButtons(SoWinMaterialEditor *p,
                     SoWidget hCtrl,
                     int id,
                     UINT codeNotify) ;
        
  void handleMenu(SoWinMaterialEditor *p,
                  int id ) ;
 
  void initPlacement() ;
 
 
  // 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;
  SoWidget              acceptButton, diamondButtons[4], radioButtons[4];
  SoWinMaterialEditor::UpdateFrequency        updateFreq;
 
  // widgets to edit the material
  SoWidget                      mgrWidget;      // topmost widget
  SoWinColorEditor    *colorEditor;
  SoWinColorSlider    *sliders[6];
  SbBool              changedIt[6];
#ifdef NOTYET
  SoWinMaterialList   *materialList;
#endif
  SbBool              ignoreCallback; // TRUE while callback should be ignored
  SbBool              openMaterialList;
  static void         colorEditorCloseCB(void *, SoWinComponent *);
  static void         materialListCloseCB(void *, SoWinComponent *);
    
  // copy/paste support
  SoWinClipboard              *clipboard;
    
  // local scene vars
  SoWinRenderArea     *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(SoWinColorSlider *, 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);
    
  // Callback routines from Xt/Motif
  void                menuPick(SoWidget, int, XmAnyCallbackStruct *);
  void                menuDisplay(SoWidget, SoWinMaterialEditor *, XtPointer);
  void                radioButtonPick(SoWidget, int, XtPointer);
  void                diamondButtonPick(SoWidget, int, XtPointer);
 
  static void         acceptButtonCB(SoWidget, SoWinMaterialEditor *, XtPointer);
    
  // Sensor callbacks
  static void         sensorCB(void *, SoSensor *);
 
  // Build routines
  SoWidget              buildWidget(SoWidget parent);
  SoWidget              buildPulldownMenu(SoWidget parent);
  SoWidget              buildControls(SoWidget parent);
  SoWidget              buildSlidersForm(SoWidget parent);
    
  static void visibilityChangeCB(void *pt, SbBool visible);
  void        activate();             // connects the sensor
  void        deactivate();           // disconnects the sensor
 
  // this is called by both constructors
  void constructorCommon(SbBool buildNow);
 
};
 
 
// Inline functions
 void
SoWinMaterialEditor::addMaterialChangedCallback(
                                                SoWinMaterialEditorCB *f, 
                                                void *userData)
{ callbackList->addCallback((SoCallbackListCB *) f, userData); }
 
 void
SoWinMaterialEditor::removeMaterialChangedCallback(
                                                   SoWinMaterialEditorCB *f, 
                                                   void *userData)
{ callbackList->removeCallback((SoCallbackListCB *) f, userData); }
 
#include <Inventor/Win/SoWinEndStrict.h>
 
#endif // _SO_WIN_MATERIAL_EDITOR_