File3dm

File3dm 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.

Derived Classes:

Namespace: Rhino.FileIO
File3dm: references

Constructors (1)

File3dm()

Initializes a new instance of a 3dm file.

Properties (40)

AllDimStyles

Dimension Styles in this file.

AllGroups

Groups in this file.

AllHatchPatterns

Hatch patterns in this file.

AllInstanceDefinitions

Instance definitions in this file

AllLayers

Layers in this file.

AllLinetypes

Linetypes in this file.

AllMaterials

Materials in this file.

AllNamedConstructionPlanes

Named construction planes in this file.

AllNamedViews

Named views in this file.

AllViews

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

ApplicationDetails

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

ApplicationName

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

ApplicationUrl

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

ArchiveVersion

Gets the 3dm file archive version.

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

CreatedBy

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

DimStyles

Dimension Styles in this file.

EarthAnchorPoint

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

EmbeddedFiles

The embedded files in this file.

HatchPatterns

Hatch patterns in this file

InstanceDefinitions

Instance definitions in this file.

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

LastEditedBy

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

Layers

Layers in this file.

Linetypes

Linetypes in this file.

Manifest

Retrieves the manifest with all object descriptions in this file.

Materials

Materials in this file.

NamedConstructionPlanes

Named construction planes in this file.

NamedViews

Named views in this file.

Notes

Gets or sets the model notes.

Objects

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

PlugInData

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

RenderEnvironments

The render environments in this file.

RenderMaterials

The render materials in this file.

RenderTextures

The render textures in this file.

Revision

Gets or sets the revision number.

Settings

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

StartSectionComments

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

Strings

Document user strings in this file

Views

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

Methods (31)

Audit(bool attemptRepair, out int repairCount, out string errors, out int warnings)

This function is only kept for forward assembly compatibility.

Dispose()

Actively reclaims unmanaged resources that this instance uses.

Dispose(bool disposing)

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.

Dump()

Prepares a text dump of the entire model.

DumpSummary()

Prepares a text dump of model properties and settings.

DumpToTextLog(TextLog log)

Prepares a text dump of the entire model.

FromByteArray(byte bytes)

Read a 3dm file from a byte array

GetPreviewImage()

Preview image used for file explorer

IsValid(out string errors)

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

IsValid(TextLog errors)

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

Polish()

This function is only kept for forward assembly compatibility.

Read(string path, TableTypeFilter tableTypeFilterFilter, ObjectTypeFilter objectTypeFilter)

Reads a 3dm file from a specified location.

Read(string path)

Reads a 3dm file from a specified location.

ReadApplicationData(string path, out string applicationName, out string applicationUrl, out string applicationDetails)

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

ReadArchiveVersion(string path)

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

ReadDimensionStyles(string path)

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

ReadEarthAnchorPoint(string path)

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

ReadNotes(string path)

Reads only the notes from an existing 3dm file.

ReadPreviewImage(string path)

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

ReadRevisionHistory(string path, out string createdBy, out string lastEditedBy, out int revision,DateTime createdOn,DateTime lastEditedOn)

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

ReadWithLog(string path, out string errorLog)

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

ReadWithLog(string path, TableTypeFilter tableTypeFilterFilter, ObjectTypeFilter objectTypeFilter, out string errorLog)

Reads a 3dm file from a specified location.

SetPreviewImage(Bitmap image)

Preview image used for file explorer

ToByteArray()

Write to an in-memory byte[]

ToByteArray(File3dmWriteOptions options)

Write to an in-memory byte[]

Write(string path, File3dmWriteOptions options)

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

Write(string path, int version)

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

WriteMultipleObjects(string path, IEnumerable<GeometryBase> geometry)

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

WriteOneObject(string path, GeometryBase geometry)

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

WriteWithLog(string path, File3dmWriteOptions options, out string errorLog)

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

WriteWithLog(string path, int version, out string errorLog)

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

Nothing found