Public Member Functions | Protected Member Functions

MFnImageSource Class Reference

Search for all occurrences

Detailed Description

Function set for image sources.

An image source is a node that is used in render graphs, e.g. compositing graphs, shading networks. It provides access to the images produced by 3D scene renderers, or 2D image processing tasks. This class provides functionality for working with image sources, e.g. retrieving the path of rendered image source files.

#include <MFnImageSource.h>

Inheritance diagram for MFnImageSource:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnImageSource ()
 Destructor.
 MFnImageSource ()
 Default constructor.
 MFnImageSource (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
MString getImageName (MCommonRenderSettingsData::MpathType pathType, double frameNumber, const MString &sceneName, const MObject camera, const MObject renderLayer, MString *bufferName=NULL, MStatus *ReturnStatus=NULL) const
 Return image path associated with this image source.
 MFnImageSource (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

MFnImageSource ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
MFnImageSource ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:

Member Function Documentation

MFn::Type type ( ) const [virtual]

Function set type.

Return the class type : MFn::kImageSource.

Reimplemented from MFnDependencyNode.

const char * className ( ) const [protected, virtual]

Class name.

Return the class name : "MFnImageSource".

Reimplemented from MFnDependencyNode.

MString getImageName ( MCommonRenderSettingsData::MpathType  pathType,
double  frameNumber,
const MString sceneName,
const MObject  camera,
const MObject  renderLayer,
MString bufferName = NULL,
MStatus ReturnStatus = NULL 
) const

Return image path associated with this image source.

Parameters:
[in]pathTypeProject relative, full, or temporary directory.
[in]frameNumberDesired frame in image sequence.
[in]sceneNameScene for which image was rendered.
[in]cameraParent transform of the camera used to render the scene.
[in]renderLayerRender layer used to render scene.
[out]bufferNameName of the buffer containing the image, used with OpenEXR files.
[out]ReturnStatusStatus code.
Returns:
Path to image file.
Status Codes:

MFnImageSource MFnImageSource MFnImageSource MFnImageSource MFnImageSource MFnImageSource MFnImageSource MFnImageSource MFnImageSource MFnImageSource
MFnImageSource MFnImageSource MFnImageSource MFnImageSource MFnImageSource MFnImageSource MFnImageSource MFnImageSource MFnImageSource MFnImageSource