IBatchRenderManager Class Reference

#include <IBatchRenderManager.h>

Class Description

This class is the manager of the batch rendering feature.

You can use this class to setup or query the batch renderer.

Inheritance diagram for IBatchRenderManager:

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 Types inherited from BaseInterface
enum	LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }

Public Member Functions
virtual int	GetViewCount ()=0
	Get the number of views currently configured. More...
virtual IBatchRenderView *	GetView (int i)=0
	Get an interface to a given batch render view. More...
virtual int	FindView (const MCHAR *name)=0
	Find a batch render view with the given name. More...
virtual void	Render ()=0
	Start the batch renderer. More...
virtual IBatchRenderView *	CreateView (INode *camera)=0
	Create a new batch render view using the given camera. More...
virtual bool	DeleteView (int i)=0
	Delete the given batch render view. More...
IBatchRenderView *	DuplicateView (int i)
	Create a new batch render view by copying an existing one. More...
virtual bool	GetNetRender ()=0
	Returns whether or not network rendering is enabled for the batch renderer. More...
virtual void	SetNetRender (bool b)=0
	Set whether of not to use network rendering for the batch renderer. More...
virtual bool	GetKeepVFB ()=0
	Returns whether or not a separate VFB will be opened (and kept open) for each batch render view when rendered. More...
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. More...
virtual bool	PrepareScene (IBatchRenderView *batchView)=0
	This will prepare the scene for a given batch render view. More...
virtual void	DoManageDialog ()=0
	This brings up the batch renderer dialog. More...
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. More...
Public Member Functions inherited from FPInterfaceDesc
CoreExport	FPInterfaceDesc ()
CoreExport	FPInterfaceDesc (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, ULONG flag,...)
CoreExport	~FPInterfaceDesc ()
virtual void	Init ()
LifetimeType	LifetimeControl ()
virtual BaseInterface *	GetInterface (Interface_ID id)
CoreExport void	LoadDescriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *pCD, ULONG flag,...)
CoreExport void	AppendFunction (int id,...)
	Add a new function to this interface descriptor. More...
CoreExport void	AppendProperty (int id,...)
	Add a new property to this interface descriptor. More...
CoreExport void	AppendEnum (int id,...)
	Add a new enum to this interface descriptor. More...
CoreExport void	SetClassDesc (ClassDesc *i_cd)
CoreExport va_list	check_fn (va_list ap, int id)
CoreExport va_list	scan_fn (va_list ap, int id, int index)
CoreExport va_list	check_prop (va_list ap, int id)
CoreExport va_list	scan_prop (va_list ap, int id, int index)
CoreExport va_list	check_enum (va_list ap, EnumID id)
CoreExport va_list	scan_enum (va_list ap, EnumID id, int index)
FPInterfaceDesc *	GetDesc ()
Interface_ID	GetID ()
CoreExport FPFunctionDef *	GetFnDef (FunctionID fid)
ActionTable *	GetActionTable ()
CoreExport void	EnableActions (BOOL onOff)
virtual CoreExport HINSTANCE	HInstance ()
virtual CoreExport const MCHAR *	GetRsrcString (StringResID id)
Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPParams *params)
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
virtual CoreExport FunctionID	FindFn (const MCHAR *name)
virtual CoreExport BOOL	IsEnabled (FunctionID actionID)
virtual CoreExport BOOL	IsChecked (FunctionID actionID)
virtual CoreExport BOOL	IsVisible (FunctionID actionID)
virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)
virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)
virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...
virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=NULL)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
Public Attributes inherited from FPInterfaceDesc
Interface_ID	ID
MSTR	internal_name
StringResID	description
ClassDesc *	cd
USHORT	flags
Tab< FPFunctionDef * >	functions
Tab< FPPropDef * >	props
Tab< FPEnum * >	enumerations
MSPluginClass *	pc
Rollout *	rollout
ActionTable *	action_table
Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface
Protected Member Functions inherited from FPInterfaceDesc
CoreExport void	load_descriptor (Interface_ID id, const MCHAR *int_name, StringResID descr, ClassDesc *cd, USHORT flag, va_list ap)
Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Member Enumeration Documentation

anonymous enum

Enumerator
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

    { 
        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
    }; 

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.