#include
<MFnCameraSet.h>
List of all
members.
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.
|
Public Member Functions
|
virtual MFn::Type |
type
() const |
|
Function set type.
|
virtual |
~MFnCameraSet
() |
|
Destructor.
|
|
MFnCameraSet
() |
|
Default constructor.
|
|
MFnCameraSet
(MObject &object,
MStatus
*ReturnStatus=NULL) |
|
Constructor.
|
MObject |
create
(MStatus
*ReturnStatus=NULL) |
MObject |
create
(const MDagPathArray &camList,
MStatus
*returnStatus=NULL) |
MObject |
create
(const MString
&name, MStatus
*ReturnStatus=NULL) |
MObject |
create
(const MDagPathArray &camList, const
MObjectArray
&setList, MStatus
*returnStatus=NULL) |
MObject |
create
(const MString
&name, const MDagPathArray &camList, const
MObjectArray
&setList, MStatus
*returnStatus=NULL) |
MStatus |
appendLayer
(const MDagPath
&camera, const MObject &set) |
MStatus |
appendLayer
(const MDagPath
&camera) |
MStatus |
insertLayer
(unsigned int index, const MDagPath &camera, const MObject &set) |
MStatus |
insertLayer
(unsigned int index, const MDagPath &camera) |
MStatus |
deleteLayer
(unsigned int index) |
MStatus |
clear
() |
unsigned int |
getNumLayers
(MStatus
*returnStatus=NULL) |
MStatus |
setLayerCamera
(unsigned int index, const MDagPath &camera) |
MStatus |
getLayerCamera
(unsigned int index, MDagPath &camera) |
MStatus |
setLayerSceneData
(unsigned int index, const MObject &set) |
MStatus |
getLayerSceneData
(unsigned int index, MObject &set) |
MStatus |
setLayerActive
(unsigned int index, bool isActive) |
bool |
isLayerActive
(unsigned int index, MStatus *returnStatus=NULL) |
MStatus |
setLayerOrder
(unsigned int index, int order) |
MStatus |
getLayerOrder
(unsigned int index, int &order) |
MStatus |
getSortedIndices
(MUintArray
&sortedIndices) |
|
MFnCameraSet
(const MObject
&object, MStatus
*ReturnStatus=NULL) |
|
Constructor.
|
Protected Member Functions
|
virtual const char * |
className
() const |
|
Class name.
|
Constructor & Destructor Documentation
MFnCameraSet::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:
-
MFnCameraSet::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:
-
Member Function Documentation
MFn::Type
MFnCameraSet::type |
( |
|
) |
const [virtual] |
const char * MFnCameraSet::className |
( |
|
) |
const [protected, virtual] |
Class name.
Return the class name : "MFnCameraSet"
Reimplemented from MFnDependencyNode.
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:
-
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:
-
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:
-
Reimplemented from MFnDependencyNode.
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:
-
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:
-
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
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
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:
-
MStatus MFnCameraSet::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:
-
MStatus MFnCameraSet::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:
-
Clear all of the camera layers.
- Returns:
- Status Code
- Status Codes:
-
unsigned int MFnCameraSet::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:
-
MStatus MFnCameraSet::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:
-
MStatus MFnCameraSet::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:
-
MStatus
MFnCameraSet::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:
-
MStatus
MFnCameraSet::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:
-
MStatus MFnCameraSet::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:
-
bool MFnCameraSet::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:
-
MStatus MFnCameraSet::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:
-
MStatus MFnCameraSet::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:
-
Get a list of the layer indices, sorted by the order
attribute.
- Parameters:
-
[out] |
sortedIndices |
The sorted indices |
- Returns:
- Status Code
- Status Codes:
-