Rhino.FileIOnamespace

Types

Rhino.FileIO.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.
Rhino.FileIO.BinaryArchiveException
Thrown by BinaryArchiveReader and BinaryArchiveWriter classes when an IO error has occurred.
Rhino.FileIO.BinaryArchiveFile
Rhino.FileIO.BinaryArchiveMode
Rhino.FileIO.BinaryArchiveReader
Represents an entity that is capable of reading a binary archive and instantiating strongly-typed objects.
Rhino.FileIO.BinaryArchiveWriter
Represents an entity that is able to write data to an archive.
Rhino.FileIO.CommonComponentTable<T>
Provides a base table type that encompasses all document tables, both in RhinoDoc and File3dm.
Rhino.FileIO.ContentHash
Contains information that is useful to uniquely identify an object. This object is immutable.
Rhino.FileIO.DracoColorFormat
Color format for vertex colors
Rhino.FileIO.DracoCompression
Google Draco compression for mesh and point cloud data
Rhino.FileIO.DracoCompressionOptions
Options for applying Draco compression
Rhino.FileIO.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.

Rhino.FileIO.File3dm.ObjectTypeFilter
Rhino.FileIO.File3dm.TableTypeFilter
Rhino.FileIO.File3dmCommonComponentTable<T>
Provides a base table type that is shared among all File3dm tables.
Rhino.FileIO.File3dmCurvePiping
Represents the curve piping attached to file3dm object attributes.
Rhino.FileIO.File3dmCurvePiping.CapTypes
Defines how the pipe is capped at the ends.
Rhino.FileIO.File3dmDimStyleTable
Provides access to annotation styles in the 3dm file.
Rhino.FileIO.File3dmDisplacement
Represents the displacement attached to file3dm object attributes.
Rhino.FileIO.File3dmDisplacement.SweepResolutionFormulas
Formula to use to calculate sweep resolution from initial quality.
Rhino.FileIO.File3dmEdgeSoftening
Represents the edge softening attached to file3dm object attributes.
Rhino.FileIO.File3dmEmbeddedFile
Rhino.FileIO.File3dmEmbeddedFiles
Rhino.FileIO.File3dmGroupTable
Provides access to groups in the 3dm file.
Rhino.FileIO.File3dmHatchPatternTable
Provides access to hatch pattern definitions in the 3dm file.
Rhino.FileIO.File3dmInstanceDefinitionTable
Provides access to instance (block) definitions in the 3dm file.
Rhino.FileIO.File3dmLayerTable
Provides access to layers in the 3dm file.
Rhino.FileIO.File3dmLinetypeTable
Provides access to Linetypes in the 3dm file.
Rhino.FileIO.File3dmMaterialTable
Provides access to materials in the 3dm file.
Rhino.FileIO.File3dmMeshModifiers
Represents the mesh modifiers attached to file3dm object attributes.
Rhino.FileIO.File3dmNamedConstructionPlanes
Provides access to named construction planes in the 3dm file.
Rhino.FileIO.File3dmNotes
Represents the notes information stored in a 3dm file.
Rhino.FileIO.File3dmObject
Used to store geometry table object definition and attributes in a File3dm.
Rhino.FileIO.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.

Rhino.FileIO.File3dmPlugInData
Represents custom plug-in data, in the 3dm file, written by a plug-in.
Rhino.FileIO.File3dmPlugInDataTable
Table of custom data provided by plug-ins
Rhino.FileIO.File3dmPlugInDetails
Details about Rhino a Rhino plug-in that was loaded in the Rhino process when a 3dm file is saved
Rhino.FileIO.File3dmRenderContent
Rhino.FileIO.File3dmRenderEnvironment
Rhino.FileIO.File3dmRenderEnvironments
Rhino.FileIO.File3dmRenderMaterial
Rhino.FileIO.File3dmRenderMaterials
Rhino.FileIO.File3dmRenderTexture
Rhino.FileIO.File3dmRenderTextures
Rhino.FileIO.File3dmSettings
General settings in a 3dm file.
Rhino.FileIO.File3dmShutLining
Represents the shut-lining attached to file3dm object attributes.
Rhino.FileIO.File3dmStringTable
Provides access to document strings in the 3dm file.
Rhino.FileIO.File3dmThickening
Represents the thickening attached to file3dm object attributes.
Rhino.FileIO.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
Rhino.FileIO.File3dmViewTable
Provides access to views in the 3dm file.
Rhino.FileIO.File3dmWriteOptions
Options used by File3dm.Write
Rhino.FileIO.File3ds
Support for writing 3ds file format
Rhino.FileIO.File3dsReadOptions
Options for reading a 3ds file
Rhino.FileIO.File3dsWriteOptions
Options for writing a 3ds file
Rhino.FileIO.File3mf
Support for writing 3mf file format
Rhino.FileIO.File3mfWriteOptions
Options for writing a 3mf file
Rhino.FileIO.FileAi
Support for writing ai file format
Rhino.FileIO.FileAiReadOptions
Options for reading a AI file (old ai files, ps not pdf)
Rhino.FileIO.FileAiReadOptions.Units
Rhino.FileIO.FileAiWriteOptions
Options for writing a ai file
Rhino.FileIO.FileAiWriteOptions.Units
Rhino.FileIO.FileAmf
Support for writing amf file format
Rhino.FileIO.FileAmfWriteOptions
Options for writing a amf file
Rhino.FileIO.FileCd
Support for writing CD file format
Rhino.FileIO.FileCdWriteOptions
Options for writing a CD file
Rhino.FileIO.FileCsv
Support for writing Csv file format

FileCsvDocument

Since v9.0
Rhino.FileIO.FileCsvDocument
A simple, general-purpose, in-memory representation of a RFC 4180-compliant comma-separated value (CSV) file.

Read a file with FileCsvDocument.Read(string) (or FileCsvDocument.Read(string, bool) to treat the first row as a column-name header), then query its dimensions (FileCsvDocument.RowCount, FileCsvDocument.ColumnCount), retrieve typed values by column and row with the TryGet methods — addressing columns by index or, when a header is present, by name — or enumerate its rows. To build a file, construct the document with a fixed column count, populate cells with the FileCsvDocument.Set(int, int, string) overloads (addressed by column and row), then persist it with FileCsvDocument.Save(string). Every row has the same number of columns; addressing a column outside that count throws.

Rhino.FileIO.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.
Rhino.FileIO.FileDgn
Support for writing Dgn file format
Rhino.FileIO.FileDgnReadOptions
Options for reading a Dgn file
Rhino.FileIO.FileDst
Support for writing dst file format
Rhino.FileIO.FileDstReadOptions
Options for reading a Dst file
Rhino.FileIO.FileDwg
Support for writing DWG file format
Rhino.FileIO.FileDwgReadOptions
Options for reading a DWG file
Rhino.FileIO.FileDwgReadOptions.MeshPrecisionMode
Rhino.FileIO.FileDwgWriteOptions
Options for writing a DWG file
Rhino.FileIO.FileDwgWriteOptions.AutocadVersion
Rhino.FileIO.FileDwgWriteOptions.ColorMethodType
Rhino.FileIO.FileDwgWriteOptions.ExportArcMode
Rhino.FileIO.FileDwgWriteOptions.ExportLineMode
Rhino.FileIO.FileDwgWriteOptions.ExportMeshMode
Rhino.FileIO.FileDwgWriteOptions.ExportPolycurveMode
Rhino.FileIO.FileDwgWriteOptions.ExportPolylineMode
Rhino.FileIO.FileDwgWriteOptions.ExportSplineMode
Rhino.FileIO.FileDwgWriteOptions.ExportSurfaceMode
Rhino.FileIO.FileDwgWriteOptions.FlattenMode
Rhino.FileIO.FileDwgWriteOptions.UseColorType
Rhino.FileIO.FileEps
Support for reading eps file format
Rhino.FileIO.FileEpsReadOptions
Options for reading a AI file (old ai files, ps not pdf)
Rhino.FileIO.FileEpsReadOptions.Units
Rhino.FileIO.FileFbx
Support for writing Fbx file format
Rhino.FileIO.FileFbxReadOptions
Options for reading a Fbx file
Rhino.FileIO.FileFbxWriteOptions
Options for writing a Fbx file
Rhino.FileIO.FileFbxWriteOptions.FileType
Rhino.FileIO.FileFbxWriteOptions.MaterialType
Rhino.FileIO.FileFbxWriteOptions.ObjectType
Rhino.FileIO.FileFindPreference
Defines options for file search.
Rhino.FileIO.FileGHS
Support for reading eps file format
Rhino.FileIO.FileGHSReadOptions
Options for reading a GHS file
Rhino.FileIO.FileGHSReadOptions.ReadViewType

FileGltf

Since v8.3
Rhino.FileIO.FileGltf
Support for writing glTF file format
Rhino.FileIO.FileGltfWriteOptions
Options used when writing a glTF file
Rhino.FileIO.FileGltfWriteOptions.SubDMeshing
Determines whether the surface or control net of a SubD object is used to generate a mesh
Rhino.FileIO.FileGts
Support for writing Gts file format
Rhino.FileIO.FileGtsWriteOptions
Options for writing a Gts file
Rhino.FileIO.FileIgs
Support for writing Igs file format
Rhino.FileIO.FileIgsWriteOptions
Options for writing a Igs file
Rhino.FileIO.FileIgsWriteOptions.EolMode
Rhino.FileIO.FileIgsWriteOptions.IgesStringTypeMode
Rhino.FileIO.FileIgsWriteOptions.IgeswVersionMode
Rhino.FileIO.FileIgsWriteOptions.MaxDegreeMode
Rhino.FileIO.FileIgsWriteOptions.MeshesMode
Rhino.FileIO.FileIgsWriteOptions.PointObjectsMode
Rhino.FileIO.FileIgsWriteOptions.PolySurfacesMode
Rhino.FileIO.FileIgsWriteOptions.SolidsMode
Rhino.FileIO.FileIgsWriteOptions.SurfacesMode
Rhino.FileIO.FileLwo
Support for writing lwo file format
Rhino.FileIO.FileLwoReadOptions
Options for reading a Lwo file
Rhino.FileIO.FileLwoWriteOptions
Options for writing a Lwo file
Rhino.FileIO.FileNwd
Support for writing Nwd file format
Rhino.FileIO.FileNwdWriteOptions
Options for writing a Nwd file
Rhino.FileIO.FileObj
Support for obj file format
Rhino.FileIO.FileObjReadOptions
Options used when reading an obj file.
Rhino.FileIO.FileObjReadOptions.UseObjGsAs
Determines how "g"s in the obj file will be interpreted on import
Rhino.FileIO.FileObjReadOptions.UseObjOsAs
Rhino.FileIO.FileObjWriteOptions
Rhino.FileIO.FileObjWriteOptions.AsciiEol
End of Line
Rhino.FileIO.FileObjWriteOptions.CurveType
Type of curve used for trimmed surfaces
Rhino.FileIO.FileObjWriteOptions.GeometryType
(trimmed) NURBS surfaces may be exported as either NURBS or meshes
Rhino.FileIO.FileObjWriteOptions.NGons
Rhino.FileIO.FileObjWriteOptions.ObjGroupNames
Rhino.FileIO.FileObjWriteOptions.ObjObjectNames
Rhino.FileIO.FileObjWriteOptions.PolylineExportType
Determines how polylines will be written to the file
Rhino.FileIO.FileObjWriteOptions.SubDMeshing
Determines whether the surface or control net of a SubD object is used to generate a mesh
Rhino.FileIO.FileObjWriteOptions.VertexWelding
Determines how/if vertexes of the mesh in Rhino will be modified in the output
Rhino.FileIO.FilePdf
Support for PDF file format
Rhino.FileIO.FilePdfEventArgs
Used for events that are fired while constructing/saving a PDF
Rhino.FileIO.FilePdfReadOptions
Options for reading a PDF file
Rhino.FileIO.FilePdfReadOptions.PDF_UNITS
Rhino.FileIO.FilePly
Support for ply file format
Rhino.FileIO.FilePlyReadOptions
Options for reading a PLY file
Rhino.FileIO.FilePlyWriteOptions
Rhino.FileIO.FilePov
Support for writing POV file format
Rhino.FileIO.FilePovWriteOptions
Options for writing a POV file
Rhino.FileIO.FileRaw
Support for writing Raw file format
Rhino.FileIO.FileRawReadOptions
Options for reading a Raw file
Rhino.FileIO.FileRawWriteOptions
Options for writing a Raw file
Rhino.FileIO.FileReadOptions
Rhino.FileIO.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.
Rhino.FileIO.FileReferenceStatus
Enumerates a list of file statuses.
Rhino.FileIO.FileSat
Support for writing Sat file format
Rhino.FileIO.FileSatWriteOptions
Options used when writing a Sat file
Rhino.FileIO.FileSatWriteOptions.SatTypes
Sat export types. Flavors of sat file that are suitable for a particular application or version of acis sat.
Rhino.FileIO.FileSkp
Support for writing Skp file format
Rhino.FileIO.FileSkpReadOptions
Options used when reading a Skp file
Rhino.FileIO.FileSkpWriteOptions
Options used when writing a Skp file
Rhino.FileIO.FileSkpWriteOptions.SketchUpVersion
SketchUp Versions
Rhino.FileIO.FileSlc
Support for writing slice (SLC) file format
Rhino.FileIO.FileSlcWriteOptions
Options used when writing a SLC file
Rhino.FileIO.FileStl
Support for writing STL file format
Rhino.FileIO.FileStlReadOptions
Options for reading a STL file
Rhino.FileIO.FileStlWriteOptions
Options for writing a STL file
Rhino.FileIO.FileStp
Support for writing STEP (STP) file format
Rhino.FileIO.FileStpReadOptions
Options used when reading a STP file
Rhino.FileIO.FileStpWriteOptions
Options used when writing a STP file
Rhino.FileIO.FileStpWriteOptions.StepSchema
Step schema.
Rhino.FileIO.FileSvg
Support for writing Svg file format
Rhino.FileIO.FileSvgReadOptions
Options used when reading a Svg file
Rhino.FileIO.FileSvgReadOptions.ImportFillMode
Rhino.FileIO.FileSW
Rhino.FileIO.FileSwReadOptions
Options used when reading a SW file
Rhino.FileIO.FileTxt
Support for writing Txt (points) file format
Rhino.FileIO.FileTxtReadOptions
Options for writing a Txt file.
Rhino.FileIO.FileTxtReadOptions.DelimiterMode
Rhino.FileIO.FileTxtWriteOptions
Options for writing a Txt file.
Rhino.FileIO.FileTxtWriteOptions.DelimiterMode
Rhino.FileIO.FileType
Rhino.FileIO.FileUdo
Support for writing Moray UDO file format
Rhino.FileIO.FileUdoWriteOptions
Options for writing a Moray UDO file
Rhino.FileIO.FileUsd
Support for writing USD file format
Rhino.FileIO.FileUsdWriteOptions
Options for writing a USD File (.usda, .usda, .usdz)
Rhino.FileIO.FileVda
Support for writing Igs file format
Rhino.FileIO.FileVdaWriteOptions
Options for writing a Vda file
Rhino.FileIO.FileVrml
Support for writing wrl file format
Rhino.FileIO.FileVrmlWriteOptions
Options for writing a wrl file
Rhino.FileIO.FileWriteOptions
Rhino.FileIO.FileX_T
Support for writing X_T file format
Rhino.FileIO.FileX_TWriteOptions
Options used when writing a X_T file
Rhino.FileIO.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.
Rhino.FileIO.FileX3dv
Support for writing x3dv file format
Rhino.FileIO.FileX3dvWriteOptions
Options for writing a x3dv file
Rhino.FileIO.FileXaml
Support for writing Xaml file format
Rhino.FileIO.FileXamlWriteOptions
Options for writing a Xaml file
Rhino.FileIO.FileXamlWriteOptions.AnimationMode
Rhino.FileIO.ImageFile
Support functions for image files
Rhino.FileIO.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.
Rhino.FileIO.NameHash
Contains information that is useful to uniquely identify an object name. This object is immutable.
Rhino.FileIO.NavisWorksVersion
Rhino.FileIO.SerializationOptions
Contains options for serializing -or storing- data, such as Rhino version, user data, and meshes.
Rhino.FileIO.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.

Rhino.FileIO.TextLog
Used for collecting text data
Rhino.FileIO.USDExportBlockHandling
USD Block Exporting Options

WorksessionFile

Since v9.0
Rhino.FileIO.WorksessionFile
Reads and writes Rhino worksession (.rws) files. A worksession file lists models and a worksession's layer overrides. It does not contain any model content, and nothing here opens or checks the model files it lists.
Rhino.FileIO.WorksessionFileLayerOverride
A layer setting in a reference model that the worksession changes. Any value that is different in the worksession values and the file values is an override. Values that are the same are not.
Rhino.FileIO.WorksessionFileLayerValues
Layer settings saved in a Rhino worksession (.rws) file.
Rhino.FileIO.WorksessionFileModel
A model in a Rhino worksession (.rws) file.