pymel.core.nodetypes.AmbientLight¶
digraph inheritance5bb85d966a { rankdir=TB; ranksep=0.15; nodesep=0.15; size="8.0, 12.0"; "AmbientLight" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="#pymel.core.nodetypes.AmbientLight",style="setlinewidth(0.5)",tooltip="class counterpart of mel function `ambientLight`",height=0.25,shape=box,fontsize=8]; "RenderLight" -> "AmbientLight" [arrowsize=0.5,style="setlinewidth(0.5)"]; "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)"]; "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 AmbientLight(*args, **kwargs)¶
class counterpart of mel function ambientLight
TlightCmd is the base class for other light commands. The ambientLight command is used to edit the parameters of existing ambientLights, or to create new ones. The default behaviour is to create a new ambientlight. This is the commmand that instantiates an ambientLight or edits the parameters of an existing one. TambientLightCmd inherits from TlightCmd which defines common flags like intensity, colour etc. See TlightCmd for a global picture of the light commands. Note that the flag fAmbientLightUsed indicates whether the command uses any ambient specific flags. That is, if a command doesn’t use flags defined here, the boolean fAmbientLightUsed is set to false and thus the undo/redo information is not saved at this level. TambientLightCmd behaves like any other command, it has flags, saves undo information etc. the only slightly different behaviour is that it calls up to TlightCmd to complete the functionality of the command. Example parseArgs: TambientLightCmd defines ambientLight specific parameters like -ambientShade however, several other parameters are available in TlightCmd such as -intensity etc. So when parsing the arguments, a call is made to TlightCmd::parseArgs to parse common parameters (like Intensity).
- getAmbientShade()¶
Retrieves the value of the “ambientShade” attribute of an ambient light node. This attribute determines how positional the light is. A value of 0 represents a completely ambient light, while a value of 1 represents a point light.
Return type: float Derived from api method maya.OpenMaya.MFnAmbientLight.ambientShade
- getCastSoftShadows()¶
Retrieves the value of the “castSoftShadows” attribute of an ambient light node. This attribute determines whether or not the light casts soft shadows.
Return type: bool Derived from api method maya.OpenMaya.MFnAmbientLight.castSoftShadows
- getDiscRadius(**kwargs)¶
radius of the disc around the light
Derived from mel command maya.cmds.ambientLight
- getExclusive(**kwargs)¶
True if the light is exclusively assigned
Derived from mel command maya.cmds.ambientLight
- getPosition(**kwargs)¶
Position of the light
Derived from mel command maya.cmds.ambientLight
- getRgb(**kwargs)¶
RGB colour of the light
Derived from mel command maya.cmds.ambientLight
- getRotation(**kwargs)¶
Rotation of the light for orientation, where applicable
Derived from mel command maya.cmds.ambientLight
- getShadowDither(**kwargs)¶
dither the shadow
Derived from mel command maya.cmds.ambientLight
- getShadowRadius()¶
Retrieves the value of the “shadowRadius” attribute of an ambient light node. This attribute represents the radius of the light used when computing soft shadows. Higher radius values result in more extended soft shadows.
Return type: float Derived from api method maya.OpenMaya.MFnAmbientLight.shadowRadius
- getShadowSamples(**kwargs)¶
number of shadow samples.
Derived from mel command maya.cmds.ambientLight
- getSoftShadow(**kwargs)¶
soft shadow
Derived from mel command maya.cmds.ambientLight
- setAmbientShade(ambient_shade)¶
Sets the value of the “ambientShade” attribute of an ambient light node.
Parameters: - ambient_shade : float
value to which the attribute will be set.
Derived from api method maya.OpenMaya.MFnAmbientLight.setAmbientShade
- setCastSoftShadows(cast_soft_shadows)¶
Sets the value of the “castSoftShadows” attribute of an ambient light node.
Parameters: - cast_soft_shadows : bool
value to which the attribute will be set.
Derived from api method maya.OpenMaya.MFnAmbientLight.setCastSoftShadows
- setDiscRadius(val=True, **kwargs)¶
radius of the disc around the light
Derived from mel command maya.cmds.ambientLight
- setShadowDither(val=True, **kwargs)¶
dither the shadow
Derived from mel command maya.cmds.ambientLight
- setShadowRadius(shadow_radius)¶
Sets the value of the “shadowRadius” attribute of an ambient light node.
Parameters: - shadow_radius : float
value to which the attribute will be set.
Derived from api method maya.OpenMaya.MFnAmbientLight.setShadowRadius
- setShadowSamples(val=True, **kwargs)¶
number of shadow samples.
Derived from mel command maya.cmds.ambientLight
- setSoftShadow(val=True, **kwargs)¶
soft shadow
Derived from mel command maya.cmds.ambientLight