SoXtDirectionalLightEditor.h

Go to the documentation of this file.

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : David Mott (MMM yyyy)
**=======================================================================*/
/*=======================================================================
 *** 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                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : VSG (MMM YYYY)
**=======================================================================*/
 
 
#ifdef SOQT
#  include <Inventor/Qt/SoQtDirectionalLightEditor.h>
#elif defined _WIN32
#  include <Inventor/Win/SoWinDirectionalLightEditor.h>
#else // _WIN32
 
#ifndef _SO_XT_DIRECTIONAL_LIGHT_EDITOR_
#define _SO_XT_DIRECTIONAL_LIGHT_EDITOR_
 
#include <X11/Intrinsic.h>
#include <Xm/Xm.h>
#include <Inventor/SbBasic.h>
#include <Inventor/SbColor.h>
#include <Inventor/misc/SoCallbackList.h>
#include <Inventor/Xt/SoXtComponent.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 SoXtClipboard;
class SoXtColorEditor;
class SoXtColorSlider;
class SoXtRenderArea;
 
 
// callback function prototypes
typedef void SoXtDirectionalLightEditorCB(void *userData, const SoDirectionalLight *light);
 
//
//  Class: SoXtDirectionalLightEditor
//
 
class  SoXtDirectionalLightEditor : public SoXtComponent {
 public:
  SoXtDirectionalLightEditor(
                             SoWidget parent = NULL,
                             const char *name = NULL,
                             SbBool buildInsideParent = TRUE);
  ~SoXtDirectionalLightEditor();
 
  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(
                                              SoXtDirectionalLightEditorCB *f,
                                              void *userData = NULL);
  inline void         removeLightChangedCallback(
                                                 SoXtDirectionalLightEditorCB *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();
 
 private:
 
  // This constructor takes a boolean whether to build the widget now.
  // Subclasses can pass FALSE, then call SoXtDirectionalLightEditor::buildWidget()
  // when they are ready for it to be built.
  SoEXTENDER
    SoXtDirectionalLightEditor(
                               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
  SoXtColorEditor     *colorEditor;
  SoXtColorSlider     *intensitySlider;
  SoXtRenderArea      *renderArea;
  SoNodeSensor        *lightSensor;
  SoNodeSensor        *cameraSensor;
  SoDirectionalLightManip     *dirLightManip;
  static char         *geomBuffer;
  SbBool              ignoreCallback; // TRUE while callback should be ignored
  SoCallbackList      *callbackList;
 
  // Copy/paste support
  SoXtClipboard       *clipboard;
 
  // copy the src light values to the dst light values
  void                copyLight(SoDirectionalLight *dst,
                                const SoDirectionalLight *src);
 
  void                updateLocalComponents();
 
 private:
  // 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(SoXtDirectionalLightEditor *, SoSensor *);
  static void         lightSensorCB(SoXtDirectionalLightEditor *, 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);
 
};
 
// Inline functions
void
SoXtDirectionalLightEditor::addLightChangedCallback(
                                                    SoXtDirectionalLightEditorCB *f,
                                                    void *userData)
{ callbackList->addCallback((SoCallbackListCB *) f, userData); }
 
void
SoXtDirectionalLightEditor::removeLightChangedCallback(
                                                       SoXtDirectionalLightEditorCB *f,
                                                       void *userData)
{ callbackList->removeCallback((SoCallbackListCB *) f, userData); }
 
#endif // _SO_XT_DIRECTIONAL_LIGHT_EDITOR_
 
#endif // _WIN32