DocumentDisplay

References
[IoId("00000000-98e8-4b08-b568-6884877317f6")] public sealed class DocumentDisplay : IStorable

Constructors

DocumentDisplay

#
public DocumentDisplay(Document doc)
Parameters:
doc (Document)

Fields

ThrottlingFast

#
public static readonly TimeSpan ThrottlingFast

ThrottlingMild

#
public static readonly TimeSpan ThrottlingMild

ThrottlingNone

#
public static readonly TimeSpan ThrottlingNone

ThrottlingSlow

#
public static readonly TimeSpan ThrottlingSlow

Properties

CurrentRuleSet

#
public DisplayRules CurrentRuleSet { get; }
Gets the currently active display rules. Note that these are the fully expanded rules, not the original rules. That is, all cite instructions have been resolved with their appropriate external rules.

CurrentRuleSetName

#
public string CurrentRuleSetName { get; set; }
Gets or sets the name of the current display rule set to use. If a non-existing name is specified, no rule set will be active.

Document

#
public Document Document { get; }
Gets the document this display object is associated with.

DocumentRuleNames

#
public IEnumerable<string> DocumentRuleNames { get; }
Enumerate over all display rule names in the document.

DrawMeshes

#
public bool DrawMeshes { get; set; }
Gets or sets whether the document preview should include meshes.

DrawWires

#
public bool DrawWires { get; set; }
Gets or sets whether the document preview should include wires.

Enabled

#
public bool Enabled { get; set; }
Gets or sets whether the preview ought to be draw at all.

Guises

#
public Guises Guises { get; set; }
Gets or sets the guises to use for drawing the preview geometry of this document.

OnlySelected

#
public bool OnlySelected { get; set; }
Gets or sets whether the document preview is limited to the selected objects. Selected objects are then drawn regardless of their own display state, and with the standard rather than the selected guise.

StandardRuleNames

#
public IEnumerable<string> StandardRuleNames { get; }
Enumerate over all standard display rule names.

Throttling

#
public TimeSpan Throttling { get; set; }
Gets or sets the timespan after which the preview cuts off in dynamic mode.

Methods

FindRuleSet

#
public DisplayRules FindRuleSet(string name)
Find a given named ruleset.
Parameters:
name (string)

ModifyRules

#
public void ModifyRules(string name, DisplayRules rules)
Try and update a named ruleset. If the name isn't known yet, a new rule set will be added. If the provided rules are null, any existing ruleset with the specified name will be removed.
Parameters:
name (string)
rules (DisplayRules)

RenameRules

#
public void RenameRules(string oldName, string newName)
Rename a ruleset.
Parameters:
oldName (string)
newName (string)

Restore

#
public void Restore(IReader reader)
Parameters:
reader (IReader)

Store

#
public void Store(IWriter writer)
Parameters:
writer (IWriter)
Implements: Store

UniqueName

#
public string UniqueName(string name)
Create a unique name based on the given one.
Parameters:
name (string)

UpdateDisplay

#
public void UpdateDisplay()
Redraw the Rhino viewports.