BinaryArchiveWriter
ReferencesRepresents an entity that is able to write data to an archive.
Properties
If a 3dm archive is being read or written, then this is the version of the 3dm archive format (1, 2, 3, 4 or 5). 0 a 3dm archive is not being read/written 1 a version 1 3dm archive is being read/written 2 a version 2 3dm archive is being read/written 3 a version 3 3dm archive is being read/written 4 a version 4 3dm archive is being read/written 5 an old version 5 3dm archive is being read 50 a version 5 3dm archive is being read/written.
Methods
[CLSCompliant(false)]
public bool BeginWrite3dmChunk(uint typecode, int majorVersion, int minorVersion)
Begins writing a chunk
Returns: True if input was valid and chunk was started. In this case you must call EndWrite3dmChunk(), even if something goes wrong while you attempt to write the contents of the chunk. False if input was not valid or the write failed.
BeginWrite3dmChunk
#Begins writing a chunk
Expert user function to control CRC calculation while reading and writing. Typically this is used when seeking around and reading/writing information in non-serial order.
Parameters:
| enable (bool) |
Returns: Current state of CRC calculation. Use the returned value to restore the CRC calculation setting after you are finished doing your fancy pants expert IO.
A chunk version is a single byte that encodes a major.minor version number. Useful when creating I/O code for 3dm chunks that may change in the future. Increment the minor version number if new information is added to the end of the chunk. Increment the major version if the format of the chunk changes in some other way.
Writes a list, an array, or any enumerable of bool to the archive.
The return will always be an array.
Parameters:
| value (IEnumerable<bool>) | A value to write. |
Writes a BoundingBox value to the archive.
Parameters:
| value (BoundingBox) | A value to write. |
Writes a list, an array, or any enumerable of byte to the archive.
The return will always be an array.
Parameters:
| value (IEnumerable<byte>) | A value to write. |
Writes a list, an array, or any enumerable of byte to the archive as a compressed buffer.
The return will always be an array.
Parameters:
| value (IEnumerable<byte>) | A value to write. |
Delivers the complete content of a dictionary to the archive.
Parameters:
| dictionary (ArchivableDictionary) | A dictionary to archive. |
Writes a list, an array, or any enumerable of double to the archive.
The return will always be an array.
Parameters:
| value (IEnumerable<double>) | A value to write. |
obsoleteThis is only present to allow writing of old, empty ON_CheckSum data
Reads a legacy ON_CheckSum, only provided to read data chunks from old V5 files, the CheckSum read is discarded
Writes a GeometryBase value to the archive.
Parameters:
| value (GeometryBase) | A value to write. |
Parameters:
| geometry (IEnumerable<GeometryBase>) |
Writes a list, an array, or any enumerable of Guid to the archive.
The return will always be an array.
Parameters:
| value (IEnumerable<Guid>) | A value to write. |
Writes a list, an array, or any enumerable of int to the archive.
The return will always be an array.
Parameters:
| value (IEnumerable<int>) | A value to write. |
Writes a MeshingParameters value to the archive.
Parameters:
| value (MeshingParameters) | A value to write. |
Writes a list, an array, or any enumerable of ObjRef to the archive.
The return will always be an array.
Parameters:
| objrefs (IEnumerable<ObjRef>) | A value to write. |
Writes a RectangleF value to the archive.
Parameters:
| value (RectangleF) | A value to write. |
Writes a RenderSettings value to the archive.
Parameters:
| value (RenderSettings) | A value to write. |
Writes a list, an array, or any enumerable of sbyte to the archive.
The return will always be an array.
Parameters:
| value (IEnumerable<sbyte>) | A value to write. |
Writes a list, an array, or any enumerable of short to the archive.
The return will always be an array.
Parameters:
| value (IEnumerable<short>) | A value to write. |
Writes a list, an array, or any enumerable of float to the archive.
The return will always be an array.
Parameters:
| value (IEnumerable<float>) | A value to write. |
Writes a list, an array, or any enumerable of string to the archive.
The return will always be an array.
Parameters:
| value (IEnumerable<string>) | A value to write. |