SoImageBackground.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-2018 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : VSG (MMM YYYY)
**=======================================================================*/
 
#ifndef _SO_IMAGE_BACKGROUND_H_
#define _SO_IMAGE_BACKGROUND_H_
 
#include <Inventor/fields/SoSFFilePathString.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFImage.h>
#include <Inventor/SbString.h>
 
#include <Inventor/nodes/SoBackground.h>
 
class SoFieldSensor;
class SbRasterImage;
 
#ifdef _MSC_VER
#pragma warning( push )
#pragma warning(disable:4251)
#endif
 
SO_PIMPL_PUBLIC_DECLARATION(SoImageBackground)
 
 
class  SoImageBackground : public SoBackground {
 
  SO_PIMPL_PUBLIC_HEADER(SoImageBackground)
  SO_NODE_HEADER(SoImageBackground);
 
public:
 
  enum Style {
    NONE       ,
    CENTER     ,
    LOWER_LEFT ,
    UPPER_LEFT ,
    UPPER_RIGHT,
    LOWER_RIGHT,
    STRETCH    ,
    TILE,
    CROP,
    FIT
  };
 
   // Fields:
   //
  SoSFFilePathString       filename;
 
  SoSFImage        image;
 
  SoSFEnum         style;
 
  SoImageBackground();
 
private:
  // Initializes this class for use in scene graphs. This
  // should be called after database initialization and before
  // any instance of this node is constructed.
  static void    initClass();
  static void    exitClass();
 
  virtual void notify( SoNotList *list );
 
private:
  // Implement render action
  // We will inherit all other action methods from SoNode.
  // We don't need a doAction because this node has no effect
  // on traversal state (or at least it shouldn't :-).
  virtual void   GLRender(SoGLRenderAction *action);
 
private:
  // Destructor. Protected to keep people from trying to delete
  // nodes, rather than using the reference count mechanism.
  virtual ~SoImageBackground();
 
  // Reads stuff into instance. Returns FALSE on error.
  virtual SbBool readInstance(SoInput *in, unsigned short flags);
 
private:
  void commonConstructor();
};
 
#ifdef _MSC_VER
#pragma warning( pop )
#endif
 
#endif //SoImageBackground