MaxPlus Python API Reference
LightObject Class Reference
+ Inheritance diagram for LightObject:

Public Member Functions

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 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 (self, selected=True)
 
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 (self, type=0)
 
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

 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
 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
 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
 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
 NumRefs = _swig_property(GetNumRefs)
 
 Refs = _swig_property(lambda self: (self.GetReference(i) for i in xrange(self.GetNumRefs())))
 
 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
 AnimHandle = _swig_property(GetAnimHandle)
 
 ClassID = _swig_property(GetClassID)
 
 ClearFlagInAllAnimatables = staticmethod(ClearFlagInAllAnimatables)
 
 GetAnimByHandle = staticmethod(GetAnimByHandle)
 
 KeyTimes = _swig_property(lambda self: (self.GetKeyTime(i) for i in xrange(self.GetNumKeys())))
 
 NodeName = _swig_property(GetNodeName)
 
 NumSubAnims = _swig_property(GetNumSubAnims)
 
 ParameterBlock = _swig_property(GetParameterBlock)
 
 SubAnimNames = _swig_property(lambda self: (self.GetSubAnimName(i) for i in xrange(self.GetNumSubAnims())))
 
 SubAnims = _swig_property(lambda self: (self.GetSubAnim(i) for i in xrange(self.GetNumSubAnims())))
 
 SuperClassID = _swig_property(GetSuperClassID)
 
 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
 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
 thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
 

Detailed Description

A light plug-in object.

Member Function Documentation

◆ Enable()

def Enable (   self,
args 
)
Enable(LightObject self, bool enab)

◆ Eval()

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

Reimplemented from Object.

◆ GetAbsMapBias()

def GetAbsMapBias (   self)
GetAbsMapBias(LightObject self) -> bool

◆ GetAspect()

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

◆ GetAtten()

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

◆ GetAttenDisplay()

def GetAttenDisplay (   self)
GetAttenDisplay(LightObject self) -> bool

◆ GetConeDisplay()

def GetConeDisplay (   self)
GetConeDisplay(LightObject self) -> bool

◆ GetFallsize()

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

◆ GetHotspot()

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

◆ GetIntensity()

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

◆ GetMapBias()

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

◆ GetMapRange()

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

◆ GetMapSize()

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

◆ GetOvershoot()

def GetOvershoot (   self)
GetOvershoot(LightObject self) -> int

◆ GetProjector()

def GetProjector (   self)
GetProjector(LightObject self) -> int

◆ GetProjMap()

def GetProjMap (   self)
GetProjMap(LightObject self) -> Texmap

◆ GetRayBias()

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

◆ GetRGBColor()

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

◆ GetShadow()

def GetShadow (   self)
GetShadow(LightObject self) -> bool

◆ GetShadowMethod()

def GetShadowMethod (   self)
GetShadowMethod(LightObject self) -> int

◆ GetShadowType()

def GetShadowType (   self)
GetShadowType(LightObject self) -> int

◆ GetTDist()

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

◆ GetUseAtten()

def GetUseAtten (   self)
GetUseAtten(LightObject self) -> bool

◆ GetUseGlobal()

def GetUseGlobal (   self)
GetUseGlobal(LightObject self) -> bool

◆ GetUseLight()

def GetUseLight (   self)
GetUseLight(LightObject self) -> bool

◆ SetAbsMapBias()

def SetAbsMapBias (   self,
args 
)
SetAbsMapBias(LightObject self, bool a)

Reimplemented in GenLight.

◆ SetAspect()

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

◆ SetAtten()

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

◆ SetAttenDisplay()

def SetAttenDisplay (   self,
args 
)
SetAttenDisplay(LightObject self, bool s)

◆ SetConeDisplay()

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

◆ SetFallsize()

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

◆ SetHotspot()

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

◆ SetIntensity()

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

◆ SetMapBias()

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

◆ SetMapRange()

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

◆ SetMapSize()

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

◆ SetOvershoot()

def SetOvershoot (   self,
args 
)
SetOvershoot(LightObject self, int a)

Reimplemented in GenLight.

◆ SetProjector()

def SetProjector (   self,
args 
)
SetProjector(LightObject self, int a)

◆ SetProjMap()

def SetProjMap (   self,
args 
)
SetProjMap(LightObject self, Texmap pmap)

◆ SetRayBias()

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

◆ SetRGBColor()

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

◆ SetShadow()

def SetShadow (   self,
args 
)
SetShadow(LightObject self, bool a)

◆ SetShadowType()

def SetShadowType (   self,
args 
)
SetShadowType(LightObject self, int a)

◆ SetTDist()

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

◆ SetUseAtten()

def SetUseAtten (   self,
args 
)
SetUseAtten(LightObject self, bool s)

◆ SetUseGlobal()

def SetUseGlobal (   self,
args 
)
SetUseGlobal(LightObject self, bool a)

◆ SetUseLight()

def SetUseLight (   self,
args 
)
SetUseLight(LightObject self, int onOff)

◆ UpdateTargDistance()

def UpdateTargDistance (   self,
args 
)
UpdateTargDistance(LightObject self, TimeValue t, INode inode)