SoOutput

java.lang.Object
- com.openinventor.inventor.Inventor
- - com.openinventor.inventor.SoOutput

```
public class SoOutput
extends Inventor
```
Used to write Open Inventor data files. This class is used for writing Open Inventor data files. It supports both ASCII (default) and binary formats and provides some convenience functions for opening and closing files. See SbFileHelper for more convenience functions. It can write to a buffer in memory as well as to a file. Since Open Inventor 8.1, SoOutput can write compressed data in the lossless Zlib (aka gzip) format. Both ASCII and binary format files may be compressed.
An instance of SoOutput is automatically created by SoWriteAction and can be queried using the getOutput() method in that class. This is typically the only instance needed. For example:
```
 SoWriteAction writeAction = new SoWriteAction()  ;
 writeAction.getOutput().openFile( "output.iv" );
 writeAction.apply( root );
 writeAction.getOutput().closeFile();
```
Note that file properties (binary, compression, header string, etc) should be set before calling openFile() or setFilePointer().
File extensions
The recommended file extension for Open Inventor format files, both ASCII and binary is ".iv". Open Inventor will automatically detect if the file is ASCII or binary based on the file header string. Compressed Open Inventor files may be given the extension ".ivz" for convenience, but it is not required. Open Inventor automatically detects compressed files.
File Header
Open Inventor writes a human readable file header as the first line of both ASCII and binary format files. Since Open Inventor 8.0, the default file header looks like this:
ASCII : "#Inventor V8.0 ascii"
Binary: "#Inventor V8.0 binary LE"
The two character code at the end of the binary header indicates if the file was written on a little-endian (LE) or big-endian (BE) machine. The version number string may change again in the future if incompatible changes are made to the file format. You can always query the current default headers using static methods getDefaultASCIIHeader() and getDefaultBinaryHeader().
All versions of Open Inventor from version 2.1 through version 7.x, wrote the version number string "V2.1" by default and did not append "LE" (or "BE") to the binary header. Open Inventor cannot, in general, load files containing a file header from a newer version. However all versions of Open Inventor can load files written by older versions and can load files containing the V2.1 file header. We recommend always using the default file header because newer versions enable performance enhancing features in the file format. If you need to write a file compatible with older versions, call setHeaderString() with "#Inventor V2.1 ascii" or "#Inventor V2.1 binary".
X3D / VRML
Open Inventor ASCII format is essentially the same as the VRML97 format (because the standard was influenced by Open Inventor), which is now called the "Classic VRML" encoding in the X3D specification (see www.x3d.org). The main difference is the file header. If you need to write VRML compatible files, you must set the appropriate file header using the setHeaderString() method, for example:
VRML97: "#VRML V2.0 utf8"
X3D : "#X3D V3.0 utf8"
When an X3D header string has been set, Open Inventor will automatically write "PROFILE Core" as the next line after the file header. However setting the correct header string does not guarantee everything in the file is valid X3D/VRML. If you need to convert a scene graph containing Open Inventor specific nodes to X3D/VRML, use SoToVRML2Action.
VRML format files were traditionally given the extension ".wrl", but X3D now specifies the extension ".x3dv" for Classic VRML format files. Compressed VRML format files were traditionally given the extension ".wrz" or ".wrl.gz", but X3D now specifies the extension ".x3dvz" or ".x3dv.gz". VRML format files can only be written in ASCII.
See also:
SoInput, SoWriteAction, SoTranSender, SbFileHelper

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`SoOutput.FileProperties` This enum defines the properties used when data are written to a file.
`static class`	`SoOutput.Stages`

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor
Inventor.ConstructorCommand

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CompressedZlib` Deprecated. Use `SoOutput.FileProperties.CompressedZlib` instead.
`static int`	`COUNT_REFS` Deprecated. Use `SoOutput.Stages.COUNT_REFS` instead.
`static int`	`DefaultProperty` Deprecated. Use `SoOutput.FileProperties.DefaultProperty` instead.
`static int`	`WRITE` Deprecated. Use `SoOutput.Stages.WRITE` instead.

Fields inherited from class com.openinventor.inventor.Inventor
VERBOSE_LEVEL, ZeroHandle

Constructor Summary

Constructors
Constructor and Description

SoOutput()
Constructor.

Constructors
Constructor and Description
`SoOutput()` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`closeFile()` Closes current file if opened with `openFile()`.
`void`	`decrementIndent()` Calls decrementIndent((int)1).
`void`	`decrementIndent(int amount)`
`int`	`filePutc(int name_21915)` Write a byte to the currently open file.
`int`	`filePuts(java.lang.String name_21914)` Write a string to the currently open file.
`void`	`flushFile()`
`long`	`getBufferSize()` The total number of bytes allocated to a memory buffer may be larger than the number of bytes written.
`static java.lang.String`	`getDefaultASCIIHeader()` Returns the string representing the default ASCII header.
`static java.lang.String`	`getDefaultBinaryHeader()` Returns the string representing the default binary header.
`SoOutput.FileProperties`	`getFileProperty()` Returns the current properties used by `SoOutput`.
`int`	`getIndentLevel()`
`SoOutput.Stages`	`getStage()`
`void`	`incrementIndent()` Calls incrementIndent((int)1).
`void`	`incrementIndent(int amount)`
`void`	`indent()`
`boolean`	`isBinary()` Returns current state of binary flag.
`boolean`	`isWritingForScaleViz()` Returns true if ScaleViz is currently writing data for synchronization.
`boolean`	`openFile(java.lang.String fileName)` Opens named file, sets current file to result.
`void`	`resetBuffer()` Resets buffer for output again.
`void`	`resetHeaderString()` Resets the header for output files to be the default header.
`void`	`setBinary(boolean flag)` Sets whether output should be ASCII (default) or binary.
`void`	`setDoublePrecision(int precision)` Sets the precision for writing floating point numbers (type double), i.e.
`void`	`setFileProperty(SoOutput.FileProperties properties)` Sets a combination of properties for the current file.
`void`	`setFloatPrecision(int precision)` Sets the precision for writing floating point numbers (type float), i.e.
`void`	`setHeaderString(java.lang.String str)` Sets the header for output files.
`void`	`setStage(SoOutput.Stages stage)`
`void`	`write(boolean b)`
`void`	`write(byte c)`
`void`	`write(double d)`
`void`	`write(float f)`
`void`	`write(int i)`
`void`	`write(long i)`
`void`	`write(short s)`
`void`	`write(java.lang.String n)`

Methods inherited from class com.openinventor.inventor.Inventor
dispose, getAddress, getNativeResourceHandle, startInternalThreads, stopInternalThreads

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DefaultProperty
```
@Deprecated
public static final int DefaultProperty
```
    Deprecated. Use SoOutput.FileProperties.DefaultProperty instead.
  - CompressedZlib
```
@Deprecated
public static final int CompressedZlib
```
    Deprecated. Use SoOutput.FileProperties.CompressedZlib instead.
  - COUNT_REFS
```
@Deprecated
public static final int COUNT_REFS
```
    Deprecated. Use SoOutput.Stages.COUNT_REFS instead.
  - WRITE
```
@Deprecated
public static final int WRITE
```
    Deprecated. Use SoOutput.Stages.WRITE instead.
- Constructor Detail
  - SoOutput
```
public SoOutput()
```
    Constructor. The default SoOutput writes to stdout.
- Method Detail
  - incrementIndent
```
public void incrementIndent()
```
    Calls incrementIndent((int)1).
  - decrementIndent
```
public void decrementIndent()
```
    Calls decrementIndent((int)1).
  - setHeaderString
```
public void setHeaderString(java.lang.String str)
```
    Sets the header for output files. This is useful, for example, if you have a file format that is a superset of the Open Inventor file format and you want Open Inventor to read the files. It is highly recommend that in your new header you simply append to the header of the Open Inventor file format you are extending. For example, if a new file format is based on the Open Inventor 2.1 file format, register a header similar to: "#Inventor V2.1 ascii MY FILE FORMAT EXTENSION". Then all Open Inventor 2.1 applications (and later) can read the file.
  - resetHeaderString
```
public void resetHeaderString()
```
    Resets the header for output files to be the default header.
  - setFileProperty
```
public void setFileProperty(SoOutput.FileProperties properties)
```
    Sets a combination of properties for the current file. The function must be called before the output of any data. It can be called before the openFile or setFilePointer functions.
    The default property is DefaultProperty when the SoOutput object is created.
    
    Since:
    
    Open Inventor 8.1
  - getFileProperty
```
public SoOutput.FileProperties getFileProperty()
```
    Returns the current properties used by SoOutput.
    
    Since:
    
    Open Inventor 8.1
  - resetBuffer
```
public void resetBuffer()
```
    Resets buffer for output again. Output starts over at beginning of buffer.
  - closeFile
```
public void closeFile()
```
    Closes current file if opened with openFile().
  - getBufferSize
```
public long getBufferSize()
```
    The total number of bytes allocated to a memory buffer may be larger than the number of bytes written. This returns that total number.
  - setBinary
```
public void setBinary(boolean flag)
```
    Sets whether output should be ASCII (default) or binary.
  - isBinary
```
public boolean isBinary()
```
    Returns current state of binary flag.
  - filePutc
```
public int filePutc(int name_21915)
```
    Write a byte to the currently open file.
    If the file is compressed the byte is compressed on the fly. Returns -1 if no file is currently open. Returns EOF if an error occurs. Returns the byte value specified if successful.
    
    Since:
    
    Open Inventor 8.1
  - filePuts
```
public int filePuts(java.lang.String name_21914)
```
    Write a string to the currently open file.
    If the file is compressed the string is compressed on the fly. Returns -1 if no file is currently open. Returns EOF if an error occurs. Returns a non-negative value if successful (same as fputs).
    
    Since:
    
    Open Inventor 8.1
  - openFile
```
public boolean openFile(java.lang.String fileName)
```
    Opens named file, sets current file to result. This returns false on error.
  - isWritingForScaleViz
```
public boolean isWritingForScaleViz()
```
    Returns true if ScaleViz is currently writing data for synchronization.
  - incrementIndent
```
public void incrementIndent(int amount)
```
  - write
```
public void write(java.lang.String n)
```
  - write
```
public void write(int i)
```
  - write
```
public void write(long i)
```
  - getStage
```
public SoOutput.Stages getStage()
```
  - decrementIndent
```
public void decrementIndent(int amount)
```
  - write
```
public void write(boolean b)
```
  - write
```
public void write(byte c)
```
  - getIndentLevel
```
public int getIndentLevel()
```
  - getDefaultASCIIHeader
```
public static java.lang.String getDefaultASCIIHeader()
```
    Returns the string representing the default ASCII header.
  - indent
```
public void indent()
```
  - setFloatPrecision
```
public void setFloatPrecision(int precision)
```
    Sets the precision for writing floating point numbers (type float), i.e. the number of significant digits. Floating point numbers are written using %.xg format, where 'x' is the value of the precision argument.
  - setDoublePrecision
```
public void setDoublePrecision(int precision)
```
    Sets the precision for writing floating point numbers (type double), i.e. the number of significant digits. Floating point numbers are written using %.xg format, where 'x' is the value of the precision argument.
  - getDefaultBinaryHeader
```
public static java.lang.String getDefaultBinaryHeader()
```
    Returns the string representing the default binary header.
  - write
```
public void write(short s)
```
  - setStage
```
public void setStage(SoOutput.Stages stage)
```
  - flushFile
```
public void flushFile()
```
  - write
```
public void write(double d)
```
  - write
```
public void write(float f)
```

Class SoOutput

Nested Class Summary

Nested classes/interfaces inherited from class com.openinventor.inventor.Inventor

Field Summary

Fields inherited from class com.openinventor.inventor.Inventor

Constructor Summary

Method Summary

Methods inherited from class com.openinventor.inventor.Inventor

Methods inherited from class java.lang.Object

Field Detail

DefaultProperty

CompressedZlib

COUNT_REFS

WRITE

Constructor Detail

SoOutput

Method Detail

incrementIndent

decrementIndent

setHeaderString

resetHeaderString

setFileProperty

getFileProperty

resetBuffer

closeFile

getBufferSize

setBinary

isBinary

filePutc

filePuts

openFile

isWritingForScaleViz

incrementIndent

write

write

write

getStage

decrementIndent

write

write

getIndentLevel

getDefaultASCIIHeader

indent

setFloatPrecision

setDoublePrecision

getDefaultBinaryHeader

write

setStage

flushFile

write

write