pymel.core.nodetypes.DirectionalLight¶
digraph inheritance96780ee989 { 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)"]; "DirectionalLight" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="#pymel.core.nodetypes.DirectionalLight",style="setlinewidth(0.5)",tooltip="class counterpart of mel function `directionalLight`",height=0.25,shape=box,fontsize=8]; "NonExtendedLightShapeNode" -> "DirectionalLight" [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)"]; "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)"]; }
- class DirectionalLight(*args, **kwargs)¶
class counterpart of mel function directionalLight
TlightCmd is the base class for other light commands. TnonAmbientLightCmd is a class that looks like a command but is not. It is a base class for the extended/nonExtended lights. TnonExtendedLightCmd is a base class and not a real command. It is inherited by several lights: TpointLight, TdirectionalLight, TspotLight etc. The directionalLight command is used to edit the parameters of existing directionalLights, or to create new ones. The default behaviour is to create a new directionallight. This is the commmand that instantiates an directionalLight or edits the parameters of an existing one. TdirectionalLightCmd inherits from TnonExtendedLightCmd which defines softShadow flags. See TlightCmd for a global picture of the light commands. TdirectionalLightCmd behaves like any other command, it has flags, saves undo information etc. the only slightly different behaviour is that it calls up to TnonExtendedLightCmd to complete the functionality of the command.
- getDiscRadius(**kwargs)¶
Radius of shadow disc.
Derived from mel command maya.cmds.directionalLight
- getExclusive(**kwargs)¶
True if the light is exclusively assigned
Derived from mel command maya.cmds.directionalLight
- getRgb(**kwargs)¶
RGB colour of the light
Derived from mel command maya.cmds.directionalLight
- getShadowAngle()¶
Retrieves the value of the “shadowAngle” attribute of a directional light node. This attribute represents an angular divergence from the direction vector of the light used to calculate soft shadows.
Return type: float Derived from api method maya.OpenMaya.MFnDirectionalLight.shadowAngle
- getShadowDither(**kwargs)¶
Shadow dithering value.
Derived from mel command maya.cmds.directionalLight
- getShadowSamples(**kwargs)¶
Numbr of shadow samples to use
Derived from mel command maya.cmds.directionalLight
- getSoftShadow(**kwargs)¶
True if soft shadowing is to be enabled
Derived from mel command maya.cmds.directionalLight
- getUseLightPosition()¶
Retrieves the value of the “useLightPosition” attribute of a directional light. This attribute determines if the objects behind the light will cast shadows.
Return type: bool Derived from api method maya.OpenMaya.MFnDirectionalLight.useLightPosition
- setShadowAngle(shadow_angle)¶
Sets the value of the “shadowAngle” attribute of a directional light node.
Parameters: - shadow_angle : float
value to which the attribute will be set.
Derived from api method maya.OpenMaya.MFnDirectionalLight.setShadowAngle
- setUseLightPosition(use_light_position)¶
Sets the value of the “useLightPosition” attribute of a directional light.
Parameters: - use_light_position : bool
value to which the attribute will be set.
Derived from api method maya.OpenMaya.MFnDirectionalLight.setUseLightPosition