pymel.core.nodetypes.VolumeLight

class VolumeLight(*args, **kwargs)

MLightDirection = Enum( EnumValue('MLightDirection', 0, 'outward'), EnumValue('MLightDirection', 1, 'inward'), EnumValue('MLightDirection', 2, 'downAxis'))

MLightShape = Enum( EnumValue('MLightShape', 0, 'boxVolume'), EnumValue('MLightShape', 1, 'sphereVolume'), EnumValue('MLightShape', 2, 'cylinderVolume'), EnumValue('MLightShape', 3, 'coneVolume'))

getArc()

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.

Return type:float

Derived from api method maya.OpenMaya.MFnVolumeLight.arc

getConeEndRadius()

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.

Return type:float

Derived from api method maya.OpenMaya.MFnVolumeLight.coneEndRadius

getEmitAmbient()

Retrieves the value of the “emitAmbient” attribute.

Return type:bool

Derived from api method maya.OpenMaya.MFnVolumeLight.emitAmbient

getLightShape()

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

Return type:VolumeLight.MLightShape

Derived from api method maya.OpenMaya.MFnVolumeLight.lightShape

getShadowAngle()

Retrieves the value of the “shadowAngle” attribute of a volume light node. This attribute represents an angular divergence from the direction vector of the light used to calculate soft shadows. It’s enabled only if the volume light direction is kDownAxis.

Return type:float

Derived from api method maya.OpenMaya.MFnVolumeLight.shadowAngle

getVolumeLightDirection()

Retrieves the value of the “volumeLightDirection” attribute.

Return type:VolumeLight.MLightDirection

Derived from api method maya.OpenMaya.MFnVolumeLight.volumeLightDirection

setArc(arc)

Sets the value of the “arc” attribute of a volume light node.

Parameters :

arc : float

value to which the attribute will be set.

Derived from api method maya.OpenMaya.MFnVolumeLight.setArc

setConeEndRadius(cone_end_radius)

Sets the value of the “coneEndRadius” attribute of a volume light node.

Parameters :

cone_end_radius : float

value to which the attribute will be set.

Derived from api method maya.OpenMaya.MFnVolumeLight.setConeEndRadius

setEmitAmbient(emit_ambient)

Sets the value of the “emitAmbient” attribute of a volume light node.

Parameters :

emit_ambient : bool

value to which the attribute will be set.

Derived from api method maya.OpenMaya.MFnVolumeLight.setEmitAmbient

setLightShape(light_shape)

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

Parameters :

light_shape : VolumeLight.MLightShape

value to which the attribute will be set.

values: ‘boxVolume’, ‘sphereVolume’, ‘cylinderVolume’, ‘coneVolume’

Derived from api method maya.OpenMaya.MFnVolumeLight.setLightShape

setShadowAngle(shadow_angle)

Sets the value of the “shadowAngle” attribute of a volume light node. It’s enabled only if the volume light direction is kDownAxis.

Parameters :

shadow_angle : float

value to which the attribute will be set.

Derived from api method maya.OpenMaya.MFnVolumeLight.setShadowAngle

setVolumeLightDirection(volume_light_direction)

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

Parameters :

volume_light_direction : VolumeLight.MLightDirection

value to which the attribute will be set.

values: ‘outward’, ‘inward’, ‘downAxis’

Derived from api method maya.OpenMaya.MFnVolumeLight.setVolumeLightDirection