MeshViz/graph/editors/PoXtLegendEditor.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-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/

#ifndef _POXTLEGENDEDITOR_H_
#define _POXTLEGENDEDITOR_H_

#include <MeshViz/PoMeshVizW.h>
#include <Inventor/SbLinear.h>
#include <Inventor/Xt/SoXtComponent.h>

#include <MeshViz/PbBasic.h>

#include <Inventor/dialog/PoXtDialog.h>

class SoCallbackList;
class PoLegend;
class SoSensor;
class SoNodeSensor;
struct menuColumn;

class SoDEPRECATED  PoXtLegendEditor
: public SoXtComponent
{

 public:

  typedef void PoXtLegendEditorCB (void * userData, PoLegend * data);

  enum LegendMask
  {
    NO_LEGEND_MASK               = 0x00000000,

    TITLE_VISIBILITY             = 0x00000001,
    TITLE_POSITION               = 0x00000002,
    TITLE_PATH                   = 0x00000004,
    TITLE_FONT_NAME              = 0x00000008,
    TITLE_FONT_SIZE              = 0x00000010,
    TITLE_STRING                 = 0x00000020,
    TITLE = TITLE_STRING | TITLE_FONT_SIZE | TITLE_FONT_NAME | TITLE_PATH
    | TITLE_POSITION | TITLE_VISIBILITY, 

    VALUE_VISIBILITY             = 0x00000040,
    VALUE_POSITION               = 0x00000080,
    VALUE_FONT_NAME              = 0x00000100,
    VALUE_ADD_STRING_VISIBILITY  = 0x00000200,
    VALUE_ADD_STRING             = 0x00000400,
    VALUE = VALUE_ADD_STRING | VALUE_ADD_STRING_VISIBILITY | VALUE_FONT_NAME
    | VALUE_POSITION | VALUE_VISIBILITY, 

    MARGIN_TYPE                  = 0x00000800,
    MARGIN_LEFT                  = 0x00001000,
    MARGIN_RIGHT                 = 0x00002000,
    MARGIN_BOTTOM                = 0x00004000,
    MARGIN_TOP                   = 0x00008000,
    MARGIN = MARGIN_TOP | MARGIN_BOTTOM | MARGIN_RIGHT 
    | MARGIN_LEFT | MARGIN_TYPE,  

    INCREMENT_TYPE               = 0x00010000,
    NUM_COLUMNS                  = 0x00020000,
    BOX_RATIO                    = 0x00040000,
    MISC_TEXT_ATTR               = 0x00080000,
    MISC = INCREMENT_TYPE | NUM_COLUMNS | BOX_RATIO | MISC_TEXT_ATTR, 
    
    ALL_LEGEND_MASK = TITLE | VALUE | MARGIN | MISC
  } ;


  enum Presentation
  {
    TOGGLE_FOLD,
    TOGGLE_UNFOLD,
    LABEL_UNFOLD 
  } ;


  enum UpdateFrequency
  {
    CONTINUOUS,  
    AFTER_ACCEPT 
  } ;



 public:

  virtual void attach (PoLegend * legend);

  void detach ();

  SbBool isAttached () const;

  void addLegendChangedCallback (PoXtLegendEditorCB * func, void * userData);

  void removeLegendChangedCallback (PoXtLegendEditorCB * func, void * userData);

  virtual void setPresentation (Presentation type);

  Presentation getPresentation () const;

  void setUpdateFrequency (UpdateFrequency freq);

  UpdateFrequency getUpdateFrequency () const;

  void setLegendFilter (unsigned long inclusionMask,
                        unsigned long exclusionMask);

  void getLegendFilter (unsigned long & inclusionMask,
                        unsigned long & exclusionMask) const;

  virtual void show ();
  virtual void hide ();
  

  /*----------------------------------------------------------------------------*/


 PoINTERNAL private:

  PoXtLegendEditor (SoWidget Parent = NULL,
                    const char * name = NULL,
                    SbBool buildInsideParent = TRUE);

  virtual void buildWidget (SoWidget Parent, 
                            const char * name, 
                            SbBool buildInsideParent);
  virtual void setFilter();

  virtual ~PoXtLegendEditor ();
  
  
  virtual SbString    getDefaultWidgetName() const;
  virtual SbString    getDefaultTitle() const;
  virtual SbString    getDefaultIconTitle() const;
  
  void updateXtElements ();

  virtual void copyLegendFields(PoLegend * dest, PoLegend * source);
  virtual void updateLegendFromXtElements ();
  
  virtual int getMenuItems();

  // Attribute
  PoLegend * _legend;
  PoLegend * _attachedLegend;
  PoXtDialog * _dialog;
  SoNodeSensor * _sensor;

  Presentation    _presentation;

  menuColumn * _menu;
  int          _menuItems;
  SoCallbackList * _callbackList;

 private:
  UpdateFrequency _frequency;
  int _classMenusNb;
  unsigned long   _incLegendMask;
  unsigned long   _excLegendMask;

  SbBool _isLegendSet;

  void activate ();
  void deactivate ();


  // Callbacks for PoXtDialog
  static void acceptCallback (void *, const PoXtDialog::PoXtDialogDataCB *);
  static void elementsCallback (void *, const PoXtDialog::PoXtDialogDataCB *);
  static void visibilityChangeCB (void *, SbBool visible);
  static void sensorCB (void *, SoSensor *);
};


#endif // _POXTLEGENDEDITOR_H_

---

Open Inventor Toolkit reference manual, generated on 22 Jul 2025
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/