Detailed Description
This class is the manager of the batch rendering feature.
You can use this class to setup or query the batch renderer.
#include <IBatchRenderManager.h>
Public Types |
|
| enum | { E_GET_COUNT, E_GET_VIEW, E_FIND_VIEW, E_CREATE_VIEW, E_DELETE_VIEW, E_DUPLICATE_VIEW, E_RENDER, E_GET_KEEP_VFB, E_SET_KEEP_VFB, E_GET_NETRENDER, E_SET_NETRENDER } |
Public Member Functions |
|
| virtual int | GetViewCount ()=0 |
| Get the number of views currently
configured. |
|
| virtual IBatchRenderView * | GetView (int i)=0 |
| Get an interface to a given batch render
view. |
|
| virtual int | FindView (const MCHAR *name)=0 |
| Find a batch render view with the given
name. |
|
| virtual void | Render ()=0 |
| Start the batch renderer. |
|
| virtual IBatchRenderView * | CreateView (INode *camera)=0 |
| Create a new batch render view using the
given camera. |
|
| virtual bool | DeleteView (int i)=0 |
| Delete the given batch render view. |
|
| IBatchRenderView * | DuplicateView (int i) |
| Create a new batch render view by copying an
existing one. |
|
| virtual bool | GetNetRender ()=0 |
| Returns whether or not network rendering is
enabled for the batch renderer. |
|
| virtual void | SetNetRender (bool b)=0 |
| Set whether of not to use network rendering
for the batch renderer. |
|
| virtual bool | GetKeepVFB ()=0 |
| Returns whether or not a separate VFB will
be opened (and kept open) for each batch render view when rendered.
|
|
| virtual void | SetKeepVFB (bool b)=0 |
| Set whether or not a separate VFB will be
opened (and kept open) for each batch render view when rendered.
|
|
| virtual bool | PrepareScene (IBatchRenderView *batchView)=0 |
| This will prepare the scene for a given
batch render view. |
|
| virtual void | DoManageDialog ()=0 |
| This brings up the batch renderer dialog.
|
|
| virtual void | EnumAuxFiles (AssetEnumCallback &nameEnum, DWORD flags=FILE_ENUM_ALL)=0 |
| This method may be used to enumerate all the
render preset files used by Batch Render. |
|
Member Enumeration Documentation
| anonymous enum |
Member Function Documentation
| virtual int GetViewCount | ( | ) | [pure virtual] |
Get the number of views currently configured.
- Returns:
- The number of batch render views
| virtual IBatchRenderView* GetView | ( | int | i | ) | [pure virtual] |
Get an interface to a given batch render view.
- Parameters:
-
[in] i - The index of the batch render view to access
- Returns:
- A batch render view interface, of NULL in case of an error
| virtual int FindView | ( | const MCHAR * | name | ) | [pure virtual] |
Find a batch render view with the given name.
- Parameters:
-
[in] name - The name of the batch render view to find
- Returns:
- The index of the batch render view with the given name, or NULL if none were found.
| virtual void Render | ( | ) | [pure virtual] |
Start the batch renderer.
| virtual IBatchRenderView* CreateView | ( | INode * | camera | ) | [pure virtual] |
Create a new batch render view using the given camera.
The batch render view will be added to the batch render list and have a unique name and default values for all it's parameters.
- Parameters:
-
[in] camera - The camera to render with the batch render view, or NULL to render from the current viewport
- Returns:
- A pointer to the newly created batch render view, or NULL if an error occurred.
| virtual bool DeleteView | ( | int | i | ) | [pure virtual] |
Delete the given batch render view.
- Parameters:
-
[in] i - The index of the batch render view to delete
- Returns:
- true if the entry was deleted, false if an error occurred
| IBatchRenderView* DuplicateView | ( | int | i | ) |
Create a new batch render view by copying an existing one.
The new view will be identical to the previous, except for its name. A new unique name will be created.
- Parameters:
-
[in] i - The index of the batch render view to copy
- Returns:
- A pointer to the newly created batch render view, or NULL in case of an error
| virtual bool GetNetRender | ( | ) | [pure virtual] |
Returns whether or not network rendering is enabled for the batch renderer.
- Returns:
- true if network rendering is enabled, false otherwise
| virtual void SetNetRender | ( | bool | b | ) | [pure virtual] |
Set whether of not to use network rendering for the batch renderer.
- Parameters:
-
[in] b - True to use network rendering, false to render locally
| virtual bool GetKeepVFB | ( | ) | [pure virtual] |
Returns whether or not a separate VFB will be opened (and kept open) for each batch render view when rendered.
In 3ds Max 8 this has no effect, and is for internal use only
- Returns:
- true if a separate VFB is used for each batch render view, false otherwise
| virtual void SetKeepVFB | ( | bool | b | ) | [pure virtual] |
Set whether or not a separate VFB will be opened (and kept open) for each batch render view when rendered.
In 3ds Max 8 this has no effect, and is for internal use only
- Parameters:
-
[in] b - Set to true to open a separate VFB for each batch render view, false to use the same VFB for all renders.
| virtual bool PrepareScene | ( | IBatchRenderView * | batchView | ) | [pure virtual] |
This will prepare the scene for a given batch render view.
This will load the preset and restore the scene state from the batch render view.
- Parameters:
-
[in] batchView - The batch render view to prepare.
- Returns:
- true if the preparation was successful and false if an error occurred.
| virtual void DoManageDialog | ( | ) | [pure virtual] |
This brings up the batch renderer dialog.
| virtual void EnumAuxFiles | ( | AssetEnumCallback & | nameEnum, |
| DWORD | flags =
FILE_ENUM_ALL |
||
| ) | [pure virtual] |
This method may be used to enumerate all the render preset files used by Batch Render.
- Parameters:
-
[in] nameEnum - The callback, called once for each render preset. [in] flags - Indicate what to enumerate.
