SoSFMLImage.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef SO_SFMLIMAGE_H
#define SO_SFMLIMAGE_H
 
 
#include "InventorWrapperDllInit.h"
 
#include <ThirdPartyWarningsDisable.h>
#include <Inventor/fields/SoSubField.h>
#include <Inventor/SbLinear.h>
#include <Inventor/SbLineard.h>
#include <ThirdPartyWarningsRestore.h>
 
#include <mlDataTypes.h>
 
class XVImageSize
{
public:
 
  MLint x,y,z,c,t,u;
 
  inline XVImageSize()                                                           { x=y=z=c=t=u=0; };
  inline XVImageSize(MLint n)                                                    { x=y=z=c=t=u=n; };
  inline XVImageSize(MLint xp, MLint yp, MLint zp, MLint cp, MLint tp, MLint up) { x=xp; y=yp; z=zp; c=cp; t=tp; u=up; };
 
  INVENTORWRAPPER_API void print();
};
 
class SoSFMLImagePrivate;
 
ML_START_NAMESPACE
  class ImagePropertyExtension;
  class PagedImage;
ML_END_NAMESPACE
 
//=============================================================
 
//=============================================================
class INVENTORWRAPPER_API SoSFMLImage : public SoSField {
 
  // Use standard field stuff
  SO_SFIELD_CONSTRUCTOR_HEADER(SoSFMLImage);
  SO_SFIELD_REQUIRED_HEADER(SoSFMLImage);
 
public:
  static void initClass();
 
  virtual void setValue();
  SbBool readValue(SoInput* in) override;
  void writeValue(SoOutput* out) const override;
 
  bool  isValid();
 
  void  getSize(XVImageSize &size);
  void  getSize(int &x, int &y, int &z, int &c, int &t, int &u);
  void  getSize(int &x, int &y, int &z, int &c, int &t);
  void  getSize(int &x, int &y, int &z, int &c);
  void  getSize(int &x, int &y, int &z);
  void  getSize(int &x, int &y);
  void  getSize(MLint &x, MLint &y, MLint &z, MLint &c, MLint &t, MLint &u);
  void  getSize(MLint &x, MLint &y, MLint &z, MLint &c, MLint &t);
  void  getSize(MLint &x, MLint &y, MLint &z, MLint &c);
  void  getSize(MLint &x, MLint &y, MLint &z);
  void  getSize(MLint &x, MLint &y);
 
  void  getPageSize(XVImageSize &size);
 
  MLint getChannels();
 
  bool isChannelName(MLint n, const char* name);
 
  MLint getTimePoints();
 
  void  getType(MLDataType &dtype, size_t &dsize);
  void  getType(MLDataType &dtype);
 
  void  getVoxelSize(float &x, float &y, float &z);
  void  getVoxelSize(double &x, double &y, double &z);
  void  getVoxelSize(float &x, float &y);
  void  getVoxelSize(double &x, double &y);
 
  double getVoxelVolumeInCubicMillimeters();
 
  double getVoxelVolumeInMilliliters();
 
  void  touch() override;
 
 
  unsigned int   getSerialNumber();
 
  double getMinValue();
  double getMaxValue();
 
  const ml::ImagePropertyExtension* getImagePropertyExtensionByType(const char* imagePropertyTypeClassName);
 
  void connectFromML(void* connector);
  void disconnectFromML();
  void *getConnector();
 
  ML_NAMESPACE::PagedImage* getPagedImage();
 
  bool  getTile3D(void* usrMem, MLDataType type, MLint x, MLint y, MLint z,
    MLint nx, MLint ny, MLint nz);
 
  bool  getScaledTile3D(void* usrMem, MLDataType type, MLint x, MLint y, MLint z,
    MLint nx, MLint ny, MLint nz,
    double srcMin, double srcMax, double dstMin, double dstMax);
 
  bool  getTile6D(void* usrMem, MLDataType type, XVImageSize &pos,
    XVImageSize &size);
 
  bool  getScaledTile6D(void* usrMem, MLDataType type,  XVImageSize &pos,
    XVImageSize &size,
    double srcMin, double srcMax, double dstMin, double dstMax);
 
  void  getVoxelToWorldMatrix(float mat[16]);
  void  getVoxelToWorldMatrix(double mat[16]);
  void  getVoxelToWorldMatrix(SbMatrix &matrix);
  void  getVoxelToWorldMatrix(SbMatrixd &matrix);
  void  getWorldToVoxelMatrix(float mat[16]);
  void  getWorldToVoxelMatrix(double mat[16]);
  void  getWorldToVoxelMatrix(SbMatrix &matrix);
  void  getWorldToVoxelMatrix(SbMatrixd &matrix);
 
  void  mapVoxelToWorld(const SbVec3f &src, SbVec3f &dst);
  void  mapVoxelToWorld(const SbVec3d &src, SbVec3d &dst);
  void  mapWorldToVoxel(const SbVec3f &src, SbVec3f &dst);
  void  mapWorldToVoxel(const SbVec3d &src, SbVec3d &dst);
 
  void  mapVoxelToWorld(float  voxelX, float  voxelY, float  voxelZ,
                        float &worldX, float &worldY, float &worldZ);
  void  mapVoxelToWorld(double  voxelX, double  voxelY, double  voxelZ,
                        double &worldX, double &worldY, double &worldZ);
 
 
  void  mapWorldToVoxel(float  worldX, float  worldY, float  worldZ,
                        float &voxelX, float &voxelY, float &voxelZ);
  void  mapWorldToVoxel(double  worldX, double  worldY, double  worldZ,
                        double &voxelX, double &voxelY, double &voxelZ);
 
  bool  isVoxelInsideImage(double voxelX, double voxelY, double voxelZ);
 
  bool  isVoxelInsideImage(const SbVec3f &voxelCoord);
  bool  isVoxelInsideImage(const SbVec3d &voxelCoord);
 
 protected:
   SoSFMLImagePrivate* _p;
 
   // WARNING: SoSFMLImage should stay binary compatible, so beware of adding
   // new member variables here, add them to \c SoSFMLImagePrivate!!!
};
 
 
#endif