Open Inventor Reference
SoSFImage.h
Go to the documentation of this file.
1/*
2 *
3 * Copyright (C) 2000 Silicon Graphics, Inc. All Rights Reserved.
4 *
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2.1 of the License, or (at your option) any later version.
9 *
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
14 *
15 * Further, this software is distributed without any warranty that it is
16 * free of the rightful claim of any third person regarding infringement
17 * or the like. Any license provided herein, whether implied or
18 * otherwise, applies only to this software file. Patent licenses, if
19 * any, provided herein do not apply to combinations of this program with
20 * other software, or any other product whatsoever.
21 *
22 * You should have received a copy of the GNU Lesser General Public
23 * License along with this library; if not, write to the Free Software
24 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
25 *
26 * Contact information: Silicon Graphics, Inc., 1600 Amphitheatre Pkwy,
27 * Mountain View, CA 94043, or:
28 *
29 * http://www.sgi.com
30 *
31 * For further information regarding this notice, see:
32 *
33 * http://oss.sgi.com/projects/GenInfo/NoticeExplan/
34 *
35 */
36
37
38/*
39 * Copyright (C) 1990,91 Silicon Graphics, Inc.
40 *
41 _______________________________________________________________________
42 ______________ S I L I C O N G R A P H I C S I N C . ____________
43 |
44 | $Revision: 1.1.1.1 $
45 |
46 | Classes:
47 | SoSFImage
48 |
49 | Author(s) : Gavin Bell
50 |
51 ______________ S I L I C O N G R A P H I C S I N C . ____________
52 _______________________________________________________________________
53 */
54
55#ifndef _SO_SF_IMAGE_
56#define _SO_SF_IMAGE_
57
59#include <Inventor/SbLinear.h>
60
61
64
116
122
123 public:
126 const unsigned char * getValue(SbVec2s &size, int &nc) const;
127
132 void setValue(const SbVec2s &size, int nc,
133 const unsigned char *bytes);
134
136 bool operator ==(const SoSFImage &f) const;
137 bool operator !=(const SoSFImage &f) const
138 { return ! ((*this) == f); }
139
145 unsigned char * startEditing(SbVec2s &size, int &nc);
148
149 SoINTERNAL public:
150 static void initClass();
151
152 private:
153 SbVec2s size;
154 int numComponents;
155 unsigned char * bytes;
156
158 virtual bool readValue(SoInput *in);
159 virtual void writeValue(SoOutput *out) const;
160};
161
162#endif /* _SO_SF_IMAGE_ */
#define SoINTERNAL
Definition SbBasic.h:155
#define INVENTOR_API
Disable some annoying warnings on MSVC 6.
Definition SbSystem.h:77
#define SO_SFIELD_CONSTRUCTOR_HEADER(className)
This declares a constructor and destructor for a single-value field class.
Definition SoSubField.h:233
#define SO_SFIELD_REQUIRED_HEADER(className)
===========================================================================
Definition SoSubField.h:224
2D vector class.
Definition SbLinear.h:354
bool operator!=(const SoField &f) const
Return TRUE (FALSE) if this field is of the same type and has the same value as f.
Definition SoField.h:309
bool operator==(const SoField &f) const
Return TRUE (FALSE) if this field is of the same type and has the same value as f.
Definition SoField.h:305
Used to read Inventor data files.
Definition SoInput.h:128
Used to write Inventor data files.
Definition SoOutput.h:90
Field containing a 2D image.
Definition SoSFImage.h:117
const unsigned char * getValue(SbVec2s &size, int &nc) const
getValue returns the size, number of components and a constant pointer to the image.
unsigned char * startEditing(SbVec2s &size, int &nc)
This method can be used to efficiently edit the values in an image field.
void finishEditing()
Finish the editing of the field values.
static void initClass()
void setValue(const SbVec2s &size, int nc, const unsigned char *bytes)
Sets the value of this field to be an image of the given size, with the given number of components,...
Abstract base class for all single-value fields.
Definition SoField.h:537