|
|
The ToolPlugin type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
ToolPlugin |
Default constructor for an ToolPlugin
|
Methods
| Name | Description | |
|---|---|---|
|
ContextMenu |
ContextMenu handler.
|
|
|
Equals | (Inherited from Object.) |
|
|
Finalize |
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetCursor |
GetCursor handler.
|
|
|
GetHashCode |
Serves as a hash function for a particular type. GetHashCode()()()() is suitable for use in hashing algorithms and data structures like a hash table. (Inherited from Object.) |
|
|
GetHelpIdAtPoint |
GetHelpIdAtPoint handler.
|
|
|
GetHelpIdForHighlight |
GetHelpIdForHighlight handler.
|
|
|
GetString |
Looks up a localizable string that is specific to this plugin
(Inherited from Plugin.) |
|
|
GetStringSafe |
Looks up a localizable string that is specific to this plugin
(Inherited from Plugin.) |
|
|
GetTooltip |
GetTooltip handler
|
|
|
GetType |
Gets the Type of the current instance. (Inherited from Object.) |
|
|
IsSelfEnabled |
Called once to determines if the plugin is enabled.
Only called if PluginRecord.SupportsIsSelfEnabled is true
(Inherited from Plugin.) |
|
|
KeyDown |
MouseLeave handler.
|
|
|
KeyDrag |
KeyDrag handler.
|
|
|
KeyUp |
KeyUp handler.
|
|
|
MakeRenderBoundingBox |
Should return bounding box of any additional model space geometry that will be rendered so that near/far clipping planes can be adjusted accordingly.
|
|
|
MemberwiseClone |
Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
ModifierKeyDown |
ModifierKeyDown handler.
|
|
|
ModifierKeyUp |
ModifierKeyUp handler.
|
|
|
MouseDown |
Mouse down handler.
|
|
|
MouseDrag |
Mouse drag handler.
|
|
|
MouseLeave |
Mouse leave handler.
|
|
|
MouseMove |
Mouse move handler.
|
|
|
MouseUp |
Mouse up handler.
|
|
|
OnLoaded |
Called once immediately after the plugin has been loaded (created).
Plugins are loaded on demand so this may be some time after application startup.
Default implementation does nothing.
This is a good place to subscribe to API events.
(Inherited from Plugin.) |
|
|
OnUnloading |
Called once just before the plugin is unloaded. If the plugin implements
IDisposable, then
Dispose will be called immediately after the plugin is unloaded.
Plugins are typically unloaded at application shutdown or when the end user has disabled a plugin.
Default implementation does nothing.
This is a good place to unsubscribe from API events.
(Inherited from Plugin.) |
|
|
OverlayRender |
Override to allow custom drawing overlayed on main render.
|
|
|
Render |
Override to allow custom drawing in main render.
|
|
|
ToString | (Inherited from Object.) |
|
|
TryGetString |
Looks up a localizable string that is specific to this plugin
(Inherited from Plugin.) |
|
|
WheelDrag |
WheelDrag handler.
|
Properties
| Name | Description | |
|---|---|---|
|
DeveloperId |
The 4 character ADN developer code or a GUID. The combination of this and Name should make the plugin unique (Inherited from Plugin.) |
|
|
Id |
The full identifier for the plugin. This is formed as
Name.DeveloperId (Inherited from Plugin.) |
|
|
Name |
The name of the Plugin. The combination of this and DeveloperId should make the plugin unique (Inherited from Plugin.) |
|
|
PluginRecord |
The PluginRecord that provides access to the attribute defined properties for this plugin. (Inherited from Plugin.) |