SoWinDirectionalLightEditor.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_DIRECTIONAL_LIGHT_EDITOR_
#define _SO_WIN_DIRECTIONAL_LIGHT_EDITOR_
 
#include <Inventor/Win/SoWinBeginStrict.h>
#include <Inventor/sys/port.h>
#include <Inventor/SbBasic.h>
#include <Inventor/SbColor.h>
#include <Inventor/misc/SoCallbackList.h>
#include <Inventor/Win/SoWinComponent.h>
 
 
class SoBase;
class SoCamera;
class SoDirectionalLight;
class SoDirectionalLightManip;
class SoDragger;
class SoGroup;
class SoNodeSensor;
class SoPath;
class SoPathList;
class SoPerspectiveCamera;
class SoSensor;
class SoSeparator;
class SoWinClipboard;
class SoWinColorEditor;
class SoWinColorSlider;
class SoWinRenderArea;
 
 
// callback function prototypes
typedef void SoWinDirectionalLightEditorCB(void *userData, const SoDirectionalLight *light);
 
//
//  Class: SoWinDirectionalLightEditor
//
 
class  SoWinDirectionalLightEditor : public SoWinComponent {
 public:
  SoWinDirectionalLightEditor(
                              SoWidget parent = NULL,
                              const char *name = NULL, 
                              SbBool buildInsideParent = TRUE);
  ~SoWinDirectionalLightEditor();
 
  void                attach(SoPath *pathToLight);
  void                detach();
  SbBool              isAttached()    { return (dirLight != NULL); }
    
  void                setLight(const SoDirectionalLight &newLight);
  const SoDirectionalLight &getLight() const { return *dirLight; }
    
  inline void         addLightChangedCallback(
                                              SoWinDirectionalLightEditorCB *f, 
                                              void *userData = NULL);
  inline void         removeLightChangedCallback(
                                                 SoWinDirectionalLightEditorCB *f, 
                                                 void *userData = NULL);
 
  // Redefined here since there are two windows to deal with -
  // the color editor and the light manipulator
  virtual void        show();
  virtual void        hide();
 
  SbBool alwaysOnTop;
 private:
 
  SoWidget              mgrWidget;      // topmost widget
 
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoWinDirectionalLightEditor::buildWidget()
  // when they are ready for it to be built.
  SoEXTENDER
    SoWinDirectionalLightEditor(
                                SoWidget parent,
                                const char *name, 
                                SbBool buildInsideParent, 
                                SbBool buildNow);
 
  // redefine these
  virtual SbString    getDefaultWidgetName() const;
  virtual SbString    getDefaultTitle() const;
  virtual SbString    getDefaultIconTitle() const;
    
  SoDirectionalLight  *dirLight;          // light we are editing
  SoSeparator         *root;              // root of local scene graph
  SoSeparator         *litStuff;          // what's on display under thelight
 
  SoPerspectiveCamera *myCamera;
  SoCamera            *cameraToWatch;
    
  // components, manips, sensors
  SoWinColorEditor    *colorEditor;
  SoWinColorSlider    *intensitySlider;
  SoWinRenderArea      *renderArea;    
  SoNodeSensor        *lightSensor;
  SoNodeSensor        *cameraSensor;
  SoDirectionalLightManip     *dirLightManip;
  static char             *geomBuffer;
  SbBool              ignoreCallback; // TRUE while callback should be ignored
  SoCallbackList      *callbackList;
    
  // Copy/paste support
  SoWinClipboard      *clipboard;
    
  // copy the src light values to the dst light values
  void                copyLight(SoDirectionalLight *dst, 
                                const SoDirectionalLight *src);
                            
  void                updateLocalComponents();
 
 private:
 
  HMENU menubar ;
 
  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 handleMenu(Hwnd hdlg,
                  SoWinDirectionalLightEditor *p,
                  int id ) ;
 
  void initPlacement() ;
 
  static void colorEditorCloseCB(void *userData, SoWinComponent *comp) ;
 
  // Callback routines from components and manipulators
  static void         colorEditorCB(void *, const SbColor *);
  static void         intensitySliderCB(void *, float);
  static void         pasteDoneCB(void *, SoPathList *);
  static void         dirLightManipCB(void *, SoDragger *);
 
  // Callback routines from Xt/Motif
  static void         menuPick(SoWidget, int, XmAnyCallbackStruct *);
    
  // Sensor callbacks
  static void         cameraSensorCB(SoWinDirectionalLightEditor *, SoSensor *);
  static void         lightSensorCB(SoWinDirectionalLightEditor *, SoSensor *);
 
  // Build routines
  SoWidget              buildWidget(SoWidget parent);
  SoWidget              buildPulldownMenu(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);
  SoNode *geom;
 
};
 
// Inline functions
 void
SoWinDirectionalLightEditor::addLightChangedCallback(
                                                     SoWinDirectionalLightEditorCB *f, 
                                                     void *userData)
{ callbackList->addCallback((SoCallbackListCB *) f, userData); }
 
 void
SoWinDirectionalLightEditor::removeLightChangedCallback(
                                                        SoWinDirectionalLightEditorCB *f, 
                                                        void *userData)
{ callbackList->removeCallback((SoCallbackListCB *) f, userData); }
 
#include <Inventor/Win/SoWinEndStrict.h>
 
#endif // _SO_WIN_DIRECTIONAL_LIGHT_EDITOR_