DigitizerPlugIn

Public Class

A Rhino plug-in that interfaces with 3-D digitizing or input devices.

Inheritance Hierarchy

System.Object
Rhino.PlugIns.PlugIn
Rhino.PlugIns.DigitizerPlugIn

Assembly: RhinoCommon (in RhinoCommon.dll)

Syntax

public abstract class DigitizerPlugIn : PlugIn

The DigitizerPlugIn type exposes the following members.

Constructors

Name

Description

Protected Method

DigitizerPlugIn

Initializes a new instance of the DigitizerPlugIn class

Properties

Name

Description

Public Property

AddToHelpMenu

Called by Rhino to determine if the plug-in name should be added to the Rhino Help/Plug-ins menu.

(Inherited from PlugIn.)

Public Property

Assembly

Source assembly for this plug-in.

(Inherited from PlugIn.)

Public Property

Description

Returns the description of the plug-in, as found in the plug-in’s assembly attributes.

(Inherited from PlugIn.)

Protected property

DigitizerUnitSystem

Unit system of the points the digitizer passes to SendPoint(). Rhino uses this value when it calibrates a digitizer. This unit system must be not change.

Public Property

Returns the Guid, or unique Id, of the plug-in.

(Inherited from PlugIn.)

Public Property

LicenseId

(Inherited from PlugIn.)

Public Property

LoadAtStartup

Obsolete. (Inherited from PlugIn.)

Public Property

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.

(Inherited from PlugIn.)

Protected property

LocalPlugInName

Optionally override this to provide a localized plug-in name

(Inherited from PlugIn.)

Public Property

Name

Returns the name of the plug-in, as found in the plug-in’s assembly attributes.

(Inherited from PlugIn.)

Protected property

PointTolerance

The point tolerance is the distance the digitizer must move (in digitizer coordinates) for a new point to be considered real rather than noise. Small desktop digitizer arms have values like 0.001 inches and 0.01 millimeters. This value should never be smaller than the accuracy of the digitizing device.

Public Property

Settings

Persistent plug-in settings.

(Inherited from PlugIn.)

Public Property

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.

(Inherited from PlugIn.)

Public Property

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.

(Inherited from PlugIn.)

Public Property

Version

Returns the version of the plug-in, as found in the plug-in’s assembly attributes.

(Inherited from PlugIn.)

Public Property

WindowPositionSettings

(Inherited from PlugIn.)

Methods

Name

Description

Protected Method

AskUserForLicense

(Inherited from PlugIn.)

Public Method

CommandSettings

(Inherited from PlugIn.)

Protected Method

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.

(Inherited from PlugIn.)

Public Method

DisplayHelp

Called by Rhino if AddToHelpMenu is true and menu item associated with this plug-in is selected.

(Inherited from PlugIn.)

Protected Method

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.

(Inherited from PlugIn.)

Protected Method

EnableDigitizer

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 Method

Equals

Determines whether the specified object is equal to the current object.

(Inherited from Object.)

Protected Method

Finalize

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

(Inherited from Object.)

Public Method

GetCommands

All of the commands associated with this plug-in.

(Inherited from PlugIn.)

Public Method

GetHashCode

Serves as the default hash function.

(Inherited from Object.)

Protected Method

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.

(Inherited from PlugIn.)

Protected Method

GetLicense(LicenseCapabilities, String, ValidateProductKeyDelegate, OnLeaseChangedDelegate)

(Inherited from PlugIn.)

Protected Method

GetLicenseOwner

Get the customer name and organization used when entering the product license.

(Inherited from PlugIn.)

Public Method

GetPlugInObject

(Inherited from PlugIn.)

Public Method

GetType

Gets the Type of the current instance.

(Inherited from Object.)

Public Method

Icon

Returns the plug-in’s icon in bitmap form.

(Inherited from PlugIn.)

Public Method

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.

(Inherited from PlugIn.)

Protected Method

MemberwiseClone

Creates a shallow copy of the current Object.

(Inherited from Object.)

Protected Method

ObjectPropertiesPages(List.ObjectPropertiesPage.)

Obsolete.

Override this function is you want to extend the object properties dialog

(Inherited from PlugIn.)

Protected Method

ObjectPropertiesPages(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 Method

OnLoad

Is called when the plug-in is being loaded.

(Inherited from PlugIn.)

Protected Method

OnShutdown

(Inherited from PlugIn.)

Protected Method

OptionsDialogPages

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 Method

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.

(Inherited from PlugIn.)

Protected Method

RegisterCommand

(Inherited from PlugIn.)

Protected Method

ResetMessageBoxes

(Inherited from PlugIn.)

Protected Method

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.

(Inherited from PlugIn.)

Public Method

SaveSettings

Write settings to disk which will raise a

SettingsSaved

event.

(Inherited from PlugIn.)

Public Method

SendPoint

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 Method

SendRay

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 Method

SetLicenseCapabilities

(Inherited from PlugIn.)

Protected Method

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().

(Inherited from PlugIn.)

Public Method

ToString

Returns a string that represents the current object.

(Inherited from Object.)

Protected Method

WriteDocument

Called when Rhino is saving a .3dm file to allow the plug-in to save document user data.

(Inherited from PlugIn.)

Events

Name

Description

Public Event

SettingsSaved

This event is raised when an instance of Rhino has modified the external settings file associated with this plug-in’s

Settings

property.

(Inherited from PlugIn.)