Click or drag to resize

DigitizerPlugIn Methods

The DigitizerPlugIn type exposes the following members.

Methods
  NameDescription
Protected methodAskUserForLicense (Inherited from PlugIn.)
Public methodCommandSettings (Inherited from PlugIn.)
Protected methodCreateCommands
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.
(Inherited from PlugIn.)
Public methodDisplayHelp
Called by Rhino if AddToHelpMenu is true and menu item associated with this plug-in is selected.
(Inherited from PlugIn.)
Protected methodDocumentPropertiesDialogPages
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.
(Inherited from PlugIn.)
Protected methodEnableDigitizer
Called by Rhino to enable/disable input from the digitizer. If enable is true and EnableDigitizer() returns false, then Rhino will not calibrate the digitizer.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetCommands
All of the commands associated with this plug-in.
(Inherited from PlugIn.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Protected methodGetLicense(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.
(Inherited from PlugIn.)
Protected methodGetLicense(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.
(Inherited from PlugIn.)
Protected methodGetLicenseOwner
Get the customer name and organization used when entering the product license.
(Inherited from PlugIn.)
Public methodGetPlugInObject (Inherited from PlugIn.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodIcon
Returns the plug-in's icon in bitmap form.
(Inherited from PlugIn.)
Public methodIsTextureSupported
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.
(Inherited from PlugIn.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodObjectPropertiesPages(ListObjectPropertiesPage) Obsolete.
Override this function is you want to extend the object properties dialog
(Inherited from PlugIn.)
Protected methodObjectPropertiesPages(ObjectPropertiesPageCollection)
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.
(Inherited from PlugIn.)
Protected methodOnLoad
Is called when the plug-in is being loaded.
(Inherited from PlugIn.)
Protected methodOnShutdown (Inherited from PlugIn.)
Protected methodOptionsDialogPages
Override this function if you want to extend the options dialog. This function is called whenever the user brings up the Options dialog.
(Inherited from PlugIn.)
Protected methodReadDocument
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.
(Inherited from PlugIn.)
Protected methodRegisterCommand (Inherited from PlugIn.)
Protected methodResetMessageBoxes (Inherited from PlugIn.)
Protected methodReturnLicense
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.
(Inherited from PlugIn.)
Public methodSaveSettings
Write settings to disk which will raise a SettingsSaved event.
(Inherited from PlugIn.)
Public methodSendPoint
If the digitizer is enabled, call this function to send a point to Rhino. Call this function as much as you like. The digitizers that Rhino currently supports send a point every 15 milliseconds or so. This function should be called when users press or release any digitizer button.
Public methodSendRay
If the digitizer is enabled, call this function to send a point and direction to Rhino. Call this function as much as you like. The digitizers that Rhino currently supports send a point every 15 milliseconds or so. This function should be called when users press or release any digitizer button.
Protected methodSetLicenseCapabilities (Inherited from PlugIn.)
Protected methodShouldCallWriteDocument
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().
(Inherited from PlugIn.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Protected methodWriteDocument
Called when Rhino is saving a .3dm file to allow the plug-in to save document user data.
(Inherited from PlugIn.)
Top
See Also