Rhino C++ API
8.10
|
#include <RhRdkSdkRender.h>
Classes | |
class | CRenderingSourcesView |
Public Member Functions | |
CRhRdkSdkRender (const CRhinoCommandContext &context, CRhinoRenderPlugIn &plugIn, const ON_wString &sRenderer, UINT uIconId) | |
RDK_DEPRECATED | CRhRdkSdkRender (const CRhinoCommandContext &context, CRhinoRenderPlugIn *pPlugIn, const ON_wString &sCaption, UINT uIconId) |
virtual | ~CRhRdkSdkRender () |
virtual BOOL32 | AddLightToScene (const CRhinoLight &light) |
virtual BOOL32 | AddRenderMeshToScene (const CRhinoObject *pObject, const CRhinoMaterial &material, const ON_Mesh *pMesh) |
virtual IRhRdkAsyncRenderContext * | AsyncRenderContext (void) const |
virtual bool | ClearLastRendering (void) const |
virtual bool | CloseWindow (void) const |
virtual const CRhinoCommandContext & | CommandContext (void) const |
virtual IRhRdkRenderWindow & | GetRenderWindow (void) const |
virtual BOOL32 | IgnoreRhinoObject (const CRhinoObject *pObject) |
virtual bool | IsRenderInitializing (void) const |
virtual BOOL32 | NeedToProcessGeometryTable () |
virtual BOOL32 | NeedToProcessLightTable () |
virtual class IRhRdkSdkRenderMeshIterator * | NewRenderMeshIterator (const ON_Viewport &vp, bool bForceTriMesh=true, bool bQuiet=false) const |
virtual void | PauseRendering (void) |
CRhinoRenderPlugIn * | PlugIn () const |
virtual CRhinoSdkRender::RenderReturnCodes | Render (const ON_2iSize &sizeImage) |
virtual BOOL32 | RenderContinueModal () |
virtual BOOL32 | RenderEnterModalLoop () |
virtual BOOL32 | RenderExitModalLoop () |
virtual BOOL32 | RenderPreCreateWindow () |
virtual BOOL32 | RenderSceneWithNoMeshes () |
virtual UUID | RenderSessionId (void) const |
virtual CRhinoSdkRender::RenderReturnCodes | RenderWindow (CRhinoView *pView, const LPRECT pRect, bool bInWindow) |
virtual void | ResumeRendering (void) |
virtual bool | ReuseRenderWindow (void) const |
virtual RDK_DEPRECATED bool | SaveImage (const wchar_t *wszFilename) const |
virtual IRhRdkRenderWindow::FileResult | SaveImage (const wchar_t *wszFilename, bool bSaveAlpha) const |
virtual void | SetAsyncRenderContext (IRhRdkAsyncRenderContext *pRC) |
virtual void | SetConfirmationSeconds (int iSeconds) |
virtual void | StartRendering (void)=0 |
virtual BOOL32 | StartRenderingInWindow (CRhinoView *pView, const LPCRECT rect) |
virtual BOOL32 | StartRenderingQuiet (LPSIZE sizeImage) |
virtual void | StopRendering () |
virtual bool | SupportsPause (void) const |
![]() | |
CRhRdkObject () | |
virtual | ~CRhRdkObject () |
virtual void * | EVF (const wchar_t *wszFunc, void *pvData) |
void | operator delete (void *buf) |
void | operator delete[] (void *buf) |
void * | operator new (size_t size) |
void * | operator new[] (size_t size) |
Static Public Member Functions | |
static class IRhRdkSdkRenderMeshIterator * | NewRenderMeshIterator (const CRhinoDoc &doc, const UUID &uuidRenderPlugIn, const ON_Viewport &vp, bool bForceTriMesh=true, bool bQuiet=false) |
static RDK_DEPRECATED class IRhRdkSdkRenderMeshIterator * | NewRenderMeshIterator (const UUID &uuidRenderPlugIn, const ON_Viewport &vp, bool bForceTriMesh=true) |
static RDK_DEPRECATED ON_2iSize | RenderSize (const CRhinoDoc &doc) |
static ON_2iSize | RenderSize (const CRhinoDoc &doc, bool bUseRenderingSources) |
static RDK_DEPRECATED CSize | RenderSize (void) |
![]() | |
static void | CheckMemory (void) |
static void | PopulateDebuggingInfo (void) |
Friends | |
class | CRhRdkRenderSession |
class | CRhRdkSdkRenderImpl |
RDK_DEPRECATED CRhRdkSdkRender::CRhRdkSdkRender | ( | const CRhinoCommandContext & | context, |
CRhinoRenderPlugIn * | pPlugIn, | ||
const ON_wString & | sCaption, | ||
UINT | uIconId | ||
) |
CRhRdkSdkRender::CRhRdkSdkRender | ( | const CRhinoCommandContext & | context, |
CRhinoRenderPlugIn & | plugIn, | ||
const ON_wString & | sRenderer, | ||
UINT | uIconId | ||
) |
Construct a subclass of this object on the stack in your Rhino plug-in's Render() or RenderWindow() implementation.
context | is the command context passed to the render command in Rhino. |
plugIn | is a reference to your Rhino plug-in. |
sRenderer | is the name of the renderer. |
uIconId | is the resource id of the icon to use for the frame window. |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Get a pointer to the object that was passed to SetAsyncRenderContext(). If SetAsyncRenderContext() has not been called, this method will return null. The returned pointer is managed by RDK and should not be stored.
|
virtual |
|
virtual |
Closes the render window associated with this render instance.
|
virtual |
|
virtual |
Get the render window interface. This interface is used to access the frame buffer to which computed pixels are written. Although this returns a reference, it is safe to store the address of the returned object for later use. The object is guaranteed to exist for the lifetime of the associated frame window. This is at least as long as the duration of your rendering procedure (render thread).
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
static |
|
virtual |
bQuiet | indicates that the render mesh iterator does not display any progress UI. |
|
static |
This method is deprecated in favor of the one below.
|
virtual |
Override this method to pause rendering.
CRhinoRenderPlugIn* CRhRdkSdkRender::PlugIn | ( | ) | const |
|
virtual |
Render the scene normally. For synchronous renders, the function returns when rendering is complete (or canceled).
sizeImage | is the size of the image to be rendered. If you want RDK to provide this value, you can call RenderSize(). |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
static |
This method is deprecated in favor of the one below.
|
static |
Get the render size as specified in the ON_3dmRenderSettings.
doc | is the document to use for the render settings. |
bUseRenderingSources | is false to get the active viewport size (the same as in previous versions of Rhino), true to use rendering sources: It will automatically return the correct size based on rendering sources or custom settings. |
|
static |
This method is deprecated in favor of the one below.
|
virtual |
Render the scene in a view window. The function returns when rendering is complete (or cancelled).
pView | is a pointer to the view that the user selected a rectangle in. |
pRect | is the rectangle that the user selected. |
bInWindow | is true to render directly into the view window (Not used in Rhino 3). |
|
virtual |
Override this method to resume (i.e., un-pause) rendering.
|
virtual |
OBSOLETE. Not called.
|
virtual |
Saves the rendered image to a file.
wszFilename | is the full path to the file name to save to. If this parameter is null, the function prompts the user for a file name. |
|
virtual |
Saves the rendered image to a file. Does not prompt the user in any way.
wszFilename | is the full path to the file name to save to. |
bSaveAlpha | determines if alpha will be saved in files that support it (e.g., PNG). |
|
virtual |
Set the rendering to be executed asynchronously. After this is called, Render() and RenderWindow() will return success immediately.
pRC | is a pointer to an instance of your implementation of IRhRdkAsyncRenderContext. Ownership of this object will be passed to RDK. |
|
virtual |
Set the number of seconds that need to elapse during rendering before the user is asked if the rendered image should be saved.
|
pure virtual |
Implement this method to start your rendering thread.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Override this method and return true if your renderer supports pause / resume.
|
friend |
|
friend |