Click or drag to resize
File3dm Methods

The File3dm type exposes the following members.

Methods
  NameDescription
Public methodAudit
Check a model to make sure it is valid and, if possible and requested, attempt to repair.
Public methodDispose
Actively reclaims unmanaged resources that this instance uses.
Protected methodDispose(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 methodDump
Prepares a text dump of the entire model.
Public methodDumpSummary
Prepares a text dump of model properties and settings.
Public methodDumpToTextLog
Prepares a text dump of the entire model.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Passively reclaims unmanaged resources when the class user did not explicitly call Dispose().
(Overrides ObjectFinalize.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIsValid(String)
Checks a model to make sure it is valid.
Public methodIsValid(TextLog)
Checks a model to make sure it is valid.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPolish
Quickly fills in the little details, like making sure there is at least one layer and table indices make sense. For a full blown check and repair, call Audit(true).
Public methodStatic memberRead(String)
Reads a 3dm file from a specified location.
Public methodStatic memberRead(String, File3dmTableTypeFilter, File3dmObjectTypeFilter)
Reads a 3dm file from a specified location.
Public methodStatic memberReadApplicationData
Reads only the application information from an existing 3dm file.
Public methodStatic memberReadArchiveVersion
Reads only the archive 3dm version from an existing 3dm file.
Public methodStatic memberReadNotes
Reads only the notes from an existing 3dm file.
Public methodStatic memberCode exampleReadPreviewImage
Attempts to read the preview image out of a 3dm file.
Public methodStatic memberReadRevisionHistory
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 methodStatic memberReadWithLog(String, String)
Read a 3dm file from a specified location and log any archive reading errors.
Public methodStatic memberReadWithLog(String, File3dmTableTypeFilter, File3dmObjectTypeFilter, String)
Reads a 3dm file from a specified location.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodWrite(String, File3dmWriteOptions)
Writes contents of this model to an openNURBS archive. I STRONGLY suggested that you call Polish() before calling Write so that your file has all the "fluff" that makes it complete. If the model is not valid, then Write will refuse to write it.
Public methodWrite(String, Int32)
Writes contents of this model to an openNURBS archive. I STRONGLY suggested that you call Polish() before calling Write so that your file has all the "fluff" that makes it complete. If the model is not valid, then Write will refuse to write it.
Public methodWriteWithLog
Writes contents of this model to an openNURBS archive. I STRONGLY suggested that you call Polish() before calling Write so that your file has all the "fluff" that makes it complete. If the model is not valid, then Write will refuse to write it.
Top
See Also