BinaryArchiveWriter

Public Class

Represents an entity that is able to write data to an archive.

Inheritance Hierarchy

System.Object
Rhino.FileIO.BinaryArchiveWriter

Namespace: Rhino.FileIO

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public class BinaryArchiveWriter

The BinaryArchiveWriter type exposes the following members.

Properties

Name

Description

---

Public Property

Archive3dmVersion

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 Property

WriteErrorOccured

Gets or sets whether an error occurred.

---

Methods

Name

Description

---

Public Method

BeginWrite3dmChunk(UInt32, Int64)

Begins writing a chunk

---

Public Method

BeginWrite3dmChunk(UInt32, Int32, Int32)

Begins writing a chunk

---

Public Method

EnableCRCCalculation

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 Method

EndWrite3dmChunk

updates length in chunk header

---

Public Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

---

Protected Method

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

(Inherited from Object.)

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---

Public Method

Write3dmChunkVersion

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 Method

WriteBool

Writes a Boolean value to the archive.

---

Public Method

WriteBoolArray

Writes a list, an array, or any enumerable of Boolean to the archive.

The return will always be an array.

---

Public Method

WriteBoundingBox

Writes a BoundingBox value to the archive.

---

Public Method

WriteByte

Writes a Byte value to the archive.

---

Public Method

WriteByteArray

Writes a list, an array, or any enumerable of Byte to the archive.

The return will always be an array.

---

Public Method

WriteColor

Writes a Color value to the archive.

---

Public Method

WriteCompressedBuffer

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 Method

WriteDictionary

Delivers the complete content of a dictionary to the archive.

---

Public Method

WriteDouble

Writes a Double value to the archive.

---

Public Method

WriteDoubleArray

Writes a list, an array, or any enumerable of Double to the archive.

The return will always be an array.

---

Public Method

WriteFont

Writes a Font value to the archive.

---

Public Method

WriteGeometry

Writes a GeometryBase value to the archive.

---

Public Method

WriteGeometryArray

---

Public Method

WriteGuid

Writes a Guid value to the archive.

---

Public Method

WriteGuidArray

Writes a list, an array, or any enumerable of Guid to the archive.

The return will always be an array.

---

Public Method

WriteInt

Writes a Int32 value to the archive.

---

Public Method

WriteInt64

Writes a Int64 value to the archive.

---

Public Method

WriteIntArray

Writes a list, an array, or any enumerable of Int32 to the archive.

The return will always be an array.

---

Public Method

WriteInterval

Writes a Interval value to the archive.

---

Public Method

WriteLine

Writes a Line value to the archive.

---

Public Method

WriteMeshingParameters

Writes a MeshingParameters value to the archive.

---

Public Method

WriteObjRef

Writes a ObjRef to the archive

---

Public Method

WriteObjRefArray

Writes a list, an array, or any enumerable of ObjRef to the archive.

The return will always be an array.

---

Public Method

WritePlane

Writes a Plane value to the archive.

---

Public Method

WritePoint

Writes a Point value to the archive.

---

Public Method

WritePoint2d

Writes a Point2d value to the archive.

---

Public Method

WritePoint3d

Writes a Point3d value to the archive.

---

Public Method

WritePoint3f

Writes a Point3f value to the archive.

---

Public Method

WritePoint4d

Writes a Point4d value to the archive.

---

Public Method

WritePointF

Writes a PointF value to the archive.

---

Public Method

WriteRay3d

Writes a Ray3d value to the archive.

---

Public Method

WriteRectangle

Writes a Rectangle value to the archive.

---

Public Method

WriteRectangleF

Writes a RectangleF value to the archive.

---

Public Method

WriteRenderSettings

Writes a RenderSettings value to the archive.

---

Public Method

WriteSByte

Writes a SByte value to the archive.

---

Public Method

WriteSByteArray

Writes a list, an array, or any enumerable of SByte to the archive.

The return will always be an array.

---

Public Method

WriteShort

Writes a Int16 value to the archive.

---

Public Method

WriteShortArray

Writes a list, an array, or any enumerable of Int16 to the archive.

The return will always be an array.

---

Public Method

WriteSingle

Writes a Single value to the archive.

---

Public Method

WriteSingleArray

Writes a list, an array, or any enumerable of Single to the archive.

The return will always be an array.

---

Public Method

WriteSize

Writes a Size value to the archive.

---

Public Method

WriteSizeF

Writes a SizeF value to the archive.

---

Public Method

WriteString

Writes a String value to the archive.

---

Public Method

WriteStringArray

Writes a list, an array, or any enumerable of String to the archive.

The return will always be an array.

---

Public Method

WriteTransform

Writes a Transform value to the archive.

---

Public Method

WriteUInt

Writes a UInt32 value to the archive.

---

Public Method

WriteUShort

Writes a UInt16 value to the archive.

---

Public Method

WriteUtf8String

Writes a String value to the archive.

---

Public Method

WriteVector2d

Writes a Vector2d value to the archive.

---

Public Method

WriteVector3d

Writes a Vector3d value to the archive.

---

Public Method

WriteVector3f

Writes a Vector3f value to the archive.

---