RenderPlugIn

PlugIn
public abstract class RenderPlugIn : PlugIn
A Rhino rendering plugin; applies materials, textures, and lights to a scene to produce rendered images.

Constructors

RenderPlugIn

#
protected RenderPlugIn()

Properties

AddToHelpMenu

Called by Rhino to determine if the plug-in name should be added to the Rhino Help/Plug-ins menu.
public virtual bool AddToHelpMenu { get; }
inherited fromPlugIn

Assembly

Source assembly for this plug-in.
public Assembly Assembly { get; }
inherited fromPlugIn

Description

Returns the description of the plug-in, as found in the plug-in's assembly attributes.
public string Description { get; }
inherited fromPlugIn

Id

Returns the Guid, or unique Id, of the plug-in.
public Guid Id { get; }
inherited fromPlugIn

InitialChannelToDisplay

#
protected virtual Guid InitialChannelToDisplay { get; }

LicenseId

public Guid LicenseId { get; }
inherited fromPlugIn

LoadAtStartup

public virtual bool LoadAtStartup { get; }
obsoleteUse LoadTime virtual property instead
inherited fromPlugIn

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.
public virtual PlugInLoadTime LoadTime { get; }
inherited fromPlugIn

LocalPlugInName

Optionally override this to provide a localized plug-in name
protected virtual string LocalPlugInName { get; }
inherited fromPlugIn

Name

Returns the name of the plug-in, as found in the plug-in's assembly attributes.
public string Name { get; }
inherited fromPlugIn

PerferBasicContent

#Since v5.12
Set to true if you would like Rhino to quickly create a basic render content in response to 'Create New' commands. Set to false if you would prefer Rhino to display the render content chooser dialog.
public bool PerferBasicContent { get; set; }

Settings

Persistent plug-in settings.
public PersistentSettings Settings { get; }
inherited fromPlugIn

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.
public string SettingsDirectory { get; }
inherited fromPlugIn

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.
public string SettingsDirectoryAllUsers { get; }
inherited fromPlugIn

SupportedChannels

#
Override to communicate that the renderer supports more channels beside the default channels RGBA, Depth, Normal, Albedo. See RenderWindow.StandardChannels. RenderWindow.ChannelId can be used to get the GUIDs for the channels to support
protected virtual Guid[] SupportedChannels { get; }

SupportsEditProperties

#
Override this property and return true if your plug-in supports decals and overrides ShowDecalProperties(List<NamedValue>)
protected virtual bool SupportsEditProperties { get; }

Version

Returns the version of the plug-in, as found in the plug-in's assembly attributes.
public string Version { get; }
inherited fromPlugIn

WindowPositionSettings

public PersistentSettings WindowPositionSettings { get; }
inherited fromPlugIn

Methods

AllowChooseContent

#
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.
protected virtual bool AllowChooseContent(
content
A render context.
)
true if the operation was successful.

AskUserForLicense

protected bool AskUserForLicense(
productBuildType,
standAlone,
textMask,
parentWindow,
validateProductKeyDelegate,
onLeaseChangedDelegate
)
inherited fromPlugIn

CommandSettings

public PersistentSettings CommandSettings(
name
)
inherited fromPlugIn

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.
protected virtual void CreateCommands()
inherited fromPlugIn

CreatePreview

#
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 arguments, 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 virtual void CreatePreview(
args
Event argument with several preview option state properties.
)

CreateTexture2dPreview

#
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 arguments, then the internal OpenGL renderer will generate a simulation.
protected virtual void CreateTexture2dPreview(
args
Event argument with several preview option state properties.
)

CurrentRendererSupportsFeature

#Since v6.1
public static bool CurrentRendererSupportsFeature()

CustomChannelName

#
Return the localized name of your custom channel.
protected virtual string CustomChannelName(
id
)

DisplayHelp

Called by Rhino if AddToHelpMenu is true and menu item associated with this plug-in is selected.
public virtual bool DisplayHelp(
nint
windowHandle
Native Window handle of the active Rhino interface.
)
inherited fromPlugIn
true = Help displayed successfully, false = Error displaying help

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.
protected virtual void DocumentPropertiesDialogPages(
doc,
document that the pages are set up for
pages
list of pages to add your custom options dialog page(s) to.
)
inherited fromPlugIn

EnableAssignMaterialButton

#Since v5.12
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 virtual bool EnableAssignMaterialButton()

EnableCreateMaterialButton

#Since v5.12
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 virtual bool EnableCreateMaterialButton()

EnableEditMaterialButton

#Since v5.12
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 virtual bool EnableEditMaterialButton(
doc,
Material
material
)

GetCommands

All of the commands associated with this plug-in.
public Command[] GetCommands()
inherited fromPlugIn

GetLicense

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.
protected bool GetLicense(
productBuildType,
The product build contentType required by your plug-in.
validateProductKeyDelegate,
Since the Rhino licensing system knows nothing about your product license, you will need to validate the product license provided by the Rhino licensing system. This is done by supplying a callback function, or delegate, that can be called to perform the validation.
leaseChangedDelegate
Called by the ZooClient when the cloud zoo lease is changed.
)
inherited fromPlugIn
true if a valid license was found. false otherwise.

GetLicense

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.
protected bool GetLicense(
licenseCapabilities,
In the event that a license was not found, or if the user wants to change the way your plug-in is licenses, then provide what capabilities your license has by using this enumeration flag.
textMask,
In the event that the user needs to be asked for a license, then you can provide a text mask, which helps the user to distinguish between proper and improper user input of your license code. Note, if you do not want to use a text mask, then pass in a null value for this parameter. For more information on text masks, search MSDN for the System.Windows.Forms.MaskedTextBox class.
validateProductKeyDelegate,
Since the Rhino licensing system knows nothing about your product license, you will need to validate the product license provided by the Rhino licensing system. This is done by supplying a callback function, or delegate, that can be called to perform the validation.
leaseChangedDelegate
Called by the ZooClient when the cloud zoo lease is changed.
)
inherited fromPlugIn
true if a valid license was found. false otherwise.

GetLicenseOwner

Get the customer name and organization used when entering the product license.
protected bool GetLicenseOwner(
out string
registeredOwner,
out string
registeredOrganization
)
inherited fromPlugIn

GetPlugInObject

public virtual object GetPlugInObject()
inherited fromPlugIn

GetRenderSettingsSections

#Since v6.17
This function returns a list of Guids for the render settings pages that should be displayed.
public List<Guid> GetRenderSettingsSections()
Return a Id list of the Render settings sections that will be displayed

Icon

Returns the plug-in's icon in bitmap form.
public Bitmap Icon(
size
The desired size in pixels.
)
inherited fromPlugIn
The icon if successful, null otherwise.

InitializeDecalProperties

#
Initialize your custom decal properties here. The input list will be empty - add your default named property values and return.
protected virtual void InitializeDecalProperties(
properties
A list of named values that will be stored on the object the input values are the current ones, you should modify the values after the dialog closes.
)

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.
public virtual bool IsTextureSupported()
inherited fromPlugIn

ObjectPropertiesPages

Override this function is you want to extend the object properties dialog
protected virtual void ObjectPropertiesPages()
obsoleteUse ObjectPropertiesPages(ObjectPropertiesPageCollection collection) instead
inherited fromPlugIn

ObjectPropertiesPages

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.
protected virtual void ObjectPropertiesPages(
collection
Add custom pages by calling collection.Add
)
inherited fromPlugIn

OnAssignMaterial

#Since v5.12
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 virtual bool OnAssignMaterial(
nint
parent,
doc,
ref Material
material
)

OnCreateMaterial

#Since v5.12
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 virtual bool OnCreateMaterial(
nint
parent,
doc,
ref Material
material
)

OnEditMaterial

#Since v5.12
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.
public virtual bool OnEditMaterial(
nint
parent,
doc,
ref Material
material
)

OnLoad

Is called when the plug-in is being loaded.
protected virtual LoadReturnCode OnLoad(
ref string
errorMessage
If a load error is returned and this string is set. This string is the error message that will be reported back to the user.
)
inherited fromPlugIn
An appropriate load return code.

The default implementation returns LoadReturnCode.Success.

OnSetCurrent

#
This plug-in (has become)/(is no longer) the current render plug-in
protected virtual void OnSetCurrent(
current
If true then this plug-in is now the current render plug-in otherwise it is no longer the current render plug-in.
)

OnShutdown

protected virtual void OnShutdown()
inherited fromPlugIn

OptionsDialogPages

Override this function if you want to extend the options dialog. This function is called whenever the user brings up the Options dialog.
protected virtual void OptionsDialogPages(
pages
list of pages to add your custom options dialog page(s) to.
)
inherited fromPlugIn

PreviewRenderType

#
Tell what kind of preview rendering your renderer supports.
protected virtual RenderPlugIn.PreviewRenderTypes PreviewRenderType()
One of PreviewRenderTypes

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.
protected virtual void ReadDocument(
doc,
A Rhino document that is being loaded.
archive,
OpenNURBS file archive object Rhino is using to read this file. Use BinaryArchiveReader.Read*() functions to read plug-in data. If any BinaryArchive.Read*() functions throws an exception then archive.ReadErrorOccurve will be true and you should immediately return.
options
Describes what is being written.
)
inherited fromPlugIn

RegisterCommand

protected bool RegisterCommand(
command
)
inherited fromPlugIn

RegisterCustomRenderSaveFileTypes

#
Override this method to add custom file types to the render window save file dialog.
protected virtual void RegisterCustomRenderSaveFileTypes()

RegisterRenderPanels

#
Override this method and call RenderPanels.RegisterPanel(PlugIn, RenderPanelType, Type, string, bool, bool) to add custom render UI to the render output window.
protected virtual void RegisterRenderPanels()

RegisterRenderTabs

#
Override this method and call RenderTabs.RegisterTab(PlugIn, Type, Guid, string, Icon) to add custom tabs to the render output window
protected virtual void RegisterRenderTabs()

Render

#
Called by Render and RenderPreview commands if this plug-in is set as the default render engine.
protected abstract Result Render(
doc,
A document.
mode,
A command running mode.
fastPreview
If true, lower quality faster render expected.
)
If true, then the renderer is required to construct a rapid preview and not the high-quality final result.

RenderContentSerializers

#
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 virtual IEnumerable<RenderContentSerializer> RenderContentSerializers()
List of RenderContentSerializer objects to register with the Rhino render content browsers.

RenderOptionsDialogPage

#
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 default Rhino page.
protected virtual OptionsDialogPage RenderOptionsDialogPage(
doc
The document properties to edit.
)
Return null to use the default Rhino page or return a page derived from OptionsDialogPage to replace the default page.

RenderSettingsCustomSections

#Since v6.0
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.
public virtual void RenderSettingsCustomSections(
sections
Create your sections and return a list of them
)

RenderSettingsSections

#
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 virtual List<Guid> RenderSettingsSections()
Remarks: You should add \e all sections you would want to appear in any context.
Return a Id list of content types to display in content browsers

RenderWindow

#
protected virtual Result RenderWindow(
doc,
modes,
fastPreview,
view,
rect,
inWindow,
blowup
)

RenderWindow

#
This function is obsolete and only exists for legacy purposes. Do not override this function - prefer overriding the version with the blowup parameter.
protected virtual Result RenderWindow(
doc,
modes,
fastPreview,
view,
rect,
inWindow
)

ResetMessageBoxes

protected virtual void ResetMessageBoxes()
inherited fromPlugIn

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.
protected bool ReturnLicense()
inherited fromPlugIn

SaveSettings

Write settings to disk which will raise a PlugIn.SettingsSaved event.
public void SaveSettings()
inherited fromPlugIn

SetLicenseCapabilities

protected void SetLicenseCapabilities(
textMask,
capabilities,
licenseId
)
inherited fromPlugIn

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().
protected virtual bool ShouldCallWriteDocument(
options
The file write options, such as "include preview image" and "include render meshes".
)
inherited fromPlugIn
true if the plug-in wants to save document user data in the version 5 .3dm file. The default returns false.

ShowDecalProperties

#
Override this function to handle showing a modal dialog with your plug-in's custom decal properties. You will be passed the current properties for the object being edited. The defaults will be set in InitializeDecalProperties.
protected virtual bool ShowDecalProperties(
properties
A list of named values that will be stored on the object the input values are the current ones, you should modify the values after the dialog closes.
)
true if the user pressed "OK", otherwise false.

SunCustomSections

#Since v6.0
Override this function to provide custom sections for the sun panel that are displayed when your plug-in is the current render plug-in.
public virtual void SunCustomSections(
sections
Create your sections and return a list of them
)

SupportedOutputTypes

#
Returns a list of output types which your renderer can write.

The default implementation returns BMP, JPG, PNG, TIF, TGA, HDR, EXR and RIMAGE.

protected virtual List<FileType> SupportedOutputTypes()
A list of file types.

SupportsFeature

#
Determines if your renderer supports a specific feature.
protected virtual bool SupportsFeature(
feature
A feature to be controlled.
)
true if the renderer indeed supports the feature.

UiContentTypes

#
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 virtual List<Guid> UiContentTypes()
Remarks: You should add \e all types you would want to appear in any context, regardless of their content kind. Rhino ensures that only types that make sense will actually be presented to the user in a given context.
Return a Id list of content types to display in content browsers

WriteDocument

Called when Rhino is saving a .3dm file to allow the plug-in to save document user data.
protected virtual void WriteDocument(
doc,
The Rhino document instance that is being saved.
archive,
OpenNURBS file archive object Rhino is using to write the file. Use BinaryArchiveWriter.Write*() functions to write plug-in data. OR use the ArchivableDictionary If any BinaryArchiveWriter.Write*() functions throw an exception, then archive.WriteErrorOccured will be true and you should immediately return. Setting archive.WriteErrorOccured to true will cause Rhino to stop saving the file.
options
The file write options, such as "include preview image" and "include render meshes".
)
inherited fromPlugIn

Events

SettingsSaved

This event is raised when an instance of Rhino has modified the external settings file associated with this plug-in's PlugIn.Settings property.
inherited fromPlugIn