- Main Page
- Related Pages
- Modules
- Classes
- Examples

- Class List
- Class Hierarchy
- Class Members

Public Member Functions | Protected Member Functions

# MFnImageSource Class Reference

# OpenMayaRender - API module for rendering | FunctionSet classes

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:
[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] | object | The MObject to attach the function set to
  [out] | ReturnStatus | the return status

Status Codes:
  - MS::kSuccess if the function set is successfully attached
  - MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnImageSource | ( | const MObject & | object,
|  | MStatus * | ReturnStatus = `NULL`
| ) |  |

Constructor.

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

Parameters:

  [in] | object | The MObject to attach the function set to
  [out] | ReturnStatus | the return status

Status Codes:
  - MS::kSuccess if the function set is successfully attached
  - MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

## Member Function Documentation

MFn::Type type | ( |  | ) | const `[virtual]`

Search for all occurrences

Function set type.

Return the class type : MFn::kImageSource.

Reimplemented from MFnDependencyNode.

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

Search for all occurrences

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

Search for all occurrences

Return image path associated with this image source.

Parameters:

  [in] | pathType | Project relative, full, or temporary directory.
  [in] | frameNumber | Desired frame in image sequence.
  [in] | sceneName | Scene for which image was rendered.
  [in] | camera | Parent transform of the camera used to render the scene.
  [in] | renderLayer | Render layer used to render scene.
  [out] | bufferName | Name of the buffer containing the image, used with OpenEXR files.
  [out] | ReturnStatus | Status code.

Returns:
  Path to image file.

Status Codes:
  - MS::kSuccess The method was successful.
  - MS::kFailure An object error has occurred.
  - MS::kInvalidParameter 'camera' is not a valid camera node, or 'renderLayer' is not a valid render layer node.

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