Publish/OpenInventorReference/SoSFImage_8h_source.html

00001 /*
00002  *
00003  *  Copyright (C) 2000 Silicon Graphics, Inc.  All Rights Reserved.
00004  *
00005  *  This library is free software; you can redistribute it and/or
00006  *  modify it under the terms of the GNU Lesser General Public
00007  *  License as published by the Free Software Foundation; either
00008  *  version 2.1 of the License, or (at your option) any later version.
00009  *
00010  *  This library is distributed in the hope that it will be useful,
00011  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00012  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013  *  Lesser General Public License for more details.
00014  *
00015  *  Further, this software is distributed without any warranty that it is
00016  *  free of the rightful claim of any third person regarding infringement
00017  *  or the like.  Any license provided herein, whether implied or
00018  *  otherwise, applies only to this software file.  Patent licenses, if
00019  *  any, provided herein do not apply to combinations of this program with
00020  *  other software, or any other product whatsoever.
00021  *
00022  *  You should have received a copy of the GNU Lesser General Public
00023  *  License along with this library; if not, write to the Free Software
00024  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
00025  *
00026  *  Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
00027  *  Mountain View, CA  94043, or:
00028  *
00029  *  http://www.sgi.com
00030  *
00031  *  For further information regarding this notice, see:
00032  *
00033  *  http://oss.sgi.com/projects/GenInfo/NoticeExplan/
00034  *
00035  */
00036
00037
00038 /*
00039  * Copyright (C) 1990,91   Silicon Graphics, Inc.
00040  *
00041  _______________________________________________________________________
00042  ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
00043  |
00044  |   $Revision: 1.1.1.1 $
00045  |
00046  |   Classes:
00047  |      SoSFImage
00048  |
00049  |   Author(s)          : Gavin Bell
00050  |
00051  ______________  S I L I C O N   G R A P H I C S   I N C .  ____________
00052  _______________________________________________________________________
00053  */
00054
00055 #ifndef  _SO_SF_IMAGE_
00056 #define  _SO_SF_IMAGE_
00057
00058 #include <Inventor/fields/SoSubField.h>
00059 #include <Inventor/SbLinear.h>
00060
00061
00064
00115
00116
00117 class INVENTOR_API SoSFImage : public SoSField {
00120     SO_SFIELD_REQUIRED_HEADER(SoSFImage);
00121     SO_SFIELD_CONSTRUCTOR_HEADER(SoSFImage);
00122
00123   public:
00126     const unsigned char *       getValue(SbVec2s &size, int &nc) const;
00127
00132     void                        setValue(const SbVec2s &size, int nc,
00133                                          const unsigned char *bytes);
00134
00136     int                         operator ==(const SoSFImage &f) const;
00137     int                         operator !=(const SoSFImage &f) const
00138         { return ! ((*this) == f); }
00139
00145     unsigned char *             startEditing(SbVec2s &size, int &nc);
00147     void                        finishEditing();
00148
00149   SoINTERNAL public:
00150     static void         initClass();
00151
00152   private:
00153     SbVec2s             size;
00154     int                 numComponents;
00155     unsigned char *     bytes;
00156
00158     virtual SbBool      readValue(SoInput *in);
00159     virtual void        writeValue(SoOutput *out) const;
00160 };
00161
00162 #endif /* _SO_SF_IMAGE_ */