class MFnVolumeLight

Jump to documentation

Inheritance:

MFnVolumeLight < MFnPointLight < MFnNonExtendedLight < MFnNonAmbientLight < MFnLight < MFnDagNode < MFnDependencyNode < MFnBase

public members:

	MFnVolumeLight ( const MObject & object, MStatus * ReturnStatus = NULL )
enum	MLightShape kBoxVolume kSphereVolume kCylinderVolume kConeVolume
enum	MLightDirection kOutward kInward kDownAxis
MObject	create ( bool UIvisible = true, MStatus * ReturnStatus = NULL )
MObject	create ( const MObject & parent, bool UIvisible = true, bool wantTransform = false, MStatus * ReturnStatus = NULL )
MFnVolumeLight::MLightShape	lightShape ( MStatus * ReturnStatus ) const
MStatus	setLightShape ( const MFnVolumeLight::MLightShape & light_shape)
MFnVolumeLight::MLightDirection	volumeLightDirection ( MStatus * ReturnStatus) const
MStatus	setVolumeLightDirection (const MFnVolumeLight::MLightDirection & volume_light_direction)
float	arc ( MStatus * ReturnStatus ) const
MStatus	setArc (const float& arc)
float	coneEndRadius ( MStatus * ReturnStatus ) const
MStatus	setConeEndRadius (const float& cone_end_radius)
bool	emitAmbient ( MStatus * ReturnStatus ) const
MStatus	setEmitAmbient (const bool& emit_ambient)
MRampAttribute	colorRamp ( MStatus * ReturnStatus) const
MRampAttribute	penumbraRamp ( MStatus * ReturnStatus) const
MObject	create ( const MObject & parent, bool UIvisible = true, MStatus * ReturnStatus = NULL ) NO SCRIPT SUPPORT

Inherited from MFnPointLight:

public members:

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

Inherited from MFnNonExtendedLight:

public members:

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 )

Inherited from MFnNonAmbientLight:

public members:

short	decayRate ( MStatus * ReturnStatus = NULL ) const
MStatus	setDecayRate ( const short& decay_rate )

Inherited from MFnLight:

public members:

MColor	color ( MStatus * ReturnStatus = NULL ) const
MStatus	setColor ( const MColor &col )
float	intensity ( MStatus * ReturnStatus = NULL ) const
MStatus	setIntensity ( const float& intens )
bool	useRayTraceShadows ( MStatus * ReturnStatus = NULL ) const
MStatus	setUseRayTraceShadows ( const bool& useRayTraceShadows )
MColor	shadowColor ( MStatus * ReturnStatus = NULL ) const
MStatus	setShadowColor ( const MColor & shadow_color )
double	centerOfIllumination ( MStatus * ReturnStatus = NULL ) const
MStatus	setCenterOfIllumination ( const double& dist )
short	numShadowSamples ( MStatus * ReturnStatus = NULL ) const
MStatus	setNumShadowSamples ( const short& num_shadow_samples )
short	rayDepthLimit ( MStatus * ReturnStatus = NULL ) const
MStatus	setRayDepthLimit ( const short& rayDepthLimit )
MColor	opticalFXvisibility ( MStatus * ReturnStatus = NULL ) const
MStatus	setOpticalFXvisibility ( const MColor & visibility )
MColor	lightIntensity ( MStatus * ReturnStatus = NULL ) const
MFloatVector	lightDirection ( int instance, MSpace::Space space = MSpace::kWorld , MStatus * ReturnStatus = NULL ) const
MFloatVector	lightDirection ( MStatus * ReturnStatus = NULL ) const
bool	lightAmbient ( MStatus * ReturnStatus = NULL ) const
bool	lightDiffuse ( MStatus * ReturnStatus = NULL ) const
bool	lightSpecular ( MStatus * ReturnStatus = NULL ) const

Inherited from MFnDagNode:

public members:

	kNextPos
MObject	create ( const MTypeId &typeId, MObject & parent = MObject::kNullObj , MStatus * ReturnStatus = NULL )
MObject	create ( const MTypeId &typeId, const MString &name, MObject & parent = MObject::kNullObj , MStatus * ReturnStatus = NULL )
MObject	create ( const MString &type, MObject & parent = MObject::kNullObj , MStatus * ReturnStatus = NULL )
MObject	create ( const MString &type, const MString &name, MObject & parent = MObject::kNullObj , MStatus * ReturnStatus = NULL )
unsigned int	parentCount ( MStatus * ReturnStatus = NULL ) const
MObject	parent ( unsigned int i, MStatus * ReturnStatus = NULL ) const
MStatus	addChild ( MObject & child , unsigned int index = kNextPos , bool keepExistingParents = false )
MStatus	removeChild ( MObject & child )
MStatus	removeChildAt ( unsigned int index )
unsigned int	childCount ( MStatus * ReturnStatus = NULL ) const
MObject	child ( unsigned int i, MStatus * ReturnStatus = NULL ) const
MObject	dagRoot ( MStatus * ReturnStatus = NULL )
bool	hasParent ( const MObject & node, MStatus * ReturnStatus = NULL ) const
bool	hasChild (const MObject & node, MStatus * ReturnStatus = NULL ) const
bool	isChildOf (const MObject & node, MStatus * ReturnStatus = NULL ) const
bool	isParentOf (const MObject & node, MStatus * ReturnStatus = NULL ) const
bool	inUnderWorld ( MStatus * ReturnStatus = NULL ) const
bool	inModel ( MStatus * ReturnStatus = NULL ) const
bool	isInstanceable ( MStatus * ReturnStatus=NULL ) const
MStatus	setInstanceable ( const bool how )
bool	isInstanced ( bool indirect = true, MStatus * ReturnStatus = NULL ) const
bool	isInstancedAttribute ( const MObject & attr, MStatus * ReturnStatus = NULL ) const
unsigned int	instanceCount ( bool total, MStatus * ReturnStatus = NULL ) const
MObject	duplicate ( bool instance = false, bool instanceLeaf = false, MStatus * ReturnStatus = NULL ) const
MStatus	getPath ( MDagPath & path )
MStatus	getAllPaths ( MDagPathArray & paths )
MString	fullPathName ( MStatus *ReturnStatus = NULL)
MString	partialPathName ( MStatus *ReturnStatus = NULL)
MMatrix	transformationMatrix ( MStatus * ReturnStatus = NULL ) const
bool	isIntermediateObject ( MStatus * ReturnStatus = NULL ) const
MStatus	setIntermediateObject ( bool isIntermediate )
int	objectColor ( MStatus * ReturnStatus = NULL ) const
MStatus	setObjectColor ( int color )
bool	usingObjectColor ( MStatus * ReturnStatus = NULL ) const
MStatus	setUseObjectColor ( bool useObjectColor )
MBoundingBox	boundingBox ( MStatus * ReturnStatus = NULL ) const
MDagPath	dagPath ( MStatus * ReturnStatus = NULL ) const
virtual MStatus	setObject ( const MDagPath & path )
virtual MStatus	setObject ( MObject & object )
MObject	model ( MStatus * ReturnStatus = NULL ) const
virtual MStatus	setObject ( const MObject & object )

Inherited from MFnDependencyNode:

public members:

virtual MFn::Type	type () const
enum	MAttrClass kGlobalDynamicAttr kLocalDynamicAttr
MObject	create ( const MTypeId & typeId , MStatus * ReturnStatus = NULL )
MObject	create ( const MTypeId & typeId , const MString & name , MStatus * ReturnStatus = NULL )
MObject	create ( const MString & type , MStatus * ReturnStatus = NULL )
MObject	create ( const MString & type , const MString & name , MStatus * ReturnStatus = NULL )
MTypeId	typeId ( MStatus * ReturnStatus = NULL ) const
MString	typeName ( MStatus * ReturnStatus = NULL ) const
MString	name ( MStatus * ReturnStatus = NULL ) const
MString	setName ( const MString & name , MStatus * ReturnStatus = NULL )
MStatus	getConnections ( MPlugArray & array ) const
unsigned int	attributeCount ( MStatus * ReturnStatus=NULL) const
MObject	attribute ( unsigned int index, MStatus * ReturnStatus=NULL) const
MObject	reorderedAttribute ( unsigned int index, MStatus * ReturnStatus=NULL) const
MObject	attribute ( const MString & attrName, MStatus * ReturnStatus=NULL) const
MAttrClass	attributeClass ( const MObject & attr, MStatus * ReturnStatus=NULL) const
MStatus	getAffectedAttributes ( const MObject & attr, MObjectArray & affectedAttributes ) const
MStatus	getAffectedByAttributes ( const MObject & attr, MObjectArray & affectedByAttributes ) const
MPlug	findPlug ( const MObject & attr, bool wantNetworkedPlug, MStatus * ReturnStatus=NULL) const
MPlug	findPlug ( const MString & attrName, bool wantNetworkedPlug, MStatus * ReturnStatus=NULL) const
MPlug	findPlug ( const MObject & attr, MStatus * ReturnStatus=NULL) const
MPlug	findPlug ( const MString & attrName, MStatus * ReturnStatus=NULL) const
MStatus	addAttribute ( const MObject & attr, MAttrClass type = kLocalDynamicAttr )
MStatus	removeAttribute ( const MObject & attr, MAttrClass type = kLocalDynamicAttr )
MPxNode *	userNode ( MStatus * ReturnStatus=NULL ) const
bool	isFromReferencedFile ( MStatus * ReturnStatus=NULL) const
bool	isShared ( MStatus * ReturnStatus=NULL) const
bool	hasUniqueName ( MStatus * ReturnStatus=NULL) const
MString	parentNamespace ( MStatus * ReturnStatus=NULL) const
bool	isLocked ( MStatus * ReturnStatus=NULL) const
MStatus	setLocked ( bool locked )
static MString	classification ( const MString & nodeTypeName )
bool	isNewAttribute ( const MObject & attr, MStatus * ReturnStatus=NULL) const
static unsigned int	allocateFlag ( const MString pluginName, MStatus * ReturnStatus=NULL )
static MStatus	deallocateFlag (const MString pluginName, unsigned int flag)
static MStatus	deallocateAllFlags (const MString pluginName)
MStatus	setFlag (unsigned int flag, bool state)
bool	isFlagSet (unsigned int flag, MStatus * ReturnStatus=NULL) const
bool	isDefaultNode ( MStatus * ReturnStatus=NULL) const
MStatus	setDoNotWrite ( bool flag )
bool	canBeWritten ( MStatus * ReturnStatus=NULL) const
bool	hasAttribute (const MString & name , MStatus * ReturnStatus=NULL) const
MObject	getAliasAttr (bool force, MStatus * ReturnStatus=NULL)
bool	setAlias (const MString & alias,const MString & name , const MPlug & plug, bool add=true, MStatus * ReturnStatus=NULL)
bool	findAlias (const MString & alias, MObject & attrObj, MStatus * ReturnStatus=NULL) const
bool	getAliasList ( MStringArray & strArray, MStatus * ReturnStatus=NULL)
MString	plugsAlias (const MPlug & plug, MStatus * ReturnStatus=NULL)
	public
bool	getPlugsAlias (const MPlug & plug, MString & aliasName, MStatus * ReturnStatus=NULL)

Inherited from MFnBase:

public members:

virtual MFn::Type	type () const
bool	hasObj ( MFn::Type ) const
bool	hasObj ( const MObject & ) const
MObject	object ( MStatus * ReturnStatus = NULL ) const
virtual MStatus	setObject ( MObject & object )
virtual MStatus	setObject ( const MObject & object )

Documentation

Description

MFnVolumeLight facilitates creation and manipulation of dependency graph nodes representing voume lights.

Functions

MFnVolumeLight:: MFnVolumeLight ()

Description

Default class constructor. The function set is not attached to an MObject.

MFnVolumeLight:: MFnVolumeLight ( MObject & object, MStatus * ReturnStatus )

Description

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

Arguments

• object the MObject to attach the function set to
• ReturnStatus the return status
  • 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

MFnVolumeLight:: MFnVolumeLight ( const MObject & object, MStatus * ReturnStatus )

Description

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

Arguments

• object the const MObject to attach the function set to
• ReturnStatus the return status
  • 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

MFnVolumeLight:: MFnVolumeLight ( const MDagPath & object, MStatus * ReturnStatus )

Description

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

Arguments

• object the const MDagPath to attach the function set to
• ReturnStatus the return status
  • 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

MFn::Type MFnVolumeLight:: type () const

Description

Return the type of this function set.

Return Value

• the constant MFn::kVolumeLight

MFnVolumeLight:: ~MFnVolumeLight ()

Description

The class destructor.

MObject MFnVolumeLight:: create ( bool UIvisible, MStatus * ReturnStatus )

Description

Creates a new volume 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.

Arguments

• UIvisible determines whether or not to connect the new node to the light classification node and add it to the default light list.
• ReturnStatus return status

Return Value

• MObject representing the new dependency node.

Status Codes

• MS::kSuccess operation successful
• MS::kInsufficientMemory ran out of memory
• MS::kNoModelActive no model is currently active
• MS::kLicenseFailure application not licensed for attempted operation
• MS::kFailure the new node could not be added to the model, or the function set could not be properly initialized with the new object.

MObject MFnVolumeLight:: create ( const MObject & parent, bool UIvisible, MStatus * ReturnStatus )

Description

Creates a new volume 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.

Arguments

• parent the node under which the new light and its transform will be added.
• UIvisible determines whether or not to connect the new node to the light classification node and add it to the default light list.
• ReturnStatus return status

Return Value

• MObject representing the new dependency node.

Status Codes

• MS::kSuccess operation successful
• MS::kInsufficientMemory ran out of memory
• MS::kNoModelActive no model is currently active
• MS::kLicenseFailure application not licensed for attempted operation
• MS::kFailure the new node could not be added to the model, or the function set could not be properly initialized with the new object.

MObject MFnVolumeLight:: create ( const MObject & parent, bool UIvisible, bool wantTransform, MStatus * ReturnStatus )

Description

Creates a new volume 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.

Arguments

• parent the node under which the new light and its transform will be added.
• wantTransform Boolean to indicate whether the transform node is needed or not, which is 'false' by default.
• UIvisible determines whether or not to connect the new node to the light classification node and add it to the default light list.
• ReturnStatus return status

Return Value

• MObject representing the new dependency node.

Status Codes

• MS::kSuccess operation successful
• MS::kInsufficientMemory ran out of memory
• MS::kNoModelActive no model is currently active
• MS::kLicenseFailure application not licensed for attempted operation
• MS::kFailure the new node could not be added to the model, or the function set could not be properly initialized with the new object.

MFnVolumeLight::MLightShape MFnVolumeLight:: lightShape ( MStatus * ReturnStatus ) const

Description

Retrieves the "lightShape" attribute of the light. The shape can be one of the following.

• MFnVolumeLight::kBoxVolume
• MFnVolumeLight::kCylinderVolume
• MFnVolumeLight::kSphereVolume
• MFnVolumeLight::kConeVolume

Arguments

• ReturnStatus return status

Return Value

• The value of the "lightShape" attribute of the volume light node.

Status Codes

• MS::kSuccess operation successful
• MS::kFailure function set does not have a valid object.

MStatus MFnVolumeLight:: setLightShape ( const MFnVolumeLight::MLightShape & light_shape )

Description

Sets the value of the "lightShape" attribute of a volume light node. The shape can be one of the following:

• MFnVolumeLight::kBoxVolume
• MFnVolumeLight::kCylinderVolume
• MFnVolumeLight::kSphereVolume
• MFnVolumeLight::kConeVolume

Arguments

• light_shape value to which the attribute will be set.

Return Value

• return status

Status Codes

• MS::kSuccess operation successful
• MS::kFailure function set does not have a valid object,

MFnVolumeLight::MLightDirection MFnVolumeLight:: volumeLightDirection ( MStatus * ReturnStatus) const

Description

Retrieves the value of the "volumeLightDirection" attribute.

The volumeLightDirection attribute determines the direction of the light within the volume. Outward has light moving away from the center of a Box or Sphere and away from the central axis of a Cylinder or Cone. Inward is the reverse of the direction. One can light from the outside of a sphere going in. Up Axis is like a directional light pointing in the positive y direction. Down axis points in the negative y direction. Note that Inward will not always shadow in a desirable fashion. The volumeLightDirection attribute can be one of the following:

• MFnVolumeLight::kInward
• MFnVolumeLight::kOutward
• MFnVolumeLight::kDownAxis

Arguments

• ReturnStatus return status

Return Value

• The value of the "lightDirection" attribute of the volume light node.

Status Codes

• MS::kSuccess operation successful
• MS::kFailure function set does not have a valid object.

MStatus MFnVolumeLight:: setVolumeLightDirection (const MFnVolumeLight::MLightDirection & volume_light_direction)

Description

Sets the value of the "volumeLightDirection" attribute of a volume light node. The shape can be one of the following.

• MFnVolumeLight::kBoxVolume
• MFnVolumeLight::kCylinderVolume
• MFnVolumeLight::kSphereVolume
• MFnVolumeLight::kConeVolume

Arguments

• volume_light_direction value to which the attribute will be set.

Return Value

• return status

Status Codes

• MS::kSuccess operation successful
• MS::kFailure function set does not have a valid object,

float MFnVolumeLight:: arc ( MStatus * ReturnStatus ) const

Description

Retrieves the value of the "arc" attribute. The arc is an angular slice of the light about the y axis. The value can range from 0 to 360 degrees.

Arguments

• ReturnStatus return status

Return Value

• The value of the "arc" attribute of the volume light node.

Status Codes

• MS::kSuccess operation successful
• MS::kFailure function set does not have a valid object.

MStatus MFnVolumeLight:: setArc (const float& arc)

Description

Sets the value of the "arc" attribute of a volume light node.

Arguments

• arc value to which the attribute will be set.

Return Value

• return status

Status Codes

• MS::kSuccess operation successful
• MS::kFailure function set does not have a valid object,

float MFnVolumeLight:: coneEndRadius ( MStatus * ReturnStatus ) const

Description

Retrieves the value of the "coneEndRadius" attribute. The coneEndRadius attribute determines the relative size of the one end of the cone. At a value of 1.0 it is a cylinder, while at 0 it is a cone.

Arguments

• ReturnStatus return status

Return Value

• The value of the "coneEndRadius" attribute of the volume light node.

Status Codes

• MS::kSuccess operation successful
• MS::kFailure function set does not have a valid object.

MStatus MFnVolumeLight:: setConeEndRadius (const float& cone_end_radius)

Description

Sets the value of the "coneEndRadius" attribute of a volume light node.

Arguments

• cone_end_radius value to which the attribute will be set.

Return Value

• return status

Status Codes

• MS::kSuccess operation successful
• MS::kFailure function set does not have a valid object,

bool MFnVolumeLight:: emitAmbient ( MStatus * ReturnStatus ) const

Description

Retrieves the value of the "emitAmbient" attribute.

If true, then light affects surfaces in a non directional fashion. When combined with Emit Diffuse the lighting at a surface will be half applied using the surface/light angle, and half in a nondirectional fashion. If Emit Diffuse is off then the light will be totally omnidirectional.

Arguments

• ReturnStatus return status

Return Value

• The value of the "emitAmbient" attribute of the volume light node.

Status Codes

• MS::kSuccess operation successful
• MS::kFailure function set does not have a valid object.

MStatus MFnVolumeLight:: setEmitAmbient (const bool& emit_ambient)

Description

Sets the value of the "emitAmbient" attribute of a volume light node.

Arguments

• emit_ambient value to which the attribute will be set.

Return Value

• return status

Status Codes

• MS::kSuccess operation successful
• MS::kFailure function set does not have a valid object,

MRampAttribute MFnVolumeLight:: colorRamp ( MStatus * ReturnStatus) const

Description

Retrieves the "colorRamp" attribute.

Arguments

• ReturnStatus return status

Return Value

• The color ramp attribute

Status Codes

• MS::kSuccess operation successful
• MS::kFailure function set does not have a valid object.

MRampAttribute MFnVolumeLight:: penumbraRamp ( MStatus * ReturnStatus) const

Description

Retrieves the "penumbraRamp" attribute.

Arguments

• ReturnStatus return status

Return Value

• The penumbra ramp attribute

Status Codes

• MS::kSuccess operation successful
• MS::kFailure function set does not have a valid object.

This class has no child classes.