pymel.core.nodetypes.SpotLight¶

digraph inheritance7bab82b14b { 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)"]; "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)"]; "SpotLight" [fontname="Vera Sans, DejaVu Sans, Liberation Sans, Arial, Helvetica, sans",URL="#pymel.core.nodetypes.SpotLight",style="setlinewidth(0.5)",tooltip="class counterpart of mel function `spotLight`",height=0.25,shape=box,fontsize=8]; "NonExtendedLightShapeNode" -> "SpotLight" [arrowsize=0.5,style="setlinewidth(0.5)"]; }

class SpotLight(*args, **kwargs)¶

class counterpart of mel function spotLight

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 spotLight command is used to edit the parameters of existing spotLights, or to create new ones. The default behaviour is to create a new spotlight.

MBarnDoor = Enum( EnumValue('MBarnDoor', 0, 'left'), EnumValue('MBarnDoor', 1, 'right'), EnumValue('MBarnDoor', 2, 'top'), EnumValue('MBarnDoor', 3, 'bottom'))¶

MDecayRegion = Enum( EnumValue('MDecayRegion', 0, 'first'), EnumValue('MDecayRegion', 1, 'second'), EnumValue('MDecayRegion', 2, 'third'))¶

getBarnDoorAngle(which_door)¶

Retrieves the value of the barn door angle for the specified barn door. The barn door angles are represented by the “leftBarnDoor”, “rightBarnDoor”, “topBarnDoor”, and “bottomBarnDoor” attributes. This function retrieves the value of the appropriate attribute.

Parameters:	which_door : `SpotLight.MBarnDoor` which barn door to return. values: ‘left’, ‘right’, ‘top’, ‘bottom’
Return type:	`float`

Derived from api method maya.OpenMaya.MFnSpotLight.barnDoorAngle

getBarnDoors()¶

Retrieves the value of the “barnDoors” attribute of a light node. This attribute determines whether or not the light uses barn doors.

Return type:	`bool`

Derived from api method maya.OpenMaya.MFnSpotLight.barnDoors

getBottomBarnDoorAngle(**kwargs)¶

Angle of the bottom of the barn door.

Derived from mel command maya.cmds.spotLight

getConeAngle()¶

Retrieves the value of the “coneAngle” attribute of a light node. This attribute represents the angle that the spotlight cone makes with the spotlight direction vector.

Return type:	`float`

Derived from api method maya.OpenMaya.MFnSpotLight.coneAngle

getDiscRadius(**kwargs)¶

Radius of shadow disc.

Derived from mel command maya.cmds.spotLight

getDropOff()¶

Retrieves the value of the “dropOff” attribute of a light node. This attribute represents the degree to which intensity of the light decreases with increasing angular distance from the light direction vector. Higher values represent more rapid intensity dropoff.

Return type:	`float`

Derived from api method maya.OpenMaya.MFnSpotLight.dropOff

getEndDistance(which_region)¶

Retrieves the value of the end distance for the specified decay regions. The end distances for the spotlight’s 3 decay regions are represented by the “endDistance1”, “endDistance2”, and “endDistance3” attributes. This function retrieves the value of the appropriate attribute.

Parameters:	which_region : `SpotLight.MDecayRegion` the decay region whose endDistance attribute is to be retrieved. values: ‘first’, ‘second’, ‘third’
Return type:	`float`

Derived from api method maya.OpenMaya.MFnSpotLight.endDistance

getExclusive(**kwargs)¶

True if the light is exclusively assigned

Derived from mel command maya.cmds.spotLight

getLeftBarnDoorAngle(**kwargs)¶

Angle of the left of the barn door.

Derived from mel command maya.cmds.spotLight

getPenumbra()¶

Retrieves the value of the “penumbraAngle” attribute of a light node. This attribute represents the extra angle beyond the cone angle used in soft shadow computations.

Return type:	`float`

Derived from api method maya.OpenMaya.MFnSpotLight.penumbraAngle

getRgb(**kwargs)¶

RGB colour of the light

Derived from mel command maya.cmds.spotLight

getRightBarnDoorAngle(**kwargs)¶

Angle of the right of the barn door.

Derived from mel command maya.cmds.spotLight

getShadowDither(**kwargs)¶

Shadow dithering value.

Derived from mel command maya.cmds.spotLight

getShadowSamples(**kwargs)¶

Numbr of shadow samples to use

Derived from mel command maya.cmds.spotLight

getSoftShadow(**kwargs)¶

True if soft shadowing is to be enabled

Derived from mel command maya.cmds.spotLight

getStartDistance(which_region)¶

Retrieves the value of the start distance for the specified decay regions. The start distances for the spotlight’s 3 decay regions are represented by the “startDistance1”, “startDistance2”, and “startDistance3” attributes. This function retrieves the value of the appropriate attribute.

Parameters:	which_region : `SpotLight.MDecayRegion` the decay region whose startDistance attribute is to be retrieved. values: ‘first’, ‘second’, ‘third’
Return type:	`float`

Derived from api method maya.OpenMaya.MFnSpotLight.startDistance

getTopBarnDoorAngle(**kwargs)¶

Angle of the top of the barn door.

Derived from mel command maya.cmds.spotLight

getUseDecayRegions()¶

Retrieves the value of the “useDecayRegions” attribute of a light node. This attribute determines whether or not the light uses decay regions.

Return type:	`bool`

Derived from api method maya.OpenMaya.MFnSpotLight.useDecayRegions

setBarnDoorAngle(which_door, barn_door_angle)¶

Sets the value of the appropriate barn door angle attribute of a light node.

Parameters:	which_door : `SpotLight.MBarnDoor` Which barn door to return. values: ‘left’, ‘right’, ‘top’, ‘bottom’ barn_door_angle : `float` New value for the barn door.

Derived from api method maya.OpenMaya.MFnSpotLight.setBarnDoorAngle

setBarnDoors(barn_doors)¶

Sets the value of the “barnDoors” attribute of a light node.

Parameters:	barn_doors : `bool` value to which the attribute will be set.

Derived from api method maya.OpenMaya.MFnSpotLight.setBarnDoors

setBottomBarnDoorAngle(val=True, **kwargs)¶

Angle of the bottom of the barn door.

Derived from mel command maya.cmds.spotLight

setConeAngle(cone_angle)¶

Sets the value of the “coneAngle” attribute of a light node.

Parameters:	cone_angle : `float` value to which the attribute will be set.

Derived from api method maya.OpenMaya.MFnSpotLight.setConeAngle

setDropOff(drop_off)¶

Sets the value of the “dropOff” attribute of a light node.

Parameters:	drop_off : `float` value to which the attribute will be set.

Derived from api method maya.OpenMaya.MFnSpotLight.setDropOff

setEndDistance(which_region, end_distance)¶

Sets the value of the appropriate decay region end distance attribute of a light node.

Parameters:	which_region : `SpotLight.MDecayRegion` the decay region whose end distance is to be set. values: ‘first’, ‘second’, ‘third’ end_distance : `float` value to which the attribute will be set.

Derived from api method maya.OpenMaya.MFnSpotLight.setEndDistance

setLeftBarnDoorAngle(val=True, **kwargs)¶

Angle of the left of the barn door.

Derived from mel command maya.cmds.spotLight

setPenumbra(penumbra_angle)¶

Sets the value of the “penumbraAngle” attribute of a light node.

Parameters:	penumbra_angle : `float` value to which the attribute will be set.

Derived from api method maya.OpenMaya.MFnSpotLight.setPenumbraAngle

setRightBarnDoorAngle(val=True, **kwargs)¶

Angle of the right of the barn door.

Derived from mel command maya.cmds.spotLight

setStartDistance(which_region, start_distance)¶

Sets the value of the appropriate decay region start distance attribute of a light node.

Parameters:	which_region : `SpotLight.MDecayRegion` the decay region whose start distance is to be set. values: ‘first’, ‘second’, ‘third’ start_distance : `float` value to which the attribute will be set.

Derived from api method maya.OpenMaya.MFnSpotLight.setStartDistance

setTopBarnDoorAngle(val=True, **kwargs)¶

Angle of the top of the barn door.

Derived from mel command maya.cmds.spotLight

setUseDecayRegions(use_decay_regions)¶

Sets the value of the “useDecayRegions” attribute of a light node.

Parameters:	use_decay_regions : `bool` value to which the attribute will be set.

Derived from api method maya.OpenMaya.MFnSpotLight.setUseDecayRegions