Skin

References

public abstract class Skin

Represents a customized environment that changes the appearance of Rhino.

Skin DLLs must contain a single class that derives from the Skin class.

Constructors

Skin

protected Skin()

Initializes a new instance of the Skin class.

Properties

ActiveSkin

#Since v5.0

public static Skin ActiveSkin { get; }

Any time Rhino is running there is at most one skin being used (and possibly no skin). If a RhinoCommon based Skin class is being used, use ActiveSkin to get at the instance of this Skin class. May return null if no Skin is being used or if the skin is not a RhinoCommon based skin.

ApplicationName

protected virtual string ApplicationName { get; }

If you want to provide a custom name for your skin.

HasBootSplash

#Since v9.0

protected static bool HasBootSplash { get; }

True when the platform's native boot splash is compiled in and shown at startup.

MainRhinoIcon

protected virtual Bitmap MainRhinoIcon { get; }

If you want to provide a custom icon for your skin.

Settings

#Since v5.0

public PersistentSettings Settings { get; }

Gets access to the skin persistent settings.

SettingsDirectory

#Since v9.0

public string SettingsDirectory { get; }

Get the skin's settings directory. This is the directory where the skin's persistent settings files are saved, matching the location used by Settings. Note, this does not verify the directory exists.

Methods

DismissBootSplash

#Since v9.0

protected static void DismissBootSplash()

Tells the platform's boot splash to dismiss, if one is up. Call this from a Skin subclass once its own window is on screen. No-op on platforms that have no boot splash.

HideSplash

protected virtual void HideSplash()

Is called when the splash screen should be hidden.

OnBeginLoadAtStartPlugIns

protected virtual void OnBeginLoadAtStartPlugIns(int expectedCount)

Is called when the first plug-in that loads at start-up is going to be loaded.

Parameters:

expectedCount (int)

The complete amount of plug-ins.

OnBeginLoadPlugIn

protected virtual void OnBeginLoadPlugIn(string description)

Is called when a specific plug-in is going to be loaded.

Parameters:

description (string)

The plug-in description.

OnBuiltInCommandsRegistered

protected virtual void OnBuiltInCommandsRegistered()

Is called when built-in commands are registered.

OnEndLoadAtStartPlugIns

protected virtual void OnEndLoadAtStartPlugIns()

Is called after all of the load at start plug-ins have been loaded.

OnEndLoadPlugIn

protected virtual void OnEndLoadPlugIn()

Is called after each plug-in has been loaded.

OnLicenseCheckCompleted

protected virtual void OnLicenseCheckCompleted()

Is called when the license check is completed.

OnMainFrameWindowCreated

protected virtual void OnMainFrameWindowCreated()

Is called when the main frame window is created.

OpenNewDocument

#Since v9.0

protected static RhinoDoc OpenNewDocument(string templatePath)

Creates a new RhinoDoc from the given template (or a blank document when the path is null/empty/missing) and brings up its document window. Must be called on the main UI thread.

Parameters:

templatePath (string)

Path to a template file, or null/empty for a blank document.

Returns: The new RhinoDoc, or null on failure.

SetBootSplashProgress

#Since v9.0

protected static void SetBootSplashProgress(int value)

Pushes a progress value to the platform's boot splash so it can paint a progress bar. The value is treated as a percentage and clamped to 0..100 on the native side. No-op on platforms that have no boot splash, and harmless if the splash is already gone.

Parameters:

value (int)

Progress percentage in the range 0..100.

ShowChooseRecent

#Since v9.0

protected virtual void ShowChooseRecent()

Called when the host requests the Skin's "choose recent" UI. Default implementation is empty.

ShowChooseTemplate

#Since v9.0

protected virtual void ShowChooseTemplate()

Called when the host requests the Skin's "choose template" UI (e.g. from the File > New Using Template menu item). Default implementation is empty.

ShowHelp

protected virtual void ShowHelp()

Called when the "help" splash screen should be shown. Default implementation just calls ShowSplash()

ShowSplash

protected virtual void ShowSplash()

Is called when the splash screen should be shown.