#include <IBatchRenderManager.h>

Class Description

This class represent one entry in the list of batch render views.

You can use the properties in this class to read or change the parameters for each batch render view.

Inheritance diagram for IBatchRenderView:

Public Types
enum	{ E_GET_CAMERA, E_SET_CAMERA, E_GET_WIDTH, E_SET_WIDTH, E_GET_HEIGHT, E_SET_HEIGHT, E_GET_START, E_SET_START, E_GET_END, E_SET_END, E_GET_NAME, E_SET_NAME, E_GET_PRESET, E_SET_PRESET, E_GET_FULL_PRESETPATH, E_GET_SCENESTATE, E_SET_SCENESTATE, E_GET_ENABLED, E_SET_ENABLED, E_GET_FILENAME, E_SET_FILENAME, E_GET_ASPECT, E_SET_ASPECT, E_GET_OVERRIDE_PRESET, E_SET_OVERRIDE_PRESET }

Public Types inherited from BaseInterface
enum	LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }

Public Member Functions
virtual INode *	GetCamera ()=0
	Get the camera that the batch render view is rendering. More...

virtual bool	SetCamera (INode *node)=0
	Set the camera that the batch render view is rendering. More...

virtual int	GetWidth ()=0
	Get the width of the rendering output. More...

virtual bool	SetWidth (int width)=0
	Set the width of the rendering output. More...

virtual int	GetHeight ()=0
	Get the height of the rendering output. More...

virtual bool	SetHeight (int height)=0
	Set the height of the rendering output. More...

virtual TimeValue	GetStart ()=0
	Get the start frame of the segment to render. More...

virtual void	SetStart (TimeValue start)=0
	Set the start frame of the segment to render. More...

virtual TimeValue	GetEnd ()=0
	Get the end frame of the segment to render. More...

virtual void	SetEnd (TimeValue end)=0
	Set the end frame of the segment to render. More...

virtual const MCHAR *	GetName ()=0
	Get the name of the batch render view. More...

virtual bool	SetName (const MCHAR *name)=0
	Set the name of the batch render view. More...

virtual const MaxSDK::AssetManagement::AssetUser &	GetPresetFile ()=0
	Return the render preset used by the batch render view. More...

virtual void	SetPresetFile (const MaxSDK::AssetManagement::AssetUser &preset)=0
	Set the filename of the render preset used for the batch render view. More...

virtual bool	GetFullPresetPath (MSTR &path)=0
	Get the fully qualified path to the render preset. More...

virtual const MCHAR *	GetSceneState ()=0
	Get the scene state used by the batch render view. More...

virtual void	SetSceneState (const MCHAR *sceneState)=0
	Set the scene state to be used by the batch render view. More...

virtual bool	GetEnabled ()=0
	Check if the batch render view is enabled. More...

virtual void	SetEnabled (bool enabled)=0
	Enable or disable the batch render view. More...

virtual BitmapInfo *	GetFileOutputInfo ()=0
	Get the parameters of the output file for the batch render view. More...

virtual void	SetFileOutputInfo (BitmapInfo *bi)=0
	Set the parameters of the output file for the batch render view. More...

virtual float	GetAspect ()=0
	Get the pixel ascpect ratio used for the rendering. More...

virtual void	SetAspect (float pixelAspect)=0
	Set the pixel aspect ratio used for the rendering. More...

virtual bool	GetOverridePreset ()=0
	Check if the render preset will be overridden for this batch render view. More...

virtual void	SetOverridePreset (bool override)=0
	Set whether or not the render preset will be overridden for this batch render view. More...

Public Member Functions inherited from FPMixinInterface
	FPMixinInterface ()

virtual LifetimeType	LifetimeControl ()

virtual CoreExport bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)

CoreExport	~FPMixinInterface ()

virtual BaseInterface *	GetInterface (Interface_ID id)

virtual FPInterfaceDesc *	GetDescByID (Interface_ID id)

virtual Interface_ID	GetID ()

Public Member Functions inherited from FPInterface
virtual FPInterfaceDesc *	GetDesc ()=0

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)

virtual ActionTable *	GetActionTable ()

virtual void	EnableActions (BOOL onOff)

Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...

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...

static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...

static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...

static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

Protected Member Functions inherited from FPMixinInterface
	FPMixinInterface (const FPMixinInterface &rhs)

FPMixinInterface &	operator= (const FPMixinInterface &rhs)

Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Protected Member Functions inherited from Noncopyable
	Noncopyable ()

	~Noncopyable ()

Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > *	interfaceNotifyCBs

Member Enumeration Documentation

anonymous enum

Enumerator
E_GET_CAMERA
E_SET_CAMERA
E_GET_WIDTH
E_SET_WIDTH
E_GET_HEIGHT
E_SET_HEIGHT
E_GET_START
E_SET_START
E_GET_END
E_SET_END
E_GET_NAME
E_SET_NAME
E_GET_PRESET
E_SET_PRESET
E_GET_FULL_PRESETPATH
E_GET_SCENESTATE
E_SET_SCENESTATE
E_GET_ENABLED
E_SET_ENABLED
E_GET_FILENAME
E_SET_FILENAME
E_GET_ASPECT
E_SET_ASPECT
E_GET_OVERRIDE_PRESET
E_SET_OVERRIDE_PRESET

     { 
         E_GET_CAMERA,
         E_SET_CAMERA,
         E_GET_WIDTH,
         E_SET_WIDTH,
         E_GET_HEIGHT,
         E_SET_HEIGHT,
         E_GET_START,
         E_SET_START,
         E_GET_END,
         E_SET_END,
         E_GET_NAME,
         E_SET_NAME,
         E_GET_PRESET,
         E_SET_PRESET,
         E_GET_FULL_PRESETPATH,
         E_GET_SCENESTATE,
         E_SET_SCENESTATE,
         E_GET_ENABLED,
         E_SET_ENABLED,
 
         E_GET_FILENAME,
         E_SET_FILENAME,
 
         E_GET_ASPECT,
         E_SET_ASPECT,
         E_GET_OVERRIDE_PRESET,
         E_SET_OVERRIDE_PRESET,
     }; 

Member Function Documentation

virtual INode* GetCamera ( )

pure virtual

Get the camera that the batch render view is rendering.

Returns: A pointer to the camera node if the view has a valid camera node, NULL otherwise. When NULL, the current viewport will be used for rending

virtual bool SetCamera ( INode * node )

pure virtual

Set the camera that the batch render view is rendering.

Parameters

[in] node - The camera node to use, or NULL to render from the current viewport

Returns: true if the operation was successful, false if an error occurred

virtual int GetWidth ( )

pure virtual

Get the width of the rendering output.

Applicable only when the preset override is enabled.

Returns: The width of the output

See also: IBatchRenderView::GetOverridePreset

virtual bool SetWidth ( int width )

pure virtual

Set the width of the rendering output.

Applicable only when the preset override is enabled.

Parameters

[in] width - The width of the rendered output in pixels

Returns: true if the operation was successful, false if an error occurred

See also: IBatchRenderView::GetOverridePreset

virtual int GetHeight ( )

pure virtual

Get the height of the rendering output.

Applicable only when the preset override is enabled.

Returns: The height of the output

See also: IBatchRenderView::GetOverridePreset

virtual bool SetHeight ( int height )

pure virtual

Set the height of the rendering output.

Applicable only when the preset override is enabled.

Parameters

[in] height - The height of the rendered output in pixels

Returns: true if the operation was successful, false if an error occurred

See also: IBatchRenderView::GetOverridePreset

virtual TimeValue GetStart ( )

pure virtual

Get the start frame of the segment to render.

Applicable only when the preset override is enabled.

Returns: The time used for the start frame

See also: IBatchRenderView::GetOverridePreset

virtual void SetStart ( TimeValue start )

pure virtual

Set the start frame of the segment to render.

Applicable only when the preset override is enabled.

Parameters

[in] start - The time of the first frame to render

See also: IBatchRenderView::GetOverridePreset

virtual TimeValue GetEnd ( )

pure virtual

Get the end frame of the segment to render.

Applicable only when the preset override is enabled.

Returns: the time used for the end frame

See also: IBatchRenderView::GetOverridePreset

virtual void SetEnd ( TimeValue end )

pure virtual

Set the end frame of the segment to render.

Applicable only when the preset override is enabled.

Parameters

[in] end - The time of the last frame to render

See also: IBatchRenderView::GetOverridePreset

virtual const MCHAR* GetName ( )

pure virtual

Get the name of the batch render view.

Returns: The name of the batch render view

virtual bool SetName ( const MCHAR * name )

pure virtual

Set the name of the batch render view.

Batch render views must be unique in the same scene.

Parameters

[in] name - The new name of the batch render view

Returns: true if the operation was successful, false otherwise.

virtual const MaxSDK::AssetManagement::AssetUser& GetPresetFile ( )

pure virtual

Return the render preset used by the batch render view.

Returns: The filename of the render preset

virtual void SetPresetFile ( const MaxSDK::AssetManagement::AssetUser & preset )

pure virtual

Set the filename of the render preset used for the batch render view.

Parameters

[in] preset - The filename of the render preset

virtual bool GetFullPresetPath ( MSTR & path )

pure virtual

Get the fully qualified path to the render preset.

Parameters

[out] path - The fully qualified path of the render preset

Returns: true if successful, otherwise false

virtual const MCHAR* GetSceneState ( )

pure virtual

Get the scene state used by the batch render view.

Returns: The scene state used by the batch render view, or an empty string in case no scene state is used.

virtual void SetSceneState ( const MCHAR * sceneState )

pure virtual

Set the scene state to be used by the batch render view.

Parameters

[in] sceneState - The name of the scene state

virtual bool GetEnabled ( )

pure virtual

Check if the batch render view is enabled.

Returns: true if the batch render view is enabled, false otherwise

virtual void SetEnabled ( bool enabled )

pure virtual

Enable or disable the batch render view.

Parameters

[in] enabled - Set to true to enable the batch render the view, false to disable it

virtual BitmapInfo* GetFileOutputInfo ( )

pure virtual

Get the parameters of the output file for the batch render view.

Returns: An object representing the output parameters (filename, filetype, etc...) for the batch render view

virtual void SetFileOutputInfo ( BitmapInfo * bi )

pure virtual

Set the parameters of the output file for the batch render view.

Parameters

[in] bi - A BitmapInfo object to use when saving the file

virtual float GetAspect ( )

pure virtual

Get the pixel ascpect ratio used for the rendering.

Applicable only when the preset override is enabled.

Returns: The pixel aspect ratio

See also: IBatchRenderView::GetOverridePreset

virtual void SetAspect ( float pixelAspect )

pure virtual

Set the pixel aspect ratio used for the rendering.

Applicable only when the preset override is enabled.

Parameters

[in] pixelAspect - The pixel aspect ratio

See also: IBatchRenderView::GetOverridePreset

virtual bool GetOverridePreset ( )

pure virtual

Check if the render preset will be overridden for this batch render view.

If this flag is 'false', the value of the width, height, start, end and aspect parameters will be taken from the render preset, or the current render settings if no preset is used. Only if this flag is true will these settings be taken from the values in this batch render view

Returns: true if the settings in this batch render view will be used, false if the render preset or current render settings will be used.

virtual void SetOverridePreset ( bool override )

pure virtual

Set whether or not the render preset will be overridden for this batch render view.

If this flag is 'false', the value of the width, height, start, end and aspect parameters will be taken from the render preset, or the current render settings if no preset is used. Only if this flag is true will these settings be taken from the values in this batch render view

Parameters

[in] override - true to use the settings in this batch render view, false to use the current render settings or render preset.

IBatchRenderView Class Reference

Class Description

Public Types

Public Member Functions

Additional Inherited Members

Member Enumeration Documentation

Member Function Documentation