Detailed 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.
#include <IBatchRenderManager.h>
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 Member Functions |
|
| virtual INode * | GetCamera ()=0 |
| Get the camera that the batch render view is
rendering. |
|
| virtual bool | SetCamera (INode *node)=0 |
| Set the camera that the batch render view is
rendering. |
|
| virtual int | GetWidth ()=0 |
| Get the width of the rendering output.
|
|
| virtual bool | SetWidth (int width)=0 |
| Set the width of the rendering output.
|
|
| virtual int | GetHeight ()=0 |
| Get the height of the rendering output.
|
|
| virtual bool | SetHeight (int height)=0 |
| Set the height of the rendering output.
|
|
| virtual TimeValue | GetStart ()=0 |
| Get the start frame of the segment to
render. |
|
| virtual void | SetStart (TimeValue start)=0 |
| Set the start frame of the segment to
render. |
|
| virtual TimeValue | GetEnd ()=0 |
| Get the end frame of the segment to render.
|
|
| virtual void | SetEnd (TimeValue end)=0 |
| Set the end frame of the segment to render.
|
|
| virtual const MCHAR * | GetName ()=0 |
| Get the name of the batch render view.
|
|
| virtual bool | SetName (const MCHAR *name)=0 |
| Set the name of the batch render view.
|
|
| virtual
const MaxSDK::AssetManagement::AssetUser & |
GetPresetFile ()=0 |
| Return the render preset used by the batch
render view. |
|
| virtual void | SetPresetFile (const MaxSDK::AssetManagement::AssetUser &preset)=0 |
| Set the filename of the render preset used
for the batch render view. |
|
| virtual bool | GetFullPresetPath (MSTR &path)=0 |
| Get the fully qualified path to the render
preset. |
|
| virtual const MCHAR * | GetSceneState ()=0 |
| Get the scene state used by the batch render
view. |
|
| virtual void | SetSceneState (const MCHAR *sceneState)=0 |
| Set the scene state to be used by the batch
render view. |
|
| virtual bool | GetEnabled ()=0 |
| Check if the batch render view is enabled.
|
|
| virtual void | SetEnabled (bool enabled)=0 |
| Enable or disable the batch render view.
|
|
| virtual BitmapInfo * | GetFileOutputInfo ()=0 |
| Get the parameters of the output file for
the batch render view. |
|
| virtual void | SetFileOutputInfo (BitmapInfo *bi)=0 |
| Set the parameters of the output file for
the batch render view. |
|
| virtual float | GetAspect ()=0 |
| Get the pixel ascpect ratio used for the
rendering. |
|
| virtual void | SetAspect (float pixelAspect)=0 |
| Set the pixel aspect ratio used for the
rendering. |
|
| virtual bool | GetOverridePreset ()=0 |
| Check if the render preset will be
overridden for this batch render view. |
|
| virtual void | SetOverridePreset (bool override)=0 |
| Set whether or not the render preset will be
overridden for this batch render view. |
|
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,
};
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.
