Constructors
PlugIn
#protected PlugIn()
Properties
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.
Returns the description of the plug-in, as found in the plug-in's assembly attributes.
Returns the number of installed Rhino plug-ins.
obsoleteUse LoadTime virtual property instead
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.
Returns the name of the plug-in, as found in the plug-in's assembly attributes.
Get the plug-in's settings directory. This is the directory where the plug-in's persistent settings files are saved. This directory will be located in the user's profile folder. Note, this does not verify the directory exists.
Get the plug-in's "all users" settings directory. This directory will be located in the system's program data folder. Note, this does not verify the directory exists.
Returns the version of the plug-in, as found in the plug-in's assembly attributes.
Methods
AskUserForLicense
#protected bool AskUserForLicense()
productBuildType,
standAlone,
textMask,
parentWindow,
validateProductKeyDelegate,
onLeaseChangedDelegate
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.
protected virtual void CreateCommands()
Called by Rhino if AddToHelpMenu is true and menu item associated with this plug-in is selected.
public virtual bool DisplayHelp()
nint
windowHandle
Native Window handle of the active Rhino interface.
Returns: true = Help displayed successfully, false = Error displaying help
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.
protected virtual void DocumentPropertiesDialogPages()
doc,
document that the pages are set up for
pages
list of pages to add your custom options dialog page(s) to.
Finds the plug-in instance that was loaded from a given assembly.
public static PlugIn Find()
pluginAssembly
The plug-in assembly.
You can get the assembly instance at runtime with the Type.Assembly instance property.
Returns: The assembly plug-in instance if successful. Otherwise, null.
Finds the plug-in instance that was loaded from a given plug-in Id.
Returns: The plug-in instance if successful. Otherwise, null.
public static void FlushSettingsSavedQueue()
All of the commands associated with this plug-in.
Gets names of all "non-test" commands for a given plug-in.
Returns: An array with all plug-in names. This can be empty, but not null.
Returns the names of all installed Rhino plug-ins.
Returns: The names if successful.
Gets a list of installed plug-in names. The list can be restricted by some filters.
public static string[] GetInstalledPlugInNames()
typeFilter,
The enumeration flags that determine which types of plug-ins are included.
loaded,
true if loaded plug-ins are returned.
unloaded,
true if unloaded plug-ins are returned.
localizedPlugInName
If true localized plug-in names are returned otherwise; English names are returned.
Returns: An array of installed plug-in names. This can be empty, but not null.
Gets a list of installed plug-in names. The list can be restricted by some filters.
public static string[] GetInstalledPlugInNames()
typeFilter,
The enumeration flags that determine which types of plug-ins are included.
loaded,
true if loaded plug-ins are returned.
unloaded
true if unloaded plug-ins are returned.
Returns: An array of installed plug-in names. This can be empty, but not null.
Get a list of all registered plug-in's regardless of if they are loaded or not.
Returns: Dictionary with plug-in ID as key and localized plug-in name as value
Get a list of all registered plug-in's regardless of if they are loaded or not.
public static Dictionary<Guid, string> GetInstalledPlugIns()
localizedPlugInName
If true then the localize plug-in name is returned otherwise; the English name is used.
Returns: Dictionary with plug-in ID as key and plug-in name as value
GetLicense
#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.
protected bool GetLicense()
productBuildType,
The product build contentType required by your plug-in.
validateProductKeyDelegate,
Since the Rhino licensing system knows nothing about your product license, you will need to validate the product license provided by the Rhino licensing system. This is done by supplying a callback function, or delegate, that can be called to perform the validation.
leaseChangedDelegate
Called by the ZooClient when the cloud zoo lease is changed.
Returns: true if a valid license was found. false otherwise.
GetLicense
#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.
protected bool GetLicense()
licenseCapabilities,
In the event that a license was not found, or if the user wants to change the way your plug-in is licenses, then provide what capabilities your license has by using this enumeration flag.
textMask,
In the event that the user needs to be asked for a license, then you can provide a text mask, which helps the user to distinguish between proper and improper user input of your license code. Note, if you do not want to use a text mask, then pass in a null value for this parameter. For more information on text masks, search MSDN for the System.Windows.Forms.MaskedTextBox class.
validateProductKeyDelegate,
Since the Rhino licensing system knows nothing about your product license, you will need to validate the product license provided by the Rhino licensing system. This is done by supplying a callback function, or delegate, that can be called to perform the validation.
leaseChangedDelegate
Called by the ZooClient when the cloud zoo lease is changed.
Returns: true if a valid license was found. false otherwise.
Get the customer name and organization used when entering the product license.
Get load protection state for a plug-in
Returns detailed information about an installed Rhino plug-in.
Returns: Detailed information about an installed Rhino plug-in if successful, null otherwise.
Returns the plug-in's icon in bitmap form.
Returns: The icon if successful, null otherwise.
Attempt to get a plugiin id from just the filename of a plug-in
Returns: id on success; Guid.Empty if no plug-in could be found
Gets the id of an installed plug-in giving the plug-in's name.
Returns: The id if successful.
Gets the id of an installed plug-in giving the plug-in's file path.
Returns: The id if successful.
Returns true if this renderer can render the texture natively without needing it to be baked into a bitmap, false otherwise. By default, returns false for all textures.
Used by compute's startup code to load plug-ins that have registered custom endpoints
public static void LoadComputeExtensionPlugins()
Loads an installed plug-in.
Returns: true if successful, false otherwise.
Loads an installed plug-in.
Returns: true if successful, false otherwise.
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
public static LoadPlugInResult LoadPlugIn()
path,
full path to plug-in to attempt to load
out Guid
plugInId
If successful (or the plug-in is already loaded), the unique id for the plug-in is returned here. Guid.Empty on failure
Gets a plug-in name for an installed plug-in given the path to that plug-in.
Returns: The plug-in name.
ObjectPropertiesPages
#Override this function is you want to extend the object properties dialog
obsoleteUse ObjectPropertiesPages(ObjectPropertiesPageCollection collection) instead
ObjectPropertiesPages
#Override this function is you want to extend the object properties dialog. This method will be called each time a new document is created for each instance of a object properties panel. On Windows there will be a single panel per document but on Mac there may be many properties panel per document.
protected virtual void ObjectPropertiesPages()
OnLoad
#Is called when the plug-in is being loaded.
protected virtual LoadReturnCode OnLoad()
ref string
errorMessage
If a load error is returned and this string is set. This string is the error message that will be reported back to the user.
Returns: An appropriate load return code.
The default implementation returns LoadReturnCode.Success.
OnShutdown
#protected virtual void 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.
protected virtual void OptionsDialogPages()
Gets the path to an installed plug-in given the id of that plug-in
Gets the path to an installed plug-in given the name of that plug-in
Verifies that a Rhino plug-in is installed.
Returns: Returns true if the plug-in exists, or is installed.
Raise any pending OnPlugInSettingsSaved events, the events are normally queued while a command is running 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.
public static void RaiseOnPlugInSettingsSavedEvent()
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.
protected virtual void ReadDocument()
doc,
A Rhino document that is being loaded.
archive,
OpenNURBS file archive object Rhino is using to read this file. Use BinaryArchiveReader.Read*() functions to read plug-in data. If any BinaryArchive.Read*() functions throws an exception then archive.ReadErrorOccurve will be true and you should immediately return.
options
Describes what is being written.
ResetMessageBoxes
#protected virtual void ResetMessageBoxes()
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.
Write settings to disk which will raise a SettingsSaved event.
public void SaveSettings()
SetLicenseCapabilities
#protected void SetLicenseCapabilities()
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().
protected virtual bool ShouldCallWriteDocument()
options
The file write options, such as "include preview image" and "include render meshes".
Returns: true if the plug-in wants to save document user data in the version 5 .3dm file. The default returns false.
WriteDocument
#Called when Rhino is saving a .3dm file to allow the plug-in to save document user data.
protected virtual void WriteDocument()
doc,
The Rhino document instance that is being saved.
archive,
OpenNURBS file archive object Rhino is using to write the file. Use BinaryArchiveWriter.Write*() functions to write plug-in data. OR use the ArchivableDictionary If any BinaryArchiveWriter.Write*() functions throw an exception, then archive.WriteErrorOccured will be true and you should immediately return. Setting archive.WriteErrorOccured to true will cause Rhino to stop saving the file.
options
The file write options, such as "include preview image" and "include render meshes".
Events
This event is raised when an instance of Rhino has modified the external settings file associated with this plug-in's Settings property.
See Also: SaveSettings()
This event is raised when a 3dm file is loaded with unknown user data, and the plug-in to handle it could not be loaded.