Click or drag to resize

RenderPlugIn Methods

The RenderPlugIn type exposes the following members.

Methods
  NameDescription
Protected methodAllowChooseContent
Default implementation returns true which means the content can be picked from the content browser by the user. Override this method and return false if you don't want to allow a certain content contentType to be picked from the content browser while your render engine is current.
Public methodAskUserForLicense(LicenseBuildType, Boolean, String, Object, ValidateProductKeyDelegate) (Inherited from PlugIn.)
Protected methodAskUserForLicense(LicenseBuildType, Boolean, String, Object, ValidateProductKeyDelegate, OnLeaseChangedDelegate) (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.)
Protected methodCreatePreview
Creates the preview bitmap that will appear in the content editor's thumbnail display when previewing materials and environments. If this function is not overridden or the PreviewImage is not set on the args, then the internal OpenGL renderer will generate a simulation of the content. This function is called with four different preview quality settings. The first quality level of RealtimeQuick is called on the main thread and needs to be drawn as fast as possible. This function is called with the other three quality settings on a separate thread and are meant for generating progressively refined preview.
Protected methodCreateTexture2dPreview
Creates the preview bitmap that will appear in the content editor's thumbnail display when previewing textures in 2d (UV) mode. If this function is not overridden or the PreviewImage is not set on the args, then the internal OpenGL renderer will generate a simulation.
Public methodStatic memberCurrentRendererSupportsFeature
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.)
Public methodEnableAssignMaterialButton
Called to enable/disable the "Material" button located on the "Material" tab in the Properties and Layer dialog boxes. The default return value is false which will disable the button. If the button is disabled then the OnAssignMaterial function is never called.
Public methodEnableCreateMaterialButton
Called to enable/disable the "New" button located on the "Material" in the Properties and Layer dialog boxes. The default return value is false which will disable the button. If the button is disabled then the OnEditMaterial function is never called.
Public methodEnableEditMaterialButton
Called to enable/disable the "Edit" button located on the "Material" in the Properties and Layer dialog boxes. The default return value is false which will disable the button. If the button is disabled then the OnEditMaterial function is never called.
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetCommands
All of the commands associated with this plug-in.
(Inherited from PlugIn.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetLicense(LicenseBuildType, ValidateProductKeyDelegate)
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(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.)
Public methodGetLicense(LicenseCapabilities, String, ValidateProductKeyDelegate)
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.)
Public methodGetLicenseOwner
Get the customer name and organization used when entering the product license.
(Inherited from PlugIn.)
Public methodGetPlugInObject (Inherited from PlugIn.)
Public methodGetType (Inherited from Object.)
Public methodIcon
Returns the plug-in's icon in bitmap form.
(Inherited from PlugIn.)
Protected methodInitializeDecalProperties
Initialize your custom decal properties here. The input list will be empty - add your default named property values and return.
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodObjectPropertiesPages
Override this function is you want to extend the object properties dialog
(Inherited from PlugIn.)
Public methodOnAssignMaterial
This function is called by the Object Properties and Layer Control dialogs when the "Material" button is pressed in the "Render" tab. This is only called if EnableAssignMaterialButton returns true.
Public methodOnCreateMaterial
This function is called by the Object Properties and Layer Control dialogs when the "New" button is pressed in the "Material" tab. This is only called if EnableCreateMaterialButton returns true.
Public methodOnEditMaterial
This function is called by the Object Properties and Layer Control dialogs when the "Edit" button is pressed in the "Material" tab. This is only called if EnableEditMaterialButton returns true. A return value of true means the material has been updated.
Protected methodOnLoad
Is called when the plug-in is being loaded.
(Inherited from PlugIn.)
Protected methodOnSetCurrent
This plug-in (has become)/(is no longer) the current render plug-in
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 methodPreviewRenderType
Tell what kind of preview rendering your renderer supports.
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 methodRegisterCustomRenderSaveFileTypes
Override this method to add custom file types to the render window save file dialog.
Protected methodRegisterRenderPanels
Override this method and call RegisterPanel(PlugIn, RenderPanelType, Type, String, Boolean, Boolean) to add custom render UI to the render output window.
Protected methodRegisterRenderTabs
Override this method and call RegisterTab(PlugIn, Type, String, Icon) to add custom tabs to the render output window
Protected methodRender
Called by Render and RenderPreview commands if this plug-in is set as the default render engine.
Protected methodRenderContentSerializers
Called by Rhino when it is time to register RenderContentSerializer derived classes. Override this method and return an array of an instance of each serialize custom content object you wish to add.
Protected methodRenderOptionsDialogPage
Override this method to replace the render properties page in the Rhino document properties dialog. The default implementation returns null which means just use the the default Rhino page.
Public methodRenderSettingsCustomSections
Override this function to provide custom sections for the render settings panel that are displayed when your plug-in is the current render plug-in.
Protected methodRenderSettingsSections
Override this method to provide the UUIDs of all sections that should be displayed in the Render Settings tab when this is the current renderer.The default implementation adds all the RDK's built-in Render Settings sections. These UUIDs start with the prefix uuidRenderSettingsSection'. They can be found in RhRdkUuids.h
Protected methodRenderWindow(RhinoDoc, RunMode, Boolean, RhinoView, Rectangle, Boolean)
This function is obsolete and only exists for legacy purposes. Do not override this function - prefer overriding the version with the blowup parameter.
Protected methodRenderWindow(RhinoDoc, RunMode, Boolean, RhinoView, Rectangle, Boolean, Boolean)
Protected methodResetMessageBoxes (Inherited from PlugIn.)
Public 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.)
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.)
Protected methodShowDecalProperties
Override this function to handle showing a modal dialog with your plugin's custom decal properties. You will be passed the current properties for the object being edited. The defaults will be set in InitializeDecalProperties.
Public methodSunCustomSections
Override this function to provide custom sections for the sun panel that are displayed when your plug-in is the current render plug-in.
Protected methodSupportedOutputTypes
Returns a list of output types which your renderer can write.

The default implementation returns bmp, jpg, png, tif, tga.

Protected methodSupportsFeature
Determines if your renderer supports a specific feature.
Public methodToString (Inherited from Object.)
Protected methodUiContentTypes
Override this method to provide the UUIDs of all content types that should be presented to the user in the types combo box or the[+] button types menu.The default implementation adds only RDK's built-in types. Rhino automatically adds types in the most efficient way to minimize the list length. If you override this method, you may call the base class first to add the built-in types, a separator will be inserted at the end of the standard list followed by your own types. You may omit the base class call and only chosen types yourself, followed by a separator and your own types. A 'More Types...' item is automatically added when needed by Rhino. Specify a separator by adding uuidUiContentType_Separator.
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