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

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

List of all members.


Detailed Description

Manage Non-extended Light dependency Nodes.

MFnNonExtendedLight facilitates manipulation of dependency graph nodes representing non-extended lights. This includes point lights, directional lights, and spotlights.


Public Member Functions

virtual MFn::Type  type () const
  Function set type.
virtual  ~MFnNonExtendedLight ()
  Destructor.
  MFnNonExtendedLight ()
  Default constructor.
  MFnNonExtendedLight (MObject &object, MStatus *ReturnStatus=NULL)
  Constructor.
  MFnNonExtendedLight (const MDagPath &object, MStatus *ret=NULL)
  Constructor.
float  shadowRadius (MStatus *ReturnStatus=NULL) const
MStatus  setShadowRadius (const float &shadow_radius)
bool  castSoftShadows (MStatus *ReturnStatus=NULL) const
MStatus  setCastSoftShadows (const bool &cast_soft_shadows)
bool  useDepthMapShadows (MStatus *ReturnStatus=NULL) const
MStatus  setUseDepthMapShadows (const bool &use_depth_map)
short  depthMapFilterSize (MStatus *ReturnStatus) const
MStatus  setDepthMapFilterSize (const short &depth_map_filter_size)
short  depthMapResolution (MStatus *ReturnStatus) const
MStatus  setDepthMapResolution (const short &depth_map_resolution)
float  depthMapBias (MStatus *ReturnStatus) const
MStatus  setDepthMapBias (const float &depth_map_bias)
bool  useDepthMapAutoFocus (MStatus *ReturnStatus=NULL) const
MStatus  setUseDepthMapAutoFocus (const bool use_depth_map_auto_focus)
float  depthMapWidthFocus (MStatus *ReturnStatus) const
MStatus  setDepthMapWidthFocus (const float depth_map_width_focus)
float  depthMapFocus (MStatus *ReturnStatus) const
MStatus  setDepthMapFocus (const float depth_map_focus)
  MFnNonExtendedLight (const MObject &object, MStatus *ret=NULL)
  Constructor.

Protected Member Functions

virtual const char *  className () const
  Class name.

Constructor & Destructor Documentation

MFnNonExtendedLight::~MFnNonExtendedLight (  )  [virtual]

Destructor.

The class destructor.

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

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

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

Function set type.

Return the class type : MFn::kNonExtendedLight

Reimplemented from MFnNonAmbientLight.

Reimplemented in MFnAreaLight, MFnDirectionalLight, MFnPointLight, MFnSpotLight, and MFnVolumeLight.

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

Class name.

Return the class name : "MFnNonExtendedLight"

Reimplemented from MFnNonAmbientLight.

Reimplemented in MFnAreaLight, MFnDirectionalLight, MFnPointLight, MFnSpotLight, and MFnVolumeLight.

float MFnNonExtendedLight::shadowRadius ( MStatus ReturnStatus = NULL  )  const

Retrieves the value of the "shadowRadius" attribute of a non-extended light node. This attribute represents the radius of the light used when computing soft shadows. Higher radius values result in more extended soft shadows.

Parameters:
[out]  ReturnStatus  return status
Returns:
The value of the "shadowRadius" attribute of the non-extended light node.
Status Codes:

MStatus MFnNonExtendedLight::setShadowRadius ( const float &  shadow_radius  ) 

Sets the value of the "shadowRadius" attribute of a non-extended light node.

Parameters:
[in]  shadow_radius  value to which the attribute will be set.
Returns:
Return status
Status Codes:

bool MFnNonExtendedLight::castSoftShadows ( MStatus ReturnStatus = NULL  )  const

Retrieves the value of the "castSoftShadows" attribute of a non-extended light node. This attribute determines whether or not the light casts soft shadows.

Parameters:
[out]  ReturnStatus  return status
Returns:
The value of the "castSoftShadows" attribute of the non-extended light node.
Status Codes:

MStatus MFnNonExtendedLight::setCastSoftShadows ( const bool &  cast_soft_shadows  ) 

Sets the value of the "castSoftShadows" attribute of a non-extended light node.

Parameters:
[in]  cast_soft_shadows  value to which the attribute will be set.
Returns:
Return status
Status Codes:

bool MFnNonExtendedLight::useDepthMapShadows ( MStatus ReturnStatus = NULL  )  const

Retrieves the value of the "useDepthMapShadows" attribute of a non-extended light node. This attribute determines whether or not a depth map will be used in shadow computations for this light.

Parameters:
[out]  ReturnStatus  return status
Returns:
The value of the "useDepthMapShadows" attribute of the non-extended light node.
Status Codes:

MStatus MFnNonExtendedLight::setUseDepthMapShadows ( const bool &  use_depth_map  ) 

Sets the value of the "useDepthMapShadows" attribute of a non-extended light node.

Parameters:
[in]  use_depth_map  value to which the attribute will be set.
Returns:
Return status
Status Codes:

short MFnNonExtendedLight::depthMapFilterSize ( MStatus ReturnStatus  )  const

Retrieves the value of the "depthMapFilterSize" attribute of a light node. This attribute determines the size of the filter used in depth map shadow computations for the light.

Parameters:
[out]  ReturnStatus  return status
Returns:
The value of the "depthMapFilterSize" attribute of the light node.
Status Codes:

MStatus MFnNonExtendedLight::setDepthMapFilterSize ( const short &  depth_map_filter_size  ) 

Sets the value of the "depthMapFilterSize" attribute of a light node.

Parameters:
[in]  depth_map_filter_size  value to which the attribute will be set.
Returns:
Return status
Status Codes:

short MFnNonExtendedLight::depthMapResolution ( MStatus ReturnStatus  )  const

Retrieves the value of the "depthMapResolution" attribute of a light node. This attribute determines the resolution of the depth map for this light.

Parameters:
[out]  ReturnStatus  return status
Returns:
The value of the "depthMapResolution" attribute of the light node.
Status Codes:

MStatus MFnNonExtendedLight::setDepthMapResolution ( const short &  depth_map_resolution  ) 

Sets the value of the "depthMapResolution" attribute of a light node.

Parameters:
[in]  depth_map_resolution  value to which the attribute will be set.
Returns:
Return status
Status Codes:

float MFnNonExtendedLight::depthMapBias ( MStatus ReturnStatus  )  const

Retrieves the value of the "depthMapBias" attribute of a light node. This attribute represents the depth bias applied in depth map shadow computations to prevent self-shadowing artifacts.

Parameters:
[out]  ReturnStatus  return status
Returns:
The value of the "depthMapBias" attribute of the light node.
Status Codes:

MStatus MFnNonExtendedLight::setDepthMapBias ( const float &  depth_map_bias  ) 

Sets the value of the "depthMapBias" attribute of a light node.

Parameters:
[in]  depth_map_bias  value to which the attribute will be set.
Returns:
Return status
Status Codes:

bool MFnNonExtendedLight::useDepthMapAutoFocus ( MStatus ReturnStatus = NULL  )  const

Retrieves the value of the "useDepthMapAutoFocus" attribute of a non-extended light node. This attribute determines whether to automatically scale the depth map so that it only fills the area of the light's illumination that contains shadow casting objects.

Parameters:
[out]  ReturnStatus  return status
Returns:
The value of the "useDepthMapAutoFocus" attribute of the non-extended light node.
Status Codes:

MStatus MFnNonExtendedLight::setUseDepthMapAutoFocus ( const bool  use_depth_map_auto_focus  ) 

Sets the value of the "useDepthMapAutoFocus" attribute of a non-extended light node.

Parameters:
[in]  use_depth_map_auto_focus  value to which the attribute will be set.
Returns:
Return status
Status Codes:

float MFnNonExtendedLight::depthMapWidthFocus ( MStatus ReturnStatus  )  const

Retrieves the value of the "depthMapWidthFocus" attribute of a light node. This attribute is used to scale the depth map within the area of the light's illumination.

Parameters:
[out]  ReturnStatus  return status
Returns:
The value of the "depthMapWidthFocus" attribute of the light node.
Status Codes:

MStatus MFnNonExtendedLight::setDepthMapWidthFocus ( const float  depth_map_width_focus  ) 

Sets the value of the "depthMapWidthFocus" attribute of a light node.

Parameters:
[in]  depth_map_width_focus  value to which the attribute will be set.
Returns:
Return status
Status Codes:

float MFnNonExtendedLight::depthMapFocus ( MStatus ReturnStatus  )  const

Retrieves the value of the "depthMapFocus" attribute of a light node. This attribute represents the depth map's field of view.

Parameters:
[out]  ReturnStatus  return status
Returns:
The value of the "depthMapFocus" attribute of the light node.
Status Codes:

MStatus MFnNonExtendedLight::setDepthMapFocus ( const float  depth_map_focus  ) 

Sets the value of the "depthMapFocus" attribute of a light node.

Parameters:
[in]  depth_map_focus  value to which the attribute will be set.
Returns:
Return status
Status Codes:

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