LDM/nodes/SoTransferFunction.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-2021 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : P. ESTRADE (Mar 2000)
**=======================================================================*/
#ifndef  _SO_TRANSFER_FUNCTION_
#define  _SO_TRANSFER_FUNCTION_

#include <LDM/SoLDM.h>

#include <Inventor/nodes/SoNode.h>
#include <Inventor/nodes/SoTexture2.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoMFFloat.h>
#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/algorithms/SoConversion.h>
#include <Inventor/SbVec.h>

#include <Inventor/SbPImpl.h>

#ifdef _WIN32
#pragma warning( push )
#pragma warning(disable:4251)
#endif

class SoGLTexture;
class SoVolumeState;

SO_PIMPL_BASE_PUBLIC_DECLARATION(SoTransferFunction)


class  SoTransferFunction : public SoNode {

  SO_NODE_HEADER( SoTransferFunction );

  SO_PIMPL_BASE_PUBLIC_HEADER(SoTransferFunction);

 public:
  SoSFInt32 transferFunctionId;

   SoSFInt32 shift;

  SoSFInt32 offset;

  SoSFInt32 minValue;

  SoSFInt32 maxValue;

  SoSFFloat fauxShadingLength;

  SoSFFloat fauxShadingStrength;

  SoSFFloat fauxShadingDarkenThreshold;

  enum PredefColorMap {
    NONE,
    GREY,
    GRAY = GREY,
    TEMPERATURE,
    PHYSICS,
    STANDARD,
    GLOW,
    BLUE_RED,
    SEISMIC,
    BLUE_WHITE_RED,
    INTENSITY,
    LABEL_256,
    VOLREN_RED,
    VOLREN_GREEN,
    AIRWAY,
    AIRWAY_SURFACES,
     INTENSITY_REVERSED
  };

  SoSFEnum predefColorMap;

  enum ColorMapType {
    ALPHA,
    LUM_ALPHA,
    RGBA
  };

  SoSFEnum  colorMapType;

  SoMFFloat colorMap;

  SoMFFloat actualColorMap;

  SoTransferFunction();

  SbBool hasTransparency() const;

  virtual SbBool loadColormap(const SbString& filename);

 private:
  virtual void doAction( SoAction *action );
  virtual void callback( SoCallbackAction *action );
  virtual void GLRender( SoGLRenderAction *action );
  virtual void pick(SoPickAction *action) ;
  virtual void write(SoWriteAction *action);

  //------------------------------------------------------------------------------
 private:

  enum MappingMethod 
  {
    MAP_TO_CENTER = SoConversion::MAP_TO_CENTER,

    MAP_TO_BORDER = SoConversion::MAP_TO_BORDER
  };

  SoSFEnum mappingMethod;

  typedef float OpacityCorrectionFunction(float alpha, void* userData);

  virtual void notify(SoNotList *list);

  virtual bool affectsPath() const;

  static void initClass();
  static void exitClass();

  int getPackedColorMap(unsigned int * &, int);
  static unsigned int  getDefaultPackedColor(unsigned int);
  enum GLColorMapType {
    NO_COLORMAP = 0,
    TEX_FRAGMENT_PROGRAM = 2
  };

  GLColorMapType installColorMap(SoState*, int alphaUse);

  GLColorMapType installColorMap(SoState*, int, OpacityCorrectionFunction* f, void* userData);
  int m_colorMapMin;
  int m_colorMapMax;

  void applyOpacityCorrection(unsigned int* allRgba, size_t numRgba,
                              OpacityCorrectionFunction* f, void* userData);

  SbBool isFullyTransparent(int64_t min, int64_t max, int alphaUse = 0);

  //for cluster command, list of method to sync
  enum Cmd{
    REMAP = 0
  };

  void  getCMBuffer( int alphaUse, int nrgba, unsigned int *rgba );

  bool isTransparent(const float min, const float max, const float materialTransparency) const;

  SoRef<SoTexture> getTexture() const;

  SbVec2i32 getTextureSize() const;

  unsigned int getNumColors() const;

  bool isBinary() const;

  static void createPreIntegratedTexture(SoState* state, SoGroup* placeHolder);

  size_t getNumComponents() const;

  int getTransferFunctionPosInTexture(int maxTfId);

private :

  // Function to factorise constructors code
  void construct();

  friend class SoVolumeState;
};

#if defined(_WIN32)
#pragma warning( pop )
#endif

#endif // _SO_TRANSFER_FUNCTION_

---

Open Inventor Toolkit reference manual, generated on 15 Mar 2023
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/