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

Public Member Functions

def ApplyCollisionObject (self, *args)
 
def ApplyForceField (self, *args)
 
def Evaluate (self, *args)
 
def GetNumLiveParticles (self)
 
def GetNumParticles (self)
 
def GetObjectDisplayRequirement (self)
 
def GetParticleAge (self, *args)
 
def GetParticleGroupTime (self, *args)
 
def GetParticleLifespan (self, *args)
 
def GetParticleOrientation (self, *args)
 
def GetParticlePosition (self, *args)
 
def GetParticleSelected (self, *args)
 
def GetParticleSize (self, *args)
 
def GetParticleSpin (self, *args)
 
def GetParticleTension (self, *args)
 
def GetParticleTM (self, *args)
 
def GetParticleVelocity (self, *args)
 
def GetParticleXYZSize (self, *args)
 
def HasConstantTopology (self)
 
def ParticleAge (self, *args)
 
def ParticleCenter (self, *args)
 
def ParticleLife (self, *args)
 
def ParticlePosition (self, *args)
 
def ParticleSize (self, *args)
 
def ParticleVelocity (self, *args)
 
def PrepareDisplay (self, *args)
 
def UpdatePerNodeItems (self, *args)
 
def UpdatePerViewItems (self, *args)
 
- Public Member Functions inherited from GeomObject
def CanDoDisplacementMapping (self)
 
def IsInstanceDependent (self)
 
def NumberOfRenderMeshes (self)
 
- 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 (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 GeomObject
 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 particle system.

Member Function Documentation

◆ ApplyCollisionObject()

def ApplyCollisionObject (   self,
args 
)
ApplyCollisionObject(ParticleObject self, CollisionObject * co) -> BOOL

◆ ApplyForceField()

def ApplyForceField (   self,
args 
)
ApplyForceField(ParticleObject self, ForceField * ff)

◆ Evaluate()

def Evaluate (   self,
args 
)
Evaluate(ParticleObject self, INode node, TimeValue t)

◆ GetNumLiveParticles()

def GetNumLiveParticles (   self)
GetNumLiveParticles(ParticleObject self) -> int

◆ GetNumParticles()

def GetNumParticles (   self)
GetNumParticles(ParticleObject self) -> int

◆ GetObjectDisplayRequirement()

def GetObjectDisplayRequirement (   self)
GetObjectDisplayRequirement(ParticleObject self) -> unsigned long

◆ GetParticleAge()

def GetParticleAge (   self,
args 
)
GetParticleAge(ParticleObject self, int i) -> int

◆ GetParticleGroupTime()

def GetParticleGroupTime (   self,
args 
)
GetParticleGroupTime(ParticleObject self, int i) -> int

◆ GetParticleLifespan()

def GetParticleLifespan (   self,
args 
)
GetParticleLifespan(ParticleObject self, int i) -> int

◆ GetParticleOrientation()

def GetParticleOrientation (   self,
args 
)
GetParticleOrientation(ParticleObject self, int i) -> Point3

◆ GetParticlePosition()

def GetParticlePosition (   self,
args 
)
GetParticlePosition(ParticleObject self, int i) -> Point3

◆ GetParticleSelected()

def GetParticleSelected (   self,
args 
)
GetParticleSelected(ParticleObject self, int i) -> bool

◆ GetParticleSize()

def GetParticleSize (   self,
args 
)
GetParticleSize(ParticleObject self, int i) -> float
GetParticleSize(ParticleObject self) -> float

◆ GetParticleSpin()

def GetParticleSpin (   self,
args 
)
GetParticleSpin(ParticleObject self, int i) -> AngAxis

◆ GetParticleTension()

def GetParticleTension (   self,
args 
)
GetParticleTension(ParticleObject self, int i) -> float

◆ GetParticleTM()

def GetParticleTM (   self,
args 
)
GetParticleTM(ParticleObject self, int i) -> Matrix3

◆ GetParticleVelocity()

def GetParticleVelocity (   self,
args 
)
GetParticleVelocity(ParticleObject self, int i) -> Point3

◆ GetParticleXYZSize()

def GetParticleXYZSize (   self,
args 
)
GetParticleXYZSize(ParticleObject self, int i) -> Point3

◆ HasConstantTopology()

def HasConstantTopology (   self)
HasConstantTopology(ParticleObject self) -> BOOL

◆ ParticleAge()

def ParticleAge (   self,
args 
)
ParticleAge(ParticleObject self, TimeValue t, int i) -> TimeValue

◆ ParticleCenter()

def ParticleCenter (   self,
args 
)
ParticleCenter(ParticleObject self, TimeValue t, int i) -> int

◆ ParticleLife()

def ParticleLife (   self,
args 
)
ParticleLife(ParticleObject self, TimeValue t, int i) -> TimeValue

◆ ParticlePosition()

def ParticlePosition (   self,
args 
)
ParticlePosition(ParticleObject self, TimeValue t, int i) -> Point3

◆ ParticleSize()

def ParticleSize (   self,
args 
)
ParticleSize(ParticleObject self, TimeValue t, int i) -> float

◆ ParticleVelocity()

def ParticleVelocity (   self,
args 
)
ParticleVelocity(ParticleObject self, TimeValue t, int i) -> Point3

◆ PrepareDisplay()

def PrepareDisplay (   self,
args 
)
PrepareDisplay(ParticleObject self, MaxSDK::Graphics::UpdateDisplayContext const & prepareDisplayContext) -> bool

◆ UpdatePerNodeItems()

def UpdatePerNodeItems (   self,
args 
)
UpdatePerNodeItems(ParticleObject self, MaxSDK::Graphics::UpdateDisplayContext const & updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext & nodeContext, 
    MaxSDK::Graphics::IRenderItemContainer & targetRenderItemContainer) -> bool

◆ UpdatePerViewItems()

def UpdatePerViewItems (   self,
args 
)
UpdatePerViewItems(ParticleObject self, MaxSDK::Graphics::UpdateDisplayContext const & updateDisplayContext, MaxSDK::Graphics::UpdateNodeContext & nodeContext, 
    MaxSDK::Graphics::UpdateViewContext & viewContext, 
    MaxSDK::Graphics::IRenderItemContainer & targetRenderItemContainer) -> bool