BinaryArchiveWriter

References
public class BinaryArchiveWriter
Represents an entity that is able to write data to an archive.

Properties

Archive3dmVersion

#Since v5.0
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.
public int Archive3dmVersion { get; }

WriteErrorOccured

#Since v5.0
Gets or sets whether an error occurred.
public bool WriteErrorOccured { get; set; }

Methods

BeginWrite3dmChunk

#Since v6.0
Begins writing a chunk
[CLSCompliant(false)] public bool BeginWrite3dmChunk(
typecode,
chunk's typecode
majorVersion,
minorVersion
)
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
[CLSCompliant(false)] public bool BeginWrite3dmChunk(
typecode,
value
)

EnableCRCCalculation

#Since v6.0
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.
public bool EnableCRCCalculation(
enable
)
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.

EndWrite3dmChunk

#Since v6.0
updates length in chunk header
public bool EndWrite3dmChunk()

Write3dmChunkVersion

#Since v5.0
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.
public void Write3dmChunkVersion(
major,
0 to 15.
minor
0 to 16.
)
true on successful read.

WriteBool

#Since v5.0
Writes a bool value to the archive.
public void WriteBool(
value
A value to write.
)

WriteBoolArray

#Since v5.0
Writes a list, an array, or any enumerable of bool to the archive.

The return will always be an array.

public void WriteBoolArray(
value
A value to write.
)

WriteBoundingBox

#Since v5.0
Writes a BoundingBox value to the archive.
public void WriteBoundingBox(
value
A value to write.
)

WriteByte

#Since v5.0
Writes a byte value to the archive.
public void WriteByte(
value
A value to write.
)

WriteByteArray

#Since v5.0
Writes a list, an array, or any enumerable of byte to the archive.

The return will always be an array.

public void WriteByteArray(
value
A value to write.
)

WriteColor

#Since v5.0
Writes a Color value to the archive.
public void WriteColor(
value
A value to write.
)

WriteCompressedBuffer

#Since v5.9
Writes a list, an array, or any enumerable of byte to the archive as a compressed buffer.

The return will always be an array.

public void WriteCompressedBuffer(
value
A value to write.
)

WriteDictionary

#Since v5.0
Delivers the complete content of a dictionary to the archive.
public void WriteDictionary(
dictionary
A dictionary to archive.
)

WriteDouble

#Since v5.0
Writes a double value to the archive.
public void WriteDouble(
value
A value to write.
)

WriteDoubleArray

#Since v5.0
Writes a list, an array, or any enumerable of double to the archive.

The return will always be an array.

public void WriteDoubleArray(
value
A value to write.
)

WriteEmptyCheckSum

#Since v6.0 Obsolete v6.0
Reads a legacy ON_CheckSum, only provided to read data chunks from old V5 files, the CheckSum read is discarded
[EditorBrowsable(EditorBrowsableState.Never)] public void WriteEmptyCheckSum()
obsoleteThis is only present to allow writing of old, empty ON_CheckSum data

WriteFont

#Since v5.0
Writes a Font value to the archive.
public void WriteFont(
value
A value to write.
)

WriteGeometry

#Since v5.0
Writes a GeometryBase value to the archive.
public void WriteGeometry(
value
A value to write.
)

WriteGeometryArray

#Since v7.0
public void WriteGeometryArray()

WriteGuid

#Since v5.0
Writes a Guid value to the archive.
public void WriteGuid(
value
A value to write.
)

WriteGuidArray

#Since v5.0
Writes a list, an array, or any enumerable of Guid to the archive.

The return will always be an array.

public void WriteGuidArray(
value
A value to write.
)

WriteInt

#Since v5.0
Writes a int value to the archive.
public void WriteInt(
value
A value to write.
)

WriteInt64

#Since v5.0
Writes a long value to the archive.
public void WriteInt64(
value
A value to write.
)

WriteIntArray

#Since v5.0
Writes a list, an array, or any enumerable of int to the archive.

The return will always be an array.

public void WriteIntArray(
value
A value to write.
)

WriteInterval

#Since v5.0
Writes a Interval value to the archive.
public void WriteInterval(
value
A value to write.
)

WriteLine

#Since v5.0
Writes a Line value to the archive.
public void WriteLine(
value
A value to write.
)

WriteMeshingParameters

#Since v5.0
Writes a MeshingParameters value to the archive.
public void WriteMeshingParameters(
value
A value to write.
)

WriteObjRef

#Since v5.8
Writes a ObjRef to the archive
public void WriteObjRef(
objref
)
the element that was read

WriteObjRefArray

#Since v5.8
Writes a list, an array, or any enumerable of ObjRef to the archive.

The return will always be an array.

public void WriteObjRefArray(
objrefs
A value to write.
)

WritePlane

#Since v5.0
Writes a Plane value to the archive.
public void WritePlane(
value
A value to write.
)

WritePoint

#Since v5.0
Writes a Point value to the archive.
public void WritePoint(
value
A value to write.
)

WritePoint2d

#Since v5.0
Writes a Point2d value to the archive.
public void WritePoint2d(
value
A value to write.
)

WritePoint3d

#Since v5.0
Writes a Point3d value to the archive.
public void WritePoint3d(
value
A value to write.
)

WritePoint3f

#Since v5.0
Writes a Point3f value to the archive.
public void WritePoint3f(
value
A value to write.
)

WritePoint4d

#Since v5.0
Writes a Point4d value to the archive.
public void WritePoint4d(
value
A value to write.
)

WritePointF

#Since v5.0
Writes a PointF value to the archive.
public void WritePointF(
value
A value to write.
)

WriteRay3d

#Since v5.0
Writes a Ray3d value to the archive.
public void WriteRay3d(
value
A value to write.
)

WriteRectangle

#Since v5.0
Writes a Rectangle value to the archive.
public void WriteRectangle(
value
A value to write.
)

WriteRectangleF

#Since v5.0
Writes a RectangleF value to the archive.
public void WriteRectangleF(
value
A value to write.
)

WriteRenderSettings

#Since v6.0
Writes a RenderSettings value to the archive.
public void WriteRenderSettings(
value
A value to write.
)

WriteSByte

#Since v5.0
Writes a sbyte value to the archive.
[CLSCompliant(false)] public void WriteSByte(
value
A value to write.
)

WriteSByteArray

#Since v5.0
Writes a list, an array, or any enumerable of sbyte to the archive.

The return will always be an array.

[CLSCompliant(false)] public void WriteSByteArray(
value
A value to write.
)

WriteShort

#Since v5.0
Writes a short value to the archive.
public void WriteShort(
value
A value to write.
)

WriteShortArray

#Since v5.0
Writes a list, an array, or any enumerable of short to the archive.

The return will always be an array.

public void WriteShortArray(
value
A value to write.
)

WriteSingle

#Since v5.0
Writes a float value to the archive.
public void WriteSingle(
value
A value to write.
)

WriteSingleArray

#Since v5.0
Writes a list, an array, or any enumerable of float to the archive.

The return will always be an array.

public void WriteSingleArray(
value
A value to write.
)

WriteSize

#Since v5.0
Writes a Size value to the archive.
public void WriteSize(
value
A value to write.
)

WriteSizeF

#Since v5.0
Writes a SizeF value to the archive.
public void WriteSizeF(
value
A value to write.
)

WriteString

#Since v5.0
Writes a string value to the archive.
public void WriteString(
value
A value to write.
)

WriteStringArray

#Since v5.0
Writes a list, an array, or any enumerable of string to the archive.

The return will always be an array.

public void WriteStringArray(
value
A value to write.
)

WriteTransform

#Since v5.0
Writes a Transform value to the archive.
public void WriteTransform(
value
A value to write.
)

WriteUInt

#Since v5.0
Writes a uint value to the archive.
[CLSCompliant(false)] public void WriteUInt(
value
A value to write.
)

WriteUShort

#Since v5.0
Writes a ushort value to the archive.
[CLSCompliant(false)] public void WriteUShort(
value
A value to write.
)

WriteUtf8String

#Since v6.0
Writes a string value to the archive.
public void WriteUtf8String(
value
A value to write.
)

WriteVector2d

#Since v5.0
Writes a Vector2d value to the archive.
public void WriteVector2d(
value
A value to write.
)

WriteVector3d

#Since v5.0
Writes a Vector3d value to the archive.
public void WriteVector3d(
value
A value to write.
)

WriteVector3f

#Since v5.0
Writes a Vector3f value to the archive.
public void WriteVector3f(
value
A value to write.
)