MFnAreaLight Class Reference
[OpenMaya - API module for common classesFunctionSet classes]

#include <MFnAreaLight.h>
Inheritance diagram for MFnAreaLight:
Inheritance graph
[legend]
Collaboration diagram for MFnAreaLight:
Collaboration graph
[legend]

List of all members.


Detailed Description

Manage Area Light dependency Nodes.

MFnAreaLight facilitates creation and manipulation of dependency graph nodes representing area lights.


Public Member Functions

virtual MFn::Type  type () const
  Function set type.
virtual  ~MFnAreaLight ()
  Destructor.
  MFnAreaLight ()
  Default constructor.
  MFnAreaLight (MObject &object, MStatus *ReturnStatus=NULL)
  Constructor.
  MFnAreaLight (const MDagPath &object, MStatus *ret=NULL)
  Constructor.
MObject  create (bool UIvisible=true, MStatus *ReturnStatus=NULL)
MObject  create (const MObject &parent, bool UIvisible=true, bool wantTransform=false, MStatus *ReturnStatus=NULL)
  MFnAreaLight (const MObject &object, MStatus *ret=NULL)
  Constructor.
MObject  create (const MObject &parent, bool UIvisible=true, MStatus *ReturnStatus=NULL)
  NO SCRIPT SUPPORT.

Protected Member Functions

virtual const char *  className () const
  Class name.

Constructor & Destructor Documentation

MFnAreaLight::~MFnAreaLight (  )  [virtual]

Destructor.

The class destructor.

MFnAreaLight::MFnAreaLight ( 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:

MFnAreaLight::MFnAreaLight ( const MDagPath object,
MStatus ReturnStatus = NULL  
)

Constructor.

Class constructor that initializes the function set to the given constant MDagPath object.

Parameters:
[in]  object  The const MDagPath to attach the function set to
[out]  ReturnStatus  The return status
Status Codes:

MFnAreaLight::MFnAreaLight ( 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 MFnAreaLight::type (  )  const [virtual]

Function set type.

Return the class type : MFn::kAreaLight

Reimplemented from MFnNonExtendedLight.

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

Class name.

Return the class name : "MFnAreaLight"

Reimplemented from MFnNonExtendedLight.

MObject MFnAreaLight::create ( bool  UIvisible = true,
MStatus ReturnStatus = NULL  
)

Creates a new area light dependency graph node and adds it to the dependency graph. If the UIvisible parameter is true, the new node will be connected to the light classification node (which allows the UI to recognize the node as a light) and added to the default light list. If UIvisible is false, the node will be created in isolation.

The light node is added to the current model, under a new transformation.

Parameters:
[in]  UIvisible  determines whether or not to connect the new node to the light classification node and add it to the default light list.
[out]  ReturnStatus  return status
Returns:
MObject representing the new dependency node.
Status Codes:

MObject MFnAreaLight::create ( const MObject parent,
bool  UIvisible = true,
bool  wantTransform = false,
MStatus ReturnStatus = NULL  
)

Creates a new area light dependency graph node and adds it to the dependency graph. If the UIvisible parameter is true, the new node will be connected to the light classification node (which allows the UI to recognize the node as a light) and added to the default light list. If UIvisible is false, the node will be created in isolation.

If wantTransform parameter is false ( which is by default ), the new shape node is created under the specified parent and no transform node is created. If the specified parent is null, then no shape node will be created.

The light node is added to the current model, under the specified parent.

Parameters:
[in]  parent  the node under which the new light and its transform will be added.
[in]  wantTransform  Boolean to indicate whether the transform node is needed or not, which is 'false' by default.
[in]  UIvisible  determines whether or not to connect the new node to the light classification node and add it to the default light list.
[out]  ReturnStatus  return status
Returns:
MObject representing the new dependency node.
Status Codes:

MObject MFnAreaLight::create ( const MObject parent,
bool  UIvisible = true,
MStatus ReturnStatus = NULL  
)

NO SCRIPT SUPPORT.

Creates a new area light dependency graph node and adds it to the dependency graph. If the UIvisible parameter is true, the new node will be connected to the light classification node (which allows the UI to recognize the node as a light) and added to the default light list. If UIvisible is false, the node will be created in isolation.

The light node is added to the current model, under a new transformation. The transformation is added to the current model under the specified parent.

Parameters:
[in]  parent  the node under which the new light and its transform will be added.
[in]  UIvisible  determines whether or not to connect the new node to the light classification node and add it to the default light list.
[out]  ReturnStatus  return status
Returns:
MObject representing the new dependency node.
Status Codes:

Autodesk® Maya® 2011 © 1997-2010 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6