LightObject Class Reference

This reference page is linked to from the following overview topics:

---

Class Description

A light plug-in object.

Inheritance diagram for LightObject:

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

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 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 Enable	(		self,
			args
	)

Enable(LightObject self, bool enab)

def Eval	(		self,
			args
	)

Eval(LightObject self, LightState ls, TimeValue time=Autodesk::Max::Now(), Interval valid=Autodesk::Max::Forever()) -> RefResult
Eval(LightObject self, LightState ls, TimeValue time=Autodesk::Max::Now()) -> RefResult
Eval(LightObject self, LightState ls) -> RefResult

def GetAbsMapBias

(

self

)

GetAbsMapBias(LightObject self) -> bool

def GetAspect	(		self,
			args
	)

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

def GetAtten	(		self,
			args
	)

GetAtten(LightObject self, int which, TimeValue t=Autodesk::Max::Now(), Interval valid=Autodesk::Max::Interval(0, 0)) -> float
GetAtten(LightObject self, int which, TimeValue t=Autodesk::Max::Now()) -> float
GetAtten(LightObject self, int which) -> float

def GetAttenDisplay

(

self

)

GetAttenDisplay(LightObject self) -> bool

def GetConeDisplay

(

self

)

GetConeDisplay(LightObject self) -> bool

def GetFallsize	(		self,
			args
	)

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

def GetHotspot	(		self,
			args
	)

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

def GetIntensity	(		self,
			args
	)

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

def GetMapBias	(		self,
			args
	)

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

def GetMapRange	(		self,
			args
	)

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

def GetMapSize	(		self,
			args
	)

GetMapSize(LightObject self, TimeValue t=Autodesk::Max::Now(), Interval valid=Autodesk::Max::Interval(0, 0)) -> int
GetMapSize(LightObject self, TimeValue t=Autodesk::Max::Now()) -> int
GetMapSize(LightObject self) -> int

def GetOvershoot

(

self

)

GetOvershoot(LightObject self) -> int

def GetProjector

(

self

)

GetProjector(LightObject self) -> int

def GetProjMap

(

self

)

GetProjMap(LightObject self) -> Texmap

def GetRayBias	(		self,
			args
	)

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

def GetRGBColor	(		self,
			args
	)

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

def GetShadow

(

self

)

GetShadow(LightObject self) -> bool

def GetShadowMethod

(

self

)

GetShadowMethod(LightObject self) -> int

def GetShadowType

(

self

)

GetShadowType(LightObject self) -> int

def GetTDist	(		self,
			args
	)

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

def GetUseAtten

(

self

)

GetUseAtten(LightObject self) -> bool

def GetUseGlobal

(

self

)

GetUseGlobal(LightObject self) -> bool

def GetUseLight

(

self

)

GetUseLight(LightObject self) -> bool

def SetAbsMapBias	(		self,
			args
	)

SetAbsMapBias(LightObject self, bool a)

def SetAspect	(		self,
			args
	)

SetAspect(LightObject self, float f, TimeValue t=Autodesk::Max::Now())
SetAspect(LightObject self, float f)

def SetAtten	(		self,
			args
	)

SetAtten(LightObject self, int which, float f, TimeValue time=Autodesk::Max::Now())
SetAtten(LightObject self, int which, float f)

def SetAttenDisplay	(		self,
			args
	)

SetAttenDisplay(LightObject self, bool s)

def SetConeDisplay	(		self,
			args
	)

SetConeDisplay(LightObject self, bool s, int notify=TRUE)
SetConeDisplay(LightObject self, bool s)

def SetFallsize	(		self,
			args
	)

SetFallsize(LightObject self, float f, TimeValue time=Autodesk::Max::Now())
SetFallsize(LightObject self, float f)

def SetHotspot	(		self,
			args
	)

SetHotspot(LightObject self, float f, TimeValue time=Autodesk::Max::Now())
SetHotspot(LightObject self, float f)

def SetIntensity	(		self,
			args
	)

SetIntensity(LightObject self, float f, TimeValue time=Autodesk::Max::Now())
SetIntensity(LightObject self, float f)

def SetMapBias	(		self,
			args
	)

SetMapBias(LightObject self, float f, TimeValue t=Autodesk::Max::Now())
SetMapBias(LightObject self, float f)

def SetMapRange	(		self,
			args
	)

SetMapRange(LightObject self, float f, TimeValue t=Autodesk::Max::Now())
SetMapRange(LightObject self, float f)

def SetMapSize	(		self,
			args
	)

SetMapSize(LightObject self, int f, TimeValue t=Autodesk::Max::Now())
SetMapSize(LightObject self, int f)

def SetOvershoot	(		self,
			args
	)

SetOvershoot(LightObject self, int a)

def SetProjector	(		self,
			args
	)

SetProjector(LightObject self, int a)

def SetProjMap	(		self,
			args
	)

SetProjMap(LightObject self, Texmap pmap)

def SetRayBias	(		self,
			args
	)

SetRayBias(LightObject self, float f, TimeValue t=Autodesk::Max::Now())
SetRayBias(LightObject self, float f)

def SetRGBColor	(		self,
			args
	)

SetRGBColor(LightObject self, Point3 rgb, TimeValue t=Autodesk::Max::Now())
SetRGBColor(LightObject self, Point3 rgb)

def SetShadow	(		self,
			args
	)

SetShadow(LightObject self, bool a)

def SetShadowType	(		self,
			args
	)

SetShadowType(LightObject self, int a)

def SetTDist	(		self,
			args
	)

SetTDist(LightObject self, float f, TimeValue time=Autodesk::Max::Now())
SetTDist(LightObject self, float f)

def SetUseAtten	(		self,
			args
	)

SetUseAtten(LightObject self, bool s)

def SetUseGlobal	(		self,
			args
	)

SetUseGlobal(LightObject self, bool a)

def SetUseLight	(		self,
			args
	)

SetUseLight(LightObject self, int onOff)

def UpdateTargDistance	(		self,
			args
	)

UpdateTargDistance(LightObject self, TimeValue t, INode inode)