RenderPanels
ReferencesThis class is used to extend the standard Render user interface
Methods
Get the instance of a render panel associated with a specific render session, this is useful when it is necessary to update a control from a RenderPipeline
Parameters:
| plugIn (PlugIn) | The plug-in that registered the custom user interface |
| panelType (Type) | The type of panel to return |
| renderSessionId (Guid) | The RenderPipeline.RenderSessionId of a specific render session. |
Returns: Returns the custom panel object if found; otherwise null is returned.
public void RegisterPanel(PlugIn plugin, RenderPanelType renderPanelType, Type panelType, Guid renderEngineId, string caption, bool alwaysShow, bool initialShow, ExtraSidePanePosition pos)
Register custom render user interface with Rhino. This should only be done in RenderPlugIn.RegisterRenderPanels(RenderPanels). Panels registered after RenderPlugIn.RegisterRenderPanels(RenderPanels) is called will be ignored.
Parameters:
| plugin (PlugIn) | The plug-in providing the custom user interface |
| renderPanelType (RenderPanelType) | See RenderPanelType for supported user interface types. |
| panelType (Type) | The type of object to be created and added to the render container. |
| renderEngineId (Guid) | The render engine id allowing the UI to be shown. |
| caption (string) | The caption for the custom user interface. |
| alwaysShow (bool) | If true the custom user interface will always be visible, if false then it may be hidden or shown as requested by the renderer. |
| initialShow (bool) | Initial visibility state of the custom user interface control. |
| pos (RenderPanels.ExtraSidePanePosition) | The position to dock the extra side pane at. |
public void RegisterPanel(PlugIn plugin, RenderPanelType renderPanelType, Type panelType, Guid renderEngineId, string caption, bool alwaysShow, bool initialShow)
Register custom render user interface with Rhino. This should only be done in RenderPlugIn.RegisterRenderPanels(RenderPanels). Panels registered after RenderPlugIn.RegisterRenderPanels(RenderPanels) is called will be ignored.
Parameters:
| plugin (PlugIn) | The plug-in providing the custom user interface |
| renderPanelType (RenderPanelType) | See RenderPanelType for supported user interface types. |
| panelType (Type) | The type of object to be created and added to the render container. |
| renderEngineId (Guid) | The render engine id allowing the UI to be shown. |
| caption (string) | The caption for the custom user interface. |
| alwaysShow (bool) | If true the custom user interface will always be visible, if false then it may be hidden or shown as requested by the renderer. |
| initialShow (bool) | Initial visibility state of the custom user interface control. |
public void RegisterPanel(PlugIn plugin, RenderPanelType renderPanelType, Type panelType, string caption, bool alwaysShow, bool initialShow)
obsoleteUse RegisterPanel(PlugIn plugin, RenderPanelType renderPanelType, Type panelType, Guid renderEngineId, string caption, bool alwaysShow, bool initialShow)
Register custom render user interface with Rhino. This should only be done in RenderPlugIn.RegisterRenderPanels(RenderPanels). Panels registered after RenderPlugIn.RegisterRenderPanels(RenderPanels) is called will be ignored.
Parameters:
| plugin (PlugIn) | The plug-in providing the custom user interface |
| renderPanelType (RenderPanelType) | See RenderPanelType for supported user interface types. |
| panelType (Type) | The type of object to be created and added to the render container. |
| caption (string) | The caption for the custom user interface. |
| alwaysShow (bool) | If true the custom user interface will always be visible, if false then it may be hidden or shown as requested by the user. |
| initialShow (bool) | Initial visibility state of the custom user interface control. |