pymel.core.nodetypes.VolumeLight¶
digraph inheritancebe7d3e393d { rankdir=TB; ranksep=0.15; nodesep=0.15; size="8.0, 12.0"; "ContainerBase" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.ContainerBase.html#pymel.core.nodetypes.ContainerBase",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "DependNode" -> "ContainerBase" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DagNode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.DagNode.html#pymel.core.nodetypes.DagNode",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "Entity" -> "DagNode" [arrowsize=0.5,style="setlinewidth(0.5)"]; "DependNode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.DependNode.html#pymel.core.nodetypes.DependNode",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "PyNode" -> "DependNode" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Entity" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.Entity.html#pymel.core.nodetypes.Entity",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "ContainerBase" -> "Entity" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Light" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.Light.html#pymel.core.nodetypes.Light",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "Shape" -> "Light" [arrowsize=0.5,style="setlinewidth(0.5)"]; "NonAmbientLightShapeNode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.NonAmbientLightShapeNode.html#pymel.core.nodetypes.NonAmbientLightShapeNode",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "RenderLight" -> "NonAmbientLightShapeNode" [arrowsize=0.5,style="setlinewidth(0.5)"]; "NonExtendedLightShapeNode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.NonExtendedLightShapeNode.html#pymel.core.nodetypes.NonExtendedLightShapeNode",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "NonAmbientLightShapeNode" -> "NonExtendedLightShapeNode" [arrowsize=0.5,style="setlinewidth(0.5)"]; "PointLight" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.PointLight.html#pymel.core.nodetypes.PointLight",style="setlinewidth(0.5)",tooltip="class counterpart of mel function `pointLight`",height=0.25,shape=box,fontsize=8]; "NonExtendedLightShapeNode" -> "PointLight" [arrowsize=0.5,style="setlinewidth(0.5)"]; "ProxyUnicode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="../pymel.util.utilitytypes/pymel.util.utilitytypes.ProxyUnicode.html#pymel.util.utilitytypes.ProxyUnicode",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "PyNode" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="../pymel.core.general/pymel.core.general.PyNode.html#pymel.core.general.PyNode",style="setlinewidth(0.5)",tooltip="Abstract class that is base for all pymel nodes classes.",height=0.25,shape=box,fontsize=8]; "ProxyUnicode" -> "PyNode" [arrowsize=0.5,style="setlinewidth(0.5)"]; "RenderLight" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.RenderLight.html#pymel.core.nodetypes.RenderLight",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "Light" -> "RenderLight" [arrowsize=0.5,style="setlinewidth(0.5)"]; "Shape" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="pymel.core.nodetypes.Shape.html#pymel.core.nodetypes.Shape",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "DagNode" -> "Shape" [arrowsize=0.5,style="setlinewidth(0.5)"]; "VolumeLight" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="#pymel.core.nodetypes.VolumeLight",style="setlinewidth(0.5)",height=0.25,shape=box,fontsize=8]; "PointLight" -> "VolumeLight" [arrowsize=0.5,style="setlinewidth(0.5)"]; }
- 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