class MCommonRenderSettingsData

Jump to documentation

public members:

	MCommonRenderSettingsData ()
	~MCommonRenderSettingsData ()
bool	isAnimated () const
bool	isMovieFormat () const
void	setPassName (const MString & pass) Used with getImageName. Sets the pass name for later use.
void	setFieldName (const MString & field) Used with getImageName. Sets the field name for later use.
const MString	getImageName ( MpathType pathType, double frameNumber, const MString & sceneName, const MString & cameraName, const MString & fileFormat, const MObject layer, const bool createDirectory = true, MStatus * ReturnStatus = NULL) const Obtains the image name with the proper subdirectory structure.
MString	name Base name for the rendered image
unsigned int	namingScheme File naming scheme.
unsigned int	framePadding Number of padding zeros for the frame number
MString	namePattern Single string that defines the whole naming convention
unsigned int	imageFormat Predefined supported image format
MString	customImageFormat Custom image format name
MTime	frameStart First frame number
MTime	frameEnd Last frame number
float	frameBy Frame number step
bool	renderAll When false, only the selected objects should be rendered
bool	useCustomExt When true, overrides the default image format extension
MString	customExt Custom format extension, when useCustomExt is true
bool	renumberFrames When true, images need to be renumbered. This only affects the image names.
float	renumberStart First image number, when renumbering
float	renumberBy Image number step, when renumbering
unsigned int	width Image width in pixels
unsigned int	height Image height in pixels
float	deviceAspectRatio Image aspect ratio. This is equal to pixelAspect * width / height
float	pixelAspectRatio Pixel aspect ratio
float	dotPerInch Dot per Inch
bool	enableDefaultLight When on, a default light should be created when no light is available in the scene.
MString	preMel The mel string to be executed before a scene is rendered
MString	postMel The mel string to be executed after a scene is rendered
MString	preRenderLayerMel The mel string to be executed before a render layer is rendered
MString	postRenderLayerMel The mel string to be executed after a render layer is rendered
MString	preRenderMel The mel string to be executed before a frame is rendered
MString	postRenderMel The mel string to be executed after a frame is rendered

Documentation

Description

MCommonRenderSettingsData is a container class that encapsulates the data for common rendering globals. The data is intended to be accessed with method MRenderUtil::getCommonRenderSettings(MCommonRenderSettingsData)

Functions

MCommonRenderSettingsData:: MCommonRenderSettingsData ()

Description

Default contructor

MCommonRenderSettingsData:: ~MCommonRenderSettingsData ()

Description

Default destructor

bool MCommonRenderSettingsData:: isAnimated () const

Description

Use namingScheme to determine if there is animation.

bool MCommonRenderSettingsData:: isMovieFormat () const

Description

Use imageFormat to determine if images will be stored in a single movie file.

const MString MCommonRenderSettingsData:: getImageName ( MpathType pathType, double frameNumber, const MString & sceneName, const MString & cameraName, const MString & fileFormat, const MObject layer, const bool createDirectory, MStatus * ReturnStatus) const

Description

Compute the path for the image. The path type returned depends on which option has been specified by pathType:

• kRelativePath returns the image name with its relative path (only the extra subdirs created within the base image dir)

• kFullPathImage returns the image full path with its path to the image dir

• kFullPathTmp returns the image full path with its path to the temp image dir

Arguments

• pathType decides file path format of the returned string. See above.
• frameNumber the frame number to be used.
• sceneName the scene name.
• cameraName the name of the camera rendering this image.
• fileFormat if not an empty string, use this file format instead of the one selected in the render settings to decide the final file name.
• layer render layer object from which this image is rendered.
• createDirectory if true, the image path directory will be created.
• ReturnStatus Status code

void MCommonRenderSettingsData:: setPassName (const MString & pass)

Description

Adds a pass subdirectory to the path for the image.

void MCommonRenderSettingsData:: setFieldName (const MString & field)

Description

Adds a field subdirectory to the path for the image.

This class has no child classes.