PreviewParams Class Reference
#include <maxapi.h>
Inheritance diagram for PreviewParams:
Public Attributes | |
| BOOL | outputType |
| Specifies the output file or device. More... | |
| int | pctSize |
| Specifies the percentage (0-100) of current rendering output resolution. More... | |
| int | start |
| The start frame limit. More... | |
| int | end |
| The end frame limit. More... | |
| int | skip |
| Specifies how many frames are skipped between rendered frames. More... | |
| int | fps |
| The frames per second setting. More... | |
| BOOL | dspGeometry |
| If TRUE is displayed in the viewports; otherwise it is not shown. More... | |
| BOOL | dspShapes |
| If TRUE shapes are displayed in the preview; otherwise they are not shown. More... | |
| BOOL | dspLights |
| If TRUE lights are displayed in the preview; otherwise they are not shown. More... | |
| BOOL | dspCameras |
| If TRUE cameras are displayed in the preview; otherwise they are not shown. More... | |
| BOOL | dspHelpers |
| If TRUE helper objects are displayed in the preview; otherwise they are not shown. More... | |
| BOOL | dspSpaceWarps |
| If TRUE space warp helper objects are displayed in the preview; otherwise they are not shown. More... | |
| BOOL | dspParticles |
| If TRUE particle objects are displayed in the preview; otherwise they are not shown. More... | |
| BOOL | dspBones |
| If TRUE bone objects are displayed in the preview; otherwise they are not shown. More... | |
| BOOL | dspGrid |
| If TRUE the grid lines are displayed in the preview; otherwise they are not shown. More... | |
| BOOL | dspSafeFrame |
| If TRUE the safe frames are displayed in the preview; otherwise they are not shown. More... | |
| BOOL | dspFrameNums |
| If TRUE frame numbers are shown in the preview; otherwise they are not shown. More... | |
| BOOL | dspBkg |
| If TRUE the background image is displayed; otherwise it is not used. More... | |
| int | rndLevel |
| Specifies the rendering level used: 0=smooth/hi, 1=smooth, 2=facet/hi, 3=facet, 4=flat, 5=hidden line 6=lit wire, 7=wire, 8=box. More... | |
| BOOL | useMPCamEffect |
| If TRUE multipass camera effects are displayed in the preview; otherwise they are not shown. 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... | |
Detailed Description
- See also
- Class Interface.
- Description:
- The data members of this class are used to specify the options for creating a preview of the active viewport. A pointer to an instance of this class is passed into the Interface method:
virtual void CreatePreview(PreviewParams *pvp=nullptr, MSTR *filename=nullptr, MSTR *snippet = nullptr, MAXScript::ScriptSource source = MAXScript::ScriptSource::NotSpecified)=0;
Member Data Documentation
◆ outputType
| BOOL outputType |
Specifies the output file or device.
0=default AVI codec, 1=user picks file, 2=user picks device
◆ pctSize
| int pctSize |
Specifies the percentage (0-100) of current rendering output resolution.
◆ start
| int start |
The start frame limit.
◆ end
| int end |
The end frame limit.
◆ skip
| int skip |
Specifies how many frames are skipped between rendered frames.
The is similar to the 'Every Nth Frame' parameter in the user interface.
◆ fps
| int fps |
The frames per second setting.
◆ dspGeometry
| BOOL dspGeometry |
If TRUE is displayed in the viewports; otherwise it is not shown.
◆ dspShapes
| BOOL dspShapes |
If TRUE shapes are displayed in the preview; otherwise they are not shown.
◆ dspLights
| BOOL dspLights |
If TRUE lights are displayed in the preview; otherwise they are not shown.
◆ dspCameras
| BOOL dspCameras |
If TRUE cameras are displayed in the preview; otherwise they are not shown.
◆ dspHelpers
| BOOL dspHelpers |
If TRUE helper objects are displayed in the preview; otherwise they are not shown.
◆ dspSpaceWarps
| BOOL dspSpaceWarps |
If TRUE space warp helper objects are displayed in the preview; otherwise they are not shown.
◆ dspParticles
| BOOL dspParticles |
If TRUE particle objects are displayed in the preview; otherwise they are not shown.
◆ dspBones
| BOOL dspBones |
If TRUE bone objects are displayed in the preview; otherwise they are not shown.
◆ dspGrid
| BOOL dspGrid |
If TRUE the grid lines are displayed in the preview; otherwise they are not shown.
◆ dspSafeFrame
| BOOL dspSafeFrame |
If TRUE the safe frames are displayed in the preview; otherwise they are not shown.
◆ dspFrameNums
| BOOL dspFrameNums |
If TRUE frame numbers are shown in the preview; otherwise they are not shown.
◆ dspBkg
| BOOL dspBkg |
If TRUE the background image is displayed; otherwise it is not used.
◆ rndLevel
| int rndLevel |
Specifies the rendering level used: 0=smooth/hi, 1=smooth, 2=facet/hi, 3=facet, 4=flat, 5=hidden line 6=lit wire, 7=wire, 8=box.
◆ useMPCamEffect
| BOOL useMPCamEffect |
If TRUE multipass camera effects are displayed in the preview; otherwise they are not shown.
