File3dm

Public Class

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.

Inheritance Hierarchy

System.Object
Rhino.FileIO.File3dm

Namespace: Rhino.FileIO

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public class File3dm : IDisposable

The File3dm type exposes the following members.

Constructors

Name

Description

---

Public Method

File3dm

Initializes a new instance of a 3dm file.

---

Properties

Name

Description

---

Public Property

AllDimStyles

Dimension Styles in this file.

---

Public Property

AllGroups

Groups in this file.

---

Public Property

AllHatchPatterns

Hatch patterns in this file.

---

Public Property

AllInstanceDefinitions

Instance definitions in this file

---

Public Property

AllLayers

Layers in this file.

---

Public Property

AllLinetypes

Linetypes in this file.

---

Public Property

AllMaterials

Materials in this file.

---

Public Property

AllNamedConstructionPlanes

Named construction planes in this file.

---

Public Property

AllNamedViews

Named views in this file.

---

Public Property

AllViews

Views that represent the RhinoViews which are displayed when Rhino loads this file.

---

Public Property

ApplicationDetails

Gets or sets details for the application that wrote this file.

---

Public Property

ApplicationName

Gets or sets the name of the application that wrote this file.

---

Public Property

ApplicationUrl

Gets or sets a URL for the application that wrote this file.

---

Public Property

ArchiveVersion

Gets the 3dm file archive version.

---

Public Property

Created

Get the DateTime that this file was originally created. If the value is not set in the 3dm file, then DateTime.MinValue is returned

---

Public Property

CreatedBy

Gets a string that names the user who created the file.

---

Public Property

DimStyles

Obsolete.

Dimension Styles in this file.

---

Public Property

EarthAnchorPoint

If set, this is the model’s location on the earth. This information is used when the model is used with GIS information.

---

Public Property

EmbeddedFiles

The embedded files in this file.

---

Public Property

HatchPatterns

Obsolete.

Hatch patterns in this file

---

Public Property

InstanceDefinitions

Obsolete.

Instance definitions in this file.

---

Public Property

LastEdited

Get the DateTime that this file was last edited. If the value is not set in the 3dm file, then DateTime.MinValue is returned

---

Public Property

LastEditedBy

Gets a string that names the user who last edited the file.

---

Public Property

Layers

Obsolete.

Layers in this file.

---

Public Property

Linetypes

Obsolete.

Linetypes in this file.

---

Public Property

Manifest

Retrieves the manifest with all object descriptions in this file.

---

Public Property

Materials

Obsolete.

Materials in this file.

---

Public Property

NamedConstructionPlanes

Named construction planes in this file.

---

Public Property

NamedViews

Named views in this file.

---

Public Property

Notes

Gets or sets the model notes.

---

Public Property

Objects

Gets access to the File3dmObjectTable class associated with this file, which contains all objects.

---

Public Property

PlugInData

Custom plug-in data in this file. This data is not attached to any geometry or attributes

---

Public Property

RenderEnvironments

The render environments in this file.

---

Public Property

RenderMaterials

The render materials in this file.

---

Public Property

RenderTextures

The render textures in this file.

---

Public Property

Revision

Gets or sets the revision number.

---

Public Property

Settings

Settings include tolerance, and unit system, and defaults used for creating views and objects.

---

Public Property

StartSectionComments

Gets or sets the start section comments, which are the comments with which the 3dm file begins.

---

Public Property

Strings

Document user strings in this file

---

Public Property

Views

Views that represent the RhinoViews which are displayed when Rhino loads this file.

---

Methods

Name

Description

---

Public Method

Audit

Obsolete.

This function is only kept for forward assembly compatibility.

---

Public Method

Dispose.

Actively reclaims unmanaged resources that this instance uses.

---

Protected Method

Dispose(Boolean)

For derived class implementers.

This method is called with argument true when class user calls Dispose(), while with argument false when the Garbage Collector invokes the finalizer, or Finalize() method.

You must reclaim all used unmanaged resources in both cases, and can use this chance to call Dispose on disposable fields if the argument is true.

Also, you must call the base virtual method within your overriding method.

---

Public Method

Dump

Prepares a text dump of the entire model.

---

Public Method

DumpSummary

Prepares a text dump of model properties and settings.

---

Public Method

DumpToTextLog

Prepares a text dump of the entire model.

---

Public Method

Equals

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

(Inherited from Object.)

---

Protected Method

Finalize

Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().

(Overrides Object.Finalize..)

---

Public Method
Static Member

FromByteArray

Read a 3dm file from a byte array

---

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

---

Public Method

GetPreviewImage

Preview image used for file explorer

---

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

---

Public Method

IsValid(String.)

Obsolete.

The File3dm object is kept consistent during its creation. Therefore, this function now returns only true.

---

Public Method

IsValid(TextLog)

Obsolete.

The File3dm object is kept consistent during its creation. Therefore, this function now returns only true.

---

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

---

Public Method

Polish

Obsolete.

This function is only kept for forward assembly compatibility.

---

Public Method
Static Member

Read(String)

Reads a 3dm file from a specified location.

---

Public Method
Static Member

Read(String, File3dm.TableTypeFilter, File3dm.ObjectTypeFilter)

Reads a 3dm file from a specified location.

---

Public Method
Static Member

ReadApplicationData

Reads only the application information from an existing 3dm file.

---

Public Method
Static Member

ReadArchiveVersion

Reads only the archive 3dm version from an existing 3dm file.

---

Public Method
Static Member

ReadDimensionStyles

Read the dimension styles table out of a 3dm file.

---

Public Method
Static Member

ReadEarthAnchorPoint

Reads only the earth anchor point from an existing 3dm file

---

Public Method
Static Member

ReadNotes

Reads only the notes from an existing 3dm file.

---

Public Method
Static Member

ReadPreviewImage

Attempts to read the preview image out of a 3dm file.

---

Public Method
Static Member

ReadRevisionHistory

Quickly check a file for it’s revision information. This function does not read the entire file, just what it needs to get revision information out

---

Public Method
Static Member

ReadWithLog(String, String.)

Read a 3dm file from a specified location and log any archive reading errors.

---

Public Method
Static Member

ReadWithLog(String, File3dm.TableTypeFilter, File3dm.ObjectTypeFilter, String.)

Reads a 3dm file from a specified location.

---

Public Method

SetPreviewImage

Preview image used for file explorer

---

Public Method

ToByteArray.

Write to an in-memory byte[]

---

Public Method

ToByteArray(File3dmWriteOptions)

Write to an in-memory byte[]

---

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

---

Public Method

Write(String, File3dmWriteOptions)

Writes contents of this model to an openNURBS archive. If the model is not valid, then Write will refuse to write it.

---

Public Method

Write(String, Int32)

Writes contents of this model to an openNURBS archive. If the model is not valid, then Write will refuse to write it.

---

Public Method
Static Member

WriteMultipleObjects

Creates a simple 3dm file that contains a multiple geometric objects.

---

Public Method
Static Member

WriteOneObject

Creates a simple 3dm file that contains a single geometric object.

---

Public Method

WriteWithLog(String, File3dmWriteOptions, String.)

Writes contents of this model to an openNURBS archive. If the model is not valid, then Write will refuse to write it.

---

Public Method

WriteWithLog(String, Int32, String.)

Writes contents of this model to an openNURBS archive. If the model is not valid, then Write will refuse to write it.

---