DisplayModeDescription

References
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
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.
public static Guid AddDisplayMode(
displayMode
The display mode description to add.
)
The id of the new display mode if successful. Guid.Empty on error.

AddDisplayMode

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

CopyDisplayMode

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

DeleteDiplayMode

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

DeleteDisplayMode

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

Dispose

#Since v5.0
public void Dispose()

Dispose

#
protected virtual void Dispose(
disposing
)

ExportToFile

#Since v6.0
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.
)

FindByName

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

GetDisplayMode

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

GetDisplayModes

#ExampleSince v5.0
Gets all display mode descriptions that Rhino currently knows about.
public static DisplayModeDescription[] GetDisplayModes()
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
Imports a DisplayModeDescription from a Windows-style .ini file.
public static Guid ImportFromFile(
filename,
The name of the file to import.
interactive
True to show user interface messages, false to suppress any user interface messages.
)
The id of the DisplayModeDescription if successful.

ImportFromFile

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

SaveDisplayModes

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

ISerializable.GetObjectData

#
[SecurityPermission(SecurityAction.LinkDemand, Flags = SecurityPermissionFlag.SerializationFormatter)] void ISerializable.GetObjectData()

UpdateDisplayMode

#Since v9.0
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.
)
true if successful, false otherwise.

UpdateDisplayMode

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