GenLight Class Reference

Class Description

A generic light object. Many light plug-ins are derived from this.

Inheritance diagram for GenLight:

Public Member Functions
def	GetAffectDiffuse (self)
def	GetAffectSpecular (self)
def	GetAmbientOnly (self)
def	GetAtmosColAmt (self, args)
def	GetAtmosOpacity (self, args)
def	GetAtmosShadows (self, args)
def	GetAttenNearDisplay (self)
def	GetColorControl (self)
def	GetContrast (self, args)
def	GetDecayRadius (self, args)
def	GetDecayType (self)
def	GetDiffuseSoft (self, args)
def	GetFalloffControl (self)
def	GetHotSpotControl (self)
def	GetLightAffectsShadow (self)
def	GetLightType (self)
def	GetShadColor (self, args)
def	GetShadMult (self, args)
def	GetShadowProjMap (self)
def	GetUseAttenNear (self)
def	GetUseShadowColorMap (self, args)
def	IsDir (self)
def	IsSpot (self)
def	SetAbsMapBias (self, args)
def	SetAffectDiffuse (self, args)
def	SetAffectSpecular (self, args)
def	SetAmbientOnly (self, args)
def	SetAtmosColAmt (self, args)
def	SetAtmosOpacity (self, args)
def	SetAtmosShadows (self, args)
def	SetAttenNearDisplay (self, args)
def	SetColorControl (self, args)
def	SetContrast (self, args)
def	SetDecayRadius (self, args)
def	SetDecayType (self, args)
def	SetDiffuseSoft (self, args)
def	SetFalloffControl (self, args)
def	SetHotSpotControl (self, args)
def	SetLightAffectsShadow (self, args)
def	SetLightType (self, args)
def	SetOvershoot (self, args)
def	SetShadColor (self, args)
def	SetShadMult (self, args)
def	SetShadowProjMap (self, args)
def	SetUseAttenNear (self, args)
def	SetUseShadowColorMap (self, args)
Public Member Functions inherited from LightObject
def	Enable (self, args)
def	Eval (self, args)
def	GetAbsMapBias (self)
def	GetAspect (self, args)
def	GetAtten (self, args)
def	GetAttenDisplay (self)
def	GetConeDisplay (self)
def	GetFallsize (self, args)
def	GetHotspot (self, args)
def	GetIntensity (self, args)
def	GetMapBias (self, args)
def	GetMapRange (self, args)
def	GetMapSize (self, args)
def	GetOvershoot (self)
def	GetProjector (self)
def	GetProjMap (self)
def	GetRayBias (self, args)
def	GetRGBColor (self, args)
def	GetShadow (self)
def	GetShadowMethod (self)
def	GetShadowType (self)
def	GetTDist (self, args)
def	GetUseAtten (self)
def	GetUseGlobal (self)
def	GetUseLight (self)
def	SetAbsMapBias (self, args)
def	SetAspect (self, args)
def	SetAtten (self, args)
def	SetAttenDisplay (self, args)
def	SetConeDisplay (self, args)
def	SetFallsize (self, args)
def	SetHotspot (self, args)
def	SetIntensity (self, args)
def	SetMapBias (self, args)
def	SetMapRange (self, args)
def	SetMapSize (self, args)
def	SetOvershoot (self, args)
def	SetProjector (self, args)
def	SetProjMap (self, args)
def	SetRayBias (self, args)
def	SetRGBColor (self, args)
def	SetShadow (self, args)
def	SetShadowType (self, args)
def	SetTDist (self, args)
def	SetUseAtten (self, args)
def	SetUseGlobal (self, args)
def	SetUseLight (self, args)
def	UpdateTargDistance (self, args)
Public Member Functions inherited from Object
def	ApplyUVWMap (self, args)
def	AsParticleObject (self, args)
def	AsShapeObject (self, args)
def	AsSplineShape (self, args)
def	AsTriObject (self, args)
def	BranchDeleted (self, args)
def	CanCacheObject (self)
def	CanConvertToType (self, args)
def	CheckObjectIntegrity (self)
def	CollapseObject (self)
def	ContainedShapeSelectionArray (self)
def	ConvertToDerivedObject (self)
def	ConvertToType (self, args)
def	CopyAdditionalChannels (self, args)
def	CopyChannelLocks (self, args)
def	DeleteAllAdditionalChannels (self)
def	DoOwnSelectHilite (self)
def	Eval (self, args)
def	FindBaseObject (self)
def	FreeChannels (self, args)
def	GetBranchINode (self, args)
def	GetChannelLocks (self, args)
def	GetChannelValidity (self, args)
def	GetContainedShape (self, args)
def	GetContainedShapeMatrix (self, args)
def	GetDeformBBox (self, args)
def	GetExtendedProperties (self, args)
def	GetNoEvalInterval (self)
def	GetNumContainedShapes (self)
def	GetNumFaces (self, args)
def	GetNumMapChannels (self)
def	GetNumMapsUsed (self)
def	GetNumPipeBranches
def	GetNumPoints (self)
def	GetNumSurfaces (self, args)
def	GetNumVerts (self, args)
def	GetObjectValidity (self, args)
def	GetPipeBranch (self, args)
def	GetPoint (self, args)
def	GetSubselState (self)
def	GetSurfacePoint (self, args)
def	GetWeight (self, args)
def	GetWorldSpaceObjectNode (self)
def	HasWeights (self)
def	InitNodeName (self, args)
def	IntersectRay (self, args)
def	InvalidateChannels (self, args)
def	IsBaseClassOwnedChannel (self, args)
def	IsDeformable (self)
def	IsManipulator (self)
def	IsMappable (self)
def	IsObjectLocked (self)
def	IsParamSurface (self)
def	IsParticleSystem (self)
def	IsPointSelected (self, args)
def	IsRenderable (self)
def	IsShapeObject (self)
def	IsWorldSpaceObject (self)
def	LockChannels (self, args)
def	LockObject (self)
def	MakeShallowCopy (self, args)
def	MergeAdditionalChannels (self, args)
def	NewAndCopyChannels (self, args)
def	NormalAlignVector (self, args)
def	PointSelection (self, args)
def	PointsWereChanged (self)
def	PreferredCollapseType (self)
def	ReadyChannelsForMod (self, args)
def	ReduceCaches (self, args)
def	SetChannelLocks (self, args)
def	SetChannelValidity (self, args)
def	SetNoEvalInterval (self, args)
def	SetPoint (self, args)
def	SetSubSelState (self, args)
def	SetWeight (self, args)
def	ShallowCopy (self, args)
def	SurfaceClosedU (self, args)
def	SurfaceClosedV (self, args)
def	TopologyChanged (self)
def	UnlockChannels (self, args)
def	UnlockObject (self)
def	UpdateValidity (self, args)
def	UseSelectionBrackets (self)
def	UsesWireColor (self)
def	WSStateInvalidate (self)
Public Member Functions inherited from BaseObject
def	ActivateSubSelSet (self, args)
def	ChangeTopology (self)
def	ClearSelection (self, args)
def	ForceNotify (self, args)
def	GetLocalBoundBox (self, args)
def	GetNamedSelSetName (self, args)
def	GetNumNamedSelSets (self)
def	GetNumSubObjTypes (self)
def	GetObjectName (self)
def	GetSubObjectLevel (self)
def	GetSubObjType (self, args)
def	GetSubObjTypeName (self, args)
def	GetWorldBoundBox (self, args)
def	HasUVW (self, args)
def	HasViewDependentBoundingBox (self)
def	HitTest (self, args)
def	InvertSelection (self, args)
def	Move (self, args)
def	NewSetFromCurSel (self, args)
def	OKToChangeTopology (self, args)
def	RemoveSubSelSet (self, args)
def	Rotate (self, args)
def	Scale (self, args)
def	SelectAll (self, args)
def	SetGenUVW (self, args)
def	SetNamedSelSetName (self, args)
def	SetupNamedSelDropDown (self)
def	SupportsNamedSubSels (self)
def	TransformCancel (self, args)
def	TransformFinish (self, args)
def	TransformHoldingFinish (self, args)
def	TransformHoldingStart (self, args)
def	TransformStart (self, args)
Public Member Functions inherited from ReferenceTarget
def	FindDependentNode (self)
def	MaybeAutoDelete (self)
def	NotifyTarget (self, args)
Public Member Functions inherited from ReferenceMaker
def	ClearFlagInHierarchy (self, args)
def	DeleteMe (self)
def	DeleteReference (self, args)
def	FindRef (self, args)
def	GetNumRefs (self)
def	GetReference (self, args)
def	NotifyChanged (self)
def	NotifyDependents (self, args)
def	ReplaceReference (self, args)
def	RescaleWorldUnits (self, args)
Public Member Functions inherited from Animatable
def	AddNewKey (self, args)
def	AssignController (self, args)
def	CanAssignController (self, args)
def	CanCopyAnim (self)
def	CanCopyTrack (self, args)
def	CanDeleteSubAnim (self, args)
def	CanMakeUnique (self)
def	ClearAFlag (self, args)
def	ClearAFlagEx (self, args)
def	ClearAllAppData (self)
def	ClearFlagBit (self, args)
def	ClearFlagInAllAnimatables (args)
def	CopyKeysFromTime (self, args)
def	DeleteAppData (self, args)
def	DeleteKeyAtTime (self, args)
def	DeleteKeyByIndex (self, args)
def	DeleteKeys (self, args)
def	DeleteSubAnim (self, args)
def	DeleteTime (self, args)
def	DoesSupportTimeOperations (self)
def	EditTimeRange (self, args)
def	FreeCaches (self)
def	GetAnimByHandle (args)
def	GetAnimHandle (self)
def	GetAppData (self, args)
def	GetClassID (self)
def	GetClassName (self)
def	GetCustomAttributeContainer (self)
def	GetHasSubElements
def	GetKeyIndex (self, args)
def	GetKeyTime (self, args)
def	GetNextKeyTime (self, args)
def	GetNodeName (self)
def	GetNumKeys (self)
def	GetNumSubAnims (self)
def	GetParameterBlock (self)
def	GetSubAnim (self, args)
def	GetSubAnimName (self, args)
def	GetSuperClassID (self)
def	GetTimeRange (self, args)
def	InsertTime (self, args)
def	IsAnimated (self)
def	IsKeyAtTime (self, args)
def	IsSubClassOf (self, args)
def	MoveKeys (self, args)
def	ReverseTime (self, args)
def	ScaleKeyValues (self, args)
def	ScaleTime (self, args)
def	SetAFlag (self, args)
def	SetAFlagEx (self, args)
def	SetAppData (self, args)
def	SetFlagBit (self, args)
def	SubNumToRefNum (self, args)
def	TestAFlag (self, args)
def	TestAFlagEx (self, args)
def	TestFlagBit (self, args)
Public Member Functions inherited from InterfaceServer
def	GetInterface (self, args)
Public Member Functions inherited from Wrapper
def	GetUnwrappedPtr (self)

Static Public Attributes
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from LightObject
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from Object
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from BaseObject
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from ReferenceTarget
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from ReferenceMaker
tuple	NumRefs = _swig_property(GetNumRefs)
tuple	Refs = _swig_property(lambda self: (self.GetReference(i) for i in xrange(self.GetNumRefs())))
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from Animatable
tuple	AnimHandle = _swig_property(GetAnimHandle)
tuple	ClassID = _swig_property(GetClassID)
tuple	ClearFlagInAllAnimatables = staticmethod(ClearFlagInAllAnimatables)
tuple	GetAnimByHandle = staticmethod(GetAnimByHandle)
tuple	KeyTimes = _swig_property(lambda self: (self.GetKeyTime(i) for i in xrange(self.GetNumKeys())))
tuple	NodeName = _swig_property(GetNodeName)
tuple	NumSubAnims = _swig_property(GetNumSubAnims)
tuple	ParameterBlock = _swig_property(GetParameterBlock)
tuple	SubAnimNames = _swig_property(lambda self: (self.GetSubAnimName(i) for i in xrange(self.GetNumSubAnims())))
tuple	SubAnims = _swig_property(lambda self: (self.GetSubAnim(i) for i in xrange(self.GetNumSubAnims())))
tuple	SuperClassID = _swig_property(GetSuperClassID)
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from InterfaceServer
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
Static Public Attributes inherited from Wrapper
tuple	thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')

Member Function Documentation

def GetAffectDiffuse

(

self

)

GetAffectDiffuse(GenLight self) -> bool

def GetAffectSpecular

(

self

)

GetAffectSpecular(GenLight self) -> bool

def GetAmbientOnly

(

self

)

GetAmbientOnly(GenLight self) -> bool

def GetAtmosColAmt	(		self,
			args
	)

GetAtmosColAmt(GenLight self, TimeValue t=Autodesk::Max::Now(), Interval valid=FOREVER) -> float
GetAtmosColAmt(GenLight self, TimeValue t=Autodesk::Max::Now()) -> float
GetAtmosColAmt(GenLight self) -> float

def GetAtmosOpacity	(		self,
			args
	)

GetAtmosOpacity(GenLight self, TimeValue t=Autodesk::Max::Now(), Interval valid=FOREVER) -> float
GetAtmosOpacity(GenLight self, TimeValue t=Autodesk::Max::Now()) -> float
GetAtmosOpacity(GenLight self) -> float

def GetAtmosShadows	(		self,
			args
	)

GetAtmosShadows(GenLight self, TimeValue t=Autodesk::Max::Now()) -> bool
GetAtmosShadows(GenLight self) -> bool

def GetAttenNearDisplay

(

self

)

GetAttenNearDisplay(GenLight self) -> bool

def GetColorControl

(

self

)

GetColorControl(GenLight self) -> Control

def GetContrast	(		self,
			args
	)

GetContrast(GenLight self, TimeValue t=Autodesk::Max::Now(), Interval valid=Autodesk::Max::Interval(0, 0)) -> float
GetContrast(GenLight self, TimeValue t=Autodesk::Max::Now()) -> float
GetContrast(GenLight self) -> float

def GetDecayRadius	(		self,
			args
	)

GetDecayRadius(GenLight self, TimeValue t=Autodesk::Max::Now(), Interval valid=Autodesk::Max::Interval(0, 0)) -> float
GetDecayRadius(GenLight self, TimeValue t=Autodesk::Max::Now()) -> float
GetDecayRadius(GenLight self) -> float

def GetDecayType

(

self

)

GetDecayType(GenLight self) -> bool

def GetDiffuseSoft	(		self,
			args
	)

GetDiffuseSoft(GenLight self, TimeValue t=Autodesk::Max::Now(), Interval valid=Autodesk::Max::Interval(0, 0)) -> float
GetDiffuseSoft(GenLight self, TimeValue t=Autodesk::Max::Now()) -> float
GetDiffuseSoft(GenLight self) -> float

def GetFalloffControl

(

self

)

GetFalloffControl(GenLight self) -> Control

def GetHotSpotControl

(

self

)

GetHotSpotControl(GenLight self) -> Control

def GetLightAffectsShadow

(

self

)

GetLightAffectsShadow(GenLight self) -> bool

def GetLightType

(

self

)

GetLightType(GenLight self) -> int

def GetShadColor	(		self,
			args
	)

GetShadColor(GenLight self, TimeValue t=Autodesk::Max::Now(), Interval valid=Autodesk::Max::Interval(0, 0)) -> Point3
GetShadColor(GenLight self, TimeValue t=Autodesk::Max::Now()) -> Point3
GetShadColor(GenLight self) -> Point3

def GetShadMult	(		self,
			args
	)

GetShadMult(GenLight self, TimeValue t=Autodesk::Max::Now(), Interval valid=Autodesk::Max::Interval(0, 0)) -> float
GetShadMult(GenLight self, TimeValue t=Autodesk::Max::Now()) -> float
GetShadMult(GenLight self) -> float

def GetShadowProjMap

(

self

)

GetShadowProjMap(GenLight self) -> Texmap

def GetUseAttenNear

(

self

)

GetUseAttenNear(GenLight self) -> bool

def GetUseShadowColorMap	(		self,
			args
	)

GetUseShadowColorMap(GenLight self, TimeValue t=Autodesk::Max::Now()) -> bool
GetUseShadowColorMap(GenLight self) -> bool

def IsDir

(

self

)

IsDir(GenLight self) -> bool

def IsSpot

(

self

)

IsSpot(GenLight self) -> bool

def SetAbsMapBias	(		self,
			args
	)

SetAbsMapBias(GenLight self, int a)

def SetAffectDiffuse	(		self,
			args
	)

SetAffectDiffuse(GenLight self, bool onOff)

def SetAffectSpecular	(		self,
			args
	)

SetAffectSpecular(GenLight self, bool onOff)

def SetAmbientOnly	(		self,
			args
	)

SetAmbientOnly(GenLight self, bool onOff)

def SetAtmosColAmt	(		self,
			args
	)

SetAtmosColAmt(GenLight self, float f, TimeValue t=Autodesk::Max::Now())
SetAtmosColAmt(GenLight self, float f)

def SetAtmosOpacity	(		self,
			args
	)

SetAtmosOpacity(GenLight self, float f, TimeValue t=Autodesk::Max::Now())
SetAtmosOpacity(GenLight self, float f)

def SetAtmosShadows	(		self,
			args
	)

SetAtmosShadows(GenLight self, bool onOff, TimeValue t=Autodesk::Max::Now())
SetAtmosShadows(GenLight self, bool onOff)

def SetAttenNearDisplay	(		self,
			args
	)

SetAttenNearDisplay(GenLight self, bool s)

def SetColorControl	(		self,
			args
	)

SetColorControl(GenLight self, Control c) -> bool

def SetContrast	(		self,
			args
	)

SetContrast(GenLight self, float f, TimeValue time=Autodesk::Max::Now())
SetContrast(GenLight self, float f)

def SetDecayRadius	(		self,
			args
	)

SetDecayRadius(GenLight self, float f, TimeValue time=Autodesk::Max::Now())
SetDecayRadius(GenLight self, float f)

def SetDecayType	(		self,
			args
	)

SetDecayType(GenLight self, bool onOff)

def SetDiffuseSoft	(		self,
			args
	)

SetDiffuseSoft(GenLight self, float f, TimeValue time=Autodesk::Max::Now())
SetDiffuseSoft(GenLight self, float f)

def SetFalloffControl	(		self,
			args
	)

SetFalloffControl(GenLight self, Control c) -> bool

def SetHotSpotControl	(		self,
			args
	)

SetHotSpotControl(GenLight self, Control c) -> bool

def SetLightAffectsShadow	(		self,
			args
	)

SetLightAffectsShadow(GenLight self, bool b)

def SetLightType	(		self,
			args
	)

SetLightType(GenLight self, int tp)

def SetOvershoot	(		self,
			args
	)

SetOvershoot(GenLight self, bool a)

def SetShadColor	(		self,
			args
	)

SetShadColor(GenLight self, Point3 rgb, TimeValue t=Autodesk::Max::Now())
SetShadColor(GenLight self, Point3 rgb)

def SetShadMult	(		self,
			args
	)

SetShadMult(GenLight self, float m, TimeValue t=Autodesk::Max::Now())
SetShadMult(GenLight self, float m)

def SetShadowProjMap	(		self,
			args
	)

SetShadowProjMap(GenLight self, Texmap pmap)

def SetUseAttenNear	(		self,
			args
	)

SetUseAttenNear(GenLight self, bool s)

def SetUseShadowColorMap	(		self,
			args
	)

SetUseShadowColorMap(GenLight self, bool onOff, TimeValue t=Autodesk::Max::Now())
SetUseShadowColorMap(GenLight self, bool onOff)