RhinoCommon documentation has a new look. The old site can still be found here.

/

/

RenderPipeline

RenderPipeline class

Provides facilities to a render plug-in for integrating with the standard Rhino render window. Also adds helper functions for processing a render scene. This is the suggested class to use when integrating a renderer with Rhino and maintaining a "standard" user interface that users will expect.

Derived Classes:

Namespace: Rhino.Render
RenderPipeline: references

Constructors (2)

RenderPipeline(RhinoDoc doc, RunMode mode, PlugIn plugin, Size sizeRendering, string caption, StandardChannels channels, bool reuseRenderWindow, bool clearLastRendering, AsyncRenderContext aRC)

Constructs a subclass of this object on the stack in your Rhino plug-in's Render() or RenderWindow() implementation. This constructor should be used when a non-blocking RenderWindow is required. Note that the asynchronous render context will not be used when mode is Scripted.

RenderPipeline(RhinoDoc doc, RunMode mode, PlugIn plugin, Size sizeRendering, string caption, StandardChannels channels, bool reuseRenderWindow, bool clearLastRendering)

Constructs a subclass of this object on the stack in your Rhino plug-in's Render() or RenderWindow() implementation.

Properties (3)

ConfirmationSeconds

Sets the number of seconds that need to elapse during rendering before the user is asked if the rendered image should be saved.

PlugIn

RenderSessionId

Get the Id associated with this render session, this is useful when looking up Rhino.Render.RenderPanels.

Methods (35)

AddLightToScene(LightObject light)

AddRenderMeshToScene(RhinoObject obj,Material material,Mesh mesh)

CloseWindow()

Closes the render window associated with this render instance.

CommandResult()

ContinueModal()

Frequently called during a rendering by the frame work in order to determine if the rendering should continue.

Dispose()

Dispose(bool isDisposing)

GetRenderWindow()

Get the RenderWindow associated with this RenderPipeline instance. This is virtual rather than abstract for V5 compat

GetRenderWindow(bool withWireframeChannel, bool fromRenderViewSource)

As GetRenderWindow(). The parameter withWireframeChannel controls whether the returned RenderWindow will have the channel added. The parameter fromRenderViewSource controls from where the RenderSize is queried.

GetRenderWindow(bool withWireframeChannel)

As GetRenderWindow(), but if withWireframeChannel is true the returned RenderWindow will have the channel added.

GetRenderWindow(ViewportInfo viewportInfo, bool fromRenderViewSource, Rectangle region)

As GetRenderWindow(). The parameter withWireframeChannel controls whether the returned RenderWindow will have the channel added. The parameter fromRenderViewSource controls from where the RenderSize is queried. The viewportInfo instance will be used to set up wireframe channel. This is necessary for rendering different view than is currently active in the viewport

GetRenderWindow(ViewportInfo viewportInfo, bool fromRenderViewSource)

As GetRenderWindow(). The parameter withWireframeChannel controls whether the returned RenderWindow will have the channel added. The parameter fromRenderViewSource controls from where the RenderSize is queried. The viewportInfo instance will be used to set up wireframe channel. This is necessary for rendering different view than is currently active in the viewport

GetRenderWindowFromRenderViewSource(bool fromRenderViewSource)

Like GetRenderWindow(), but with the size for RenderWindow set from RenderViewSources if fromRenderViewSource is set to true

IgnoreRhinoObject(RhinoObject obj)

LocalizeRenderReturnCode(RenderReturnCode rc)

NeedToProcessGeometryTable()

NeedToProcessLightTable()

OnRenderBegin()

Called by the framework when it is time to start rendering, the render window will be created at this point and it is safe to start

OnRenderBeginQuiet(Size imageSize)

Called by the framework when it is time to start rendering quietly, there is no user interface when rendering in this mode and the default post process effects will get applied to the scene when the rendering is complete.

OnRenderEnd(RenderEndEventArgs e)

Called by the framework when the user closes the render window or clicks on the stop button in the render window.

OnRenderWindowBegin(RhinoView view,Rectangle rectangle)

PauseRendering()

Implement to pause the current render session

Render()

Call this function to render the scene normally. The function returns when rendering is complete (or cancelled).

RenderEnterModalLoop()

RenderExitModalLoop()

RenderPreCreateWindow()

RenderSceneWithNoMeshes()

RenderSize()

RenderSize(RhinoDoc doc, bool fromRenderSources)

Get the render size as specified in the ON_3dmRenderSettings, and from RenderSources when fromRenderSources is true.

RenderSize(RhinoDoc doc)

Get the render size as specified in the ON_3dmRenderSettings. Will automatically return the correct size based on the ActiveView or custom settings.

RenderWindow(RhinoView view, Rectangle rect, bool inWindow)

Call this function to render the scene in a view window. The function returns when rendering is complete (or cancelled).

ResumeRendering()

Implement to resume current render session

SaveImage(string fileName, bool saveAlpha)

Saves the rendered image to a file. Does not prompt the user in any way.

SetAsyncRenderContext(ref AsyncRenderContext aRC)

SupportsPause()

Override and return True if the renderer supports pausing

Nothing found