DisplayModeDescription

References
[Serializable] public class DisplayModeDescription : IDisposable, ISerializable
Description 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

AllowObjectAssignment

#Since v5.0
public bool AllowObjectAssignment { get; set; }

AmbientOcclusionId

#Since v6.0
public static Guid AmbientOcclusionId { get; }

ArtisticId

#Since v6.26
public static Guid ArtisticId { get; }

DisplayAttributes

#ExampleSince v5.0
public DisplayPipelineAttributes DisplayAttributes { get; }

EnglishName

#Since v5.0
public string EnglishName { get; set; }

GhostedId

#Since v6.0
public static Guid GhostedId { get; }

Id

#Since v5.0
public Guid Id { get; }

InMenu

#Since v5.0
public bool InMenu { get; set; }

LocalName

#Since v5.0
public string LocalName { get; }

MonochromeId

#Since v8.14
public static Guid MonochromeId { get; }

PenId

#Since v6.0
public static Guid PenId { get; }

PipelineLocked

#Since v5.0
public bool PipelineLocked { get; set; }

RaytracedId

#Since v6.0
public static Guid RaytracedId { get; }

RenderedId

#Since v6.0
public static Guid RenderedId { get; }

RenderedShadowsId

#Since v6.0
public static Guid RenderedShadowsId { get; }

ShadedId

#Since v6.0
public static Guid ShadedId { get; }

ShadedPipelineRequired

#Since v5.0
public bool ShadedPipelineRequired { get; set; }

SupportsShadeCommand

#Since v5.0
public bool SupportsShadeCommand { get; set; }

SupportsShading

#Since v5.0
public bool SupportsShading { get; set; }

TechId

#Since v6.0
public static Guid TechId { get; }

WireframeId

#Since v6.0
public static Guid WireframeId { get; }

WireframePipelineRequired

#Since v5.0
public bool WireframePipelineRequired { get; set; }

XRayId

#Since v6.0
public static Guid XRayId { get; }

Methods

AddDisplayMode

#Since v5.0
public static Guid AddDisplayMode(DisplayModeDescription displayMode)
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.
Parameters:
displayMode (DisplayModeDescription)The display mode description to add.
Returns: The id of the new display mode if successful. Guid.Empty on error.

AddDisplayMode

#Since v6.7
public static Guid AddDisplayMode(string name)
Adds a new display mode. Note that this only registers the mode in memory; call UpdateDisplayMode to persist it to disk.
Parameters:
name (string)The name of the new display mode.
Returns: The id of the new display mode if successful. Guid.Empty on error.

CopyDisplayMode

#Since v6.7
public static Guid CopyDisplayMode(Guid id, string name)
Copies an existing display mode. Note that this only registers the new mode in memory; call UpdateDisplayMode to persist it to disk.
Parameters:
id (Guid)The id of the existing display mode to copy.
name (string)The name of the new display mode.
Returns: The id of the new display mode if successful. Guid.Empty on error.

DeleteDiplayMode

#Since v5.0 Obsolete v7.0
public static bool DeleteDiplayMode(Guid id)
obsoleteUse DisplayModeDescription.DeleteDisplayMode
Deletes an existing display mode.
Parameters:
id (Guid)The id of the existing display mode to delete.
Returns: true if successful, false otherwise.

DeleteDisplayMode

#Since v7.0
public static bool DeleteDisplayMode(Guid id)
Deletes an existing display mode.
Parameters:
id (Guid)The id of the existing display mode to delete.
Returns: true if successful, false otherwise.

Dispose

#Since v5.0
public void Dispose()

Dispose

#
protected virtual void Dispose(bool disposing)
Parameters:
disposing (bool)

ExportToFile

#Since v6.0
public static bool ExportToFile(DisplayModeDescription displayMode, string filename)
Exports a DisplayModeDescription to a Windows-style .ini file.
Parameters:
displayMode (DisplayModeDescription)The DisplayModeDescription to export.
filename (string)The name of the file to create.

FindByName

#Since v5.0
public static DisplayModeDescription FindByName(string englishName)
Finds a display mode description by its English name.
Parameters:
englishName (string)The English name of the display mode.
Returns: The display mode description if found, null otherwise.

GetDisplayMode

#Since v5.0
public static DisplayModeDescription GetDisplayMode(Guid id)
Gets a display mode description by id.
Parameters:
id (Guid)The id of the display mode.
Returns: The display mode description if found, null otherwise.

GetDisplayModes

#ExampleSince v5.0
public static DisplayModeDescription[] GetDisplayModes()
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.

ImportFromFile

#Since v8.27
public static Guid ImportFromFile(string filename, bool interactive)
Imports a DisplayModeDescription from a Windows-style .ini file.
Parameters:
filename (string)The name of the file to import.
interactive (bool)True to show user interface messages, false to suppress any user interface messages.
Returns: The id of the DisplayModeDescription if successful.

ImportFromFile

#Since v6.0
public static Guid ImportFromFile(string filename)
Imports a DisplayModeDescription from a Windows-style .ini file.
Parameters:
filename (string)The name of the file to import.
Returns: The id of the DisplayModeDescription if successful.

SaveDisplayModes

#Since v9.0
public static void SaveDisplayModes()
Saves all display modes to disk.
Explicit

ISerializable.GetObjectData

#
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)] void ISerializable.GetObjectData(SerializationInfo info, StreamingContext context)
Parameters:
info (SerializationInfo)
context (StreamingContext)

UpdateDisplayMode

#Since v9.0
public static bool UpdateDisplayMode(DisplayModeDescription displayMode, bool bSave)
Updates an existing display mode.
Parameters:
displayMode (DisplayModeDescription)The display mode description to update.
bSave (bool)True to save the display mode to disk, false otherwise.
Returns: true if successful, false otherwise.

UpdateDisplayMode

#ExampleSince v5.0
public static bool UpdateDisplayMode(DisplayModeDescription displayMode)
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.
Parameters:
displayMode (DisplayModeDescription)The display mode description to update.
Returns: true if successful, false otherwise.