Camera set node function set. More...

#include <MFnCameraSet.h>

Inheritance diagram for MFnCameraSet:

Public Member Functions
virtual MFn::Type	type () const
	Function set type. More...

virtual	~MFnCameraSet ()
	Destructor.

	MFnCameraSet ()
	Default constructor.

	MFnCameraSet (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

MObject	create (MStatus *ReturnStatus=NULL)
	Creates a new cameraSet dependency node and puts it in the dependency graph. More...

MObject	create (const MDagPathArray &camList, MStatus *returnStatus=NULL)
	Creates a new cameraSet dependency node and puts it in the dependency graph. More...

MObject	create (const MString &name, MStatus *ReturnStatus=NULL)
	Creates a new cameraSet dependency node and puts it in the dependency graph. More...

MObject	create (const MDagPathArray &camList, const MObjectArray &setList, MStatus *returnStatus=NULL)
	Creates a new cameraSet dependency node and puts it in the dependency graph. More...

MObject	create (const MString &name, const MDagPathArray &camList, const MObjectArray &setList, MStatus *returnStatus=NULL)
	Creates a new cameraSet dependency node and puts it in the dependency graph. More...

MStatus	appendLayer (const MDagPath &camera, const MObject &set)
	Appends a layer to the associated cameraSet node. More...

MStatus	appendLayer (const MDagPath &camera)
	Appends a layer to the associated cameraSet node using the given camera. More...

MStatus	insertLayer (unsigned int index, const MDagPath &camera, const MObject &set)
	Inserts a layer at the given index to the associated cameraSet node using the given camera. More...

MStatus	insertLayer (unsigned int index, const MDagPath &camera)
	Inserts a layer at the given index to the associated cameraSet node using the given camera. More...

MStatus	deleteLayer (unsigned int index)
	Deletes the layer denoted by the given index. More...

MStatus	clear ()
	Clear all of the camera layers. More...

unsigned int	getNumLayers (MStatus *returnStatus=NULL)
	Return the number of layers in the cameraSet. More...

MStatus	setLayerCamera (unsigned int index, const MDagPath &camera)
	Set the camera to be used for a particular layer. More...

MStatus	getLayerCamera (unsigned int index, MDagPath &camera)
	Get the camera used for a particular layer. More...

MStatus	setLayerSceneData (unsigned int index, const MObject &set)
	Set the scene data to be used for a particular layer. More...

MStatus	getLayerSceneData (unsigned int index, MObject &set)
	Get the scene data used for a particular layer. More...

MStatus	setLayerActive (unsigned int index, bool isActive)
	Set a particular layer to be active. More...

bool	isLayerActive (unsigned int index, MStatus *returnStatus=NULL)
	Get whether a particular layer is active. More...

MStatus	setLayerOrder (unsigned int index, int order)
	Set the processing order of a particular layer. More...

MStatus	getLayerOrder (unsigned int index, int &order)
	Get the processing order of a particular layer. More...

MStatus	getSortedIndices (MUintArray &sortedIndices)
	Get a list of the layer indices, sorted by the order attribute. More...

MStatus	setLayerClearDepthValue (unsigned int index, bool depth)
	This method sets the clearDepth attribute for the specified camera layer. More...

MStatus	getLayerClearDepthValue (unsigned int index, bool &depth) const
	This method gets the clearDepth attribute value for the specified camera layer. More...

	MFnCameraSet (const MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

Public Member Functions inherited from MFnDependencyNode
virtual	~MFnDependencyNode ()
	Destructor.

	MFnDependencyNode ()
	Default constructor.

	MFnDependencyNode (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

MObject	create (const MTypeId &typeId, MStatus *ReturnStatus=NULL)
	Creates a new dependency node with the given type tag. More...

MObject	create (const MTypeId &typeId, const MString &name, MStatus *ReturnStatus=NULL)
	Creates a new dependency node with the given type tag. More...

MObject	create (const MString &type, MStatus *ReturnStatus=NULL)
	Creates a new dependency node with the given type. More...

MObject	create (const MString &type, const MString &name, MStatus *ReturnStatus=NULL)
	Creates a new dependency node with the given type. More...

MTypeId	typeId (MStatus *ReturnStatus=NULL) const
	Returns the type id of this node. More...

MString	typeName (MStatus *ReturnStatus=NULL) const
	Returns the type name of this node. More...

MString	name (MStatus *ReturnStatus=NULL) const
	Returns the name of this node. More...

MString	absoluteName (MStatus *ReturnStatus=NULL) const
	Returns the absolute name of this node. More...

MString	pluginName (MStatus *ReturnStatus=NULL) const
	Returns the name of the plug-in this MFnDependendencyNode was defined in. More...

MString	setName (const MString &name, bool createNamespace=false, MStatus *ReturnStatus=NULL)
	Sets the name of this node. More...

MUuid	uuid (MStatus *ReturnStatus=NULL) const
	Returns the node's UUID. More...

void	setUuid (const MUuid &uuid, MStatus *ReturnStatus=NULL)
	Sets the node's UUID. More...

MStatus	getConnections (MPlugArray &array) const
	Get all of the current connections to this node as an array of plugs. More...

unsigned int	attributeCount (MStatus *ReturnStatus=NULL) const
	Returns the number of attributes that this node has. More...

MObject	attribute (unsigned int index, MStatus *ReturnStatus=NULL) const
	Finds the attribute of this node at the given index. More...

MObject	reorderedAttribute (unsigned int index, MStatus *ReturnStatus=NULL) const
	Some nodes, such as the various animCurve nodes, require that their attributes be set in a specific order for proper operation. More...

MObject	attribute (const MString &attrName, MStatus *ReturnStatus=NULL) const
	Finds the attribute of this node that has the given name. More...

MAttrClass	attributeClass (const MObject &attr, MStatus *ReturnStatus=NULL) const
	Returns the class (normal, dynamic, extension) of the specified attribute. More...

MStatus	getAffectedAttributes (const MObject &attr, MObjectArray &affectedAttributes) const
	Returns an array of attributes that are affected by the attribute passed in. More...

MStatus	getAffectedByAttributes (const MObject &attr, MObjectArray &affectedByAttributes) const
	Returns an array of attributes that affect the attribute passed in, attr. More...

MPlug	findPlug (const MObject &attr, bool wantNetworkedPlug, MStatus *ReturnStatus=NULL) const
	Attempt to find a plug for the given attribute. More...

MPlug	findPlug (const MString &attrName, bool wantNetworkedPlug, MStatus *ReturnStatus=NULL) const
	Attempt to find a plug for the given attribute. More...

MPlug	findPlug (const MObject &attr, MStatus *ReturnStatus=NULL) const
	This method is obsolete. More...

MPlug	findPlug (const MString &attrName, MStatus *ReturnStatus=NULL) const
	This method is obsolete. More...

MStatus	addAttribute (const MObject &attr)
	Add a new dynamic attibute to this node. More...

MStatus	removeAttribute (const MObject &attr)
	Remove a dynamic attribute from a node. More...

MPxNode *	userNode (MStatus *ReturnStatus=NULL) const
	If the function set's node is a plug-in node, then this method will extract the MPxNode pointer from it. More...

bool	isFromReferencedFile (MStatus *ReturnStatus=NULL) const
	Indicates whether or not this node came from a referenced file. More...

bool	isShared (MStatus *ReturnStatus=NULL) const
	Indicates whether or not this node is shared. More...

bool	isTrackingEdits (MStatus *ReturnStatus=NULL) const
	Returns whether or not edits on the given node are being tracked by the generalized edit system. More...

bool	hasUniqueName (MStatus *ReturnStatus=NULL) const
	Indicates whether or not this node's name is unique within the scene. More...

MString	parentNamespace (MStatus *ReturnStatus=NULL) const
	Returns the name of the namespace in which this node resides. More...

bool	isLocked (MStatus *ReturnStatus=NULL) const
	Indicates whether or not this node is locked. More...

MStatus	setLocked (bool locked)
	Locks or unlocks this node. More...

bool	isNewAttribute (const MObject &attr, MStatus *ReturnStatus=NULL) const
	Indicates whether or not the specified attribute was added to this node within the current scene. More...

MStatus	setFlag (unsigned int flag, bool state)
	Sets the state of the specified flag for the node. More...

bool	isFlagSet (unsigned int flag, MStatus *ReturnStatus=NULL) const
	Retrieves the current state of the specified flag for a node. More...

bool	isDefaultNode (MStatus *ReturnStatus=NULL) const
	Returns true if the node is a default node. More...

MStatus	setDoNotWrite (bool flag)
	Use this method to mark the "do not write" state of this node. More...

bool	canBeWritten (MStatus *ReturnStatus=NULL) const
	Returns the do not write state of the node. More...

bool	hasAttribute (const MString &name, MStatus *ReturnStatus=NULL) const
	Returns true if the node already has an attribute with the given name. More...

MObject	getAliasAttr (bool force, MStatus *ReturnStatus=NULL)
	Returns the node's alias attribute, which is a special attribute used to store information about the node's attribute aliases. More...

bool	setAlias (const MString &alias, const MString &name, const MPlug &plug, bool add=true, MStatus *ReturnStatus=NULL)
	Sets or removes an alias (i.e. More...

bool	findAlias (const MString &alias, MObject &attrObj, MStatus *ReturnStatus=NULL) const
	Retrieves the attribute with the given alias. More...

bool	getAliasList (MStringArray &strArray, MStatus *ReturnStatus=NULL)
	Returns a list of all attribute aliases for this node. More...

MString	plugsAlias (const MPlug &plug, MStatus *ReturnStatus=NULL)
	Returns the alias for the plug's attribute or the empty string if that attribute has no alias. More...

MStatus	setIcon (const MString &filename)
	Associates a custom icon with the node for display in the Maya UI. More...

MString	icon (MStatus *ReturnStatus=NULL) const
	Returns the custom icon filename associated with the node. More...

MStatus	getExternalContent (MExternalContentInfoTable &table) const
	Returns the external content (files) that this node depends on. More...

MStatus	addExternalContentForFileAttr (MExternalContentInfoTable &table, const MObject &attr) const
	Adds content info to the specified table from a file path attribute. More...

MStatus	setExternalContentForFileAttr (const MObject &attr, const MExternalContentLocationTable &table)
	Sets content info in the specified attribute from the table. More...

MStatus	setExternalContent (const MExternalContentLocationTable &table)
	Changes the location of external content. More...

bool	affectsAnimation (MStatus *ReturnStatus=NULL) const
	Indicates whether or not this node is allowed to animate. More...

MStatus	setAffectsAnimation ()
	Define a node can affect animation. More...

MString	setName (const MString &name, MStatus *ReturnStatus)
	NO SCRIPT SUPPORT. More...

	MFnDependencyNode (const MObject &object, MStatus *ReturnStatus=NULL)
	NO SCRIPT SUPPORT. More...

bool	getPlugsAlias (const MPlug &plug, MString &aliasName, MStatus *ReturnStatus=NULL)
	NO SCRIPT SUPPORT. More...

virtual const adsk::Data::Associations *	metadata (MStatus *ReturnStatus=NULL) const
	This method is not available in Python. More...

virtual MStatus	setMetadata (const adsk::Data::Associations &)
	This method is not available in Python. More...

virtual MStatus	deleteMetadata ()
	This method is not available in Python. More...

virtual MStatus	validateMetadata (MString &errors) const
	This method is not available in Python. More...

MStatus	dgTimerOn ()
	Indicates that this node should collect DG timing data whenever DG timing is enabled. More...

MStatus	dgTimerOff ()
	Indicates that this node should no longer collect DG timing data when DG timing is enabled. More...

MdgTimerState	dgTimerQueryState (MStatus *ReturnStatus=NULL)
	The function returns the current on/off state of the node's timer. More...

MStatus	dgTimerReset ()
	The function resets the dependency graph timers and counters for this node to zero. More...

double	dgTimer (const MdgTimerMetric timerMetric, const MdgTimerType timerType, MStatus *ReturnStatus=NULL) const
	The function returns the specified timer value for the current node. More...

MStatus	dgCallbacks (const MdgTimerType type, MStringArray &callbackName, MDoubleArray &value)
	Node callbacks that occur when timing is enabled get logged with the node and can be queried via this method. More...

MStatus	dgCallbackIds (const MdgTimerType type, const MString &callbackName, MCallbackIdArray &callbackId, MDoubleArray &value)
	This method provides a further breakdown of the per-callback time returned via dgCallbacks() by returning the data on a per-callbackId basis. More...

MStatus	addAttribute (const MObject &attr, MAttrClass type)
	This method is obsolete. More...

MStatus	removeAttribute (const MObject &attr, MAttrClass type)
	This method is obsolete. More...

Public Member Functions inherited from MFnBase
virtual	~MFnBase ()
	Class Destructor. More...

bool	hasObj (MFn::Type) const
	Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...

bool	hasObj (const MObject &) const
	Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...

MObject	object (MStatus *ReturnStatus=NULL) const
	Returns the MObject that is attached to the Function Set. More...

virtual MStatus	setObject (MObject &object)
	Attaches the Function Set to the specified Maya Object. More...

virtual MStatus	setObject (const MObject &object)
	NO SCRIPT SUPPORT. More...

Static Public Member Functions
static const char *	className ()
	Returns the name of this class. More...

Static Public Member Functions inherited from MFnDependencyNode
static const char *	className ()
	Returns the name of this class. More...

static MString	classification (const MString &nodeTypeName)
	Retrieves the classification string for a node type. More...

static unsigned int	allocateFlag (const MString pluginName, MStatus *ReturnStatus=NULL)
	Allocates a node flag for sole use by the caller. More...

static MStatus	deallocateFlag (const MString pluginName, unsigned int flag)
	Deallocates a node flag which was previously allocated by a call to allocateFlag. More...

static MStatus	deallocateAllFlags (const MString pluginName)
	Deallocates all of the node flags which are currently allocated to the specified plugin. More...

static void	enableDGTiming (bool enable)
	Globally enables or disables the DG node timing mechanism. More...

Static Public Member Functions inherited from MFnBase
static const char *	className ()
	Returns the name of this class. More...

static const char *	typeString (MFn::Type)
	Returns the type string for a given type. More...

static bool	isValid (MFn::Type)
	Returns true if type is in the range of valid types. More...

Additional Inherited Members
Public Types inherited from MFnDependencyNode
enum	MAttrClass { kLocalDynamicAttr = 1, kNormalAttr, kExtensionAttr, kInvalidAttr }
	Specifies the scope of the attribute. More...

enum	MdgTimerState { kTimerOff, kTimerOn, kTimerUninitialized, kTimerInvalidState }
	Possible states for the node's timer. More...

enum	MdgTimerMetric { kTimerMetric_callback, kTimerMetric_compute, kTimerMetric_dirty, kTimerMetric_draw, kTimerMetric_fetch, kTimerMetric_callbackViaAPI, kTimerMetric_callbackNotViaAPI, kTimerMetric_computeDuringCallback, kTimerMetric_computeNotDuringCallback, kTimerMetrics }
	The different timer metrics which can be queried. More...

enum	MdgTimerType { kTimerType_self, kTimerType_inclusive, kTimerType_count, kTimerTypes }
	The types of timers which can be queried. More...

Detailed Description

Camera set node function set.

MFnCameraSet is the function set that is used for manipulating cameraSet nodes.

A cameraSet node defines a list of camera layeres to be processed in order, defining a multi-layer viewing of the scene. A camera layer consists of an object set to be used by the layer, and a camera through which the set is viewed. Individual layers may be marked active or inactive and ordered arbitrarily.

Examples:: cameraSetSubclass/testExCameraSetCmd.cpp, exampleCameraSetView/exampleCameraSetViewCmd.cpp, and testCameraSetCmd/testCameraSetCmd.cpp.

Constructor & Destructor Documentation

MFnCameraSet	(	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

MFnCameraSet	(	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

Function set type.

Return the class type : MFn::kCameraSet.

Returns: the class type.

Reimplemented from MFnDependencyNode.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( )

static

Returns the name of this class.

Return the class name : "MFnCameraSet".

Returns: Name of this class.

MObject create ( MStatus * returnStatus = NULL )

Creates a new cameraSet dependency node and puts it in the dependency graph.

Parameters

[out] returnStatus return status

Returns: A pointer to the new cameraSet node object.

Status Codes:

MS::kSuccess operation successful
MS::kLicenseFailure application not licensed for attempted operation
MS::kInsufficientMemory out of memory

Examples:: exampleCameraSetView/exampleCameraSetViewCmd.cpp, and testCameraSetCmd/testCameraSetCmd.cpp.

MObject create	(	const MDagPathArray &	camList,
		MStatus *	returnStatus = `NULL`
	)

Creates a new cameraSet dependency node and puts it in the dependency graph.

The method takes a list of cameras and creates a camera layer for each corresponding camera. Sets are not connected.

Parameters

[in]	camList	The list of cameras or stereo rigs
[out]	returnStatus	return status

Returns: A pointer to the new cameraSet node object.

Status Codes:

MS::kSuccess operation successful
MS::kLicenseFailure application not licensed for attempted operation
MS::kInsufficientMemory out of memory

MObject create	(	const MString &	name,
		MStatus *	returnStatus = `NULL`
	)

Creates a new cameraSet dependency node and puts it in the dependency graph.

Parameters

[in]	name	The name for the new cameraSet node
[out]	returnStatus	return status

Returns: A pointer to the new cameraSet node object.

Status Codes:

MS::kSuccess operation successful
MS::kLicenseFailure application not licensed for attempted operation
MS::kInsufficientMemory out of memory

MObject create	(	const MDagPathArray &	camList,
		const MObjectArray &	setList,
		MStatus *	returnStatus = `NULL`
	)

Creates a new cameraSet dependency node and puts it in the dependency graph.

The method takes a list of cameras and object sets and creates a camera layer for each corresponding camera and object set.

Parameters

[in]	camList	The list of cameras or stereo rigs
[in]	setList	The list of sets
[out]	returnStatus	return status

Returns: A pointer to the new cameraSet node object.

Status Codes:

MS::kSuccess operation successful
MS::kLicenseFailure application not licensed for attempted operation
MS::kInsufficientMemory out of memory

MObject create	(	const MString &	name,
		const MDagPathArray &	camList,
		const MObjectArray &	setList,
		MStatus *	returnStatus = `NULL`
	)

Creates a new cameraSet dependency node and puts it in the dependency graph.

The method takes a list of cameras and object sets and creates a camera layer for each corresponding camera and object set.

Parameters

[in]	name	The name for the new cameraSet node
[in]	camList	The list of cameras or stereo rigs
[in]	setList	The list of sets
[out]	returnStatus	return status

Returns: A pointer to the new cameraSet node object.

Status Codes:

MS::kSuccess operation successful
MS::kLicenseFailure application not licensed for attempted operation
MS::kInsufficientMemory out of memory

MStatus appendLayer	(	const MDagPath &	camera,
		const MObject &	set
	)

Appends a layer to the associated cameraSet node.

The given camera and object set are used in the layer. If MObject::kNullObj is passed as the set, then the whole scene will be rendered in the layer.

Parameters

[in]	camera	The camera or stereo rig for the layer
[in]	set	The set of objects used in the layer

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kInvalidObjectType camera and/or set incorrectly specified

Examples:: exampleCameraSetView/exampleCameraSetViewCmd.cpp, and testCameraSetCmd/testCameraSetCmd.cpp.

MStatus appendLayer ( const MDagPath & camera )

Appends a layer to the associated cameraSet node using the given camera.

The whole scene will be used with this layer as no object set is provided.

Parameters

[in] camera The camera or stereo rig for the layer

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kInvalidObjectType camera and/or set incorrectly specified

MStatus insertLayer	(	unsigned int	index,
		const MDagPath &	camera,
		const MObject &	set
	)

Inserts a layer at the given index to the associated cameraSet node using the given camera.

The index value must be in the range from 0 to the number of layers currently defined. The given camera and object set are used in the layer. If MObject::kNullObj is passed as the set, then the whole scene will be rendered in the layer.

Parameters

[in]	index	The index of the layer
[in]	camera	The camera for the layer
[in]	set	The set of objects used in the layer

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter The passed index was invalid
MS::kInvalidObjectType camera and/or set incorrectly specified

Examples:: testCameraSetCmd/testCameraSetCmd.cpp.

MStatus insertLayer	(	unsigned int	index,
		const MDagPath &	camera
	)

Inserts a layer at the given index to the associated cameraSet node using the given camera.

The index value must be in the range from 0 to the number of layers currently defined. The whole scene will be used with this layer as no object set is provided.

Parameters

[in]	index	The index of the layer
[in]	camera	The camera for the layer

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter The passed index was invalid
MS::kInvalidObjectType camera and/or set incorrectly specified

MStatus deleteLayer ( unsigned int index )

Deletes the layer denoted by the given index.

Parameters

[in] index The index of the layer

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter The passed index was invalid

Examples:: testCameraSetCmd/testCameraSetCmd.cpp.

MStatus clear ( )

Clear all of the camera layers.

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kFailure operation failed

Examples:: testCameraSetCmd/testCameraSetCmd.cpp.

unsigned int getNumLayers ( MStatus * returnStatus = NULL )

Return the number of layers in the cameraSet.

Parameters

[out] returnStatus The return status

Returns: The number of layers

Status Codes:

MS::kSuccess operation successful
MS::kFailure operation failed

Examples:: exampleCameraSetView/exampleCameraSetViewCmd.cpp, and testCameraSetCmd/testCameraSetCmd.cpp.

MStatus setLayerCamera	(	unsigned int	index,
		const MDagPath &	camera
	)

Set the camera to be used for a particular layer.

Parameters

[in]	index	The index of the layer
[in]	camera	The camera for the layer

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter The passed index was invalid
MS::kInvalidObjectType Camera and/or set incorrectly specified
MS::kFailure The operation failed

Examples:: testCameraSetCmd/testCameraSetCmd.cpp.

MStatus getLayerCamera	(	unsigned int	index,
		MDagPath &	camera
	)

Get the camera used for a particular layer.

Parameters

[in]	index	The index of the layer
[out]	camera	The camera for the layer

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter The passed index was invalid
MS::kFailure The operation failed

Examples:: exampleCameraSetView/exampleCameraSetViewCmd.cpp, and testCameraSetCmd/testCameraSetCmd.cpp.

MStatus setLayerSceneData	(	unsigned int	index,
		const MObject &	set
	)

Set the scene data to be used for a particular layer.

Parameters

[in]	index	The index of the layer
[in]	set	The object set for the layer

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter The passed index was invalid
MS::kInvalidObjectType The set was incorrectly specified
MS::kFailure The operation failed

Examples:: testCameraSetCmd/testCameraSetCmd.cpp.

MStatus getLayerSceneData	(	unsigned int	index,
		MObject &	set
	)

Get the scene data used for a particular layer.

The returned scene data could be MObject::kNullObj if no scene data has been set. The operation will still be deemed successful.

Parameters

[in]	index	The index of the layer
[out]	set	The object set for the layer

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter The passed index was invalid
MS::kFailure The operation failed

Examples:: testCameraSetCmd/testCameraSetCmd.cpp.

MStatus setLayerActive	(	unsigned int	index,
		bool	isActive
	)

Set a particular layer to be active.

Parameters

[in]	index	The index of the layer
[in]	isActive	Whether the layer should be processed

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter The passed index was invalid
MS::kFailure The operation failed

Examples:: testCameraSetCmd/testCameraSetCmd.cpp.

bool isLayerActive	(	unsigned int	index,
		MStatus *	returnStatus = `NULL`
	)

Get whether a particular layer is active.

Parameters

[in]	index	The index of the layer
[out]	returnStatus	The return status

Returns: Whether the layer is being processed

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter The passed index was invalid
MS::kFailure The operation failed

Examples:: testCameraSetCmd/testCameraSetCmd.cpp.

MStatus setLayerOrder	(	unsigned int	index,
		int	order
	)

Set the processing order of a particular layer.

Parameters

[in]	index	The index of the layer
[in]	order	The order number

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter The passed index was invalid
MS::kFailure The operation failed

Examples:: testCameraSetCmd/testCameraSetCmd.cpp.

MStatus getLayerOrder	(	unsigned int	index,
		int &	order
	)

Get the processing order of a particular layer.

Parameters

[in]	index	The index of the layer
[out]	order	The processing order

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter The passed index was invalid
MS::kFailure The operation failed

Examples:: testCameraSetCmd/testCameraSetCmd.cpp.

MStatus getSortedIndices ( MUintArray & sortedIndices )

Get a list of the layer indices, sorted by the order attribute.

Parameters

[out] sortedIndices The sorted indices

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kFailure The operation failed

MStatus setLayerClearDepthValue	(	unsigned int	index,
		bool	depth
	)

This method sets the clearDepth attribute for the specified camera layer.

Parameters

[in]	index	The index of the layer
[in]	depth	The clear depth value

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter The passed index was invalid
MS::kFailure The operation failed

MStatus getLayerClearDepthValue	(	unsigned int	index,
		bool &	depth
	)		const

This method gets the clearDepth attribute value for the specified camera layer.

Parameters

[in]	index	The index of the layer
[out]	depth	The clear depth value

Returns: Status Code

Status Codes:

MS::kSuccess operation successful
MS::kInvalidParameter The passed index was invalid
MS::kFailure The operation failed

The documentation for this class was generated from the following files:

MFnCameraSet.h
MFnCameraSet.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation