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

Public Member Functions

def Active (self, *args)
 
def AppendGizmo (self, *args)
 
def DeleteGizmo (self, *args)
 
def EditGizmo (self, *args)
 
def GetGizmo (self, *args)
 
def GetName (self)
 
def GetNumGizmos (self)
 
def GetSpecialFXName (self)
 
def InsertGizmo (self, *args)
 
def OKGizmo (self, *args)
 
def SetSpecialFXName (self, *args)
 
def Update (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 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

Base class for plug-ins that have an effect on the render like atmospherics and anti-aliasing kernels.

Member Function Documentation

◆ Active()

def Active (   self,
args 
)
Active(SpecialFX self, TimeValue t=Autodesk::Max::Now()) -> bool
Active(SpecialFX self) -> bool

◆ AppendGizmo()

def AppendGizmo (   self,
args 
)
AppendGizmo(SpecialFX self, INode node)

◆ DeleteGizmo()

def DeleteGizmo (   self,
args 
)
DeleteGizmo(SpecialFX self, int i)

◆ EditGizmo()

def EditGizmo (   self,
args 
)
EditGizmo(SpecialFX self, INode node)

◆ GetGizmo()

def GetGizmo (   self,
args 
)
GetGizmo(SpecialFX self, int i) -> INode

◆ GetName()

def GetName (   self)
GetName(SpecialFX self) -> WStr

◆ GetNumGizmos()

def GetNumGizmos (   self)
GetNumGizmos(SpecialFX self) -> int

◆ GetSpecialFXName()

def GetSpecialFXName (   self)
GetSpecialFXName(SpecialFX self) -> WStr

◆ InsertGizmo()

def InsertGizmo (   self,
args 
)
InsertGizmo(SpecialFX self, int i, INode node)

◆ OKGizmo()

def OKGizmo (   self,
args 
)
OKGizmo(SpecialFX self, INode node) -> bool

◆ SetSpecialFXName()

def SetSpecialFXName (   self,
args 
)
SetSpecialFXName(SpecialFX self, WStr value)

◆ Update()

def Update (   self,
args 
)
Update(SpecialFX self, TimeValue t=Autodesk::Max::Now(), Interval valid=Autodesk::Max::Forever())
Update(SpecialFX self, TimeValue t=Autodesk::Max::Now())
Update(SpecialFX self)

Reimplemented in ToneOperator.