Skip to content

Rhino.FileIO

Classes

Class

Description


Public Class
BinaryArchiveException

Thrown by BinaryArchiveReader and BinaryArchiveWriter classes when an IO error has occurred.


Public Class
BinaryArchiveFile
Public Class
BinaryArchiveReader

Represents an entity that is capable of reading a binary archive and instantiating strongly-typed objects.


Public Class
BinaryArchiveWriter

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


Public Class
CommonComponentTable.T.

Provides a base table type that encompasses all document tables, both in RhinoDoc and File3dm.


Public Class
ContentHash

Contains information that is useful to uniquely identify an object.

Remarks

This object is immutable.


Public Class
DracoCompression

Google Draco compression for mesh and point cloud data


Public Class
DracoCompressionOptions

Options for applying Draco compression


Public Class
File3dm

Represents a 3dm file, which is stored using the OpenNURBS file standard.

The 3dm format is the main Rhinoceros storage format.

Visit http://www.opennurbs.com/ for more details.


Public Class
File3dmCommonComponentTable.T.

Provides a base table type that is shared among all File3dm tables.


Public Class
File3dmCurvePiping

Represents the curve piping attached to file3dm object attributes.


Public Class
File3dmDimStyleTable

Provides access to annotation styles in the 3dm file.


Public Class
File3dmDisplacement

Represents the displacement attached to file3dm object attributes.


Public Class
File3dmEdgeSoftening

Represents the edge softening attached to file3dm object attributes.


Public Class
File3dmEmbeddedFile
Public Class
File3dmEmbeddedFiles
Public Class
File3dmGroupTable

Provides access to groups in the 3dm file.


Public Class
File3dmHatchPatternTable

Provides access to hatch pattern definitions in the 3dm file.


Public Class
File3dmInstanceDefinitionTable

Provides access to instance (block) definitions in the 3dm file.


Public Class
File3dmLayerTable

Provides access to layers in the 3dm file.


Public Class
File3dmLinetypeTable

Provides access to Linetypes in the 3dm file.


Public Class
File3dmMaterialTable

Provides access to materials in the 3dm file.


Public Class
File3dmMeshModifiers

Represents the mesh modifiers attached to file3dm object attributes.


Public Class
File3dmNamedConstructionPlanes

Provides access to named construction planes in the 3dm file.


Public Class
File3dmNotes

Represents the notes information stored in a 3dm file.


Public Class
File3dmObject

Used to store geometry table object definition and attributes in a File3dm.


Public Class
File3dmObjectTable

Represents a simple object table for a file that is open externally.

This class mimics Rhino.DocObjects.Tables.ObjectTable while providing external access to the file.


Public Class
File3dmPlugInData

Represents custom plug-in data, in the 3dm file, written by a plug-in.


Public Class
File3dmPlugInDataTable

Table of custom data provided by plug-ins


Public Class
File3dmRenderContent
Public Class
File3dmRenderEnvironment
Public Class
File3dmRenderEnvironments
Public Class
File3dmRenderMaterial
Public Class
File3dmRenderMaterials
Public Class
File3dmRenderTexture
Public Class
File3dmRenderTextures
Public Class
File3dmSettings

General settings in a 3dm file.


Public Class
File3dmShutLining

Represents the shut-lining attached to file3dm object attributes.


Public Class
File3dmStringTable

Provides access to document strings in the 3dm file.


Public Class
File3dmThickening

Represents the thickening attached to file3dm object attributes.


Public Class
File3dmTypeCodes

Typecode format 4 bytes long

x xxxxxxxxxxxxxxx,x xxx xxxx xxxx x x xx
| | | | | | |
| | | |
| | | | +--- "stuff" bit
| | | |
| | | +-- specific codes
| | |
| | +-- RESERVED - DO NOT USE (should be 0) (will be used to control CRC on/off)
| |
| +-- category:_000 0000 0000 0001 Legacy geometry TCODE_LEGACY_GEOMETRY
| _000 0000 0000 0010 openNURBS object TCODE_OPENNURBS_OBJECT
| _000 0000 0000 0100 -- RESERVED - DO NOT USE (should be 0 in any typecode) --
| _000 0000 0000 1000 -- RESERVED - DO NOT USE (should be 0 in any typecode) --
| _000 0000 0001 0000 Geometry TCODE_GEOMETRY
| _000 0000 0010 0000 Annotation
| _000 0000 0100 0000 Display Attributes TCODE_DISPLAY
| _000 0000 1000 0000 Rendering TCODE_RENDER
| _000 0001 0000 0000
| _000 0010 0000 0000 Interface TCODE_INTERFACE
| _000 0100 0000 0000 -- RESERVED - DO NOT USE (should be 0 in any typecode) --
| _000 1000 0000 0000 Tolerances TCODE_TOLERANCE
| _001 0000 0000 0000 Tables TCODE_TABLE
| _010 0000 0000 0000 Table record TCODE_TABLEREC
| _100 0000 0000 0000 User information TCODE_USER
|
+-- format: 0 - data size in header - data block follows TCODE_SHORT
1 - data in header - no data block follows

Public Class
File3dmViewTable

Provides access to views in the 3dm file.


Public Class
File3dmWriteOptions

Options used by File3dm.Write


Public Class
File3ds

Support for writing 3ds file format


Public Class
File3dsReadOptions

Options for reading a 3ds file


Public Class
File3dsWriteOptions

Options for writing a 3ds file


Public Class
File3mf

Support for writing 3mf file format


Public Class
File3mfWriteOptions

Options for writing a 3mf file


Public Class
FileAi

Support for writing ai file format


Public Class
FileAiReadOptions

Options for reading a AI file (old ai files, ps not pdf)


Public Class
FileAiWriteOptions

Options for writing a ai file


Public Class
FileAmf

Support for writing amf file format


Public Class
FileAmfWriteOptions

Options for writing a amf file


Public Class
FileCd

Support for writing CD file format


Public Class
FileCdWriteOptions

Options for writing a CD file


Public Class
FileCsv

Support for writing Csv file format


Public Class
FileCsvWriteOptions

Options for writing a Csv file. Set any value you want included in the output to true. With the exception of Header and CumulativeMassProperties, all checked items apply to each and every object exported.


Public Class
FileDgn

Support for writing Dgn file format


Public Class
FileDgnReadOptions

Options for reading a Dgn file


Public Class
FileDst

Support for writing dst file format


Public Class
FileDstReadOptions

Options for reading a Dst file


Public Class
FileDwg

Support for writing DWG file format


Public Class
FileDwgReadOptions

Options for reading a DWG file


Public Class
FileDwgWriteOptions

Options for writing a DWG file


Public Class
FileEps

Support for reading eps file format


Public Class
FileEpsReadOptions

Options for reading a AI file (old ai files, ps not pdf)


Public Class
FileFbx

Support for writing Fbx file format


Public Class
FileFbxReadOptions

Options for reading a Fbx file


Public Class
FileFbxWriteOptions

Options for writing a Fbx file


Public Class
FileGHS

Support for reading eps file format


Public Class
FileGHSReadOptions

Options for reading a GHS file


Public Class
FileGltf

Support for writing glTF file format


Public Class
FileGltfWriteOptions

Options used when writing a glTF file


Public Class
FileGts

Support for writing Gts file format


Public Class
FileGtsWriteOptions

Options for writing a Gts file


Public Class
FileIgs

Support for writing Igs file format


Public Class
FileIgsWriteOptions

Options for writing a Igs file


Public Class
FileLwo

Support for writing lwo file format


Public Class
FileLwoReadOptions

Options for reading a Lwo file


Public Class
FileLwoWriteOptions

Options for writing a Lwo file


Public Class
FileObj

Support for obj file format


Public Class
FileObjReadOptions

Options used when reading an obj file.


Public Class
FileObjWriteOptions
Public Class
FilePdf

Support for PDF file format


Public Class
FilePdfEventArgs

Used for events that are fired while constructing/saving a PDF


Public Class
FilePdfReadOptions

Options for reading a PDF file


Public Class
FilePly

Support for ply file format


Public Class
FilePlyReadOptions

Options for reading a PLY file


Public Class
FilePlyWriteOptions
Public Class
FilePov

Support for writing POV file format


Public Class
FilePovWriteOptions

Options for writing a POV file


Public Class
FileRaw

Support for writing Raw file format


Public Class
FileRawReadOptions

Options for reading a Raw file


Public Class
FileRawWriteOptions

Options for writing a Raw file


Public Class
FileReadOptions
Public Class
FileReference

Manages a reference to an existing or non-existing file, using either or both absolute or relative paths. Once constructed, this class is immutable.


Public Class
FileSat

Support for writing Sat file format


Public Class
FileSatWriteOptions

Options used when writing a Sat file


Public Class
FileSkp

Support for writing Skp file format


Public Class
FileSkpReadOptions

Options used when reading a Skp file


Public Class
FileSkpWriteOptions

Options used when writing a Skp file


Public Class
FileSlc

Support for writing slice (SLC) file format


Public Class
FileSlcWriteOptions

Options used when writing a SLC file


Public Class
FileStl

Support for writing STL file format


Public Class
FileStlReadOptions

Options for reading a STL file


Public Class
FileStlWriteOptions

Options for writing a STL file


Public Class
FileStp

Support for writing STEP (STP) file format


Public Class
FileStpReadOptions

Options used when reading a STP file


Public Class
FileStpWriteOptions

Options used when writing a STP file


Public Class
FileSvg

Support for writing Svg file format


Public Class
FileSvgReadOptions

Options used when reading a Svg file


Public Class
FileSW
Public Class
FileSwReadOptions

Options used when reading a SW file


Public Class
FileTxt

Support for writing Txt (points) file format


Public Class
FileTxtReadOptions

Options for writing a Txt file.


Public Class
FileTxtWriteOptions

Options for writing a Txt file.


Public Class
FileType
Public Class
FileUdo

Support for writing Moray UDO file format


Public Class
FileUdoWriteOptions

Options for writing a Moray UDO file


Public Class
FileUsd

Support for writing USD file format


Public Class
FileUsdWriteOptions

Options for writing a USD file


Public Class
FileVda

Support for writing Igs file format


Public Class
FileVdaWriteOptions

Options for writing a Vda file


Public Class
FileVrml

Support for writing wrl file format


Public Class
FileVrmlWriteOptions

Options for writing a wrl file


Public Class
FileWriteOptions
Public Class
FileX_T

Support for writing X_T file format


Public Class
FileX_TWriteOptions

Options used when writing a X_T file


Public Class
FileX3dv

Support for writing x3dv file format


Public Class
FileX3dvWriteOptions

Options for writing a x3dv file


Public Class
FileXaml

Support for writing Xaml file format


Public Class
FileXamlWriteOptions

Options for writing a Xaml file


Public Class
ImageFile

Support functions for image files


Public Class
ManifestTable

Maintains an index to every model component that is in the 3dm file. This is the “more comprehensive” table that contains all objects in all other tables.


Public Class
NameHash

Contains information that is useful to uniquely identify an object name.

Remarks

This object is immutable.


Public Class
SerializationOptions

Contains options for serializing -or storing- data, such as Rhino version, user data, and meshes.


Public Class
SHA1OpenNURBS

Provides the OpenNURBS implementation of SHA1.

This class is provided only with the purpose of hashing. It is not meant to be used for any cryptographic purpose.


Public Class
TextLog

Used for collecting text data


Interfaces

Interface

Description


Public Interface
ICommonComponentTable.T.

Provides methods to use all File3dm and RhinoDoc tables under the same contract. Do not derive from this interface. This is to ensure all tables can be used with the same method list.


Enumerations

Enumeration

Description


Public Enum
BinaryArchiveMode
Public Enum
DracoColorFormat

Color format for vertex colors


Public Enum
File3dm.ObjectTypeFilter
Public Enum
File3dm.TableTypeFilter
Public Enum
File3dmCurvePiping.CapTypes

Defines how the pipe is capped at the ends.


Public Enum
File3dmDisplacement.SweepResolutionFormulas

Formula to use to calculate sweep resolution from initial quality.


Public Enum
FileAiReadOptions.Units
Public Enum
FileAiWriteOptions.Units
Public Enum
FileDwgReadOptions.MeshPrecisionMode
Public Enum
FileDwgWriteOptions.AutocadVersion

AutoCAD version format to write to


Public Enum
FileDwgWriteOptions.ColorMethodType
Public Enum
FileDwgWriteOptions.ExportArcMode
Public Enum
FileDwgWriteOptions.ExportLineMode
Public Enum
FileDwgWriteOptions.ExportMeshMode
Public Enum
FileDwgWriteOptions.ExportPolycurveMode
Public Enum
FileDwgWriteOptions.ExportPolylineMode
Public Enum
FileDwgWriteOptions.ExportSplineMode
Public Enum
FileDwgWriteOptions.ExportSurfaceMode
Public Enum
FileDwgWriteOptions.FlattenMode
Public Enum
FileEpsReadOptions.Units
Public Enum
FileFbxWriteOptions.FileType
Public Enum
FileFbxWriteOptions.MaterialType
Public Enum
FileFbxWriteOptions.ObjectType
Public Enum
FileFindPreference

Defines options for file search.


Public Enum
FileGHSReadOptions.ReadViewType
Public Enum
FileGltfWriteOptions.SubDMeshing

Determines whether the surface or control net of a SubD object is used to generate a mesh


Public Enum
FileIgsWriteOptions.EolMode
Public Enum
FileIgsWriteOptions.IgesStringTypeMode
Public Enum
FileIgsWriteOptions.IgeswVersionMode
Public Enum
FileIgsWriteOptions.MaxDegreeMode
Public Enum
FileIgsWriteOptions.MeshesMode
Public Enum
FileIgsWriteOptions.PointObjectsMode
Public Enum
FileIgsWriteOptions.PolySurfacesMode
Public Enum
FileIgsWriteOptions.SolidsMode
Public Enum
FileIgsWriteOptions.SurfacesMode
Public Enum
FileObjReadOptions.UseObjGsAs

Determines how “g”s in the obj file will be interpreted on import


Public Enum
FileObjReadOptions.UseObjOsAs
Public Enum
FileObjWriteOptions.AsciiEol

End of Line


Public Enum
FileObjWriteOptions.CurveType

Type of curve used for trimmed surfaces


Public Enum
FileObjWriteOptions.GeometryType

(trimmed) NURBS surfaces may be exported as either NURBS or meshes


Public Enum
FileObjWriteOptions.NGons
Public Enum
FileObjWriteOptions.ObjGroupNames
Public Enum
FileObjWriteOptions.ObjObjectNames
Public Enum
FileObjWriteOptions.PolylineExportType

Determines how polylines will be written to the file


Public Enum
FileObjWriteOptions.SubDMeshing

Determines whether the surface or control net of a SubD object is used to generate a mesh


Public Enum
FileObjWriteOptions.VertexWelding

Determines how/if vertexes of the mesh in Rhino will be modified in the output


Public Enum
FilePdfReadOptions.PDF_UNITS
Public Enum
FileReferenceStatus

Enumerates a list of file statuses.


Public Enum
FileSatWriteOptions.SatTypes

Sat export types. Flavors of sat file that are suitable for a particular application or version of acis sat.


Public Enum
FileSkpWriteOptions.SketchUpVersion

SketchUp Versions


Public Enum
FileStpWriteOptions.StepSchema

Step schema.


Public Enum
FileSvgReadOptions.ImportFillMode
Public Enum
FileTxtReadOptions.DelimiterMode
Public Enum
FileTxtWriteOptions.DelimiterMode
Public Enum
FileX_TWriteOptions.X_T_Types

X_T export types. Flavors of x_t file that are suitable for a particular application or version of parsolid x_t.


Public Enum
FileXamlWriteOptions.AnimationMode