PreviewParams Class Reference
 
 
 
PreviewParams Class Reference

#include <maxapi.h>

Inheritance diagram for PreviewParams:
MaxHeapOperators

Class 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=NULL)=0;

Public Attributes

BOOL  outputType
  Specifies the output file or device.
int  pctSize
  Specifies the percentage (0-100) of current rendering output resolution.
int  start
  The start frame limit.
int  end
  The end frame limit.
int  skip
  Specifies how many frames are skipped between rendered frames.
int  fps
  The frames per second setting.
BOOL  dspGeometry
  If TRUE is displayed in the viewports; otherwise it is not shown.
BOOL  dspShapes
  If TRUE shapes are displayed in the preview; otherwise they are not shown.
BOOL  dspLights
  If TRUE lights are displayed in the preview; otherwise they are not shown.
BOOL  dspCameras
  If TRUE cameras are displayed in the preview; otherwise they are not shown.
BOOL  dspHelpers
  If TRUE helper objects are displayed in the preview; otherwise they are not shown.
BOOL  dspSpaceWarps
  If TRUE space warp helper objects are displayed in the preview; otherwise they are not shown.
BOOL  dspParticles
  If TRUE particle objects are displayed in the preview; otherwise they are not shown.
BOOL  dspBones
  If TRUE bone objects are displayed in the preview; otherwise they are not shown.
BOOL  dspGrid
  If TRUE the grid lines are displayed in the preview; otherwise they are not shown.
BOOL  dspSafeFrame
  If TRUE the safe frames are displayed in the preview; otherwise they are not shown.
BOOL  dspFrameNums
  If TRUE frame numbers are shown in the preview; otherwise they are not shown.
BOOL  dspBkg
  If TRUE the background image is displayed; otherwise it is not used.
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.
BOOL  useMPCamEffect
  If TRUE multipass camera effects are displayed in the preview; otherwise they are not shown.

Member Data Documentation

BOOL outputType

Specifies the output file or device.

0=default AVI codec, 1=user picks file, 2=user picks device

int pctSize

Specifies the percentage (0-100) of current rendering output resolution.

int start

The start frame limit.

int end

The end frame limit.

int skip

Specifies how many frames are skipped between rendered frames.

The is similar to the 'Every Nth Frame' parameter in the user interface.

int fps

The frames per second setting.

If TRUE is displayed in the viewports; otherwise it is not shown.

BOOL dspShapes

If TRUE shapes are displayed in the preview; otherwise they are not shown.

BOOL dspLights

If TRUE lights are displayed in the preview; otherwise they are not shown.

BOOL dspCameras

If TRUE cameras are displayed in the preview; otherwise they are not shown.

BOOL dspHelpers

If TRUE helper objects are displayed in the preview; otherwise they are not shown.

If TRUE space warp helper objects are displayed in the preview; otherwise they are not shown.

If TRUE particle objects are displayed in the preview; otherwise they are not shown.

BOOL dspBones

If TRUE bone objects are displayed in the preview; otherwise they are not shown.

BOOL dspGrid

If TRUE the grid lines are displayed in the preview; otherwise they are not shown.

If TRUE the safe frames are displayed in the preview; otherwise they are not shown.

If TRUE frame numbers are shown in the preview; otherwise they are not shown.

BOOL dspBkg

If TRUE the background image is displayed; otherwise it is not used.

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.

If TRUE multipass camera effects are displayed in the preview; otherwise they are not shown.