Represents an active model.

System.Object
  Rhino.RhinoDoc
Namespace: Rhino
Assembly: RhinoCommon (in RhinoCommon.dll) Version: Rhino 6.0

C#

public sealed class RhinoDoc

VB

Public NotInheritable Class RhinoDoc

The RhinoDoc type exposes the following members.

	Name	Description
	ActiveDoc	WARNING!! Do not use the ActiveDoc if you don't have to. Under Mac Rhino the ActiveDoc can change while a command is running. Use the doc that is passed to you in your RunCommand function or continue to use the same doc after the first call to ActiveDoc.
	Bitmaps	bitmaps used in textures, backgrounds, wallpapers, ...
	CurrentUndoRecordSerialNumber	0: undo recording is active and being saved on the undo record with the specified serial number. 0: undo recording is not active. (Disabled or nothing is being recorded.)
	DateCreated
	DateLastEdited
	DimStyles
	DistanceDisplayPrecision
	DocumentId	**Obsolete. ** Gets the Document Id.
	EarthAnchorPoint
	Fonts
	Groups
	HatchPatterns
	InstanceDefinitions
	IsLocked	Check to see if the file associated with this document is locked. If it is locked then this is the only document that will be able to write the file. Other instances of Rhino will fail to write this document.
	IsReadOnly	Current read-only mode for this document. true if the document can be viewed but NOT saved. false if document can be viewed and saved.
	IsSendingMail	true if Rhino is in the process of sending this document as an email attachment.
	Layers	Layers in the document.
	Lights
	Linetypes	Linetypes in the document.
	Materials	Materials in the document.
	MeshingParameterStyle	Type of MeshingParameters currently used by the document to mesh objects
	ModelAbsoluteTolerance	Model space absolute tolerance.
	ModelAngleToleranceDegrees	Model space angle tolerance.
	ModelAngleToleranceRadians	Model space angle tolerance.
	ModelDistanceDisplayPrecision
	ModelRelativeTolerance	Model space relative tolerance.
	ModelUnitSystem
	Modified	Returns or sets the document's modified flag.
	Name	Returns the name of the currently loaded Rhino document (3DM file).
	NamedConstructionPlanes
	NamedViews
	NextUndoRecordSerialNumber	The serial number that will be assigned to the next undo record that is constructed.
	Notes	Returns or sets the document's notes.
	Objects
	PageAbsoluteTolerance	Page space absolute tolerance.
	PageAngleToleranceDegrees	Page space angle tolerance.
	PageAngleToleranceRadians	Page space angle tolerance.
	PageDistanceDisplayPrecision
	PageRelativeTolerance	Page space relative tolerance.
	PageUnitSystem
	Path	Returns the path of the currently loaded Rhino document (3DM file).
	RenderSettings
	RuntimeSerialNumber	Unique serialNumber for the document while the application is running. This is not a persistent value.
	Strings
	TemplateFileUsed	name of the template file used to create this document. This is a runtime value only present if the document was newly created.
	UndoRecordingEnabled
	UndoRecordingIsActive	true if undo recording is actually happening now.
	Views

	Name	Description
	AddCustomUndoEvent(String, EventHandler(CustomUndoEventArgs))
	AddCustomUndoEvent(String, EventHandler(CustomUndoEventArgs), Object)	Add a custom undo event so you can undo private plug-in data when the user performs an undo or redo
	AdjustModelUnitSystem
	AdjustPageUnitSystem
	BeginUndoRecord	Instructs Rhino to begin recording undo information when the document is changed outside of a command. We use this, e.g., to save changes caused by the modeless layer or object properties dialogs when commands are not running.
	ClearRedoRecords
	ClearUndoRecords(Boolean)
	ClearUndoRecords(UInt32, Boolean)
	CreateDefaultAttributes	Gets the default object attributes for this document. The attributes will be linked to the currently active layer and they will inherit the Document WireDensity setting.
	EndUndoRecord
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	ExtractPreviewImage	Extracts the bitmap preview image from the specified model (3DM).
	FindFile	Search for a file using Rhino's search path. Rhino will look in the following places: 1. Current model folder 2. Path specified in options dialog/File tab 3. Rhino system folders 4. Rhino executable folder
	FromFilePath	Search the open document list for a document with a Path equal to the specified file path.
	FromId	**Obsolete. **
	FromRuntimeSerialNumber
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetMeshingParameters	Get MeshingParameters currently used by the document
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetUnitSystemName
	Open	Opens a 3dm file and makes it the active document. If called on windows the active document will be saved and closed and the new document will be opened and become the active document. If called on the Mac the file will be opened in a new document window.
	OpenDocuments	Returns a list of currently open Rhino documents
	OpenFile	**Obsolete. **
	ReadFile
	ReadFileVersion	Returns the file version of the current document. Use this function to determine which version of Rhino last saved the document.
	SetCustomMeshingParameters	Set the custom meshing parameters that this document will use. You must also modify the MeshingParameterStyle property on the document to Custom if you want these meshing parameters to be used
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	WriteFile

	Name	Description
	ActiveDocumentChanged	This event is raised when the active document used by modeless user interface changes. On Mac Rhino this will get raised before the NewDocument, BeginOpenDocument and EndOpenDocument events. Mac Rhino will also raise this event with 0 for the document Id and a null document pointer when the last document is closed. Windows Rhino will raise this event after the NewDocument, BeginOpenDocument and EndOpenDocument events when a new or existing model is opened.
	AddRhinoObject	Called if a new object is added to the document.
	BeforeTransformObjects	Called before objects are being transformed
	BeginOpenDocument
	BeginSaveDocument
	CloseDocument
	DeleteRhinoObject	Called if an object is deleted. At some later point the object can be un-deleted.
	DeselectAllObjects	Called when all objects are deselected.
	DeselectObjects	Called when object(s) are deselected.
	DocumentPropertiesChanged
	EndOpenDocument
	EndSaveDocument
	GroupTableEvent	Called when any modification happens to a document's group table.
	InstanceDefinitionTableEvent	Called when any modification happens to a document's light table.
	LayerTableEvent	Called when any modification happens to a document's layer table.
	LightTableEvent	Called when any modification happens to a document's light table.
	MaterialTableEvent	Called when any modification happens to a document's material table.
	ModifyObjectAttributes	Called when all object attributes are changed.
	NewDocument
	PurgeRhinoObject	Called if an object is being purged from a document. The object will cease to exist forever.
	ReplaceRhinoObject	Called if an object is about to be replaced. If both RhinoDoc.UndoActive() and RhinoDoc.RedoActive() return false, then immediately after the ReplaceObject event, there will be a DeleteObject event followed by an AddObject event. If either RhinoDoc.UndoActive() or RhinoDoc::RedoActive() return true, then immediately after the ReplaceObject event, there will be a DeleteObject event followed by an UndeleteObject event.
	SelectObjects	Called when object(s) are selected.
	TextureMappingEvent	Called when any modification happens to a document objects texture mapping.
	UndeleteRhinoObject	Called if an object is un-deleted.

Supported in: 5D58w

Rhino Namespace