Inventor/nodes/SoImage.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      : R. ALBOU (Feb 1998)
**=======================================================================*/

                                                             /* include files */
#ifndef _SO_IMAGE_
#define _SO_IMAGE_

#include <Inventor/nodes/SoShape.h>

#include <Inventor/fields/SoSFFilePathString.h>
#include <Inventor/fields/SoSFImage.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/nodes/SoNode.h>
#include <Inventor/nodes/SoTexture.h>
#include <Inventor/image/SbRasterImage.h>

#include <Inventor/sys/SoGLType.h>

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

class SoGetPrimitiveCountAction;
class SoGLRenderAction;
class SoSensor;
class SoFieldSensor;

class  SoImage : public SoShape {

  SO_NODE_HEADER(SoImage);

 public:

  enum HorAlignment {
    LEFT,
    CENTER,
    RIGHT
  };
  
  enum VertAlignment {
    BOTTOM,
    HALF,
    TOP
  };

  enum FileType {
    UNKNOWN = SoTexture::UNKNOWN,
    RGB = SoTexture::RGB,
    SGI = SoTexture::SGI,
    TIFF = SoTexture::TIFF,
    GIF = SoTexture::GIF,
    JPEG = SoTexture::JPEG,
    BMP = SoTexture::BMP,
    PNG = SoTexture::PNG,
    JPEG2000 = SoTexture::JPEG2000,
    PGX = SoTexture::PGX,
    PNM = SoTexture::PNM,
    RAS = SoTexture::RAS,
    DDS = SoTexture::DDS,
    HDRI = SoTexture::HDRI,
    NUM_FILETYPES
  };


  // Fields
  SoSFFilePathString filename;

  SoSFImage image;
  SoSFEnum horAlignment;
  SoSFEnum vertAlignment;

  SoSFInt32 width;

  SoSFInt32 height;

  SoImage();

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

 private:
  virtual void GLRender(SoGLRenderAction *action);
  virtual void rayPick(SoRayPickAction *action);
  virtual void getPrimitiveCount(SoGetPrimitiveCountAction *action);

  virtual void computeBBox(SoAction *action, SbBox3f &box, SbVec3f &center);

 private:
  static void initClass();
  static void exitClass();

  static void computeRasterLimits( SoAction *action, int width, int height,
                                   const SbVec3f &leftBottomPointPix, const SbMatrix &screenToObj,
                                   SbVec3f &llp0, SbVec3f &lrp1,
                                   SbVec3f &ulp2, SbVec3f &urp3 );


  // Return the left bottom point of the image in pixels
  static SbVec3f getRasterLeftBottomPoint( const SbVec3f &origPixels, HorAlignment halign, VertAlignment valign, 
                                           int widthPixels, int heightPixels );

  static void computeRasterLimitsPoints( SoAction *action, 
                                         HorAlignment halign, VertAlignment valign, 
                                         int width, int height, 
                                         const SbVec3f &screenOrigin,
                                         SbVec3f &p0, SbVec3f &p1, SbVec3f &p2, SbVec3f &p3, bool toObj = true );

 private:
  virtual void generatePrimitives(SoAction *action);

  // Returns TRUE if the shape should be rendered. Subclasses can
  // call this in their rendering methods to determine whether to
  // continue.
  virtual SbBool shouldGLRender(SoGLRenderAction *action,
                                SbBool isPointsOrLines = FALSE);

  // Reads stuff into instance. Returns FALSE on error.
  virtual SbBool readInstance(SoInput *in, unsigned short flags);

  int  getReadStatus()             { return m_readStatus; }
  void setReadStatus(SbBool flag)  { m_readStatus = flag; }

  // Destructor
  virtual ~SoImage();

 private:
  SbBool m_readStatus;
  
  // These keep the image and filename fields in sync.
  SoFieldSensor *m_imageSensor;
  SoFieldSensor *m_filenameSensor;
  
  static void imageChangedCB(void *, SoSensor *);
  static void filenameChangedCB(void *, SoSensor *);

  // Compute the limits of the image
  void computeImageLimits(SoAction *action, SbBox3f &box);

  // Compute the limits of the image
  void computeImageLimitsPoints(SoAction *action,SbVec3f &p0,
                                SbVec3f &p1, SbVec3f &p2, SbVec3f &p3);


 
  // Draw the image with GL
  void drawImage(SoState *state, int widthPixels, int heightPixels);
 
  // Return the left bottom point of the image in pixels
  SbVec3f getLeftBottomPoint(SbVec3f &origPixels, 
                             int widthPixels, int heightPixels);
 
  // Return the requested size of the image.
  int getWidth();
  int getHeight();
 
  FileType m_filetype; 
 
};
/*----------------------------------------------------------------------------*/

#endif /* _SO_IMAGE_ */

---

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/