Coin Logo http://www.sim.no
http://www.coin3d.org

SoSFImage.h
1 #ifndef COIN_SOSFIMAGE_H
2 #define COIN_SOSFIMAGE_H
3 
4 /**************************************************************************\
5  *
6  * This file is part of the Coin 3D visualization library.
7  * Copyright (C) 1998-2007 by Systems in Motion. All rights reserved.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * ("GPL") version 2 as published by the Free Software Foundation.
12  * See the file LICENSE.GPL at the root directory of this source
13  * distribution for additional information about the GNU GPL.
14  *
15  * For using Coin with software that can not be combined with the GNU
16  * GPL, and for taking advantage of the additional benefits of our
17  * support services, please contact Systems in Motion about acquiring
18  * a Coin Professional Edition License.
19  *
20  * See http://www.coin3d.org/ for more information.
21  *
22  * Systems in Motion, Postboks 1283, Pirsenteret, 7462 Trondheim, NORWAY.
23  * http://www.sim.no/ sales@sim.no coin-support@coin3d.org
24  *
25 \**************************************************************************/
26 
27 #include <Inventor/fields/SoSField.h>
28 #include <Inventor/fields/SoSubField.h>
29 #include <Inventor/SbVec2s.h>
30 
31 
32 class COIN_DLL_API SoSFImage : public SoSField {
33  typedef SoSField inherited;
34 
35  SO_SFIELD_CONSTRUCTOR_HEADER(SoSFImage);
36  SO_SFIELD_REQUIRED_HEADER(SoSFImage);
37 
38 public:
39  enum CopyPolicy {
40  COPY,
41  NO_COPY,
42  NO_COPY_AND_DELETE,
43  NO_COPY_AND_FREE
44  };
45 
46  static void initClass(void);
47 
48  const unsigned char * getValue(SbVec2s & size, int & nc) const;
49  void setValue(const SbVec2s & size, const int nc,
50  const unsigned char * pixels, CopyPolicy copypolicy = COPY);
51 
52  int operator==(const SoSFImage & field) const;
53  int operator!=(const SoSFImage & field) const { return ! operator == (field); }
54 
55  unsigned char * startEditing(SbVec2s & size, int & nc);
56  void finishEditing(void);
57 
58  void setSubValue(const SbVec2s & dims, const SbVec2s & offset, unsigned char * pixels);
59  void setSubValues(const SbVec2s * dims, const SbVec2s * offsets, int num, unsigned char ** pixelblocks);
60  unsigned char * getSubTexture(int idx, SbVec2s & dims, SbVec2s & offset) const;
61  SbBool hasSubTextures(int & numsubtextures);
62 
63  void setNeverWrite(SbBool flag);
64  SbBool isNeverWrite(void) const;
65 
66  SbBool hasTransparency(void) const;
67 
68 private:
69  virtual SbBool readValue(SoInput * in);
70  virtual void writeValue(SoOutput * out) const;
71 
72  class SoSFImageP * pimpl;
73 };
74 
75 #endif // !COIN_SOSFIMAGE_H
SoReadError::post
static void post(const SoInput *const in, const char *const format,...)
Definition: SoReadError.cpp:110
SoSFImage::setNeverWrite
void setNeverWrite(SbBool flag)
Definition: SoSFImage.cpp:512
SoField::valueChanged
void valueChanged(SbBool resetdefault=1)
Definition: SoField.cpp:2433
SoSFImage::isNeverWrite
SbBool isNeverWrite(void) const
Definition: SoSFImage.cpp:529
SoField::writeValue
virtual void writeValue(SoOutput *out) const =0
SoField::readValue
virtual SbBool readValue(SoInput *in)=0
SoOutput::write
virtual void write(const char c)
Definition: SoOutput.cpp:757
SoOutput::indent
virtual void indent(void)
Definition: SoOutput.cpp:1074
SoOutput
The SoOutput class is an abstraction of an output stream.
Definition: SoOutput.h:42
SoInput::readBinaryArray
virtual SbBool readBinaryArray(unsigned char *c, int length)
Definition: SoInput.cpp:1681
SoSFImage::getSubTexture
unsigned char * getSubTexture(int idx, SbVec2s &dims, SbVec2s &offset) const
Definition: SoSFImage.cpp:472
SoDebugError::postWarning
static void postWarning(const char *const source, const char *const format,...)
Definition: SoDebugError.cpp:324
SoInput::getIVVersion
virtual float getIVVersion(void)
Definition: SoInput.cpp:1086
SoSField
The SoSField class is the base class for fields which contains only a single value.
Definition: SoSField.h:29
SoSFImage::operator!=
int operator!=(const SoSFImage &field) const
Definition: SoSFImage.h:53
SbVec2s
The SbVec2s class is a 2 dimensional vector with short integer coordinates.
Definition: SbVec2s.h:37
SoSFImage::setSubValue
void setSubValue(const SbVec2s &dims, const SbVec2s &offset, unsigned char *pixels)
Definition: SoSFImage.cpp:442
SoOutput::isBinary
virtual SbBool isBinary(void) const
Definition: SoOutput.cpp:650
SoSFImage::operator==
int operator==(const SoSFImage &field) const
Definition: SoSFImage.cpp:311
SoField::operator==
int operator==(const SoField &f) const
Definition: SoField.cpp:1547
SoDebugError::postInfo
static void postInfo(const char *const source, const char *const format,...)
Definition: SoDebugError.cpp:334
SoSFImage::finishEditing
void finishEditing(void)
Definition: SoSFImage.cpp:430
SoSFImage::getValue
const unsigned char * getValue(SbVec2s &size, int &nc) const
Definition: SoSFImage.cpp:322
SoSFImage::setSubValues
void setSubValues(const SbVec2s *dims, const SbVec2s *offsets, int num, unsigned char **pixelblocks)
Definition: SoSFImage.cpp:457
SoSFImage::startEditing
unsigned char * startEditing(SbVec2s &size, int &nc)
Definition: SoSFImage.cpp:420
SoSFImage::hasTransparency
SbBool hasTransparency(void) const
Definition: SoSFImage.cpp:543
SoSFImage::hasSubTextures
SbBool hasSubTextures(int &numsubtextures)
Definition: SoSFImage.cpp:493
SoInput::read
virtual SbBool read(char &c)
Definition: SoInput.cpp:1180
SoInput::isBinary
virtual SbBool isBinary(void)
Definition: SoInput.cpp:1096
SoSFImage::setValue
void setValue(const SbVec2s &size, const int nc, const unsigned char *pixels, CopyPolicy copypolicy=COPY)
Definition: SoSFImage.cpp:362
SoInput
The SoInput class is an abstraction of file import functionality.
Definition: SoInput.h:55
SoOutput::writeBinaryArray
virtual void writeBinaryArray(const unsigned char *c, const int length)
Definition: SoOutput.cpp:973
SoField::evaluate
void evaluate(void) const
Definition: SoField.h:130
SoSFImage
The SoSFImage class is used to store pixel images.
Definition: SoSFImage.h:32
SbImage
The SbImage class is an abstract datatype for 2D and 3D images.
Definition: SbImage.h:36

Copyright © 1998-2007 by Systems in Motion AS. All rights reserved.

Generated on Wed Jul 24 2019 for Coin by Doxygen. 1.8.17