pymel.core.rendering.ambientLight¶

ambientLight(*args, **kwargs)¶

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).

Maya Bug Fix:

• name flag was ignored

Flags:

Long Name / Short Name		Argument Types	Properties
ambientShade / ambientShade		float
	ambientShade
discRadius / drs		float
	radius of the disc around the light
exclusive / exc		bool
	True if the light is exclusively assigned
intensity / i		float
	Intensity of the light
name / n		unicode
	Name of the light
position / pos		float, float, float
	Position of the light
rgb / rgb		float, float, float
	RGB colour of the light
rotation / rot		float, float, float
	Rotation of the light for orientation, where applicable
shadowColor / sc		float, float, float
	Color of the light’s shadow
shadowDither / sd		float
	dither the shadow
shadowSamples / sh		int
	number of shadow samples.
softShadow / ss		bool
	soft shadow
useRayTraceShadows / rs		bool
	True if ray trace shadows are to be used Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.ambientLight

Example:

import pymel.core as pm

# Create an ambientLight light
light = pm.ambientLight(intensity=0.8)

# Change the light intensity
pm.ambientLight( light, e=True, intensity=0.5 )

# Query it
pm.ambientLight( light, q=True, intensity=True )
# Result: 0.5 #