RhinoCommon API
PlugIn Class |
[Missing <summary> documentation for "T:Rhino.PlugIns.PlugIn"]

SystemObject
Rhino.PlugInsPlugIn
Rhino.PlugInsDigitizerPlugIn
Rhino.PlugInsFileExportPlugIn
Rhino.PlugInsFileImportPlugIn
Rhino.PlugInsRenderPlugIn
Rhino.PlugInsPlugIn
Rhino.PlugInsDigitizerPlugIn
Rhino.PlugInsFileExportPlugIn
Rhino.PlugInsFileImportPlugIn
Rhino.PlugInsRenderPlugIn
Namespace: Rhino.PlugIns
Assembly: RhinoCommon (in RhinoCommon.dll)

The PlugIn type exposes the following members.


Name | Description | |
---|---|---|
![]() ![]() | AskOnLoadProtection |
If true, Rhino will display a warning dialog when load-protected plug-ins are attempting to load.
If false, load-protected plug-ins will silently not load.
|
![]() | Assembly | Source assembly for this plug-in. |
![]() | Description |
Returns the description of the plug-in, as found in the plug-in's assembly attributes.
|
![]() | Id |
Returns the Guid, or unique Id, of the plug-in.
|
![]() ![]() | InstalledPlugInCount |
Returns the number of installed Rhino plug-ins.
|
![]() | LicenseId | |
![]() | LoadAtStartup | Obsolete. |
![]() | LoadTime |
Plug-ins are typically loaded on demand when they are first needed. You can change
this behavior to load the plug-in at during different stages in time by overriding
this property.
|
![]() | Name |
Returns the name of the plug-in, as found in the plug-in's assembly attributes.
|
![]() | Settings |
Persistent plug-in settings.
|
![]() | SettingsDirectory | |
![]() | SettingsDirectoryAllUsers | |
![]() | Version |
Returns the version of the plug-in, as found in the plug-in's assembly attributes.
|
![]() | WindowPositionSettings |

Name | Description | |
---|---|---|
![]() | AskUserForLicense(LicenseBuildType, Boolean, String, Object, ValidateProductKeyDelegate) | |
![]() | AskUserForLicense(LicenseBuildType, Boolean, String, Object, ValidateProductKeyDelegate, OnLeaseChangedDelegate) | |
![]() | CommandSettings | |
![]() | CreateCommands |
Called right after plug-in is created and is responsible for creating
all of the commands in a given plug-in. The base class implementation
Constructs an instance of every publicly exported command class in your
plug-in's assembly.
|
![]() | DocumentPropertiesDialogPages |
Override this function if you want to extend the document properties sections
of the options dialog. This function is called whenever the user brings up the
Options dialog.
|
![]() | Equals | (Inherited from Object.) |
![]() | Finalize | (Inherited from Object.) |
![]() ![]() | Find(Guid) |
Finds the plug-in instance that was loaded from a given plug-in Id.
|
![]() ![]() | Find(Assembly) |
Finds the plug-in instance that was loaded from a given assembly.
|
![]() ![]() | FlushSettingsSavedQueue | |
![]() | GetCommands |
All of the commands associated with this plug-in.
|
![]() ![]() | GetEnglishCommandNames |
Gets names of all "non-test" commands for a given plug-in.
|
![]() | GetHashCode | (Inherited from Object.) |
![]() ![]() | GetInstalledPlugInFolders | |
![]() ![]() | GetInstalledPlugInNames |
Returns the names of all installed Rhino plug-ins.
|
![]() ![]() | GetInstalledPlugInNames(PlugInType, Boolean, Boolean) |
Gets a list of installed plug-in names. The list can be restricted by some filters.
|
![]() ![]() | GetInstalledPlugIns | |
![]() | GetLicense(LicenseBuildType, ValidateProductKeyDelegate) |
Verifies that there is a valid product license for your plug-in, using
the Rhino licensing system. If the plug-in is installed as a standalone
node, the locally installed license will be validated. If the plug-in
is installed as a network node, a loaner license will be requested by
the system's assigned Zoo server. If the Zoo server finds and returns
a license, then this license will be validated. If no license is found,
then the user will be prompted to provide a license key, which will be
validated.
|
![]() | GetLicense(LicenseBuildType, ValidateProductKeyDelegate, OnLeaseChangedDelegate) |
Verifies that there is a valid product license for your plug-in, using
the Rhino licensing system. If the plug-in is installed as a standalone
node, the locally installed license will be validated. If the plug-in
is installed as a network node, a loaner license will be requested by
the system's assigned Zoo server. If the Zoo server finds and returns
a license, then this license will be validated. If no license is found,
then the user will be prompted to provide a license key, which will be
validated.
|
![]() | GetLicense(LicenseCapabilities, String, ValidateProductKeyDelegate) |
Verifies that there is a valid product license for your plug-in, using
the Rhino licensing system. If the plug-in is installed as a standalone
node, the locally installed license will be validated. If the plug-in
is installed as a network node, a loaner license will be requested by
the system's assigned Zoo server. If the Zoo server finds and returns
a license, then this license will be validated. If no license is found,
then the user will be prompted to provide a license key, which will be
validated.
|
![]() | GetLicense(LicenseCapabilities, String, ValidateProductKeyDelegate, OnLeaseChangedDelegate) |
Verifies that there is a valid product license for your plug-in, using
the Rhino licensing system. If the plug-in is installed as a standalone
node, the locally installed license will be validated. If the plug-in
is installed as a network node, a loaner license will be requested by
the system's assigned Zoo server. If the Zoo server finds and returns
a license, then this license will be validated. If no license is found,
then the user will be prompted to provide a license key, which will be
validated.
|
![]() | GetLicenseOwner |
Get the customer name and organization used when entering the product
license.
|
![]() ![]() | GetLoadProtection |
Get load protection state for a plug-in
|
![]() ![]() | GetPlugInInfo |
Returns detailed information about an installed Rhino plug-in.
|
![]() | GetPlugInObject | |
![]() ![]() | GetPluginSettings | |
![]() | GetType | (Inherited from Object.) |
![]() | Icon |
Returns the plug-in's icon in bitmap form.
|
![]() ![]() | IdFromName |
Gets the id of an installed plug-in giving the plug-in's name.
|
![]() ![]() | IdFromPath |
Gets the id of an installed plug-in giving the plug-in's file path.
|
![]() ![]() | LoadPlugIn(Guid) |
Loads an installed plug-in.
|
![]() ![]() | LoadPlugIn(String, Guid) |
Attempt to load a plug-in at a path. Loaded plug-ins are remembered by
Rhino between sessions, so this function can also be considered a plug-in
installation routine
|
![]() ![]() | LoadPlugIn(Guid, Boolean, Boolean) |
Loads an installed plug-in.
|
![]() | MemberwiseClone | (Inherited from Object.) |
![]() ![]() | NameFromPath |
Gets a plug-in name for an installed plug-in given the path to that plug-in.
|
![]() | ObjectPropertiesPages |
Override this function is you want to extend the object properties dialog
|
![]() | OnLoad |
Is called when the plug-in is being loaded.
|
![]() | OnShutdown | |
![]() | OptionsDialogPages |
Override this function if you want to extend the options dialog. This function is
called whenever the user brings up the Options dialog.
|
![]() ![]() | PathFromId |
Gets the path to an installed plug-in given the id of that plug-in
|
![]() ![]() | PathFromName |
Gets the path to an installed plug-in given the name of that plug-in
|
![]() ![]() | PlugInExists |
Verifies that a Rhino plug-in is installed.
|
![]() ![]() | RaiseOnPlugInSettingsSavedEvent |
Raise any pending OnPlugInSettingsSaved events, the events are normally
queued while a command is running and and fired while Rhino is in an
idle state. Calling this method will raise any pending changed events
regardless of Rhino's current idle state or if a command is running.
|
![]() | ReadDocument |
Called whenever a Rhino document is being loaded and plug-in user data was
encountered written by a plug-in with this plug-in's GUID.
|
![]() | RegisterCommand | |
![]() | ResetMessageBoxes | |
![]() | ReturnLicense |
Returns, or releases, a product license that was obtained from the Rhino
licensing system. Note, most plug-ins do not need to call this as the
Rhino licensing system will return all licenses when Rhino shuts down.
|
![]() ![]() | SavePluginSettings | |
![]() | SaveSettings |
Write settings to disk which will raise a SettingsSaved
event.
|
![]() | SetLicenseCapabilities | |
![]() ![]() | SetLoadProtection |
Set load protection state for a certain plug-in
|
![]() | ShouldCallWriteDocument |
Called whenever a Rhino is about to save a .3dm file.
If you want to save plug-in document data when a model is
saved in a version 5 .3dm file, then you must override this
function to return true and you must override WriteDocument().
|
![]() | ToString | (Inherited from Object.) |
![]() | WriteDocument |
Called when Rhino is saving a .3dm file to allow the plug-in
to save document user data.
|

Name | Description | |
---|---|---|
![]() | SettingsSaved |
This event is raised when an instance of Rhino has modified the
external settings file associated with this plug-in's Settings
property.
|

Rhino for Mac
Supported in: 5.4Rhino for Windows
Supported in: 6.8