DisplayModeDescription
ReferencesDescription of a how Rhino will display in a viewport. These are the modes that are listed under "Advanced display" in the options dialog.
Finalizer
~DisplayModeDescription
#~DisplayModeDescription()
Properties
Methods
Adds a new display mode from an existing description. Note that this only registers the mode in memory; call UpdateDisplayMode to persist it to disk.
Returns: The id of the new display mode if successful. Guid.Empty on error.
Adds a new display mode. Note that this only registers the mode in memory; call UpdateDisplayMode to persist it to disk.
Returns: The id of the new display mode if successful. Guid.Empty on error.
Copies an existing display mode. Note that this only registers the new mode in memory; call UpdateDisplayMode to persist it to disk.
Returns: The id of the new display mode if successful. Guid.Empty on error.
Deletes an existing display mode.
obsoleteUse DisplayModeDescription.DeleteDisplayMode
Returns: true if successful, false otherwise.
Deletes an existing display mode.
Returns: true if successful, false otherwise.
public void Dispose()
Exports a DisplayModeDescription to a Windows-style .ini file.
public static bool ExportToFile()
displayMode,
The DisplayModeDescription to export.
filename
The name of the file to create.
Finds a display mode description by its English name.
Returns: The display mode description if found, null otherwise.
Gets a display mode description by id.
Returns: The display mode description if found, null otherwise.
Gets all display mode descriptions that Rhino currently knows about.
Returns: Copies of all of the display mode descriptions. If you want to modify these descriptions, you must call UpdateDisplayMode or AddDisplayMode.
Imports a DisplayModeDescription from a Windows-style .ini file.
Returns: The id of the DisplayModeDescription if successful.
Imports a DisplayModeDescription from a Windows-style .ini file.
Returns: The id of the DisplayModeDescription if successful.
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)]
void ISerializable.GetObjectData()
Updates an existing display mode.
public static bool UpdateDisplayMode()
displayMode,
The display mode description to update.
bSave
True to save the display mode to disk, false otherwise.
Returns: true if successful, false otherwise.
Updates an existing display mode and immediately saves it to disk. Call this after AddDisplayMode/CopyDisplayMode or changing DisplayAttributes to persist the change; otherwise an unrelated settings save elsewhere in Rhino can reload the display mode list from disk and silently discard the unsaved mode.
Returns: true if successful, false otherwise.