Click or drag to resize

Rhino.FileIO Namespace

[Missing <summary> documentation for "N:Rhino.FileIO"]

Classes
  ClassDescription
Public classBinaryArchiveException
Thrown by BinaryArchiveReader and BinaryArchiveWriter classes when an IO error has occurred.
Public classBinaryArchiveFile
Public classBinaryArchiveReader
Represents an entity that is capable of reading a binary archive and instantiating strongly-typed objects.
Public classBinaryArchiveWriter
Represents an entity that is able to write data to an archive.
Public classCommonComponentTableT
Provides a base table type that encompasses all document tables, both in RhinoDoc and File3dm.
Public classContentHash
Contains information that is useful to uniquely identify an object.
Remarks
This object is immutable.
Public classDracoCompression
Google Draco compression for mesh and point cloud data
Public classDracoCompressionOptions
Options for applying Draco compression
Public classFile3dm
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 classFile3dmCommonComponentTableT
Provides a base table type that is shared among all File3dm tables.
Public classFile3dmCurvePiping
Represents the curve piping attached to file3dm object attributes.
Public classFile3dmDimStyleTable
Provides access to annotation styles in the 3dm file.
Public classFile3dmDisplacement
Represents the displacement attached to file3dm object attributes.
Public classFile3dmEdgeSoftening
Represents the edge softening attached to file3dm object attributes.
Public classFile3dmEmbeddedFile
Public classFile3dmEmbeddedFiles
Public classFile3dmGroupTable
Provides access to groups in the 3dm file.
Public classFile3dmHatchPatternTable
Provides access to hatch pattern definitions in the 3dm file.
Public classFile3dmInstanceDefinitionTable
Provides access to instance (block) definitions in the 3dm file.
Public classFile3dmLayerTable
Provides access to layers in the 3dm file.
Public classFile3dmLinetypeTable
Provides access to Linetypes in the 3dm file.
Public classFile3dmMaterialTable
Provides access to materials in the 3dm file.
Public classFile3dmMeshModifiers
Represents the mesh modifiers attached to file3dm object attributes.
Public classFile3dmNamedConstructionPlanes
Provides access to named construction planes in the 3dm file.
Public classFile3dmNotes
Represents the notes information stored in a 3dm file.
Public classFile3dmObject
Used to store geometry table object definition and attributes in a File3dm.
Public classFile3dmObjectTable
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 classFile3dmPlugInData
Represents custom plug-in data, in the 3dm file, written by a plug-in.
Public classFile3dmPlugInDataTable
Table of custom data provided by plug-ins
Public classFile3dmRenderContent
Public classFile3dmRenderEnvironment
Public classFile3dmRenderEnvironments
Public classFile3dmRenderMaterial
Public classFile3dmRenderMaterials
Public classFile3dmRenderTexture
Public classFile3dmRenderTextures
Public classFile3dmSettings
General settings in a 3dm file.
Public classFile3dmShutLining
Represents the shut-lining attached to file3dm object attributes.
Public classFile3dmStringTable
Provides access to document strings in the 3dm file.
Public classFile3dmThickening
Represents the thickening attached to file3dm object attributes.
Public classFile3dmTypeCodes
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 classFile3dmViewTable
Provides access to views in the 3dm file.
Public classFile3dmWriteOptions
Options used by File3dm.Write
Public classFile3ds
Support for writing 3ds file format
Public classFile3dsReadOptions
Options for reading a 3ds file
Public classFile3dsWriteOptions
Options for writing a 3ds file
Public classFile3mf
Support for writing 3mf file format
Public classFile3mfWriteOptions
Options for writing a 3mf file
Public classFileAi
Support for writing ai file format
Public classFileAiReadOptions
Options for reading a AI file (old ai files, ps not pdf)
Public classFileAiWriteOptions
Options for writing a ai file
Public classFileAmf
Support for writing amf file format
Public classFileAmfWriteOptions
Options for writing a amf file
Public classFileCd
Support for writing CD file format
Public classFileCdWriteOptions
Options for writing a CD file
Public classFileCsv
Support for writing Csv file format
Public classFileCsvWriteOptions
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 classFileDgn
Support for writing Dgn file format
Public classFileDgnReadOptions
Options for reading a Dgn file
Public classFileDst
Support for writing dst file format
Public classFileDstReadOptions
Options for reading a Dst file
Public classFileDwg
Support for writing DWG file format
Public classFileDwgReadOptions
Options for reading a DWG file
Public classFileDwgWriteOptions
Options for writing a DWG file
Public classFileEps
Support for reading eps file format
Public classFileEpsReadOptions
Options for reading a AI file (old ai files, ps not pdf)
Public classFileFbx
Support for writing Fbx file format
Public classFileFbxReadOptions
Options for reading a Fbx file
Public classFileFbxWriteOptions
Options for writing a Fbx file
Public classFileGHS
Support for reading eps file format
Public classFileGHSReadOptions
Options for reading a GHS file
Public classFileGltf
Support for writing glTF file format
Public classFileGltfWriteOptions
Options used when writing a glTF file
Public classFileGts
Support for writing Gts file format
Public classFileGtsWriteOptions
Options for writing a Gts file
Public classFileIgs
Support for writing Igs file format
Public classFileIgsWriteOptions
Options for writing a Igs file
Public classFileLwo
Support for writing lwo file format
Public classFileLwoReadOptions
Options for reading a Lwo file
Public classFileLwoWriteOptions
Options for writing a Lwo file
Public classFileObj
Support for obj file format
Public classFileObjReadOptions
Options used when reading an obj file.
Public classFileObjWriteOptions
Public classFilePdf
Support for PDF file format
Public classFilePdfEventArgs
Used for events that are fired while constructing/saving a PDF
Public classFilePdfReadOptions
Options for reading a PDF file
Public classFilePly
Support for ply file format
Public classFilePlyReadOptions
Options for reading a PLY file
Public classFilePlyWriteOptions
Public classFilePov
Support for writing POV file format
Public classFilePovWriteOptions
Options for writing a POV file
Public classFileRaw
Support for writing Raw file format
Public classFileRawReadOptions
Options for reading a Raw file
Public classFileRawWriteOptions
Options for writing a Raw file
Public classFileReadOptions
Public classFileReference
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 classFileSat
Support for writing Sat file format
Public classFileSatWriteOptions
Options used when writing a Sat file
Public classFileSkp
Support for writing Skp file format
Public classFileSkpReadOptions
Options used when reading a Skp file
Public classFileSkpWriteOptions
Options used when writing a Skp file
Public classFileSlc
Support for writing slice (SLC) file format
Public classFileSlcWriteOptions
Options used when writing a SLC file
Public classFileStl
Support for writing STL file format
Public classFileStlReadOptions
Options for reading a STL file
Public classFileStlWriteOptions
Options for writing a STL file
Public classFileStp
Support for writing STEP (STP) file format
Public classFileStpReadOptions
Options used when reading a STP file
Public classFileStpWriteOptions
Options used when writing a STP file
Public classFileSvg
Support for writing Svg file format
Public classFileSvgReadOptions
Options used when reading a Svg file
Public classFileSW
Public classFileSwReadOptions
Options used when reading a SW file
Public classFileTxt
Support for writing Txt (points) file format
Public classFileTxtReadOptions
Options for writing a Txt file.
Public classFileTxtWriteOptions
Options for writing a Txt file.
Public classFileType
Public classFileUdo
Support for writing Moray UDO file format
Public classFileUdoWriteOptions
Options for writing a Moray UDO file
Public classFileUsd
Support for writing USD file format
Public classFileUsdWriteOptions
Options for writing a USD file
Public classFileVda
Support for writing Igs file format
Public classFileVdaWriteOptions
Options for writing a Vda file
Public classFileVrml
Support for writing wrl file format
Public classFileVrmlWriteOptions
Options for writing a wrl file
Public classFileWriteOptions
Public classFileX_T
Support for writing X_T file format
Public classFileX_TWriteOptions
Options used when writing a X_T file
Public classFileX3dv
Support for writing x3dv file format
Public classFileX3dvWriteOptions
Options for writing a x3dv file
Public classFileXaml
Support for writing Xaml file format
Public classFileXamlWriteOptions
Options for writing a Xaml file
Public classImageFile
Support functions for image files
Public classManifestTable
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 classNameHash
Contains information that is useful to uniquely identify an object name.
Remarks
This object is immutable.
Public classSerializationOptions
Contains options for serializing -or storing- data, such as Rhino version, user data, and meshes.
Public classSHA1OpenNURBS
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 classTextLog
Used for collecting text data
Interfaces
  InterfaceDescription
Public interfaceICommonComponentTableT
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
  EnumerationDescription
Public enumerationBinaryArchiveMode
Public enumerationDracoColorFormat
Color format for vertex colors
Public enumerationFile3dmObjectTypeFilter
Public enumerationFile3dmTableTypeFilter
Public enumerationFile3dmCurvePipingCapTypes
Defines how the pipe is capped at the ends.
Public enumerationFile3dmDisplacementSweepResolutionFormulas
Formula to use to calculate sweep resolution from initial quality.
Public enumerationFileAiReadOptionsUnits
Public enumerationFileAiWriteOptionsUnits
Public enumerationFileDwgReadOptionsMeshPrecisionMode
Public enumerationFileDwgWriteOptionsAutocadVersion
AutoCAD version format to write to
Public enumerationFileDwgWriteOptionsColorMethodType
Public enumerationFileDwgWriteOptionsExportArcMode
Public enumerationFileDwgWriteOptionsExportLineMode
Public enumerationFileDwgWriteOptionsExportMeshMode
Public enumerationFileDwgWriteOptionsExportPolycurveMode
Public enumerationFileDwgWriteOptionsExportPolylineMode
Public enumerationFileDwgWriteOptionsExportSplineMode
Public enumerationFileDwgWriteOptionsExportSurfaceMode
Public enumerationFileDwgWriteOptionsFlattenMode
Public enumerationFileEpsReadOptionsUnits
Public enumerationFileFbxWriteOptionsFileType
Public enumerationFileFbxWriteOptionsMaterialType
Public enumerationFileFbxWriteOptionsObjectType
Public enumerationFileFindPreference
Defines options for file search.
Public enumerationFileGHSReadOptionsReadViewType
Public enumerationFileGltfWriteOptionsSubDMeshing
Determines whether the surface or control net of a SubD object is used to generate a mesh
Public enumerationFileIgsWriteOptionsEolMode
Public enumerationFileIgsWriteOptionsIgesStringTypeMode
Public enumerationFileIgsWriteOptionsIgeswVersionMode
Public enumerationFileIgsWriteOptionsMaxDegreeMode
Public enumerationFileIgsWriteOptionsMeshesMode
Public enumerationFileIgsWriteOptionsPointObjectsMode
Public enumerationFileIgsWriteOptionsPolySurfacesMode
Public enumerationFileIgsWriteOptionsSolidsMode
Public enumerationFileIgsWriteOptionsSurfacesMode
Public enumerationFileObjReadOptionsUseObjGsAs
Determines how "g"s in the obj file will be interpreted on import
Public enumerationFileObjReadOptionsUseObjOsAs
Public enumerationFileObjWriteOptionsAsciiEol
End of Line
Public enumerationFileObjWriteOptionsCurveType
Type of curve used for trimmed surfaces
Public enumerationFileObjWriteOptionsGeometryType
(trimmed) NURBS surfaces may be exported as either NURBS or meshes
Public enumerationFileObjWriteOptionsNGons
Public enumerationFileObjWriteOptionsObjGroupNames
Public enumerationFileObjWriteOptionsObjObjectNames
Public enumerationFileObjWriteOptionsPolylineExportType
Determines how polylines will be written to the file
Public enumerationFileObjWriteOptionsSubDMeshing
Determines whether the surface or control net of a SubD object is used to generate a mesh
Public enumerationFileObjWriteOptionsVertexWelding
Determines how/if vertexes of the mesh in Rhino will be modified in the output
Public enumerationFilePdfReadOptionsPDF_UNITS
Public enumerationFileReferenceStatus
Enumerates a list of file statuses.
Public enumerationFileSatWriteOptionsSatTypes
Sat export types. Flavors of sat file that are suitable for a particular application or version of acis sat.
Public enumerationFileSkpWriteOptionsSketchUpVersion
SketchUp Versions
Public enumerationFileStpWriteOptionsStepSchema
Step schema.
Public enumerationFileSvgReadOptionsImportFillMode
Public enumerationFileTxtReadOptionsDelimiterMode
Public enumerationFileTxtWriteOptionsDelimiterMode
Public enumerationFileX_TWriteOptionsX_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 enumerationFileXamlWriteOptionsAnimationMode