Public Member Functions | Protected Member Functions

MFnNonExtendedLight Class Reference

Search for all occurrences

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.

#include <MFnNonExtendedLight.h>

Inheritance diagram for MFnNonExtendedLight:
Inheritance graph
[legend]

List of all members.

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
 Retrieves the value of the "shadowRadius" attribute of a non-extended light node.
MStatus setShadowRadius (const float &shadow_radius)
 Sets the value of the "shadowRadius" attribute of a non-extended light node.
bool castSoftShadows (MStatus *ReturnStatus=NULL) const
 Retrieves the value of the "castSoftShadows" attribute of a non-extended light node.
MStatus setCastSoftShadows (const bool &cast_soft_shadows)
 Sets the value of the "castSoftShadows" attribute of a non-extended light node.
bool useDepthMapShadows (MStatus *ReturnStatus=NULL) const
 Retrieves the value of the "useDepthMapShadows" attribute of a non-extended light node.
MStatus setUseDepthMapShadows (const bool &use_depth_map)
 Sets the value of the "useDepthMapShadows" attribute of a non-extended light node.
short depthMapFilterSize (MStatus *ReturnStatus) const
 Retrieves the value of the "depthMapFilterSize" attribute of a light node.
MStatus setDepthMapFilterSize (const short &depth_map_filter_size)
 Sets the value of the "depthMapFilterSize" attribute of a light node.
short depthMapResolution (MStatus *ReturnStatus) const
 Retrieves the value of the "depthMapResolution" attribute of a light node.
MStatus setDepthMapResolution (const short &depth_map_resolution)
 Sets the value of the "depthMapResolution" attribute of a light node.
float depthMapBias (MStatus *ReturnStatus) const
 Retrieves the value of the "depthMapBias" attribute of a light node.
MStatus setDepthMapBias (const float &depth_map_bias)
 Sets the value of the "depthMapBias" attribute of a light node.
bool useDepthMapAutoFocus (MStatus *ReturnStatus=NULL) const
 Retrieves the value of the "useDepthMapAutoFocus" attribute of a non-extended light node.
MStatus setUseDepthMapAutoFocus (const bool use_depth_map_auto_focus)
 Sets the value of the "useDepthMapAutoFocus" attribute of a non-extended light node.
float depthMapWidthFocus (MStatus *ReturnStatus) const
 Retrieves the value of the "depthMapWidthFocus" attribute of a light node.
MStatus setDepthMapWidthFocus (const float depth_map_width_focus)
 Sets the value of the "depthMapWidthFocus" attribute of a light node.
float depthMapFocus (MStatus *ReturnStatus) const
 Retrieves the value of the "depthMapFocus" attribute of a light node.
MStatus setDepthMapFocus (const float depth_map_focus)
 Sets the value of the "depthMapFocus" attribute of a light node.
 MFnNonExtendedLight (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

~MFnNonExtendedLight ( ) [virtual]

Destructor.

The class destructor.

MFnNonExtendedLight ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
MFnNonExtendedLight ( const MDagPath object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in]objectThe const MDagPath to attach the function set to
[out]ReturnStatusThe return status
Status Codes:
MFnNonExtendedLight ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:

Member Function Documentation

MFn::Type 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 * className ( ) const [protected, virtual]

Class name.

Return the class name : "MFnNonExtendedLight".

Reimplemented from MFnNonAmbientLight.

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

float 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]ReturnStatusreturn status
Returns:
The value of the "shadowRadius" attribute of the non-extended light node.
Status Codes:
MStatus setShadowRadius ( const float &  shadow_radius)

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

Parameters:
[in]shadow_radiusvalue to which the attribute will be set.
Returns:
Return status
Status Codes:
bool 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]ReturnStatusreturn status
Returns:
The value of the "castSoftShadows" attribute of the non-extended light node.
Status Codes:
MStatus setCastSoftShadows ( const bool &  cast_soft_shadows)

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

Parameters:
[in]cast_soft_shadowsvalue to which the attribute will be set.
Returns:
Return status
Status Codes:
bool 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]ReturnStatusreturn status
Returns:
The value of the "useDepthMapShadows" attribute of the non-extended light node.
Status Codes:
MStatus setUseDepthMapShadows ( const bool &  use_depth_map)

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

Parameters:
[in]use_depth_mapvalue to which the attribute will be set.
Returns:
Return status
Status Codes:
short 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]ReturnStatusreturn status
Returns:
The value of the "depthMapFilterSize" attribute of the light node.
Status Codes:
MStatus setDepthMapFilterSize ( const short &  depth_map_filter_size)

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

Parameters:
[in]depth_map_filter_sizevalue to which the attribute will be set.
Returns:
Return status
Status Codes:
short 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]ReturnStatusreturn status
Returns:
The value of the "depthMapResolution" attribute of the light node.
Status Codes:
MStatus setDepthMapResolution ( const short &  depth_map_resolution)

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

Parameters:
[in]depth_map_resolutionvalue to which the attribute will be set.
Returns:
Return status
Status Codes:
float 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]ReturnStatusreturn status
Returns:
The value of the "depthMapBias" attribute of the light node.
Status Codes:
MStatus setDepthMapBias ( const float &  depth_map_bias)

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

Parameters:
[in]depth_map_biasvalue to which the attribute will be set.
Returns:
Return status
Status Codes:
bool 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]ReturnStatusreturn status
Returns:
The value of the "useDepthMapAutoFocus" attribute of the non-extended light node.
Status Codes:
MStatus 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_focusvalue to which the attribute will be set.
Returns:
Return status
Status Codes:
float 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]ReturnStatusreturn status
Returns:
The value of the "depthMapWidthFocus" attribute of the light node.
Status Codes:
MStatus setDepthMapWidthFocus ( const float  depth_map_width_focus)

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

Parameters:
[in]depth_map_width_focusvalue to which the attribute will be set.
Returns:
Return status
Status Codes:
float 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]ReturnStatusreturn status
Returns:
The value of the "depthMapFocus" attribute of the light node.
Status Codes:
MStatus setDepthMapFocus ( const float  depth_map_focus)

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

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

MFnNonExtendedLight MFnNonExtendedLight MFnNonExtendedLight MFnNonExtendedLight MFnNonExtendedLight MFnNonExtendedLight MFnNonExtendedLight MFnNonExtendedLight MFnNonExtendedLight MFnNonExtendedLight
MFnNonExtendedLight MFnNonExtendedLight MFnNonExtendedLight MFnNonExtendedLight MFnNonExtendedLight MFnNonExtendedLight MFnNonExtendedLight MFnNonExtendedLight MFnNonExtendedLight MFnNonExtendedLight