FileImportPlugIn

PlugIn
public abstract class FileImportPlugIn : PlugIn
Rhino plug-in that imports data from other file formats into Rhino; can support more that one format.

Constructors

FileImportPlugIn

#
protected FileImportPlugIn()

Properties

AddToHelpMenu

Called by Rhino to determine if the plug-in name should be added to the Rhino Help/Plug-ins menu.
public virtual bool AddToHelpMenu { get; }
inherited fromPlugIn

Assembly

Source assembly for this plug-in.
public Assembly Assembly { get; }
inherited fromPlugIn

Description

Returns the description of the plug-in, as found in the plug-in's assembly attributes.
public string Description { get; }
inherited fromPlugIn

Id

Returns the Guid, or unique Id, of the plug-in.
public Guid Id { get; }
inherited fromPlugIn

LicenseId

public Guid LicenseId { get; }
inherited fromPlugIn

LoadAtStartup

public virtual bool LoadAtStartup { get; }
obsoleteUse LoadTime virtual property instead
inherited fromPlugIn

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.
public virtual PlugInLoadTime LoadTime { get; }
inherited fromPlugIn

LocalPlugInName

Optionally override this to provide a localized plug-in name
protected virtual string LocalPlugInName { get; }
inherited fromPlugIn

Name

Returns the name of the plug-in, as found in the plug-in's assembly attributes.
public string Name { get; }
inherited fromPlugIn

Settings

Persistent plug-in settings.
public PersistentSettings Settings { get; }
inherited fromPlugIn

SettingsDirectory

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.
public string SettingsDirectory { get; }
inherited fromPlugIn

SettingsDirectoryAllUsers

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.
public string SettingsDirectoryAllUsers { get; }
inherited fromPlugIn

Version

Returns the version of the plug-in, as found in the plug-in's assembly attributes.
public string Version { get; }
inherited fromPlugIn

WindowPositionSettings

public PersistentSettings WindowPositionSettings { get; }
inherited fromPlugIn

Methods

AddFileTypes

#
protected abstract FileTypeList AddFileTypes()

AskUserForLicense

protected bool AskUserForLicense(
productBuildType,
standAlone,
textMask,
parentWindow,
validateProductKeyDelegate,
onLeaseChangedDelegate
)
inherited fromPlugIn

CommandSettings

public PersistentSettings CommandSettings(
name
)
inherited fromPlugIn

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()
inherited fromPlugIn

DisplayHelp

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.
)
inherited fromPlugIn
true = Help displayed successfully, false = Error displaying help

DisplayOptionsDialog

#
protected virtual void DisplayOptionsDialog(
nint
parent,
description,
extension
)

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.
)
inherited fromPlugIn

GetCommands

All of the commands associated with this plug-in.
public Command[] GetCommands()
inherited fromPlugIn

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.
)
inherited fromPlugIn
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.
)
inherited fromPlugIn
true if a valid license was found. false otherwise.

GetLicenseOwner

Get the customer name and organization used when entering the product license.
protected bool GetLicenseOwner(
out string
registeredOwner,
out string
registeredOrganization
)
inherited fromPlugIn

GetPlugInObject

public virtual object GetPlugInObject()
inherited fromPlugIn

Icon

Returns the plug-in's icon in bitmap form.
public Bitmap Icon(
size
The desired size in pixels.
)
inherited fromPlugIn
The icon if successful, null otherwise.

IsTextureSupported

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.
public virtual bool IsTextureSupported()
inherited fromPlugIn

MakeReferenceTableName

#
protected string MakeReferenceTableName(
doc,
nameToPrefix
)

MakeReferenceTableName

#
protected string MakeReferenceTableName(
nameToPrefix
)
obsoleteUse MakeReferenceTableName(RhinoDoc doc, string nameToPrefix) instead. This method will use the active document which will be a poor choice on the Mac

ObjectPropertiesPages

Override this function is you want to extend the object properties dialog
protected virtual void ObjectPropertiesPages()
obsoleteUse ObjectPropertiesPages(ObjectPropertiesPageCollection collection) instead
inherited fromPlugIn

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(
collection
Add custom pages by calling collection.Add
)
inherited fromPlugIn

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.
)
inherited fromPlugIn
An appropriate load return code.

The default implementation returns LoadReturnCode.Success.

OnShutdown

protected virtual void OnShutdown()
inherited fromPlugIn

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(
pages
list of pages to add your custom options dialog page(s) to.
)
inherited fromPlugIn

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.
)
inherited fromPlugIn

ReadFile

#
protected abstract bool ReadFile(
filename,
index,
doc,
options
)

RegisterCommand

protected bool RegisterCommand(
command
)
inherited fromPlugIn

ResetMessageBoxes

protected virtual void ResetMessageBoxes()
inherited fromPlugIn

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.
protected bool ReturnLicense()
inherited fromPlugIn

SaveSettings

Write settings to disk which will raise a PlugIn.SettingsSaved event.
public void SaveSettings()
inherited fromPlugIn

SetLicenseCapabilities

protected void SetLicenseCapabilities(
textMask,
capabilities,
licenseId
)
inherited fromPlugIn

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".
)
inherited fromPlugIn
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".
)
inherited fromPlugIn

Events

SettingsSaved

This event is raised when an instance of Rhino has modified the external settings file associated with this plug-in's PlugIn.Settings property.
inherited fromPlugIn