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

SoOutput.h
1 #ifndef COIN_SOOUTPUT_H
2 #define COIN_SOOUTPUT_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/system/inttypes.h>
28 #include <Inventor/SbBasic.h>
29 #include <Inventor/SbString.h>
30 #include <stdio.h>
31 
32 class SbDict;
33 class SbName;
34 class SoBase;
35 class SoOutputP;
36 class SoProto;
37 class SoField;
38 class SoFieldContainer;
39 
40 typedef void * SoOutputReallocCB(void * ptr, size_t newSize);
41 
42 class COIN_DLL_API SoOutput {
43 public:
44  enum Stage { COUNT_REFS, WRITE };
45  // Bitwise flags for the annotations.
46  enum Annotations { ADDRESSES = 0x01, REF_COUNTS = 0x02 };
47 
48  SoOutput(void);
49  SoOutput(SoOutput * dictOut);
50  virtual ~SoOutput();
51 
52  virtual void setFilePointer(FILE * newFP);
53  virtual FILE * getFilePointer(void) const;
54  virtual SbBool openFile(const char * const fileName);
55  virtual void closeFile(void);
56 
57  SbBool setCompression(const SbName & compmethod,
58  const float level = 0.5f);
59  static const SbName * getAvailableCompressionMethods(unsigned int & num);
60 
61  virtual void setBuffer(void * bufPointer, size_t initSize,
62  SoOutputReallocCB * reallocFunc, int32_t offset = 0);
63  virtual SbBool getBuffer(void * & bufPointer, size_t & nBytes) const;
64  virtual size_t getBufferSize(void) const;
65  virtual void resetBuffer(void);
66  virtual void setBinary(const SbBool flag);
67  virtual SbBool isBinary(void) const;
68  virtual void setHeaderString(const SbString & str);
69  virtual void resetHeaderString(void);
70  virtual void setFloatPrecision(const int precision);
71 
72  void setStage(Stage stage);
73  Stage getStage(void) const;
74 
75  void incrementIndent(const int levels = 1);
76  void decrementIndent(const int levels = 1);
77 
78  virtual void write(const char c);
79  virtual void write(const char * s);
80  virtual void write(const SbString & s);
81  virtual void write(const SbName & n);
82  virtual void write(const int i);
83  virtual void write(const unsigned int i);
84  virtual void write(const short s);
85  virtual void write(const unsigned short s);
86  virtual void write(const float f);
87  virtual void write(const double d);
88  virtual void writeBinaryArray(const unsigned char * c, const int length);
89  virtual void writeBinaryArray(const int32_t * const l, const int length);
90  virtual void writeBinaryArray(const float * const f, const int length);
91  virtual void writeBinaryArray(const double * const d, const int length);
92 
93  virtual void indent(void);
94  virtual void reset(void);
95  void setCompact(SbBool flag);
96  SbBool isCompact(void) const;
97  void setAnnotation(uint32_t bits);
98  uint32_t getAnnotation(void);
99 
100  static SbString getDefaultASCIIHeader(void);
101  static SbString getDefaultBinaryHeader(void);
102 
103  int addReference(const SoBase * base);
104  int findReference(const SoBase * base) const;
105  void setReference(const SoBase * base, int refid);
106 
107  void addDEFNode(SbName name);
108  SbBool lookupDEFNode(SbName name);
109  void removeDEFNode(SbName name);
110 
111  void pushProto(SoProto * proto);
112  SoProto * getCurrentProto(void) const;
113  void popProto(void);
114 
115  void addRoute(SoFieldContainer * from, const SbName & fromfield,
116  SoFieldContainer * to, const SbName & tofield);
117  void resolveRoutes(void);
118 
119 protected:
120  SbBool isToBuffer(void) const;
121  size_t bytesInBuf(void) const;
122  SbBool makeRoomInBuf(size_t nBytes);
123  void convertShort(short s, char * to);
124  void convertInt32(int32_t l, char * to);
125  void convertFloat(float f, char * to);
126  void convertDouble(double d, char * to);
127  void convertShortArray(short * from, char * to, int len);
128  void convertInt32Array(int32_t * from, char * to, int len);
129  void convertFloatArray(float * from, char * to, int len);
130  void convertDoubleArray(double * from, char * to, int len);
131 
132  static SbString padHeader(const SbString & inString);
133 
134  SbBool wroteHeader;
135 
136 private:
137  SoOutputP * pimpl;
138 
139  void constructorCommon(void);
140 
141  void checkHeader(void);
142  void writeBytesWithPadding(const char * const p, const size_t nr);
143 
144  friend class SoBase; // Need to be able to remove items from dict.
145  friend class SoWriterefCounter; // ditto
146  void removeSoBase2IdRef(const SoBase * base);
147 };
148 
149 #endif // !COIN_SOOUTPUT_H
SoOutput::isToBuffer
SbBool isToBuffer(void) const
Definition: SoOutput.cpp:1279
SbList::getArrayPtr
const Type * getArrayPtr(const int start=0) const
Definition: SbList.h:168
SbName
The SbName class stores strings by reference.
Definition: SbName.h:31
SoOutput::getDefaultBinaryHeader
static SbString getDefaultBinaryHeader(void)
Definition: SoOutput.cpp:696
SoOutput::setBinary
virtual void setBinary(const SbBool flag)
Definition: SoOutput.cpp:638
SoOutput::getBuffer
virtual SbBool getBuffer(void *&bufPointer, size_t &nBytes) const
Definition: SoOutput.cpp:590
SoOutput::write
virtual void write(const char c)
Definition: SoOutput.cpp:757
SoOutput::indent
virtual void indent(void)
Definition: SoOutput.cpp:1074
SoOutput::closeFile
virtual void closeFile(void)
Definition: SoOutput.cpp:426
SoOutput::convertDoubleArray
void convertDoubleArray(double *from, char *to, int len)
Definition: SoOutput.cpp:1621
SoOutput
The SoOutput class is an abstraction of an output stream.
Definition: SoOutput.h:42
SoOutput::resetBuffer
virtual void resetBuffer(void)
Definition: SoOutput.cpp:621
SoOutput::resetHeaderString
virtual void resetHeaderString(void)
Definition: SoOutput.cpp:673
SbList::pop
Type pop(void)
Definition: SbList.h:161
SoBase::getName
virtual SbName getName(void) const
Definition: SoBase.cpp:730
SoOutput::~SoOutput
virtual ~SoOutput()
Definition: SoOutput.cpp:345
SoDebugError::postWarning
static void postWarning(const char *const source, const char *const format,...)
Definition: SoDebugError.cpp:324
SoOutput::setAnnotation
void setAnnotation(uint32_t bits)
Definition: SoOutput.cpp:1171
SoOutput::openFile
virtual SbBool openFile(const char *const fileName)
Definition: SoOutput.cpp:400
SoOutput::bytesInBuf
size_t bytesInBuf(void) const
Definition: SoOutput.cpp:1291
SoOutput::convertShortArray
void convertShortArray(short *from, char *to, int len)
Definition: SoOutput.cpp:1579
SoOutput::addRoute
void addRoute(SoFieldContainer *from, const SbName &fromfield, SoFieldContainer *to, const SbName &tofield)
Definition: SoOutput.cpp:1436
SoOutput::getAvailableCompressionMethods
static const SbName * getAvailableCompressionMethods(unsigned int &num)
Definition: SoOutput.cpp:494
SbList::append
void append(const Type item)
Definition: SbList.h:98
SoOutput::reset
virtual void reset(void)
Definition: SoOutput.cpp:1113
SbString
The SbString class is a string class with convenience functions for string operations.
Definition: SbString.h:42
SoOutput::setCompact
void setCompact(SbBool flag)
Definition: SoOutput.cpp:1139
SoOutput::padHeader
static SbString padHeader(const SbString &inString)
Definition: SoOutput.cpp:1634
SoOutput::Annotations
Annotations
Definition: SoOutput.h:46
SoOutput::findReference
int findReference(const SoBase *base) const
Definition: SoOutput.cpp:1312
SoOutput::setBuffer
virtual void setBuffer(void *bufPointer, size_t initSize, SoOutputReallocCB *reallocFunc, int32_t offset=0)
Definition: SoOutput.cpp:572
SoOutput::addReference
int addReference(const SoBase *base)
Definition: SoOutput.cpp:1303
SbList::push
void push(const Type item)
Definition: SbList.h:157
SoField
The SoField class is the top-level abstract base class for fields.
Definition: SoField.h:38
SoOutput::getFilePointer
virtual FILE * getFilePointer(void) const
Definition: SoOutput.cpp:384
SoOutput::isBinary
virtual SbBool isBinary(void) const
Definition: SoOutput.cpp:650
SbList
The SbList class is a template container class for lists.
Definition: SoType.h:46
SbName::getString
const char * getString(void) const
Definition: SbName.cpp:278
SoOutput::wroteHeader
SbBool wroteHeader
Definition: SoOutput.h:134
SoDebugError::postInfo
static void postInfo(const char *const source, const char *const format,...)
Definition: SoDebugError.cpp:334
SoOutput::convertInt32
void convertInt32(int32_t l, char *to)
Definition: SoOutput.cpp:1539
SbList::getLength
int getLength(void) const
Definition: SbList.h:145
SoOutput::convertShort
void convertShort(short s, char *to)
Definition: SoOutput.cpp:1526
SoBase
The SoBase class is the top-level superclass for a number of class-hierarchies.
Definition: SoBase.h:41
SoOutput::pushProto
void pushProto(SoProto *proto)
Definition: SoOutput.cpp:1376
SoOutput::getAnnotation
uint32_t getAnnotation(void)
Definition: SoOutput.cpp:1190
SoOutput::setReference
void setReference(const SoBase *base, int refid)
Definition: SoOutput.cpp:1321
SoOutput::resolveRoutes
void resolveRoutes(void)
Definition: SoOutput.cpp:1457
SoOutput::incrementIndent
void incrementIndent(const int levels=1)
Definition: SoOutput.cpp:1044
SoOutput::convertFloat
void convertFloat(float f, char *to)
Definition: SoOutput.cpp:1553
SoFieldContainer
The SoFieldContainer class is a base class for all classes that contain fields.
Definition: SoFieldContainer.h:35
SoOutput::convertFloatArray
void convertFloatArray(float *from, char *to, int len)
Definition: SoOutput.cpp:1607
SbDict
The SbDict class organizes a dictionary of keys and values.
Definition: SbDict.h:47
SbString::sprintf
SbString & sprintf(const char *formatstr,...)
Definition: SbString.h:105
SbList::remove
void remove(const int index)
Definition: SbList.h:129
SoOutput::setStage
void setStage(Stage stage)
Definition: SoOutput.cpp:728
SoOutput::getCurrentProto
SoProto * getCurrentProto(void) const
Definition: SoOutput.cpp:1395
SoBase::getTypeId
virtual SoType getTypeId(void) const =0
SoOutput::getStage
Stage getStage(void) const
Definition: SoOutput.cpp:744
SoOutput::isCompact
SbBool isCompact(void) const
Definition: SoOutput.cpp:1161
SoOutput::removeDEFNode
void removeDEFNode(SbName name)
Definition: SoOutput.cpp:1356
SoOutput::decrementIndent
void decrementIndent(const int levels=1)
Definition: SoOutput.cpp:1055
SoOutput::SoOutput
SoOutput(void)
Definition: SoOutput.cpp:292
SoOutput::lookupDEFNode
SbBool lookupDEFNode(SbName name)
Definition: SoOutput.cpp:1343
SoOutput::Stage
Stage
Definition: SoOutput.h:44
SoOutput::getDefaultASCIIHeader
static SbString getDefaultASCIIHeader(void)
Definition: SoOutput.cpp:685
SoType::getName
SbName getName(void) const
Definition: SoType.cpp:628
SoOutput::setCompression
SbBool setCompression(const SbName &compmethod, const float level=0.5f)
Definition: SoOutput.cpp:459
SbString::getLength
int getLength(void) const
Definition: SbString.h:63
SoOutput::writeBinaryArray
virtual void writeBinaryArray(const unsigned char *c, const int length)
Definition: SoOutput.cpp:973
SoOutput::makeRoomInBuf
SbBool makeRoomInBuf(size_t nBytes)
Definition: SoOutput.cpp:1206
SbString::getString
const char * getString(void) const
Definition: SbString.h:71
SoOutput::convertDouble
void convertDouble(double d, char *to)
Definition: SoOutput.cpp:1567
SoOutput::setFilePointer
virtual void setFilePointer(FILE *newFP)
Definition: SoOutput.cpp:364
SoOutput::addDEFNode
void addDEFNode(SbName name)
Definition: SoOutput.cpp:1331
SoOutput::convertInt32Array
void convertInt32Array(int32_t *from, char *to, int len)
Definition: SoOutput.cpp:1593
SoOutput::popProto
void popProto(void)
Definition: SoOutput.cpp:1415
SoOutput::getBufferSize
virtual size_t getBufferSize(void) const
Definition: SoOutput.cpp:607
SoOutput::setHeaderString
virtual void setHeaderString(const SbString &str)
Definition: SoOutput.cpp:661
SoOutput::setFloatPrecision
virtual void setFloatPrecision(const int precision)
Definition: SoOutput.cpp:707

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

Generated on Mon Jul 27 2020 for Coin by Doxygen. 1.8.18