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

Public Member Functions

def ApplyUVWMap (self, *args)
 
def CanConvertToType (self, *args)
 
def CanDoDisplacementMapping (self)
 
def ChannelValidity (self, *args)
 
def CheckMesh (self, *args)
 
def CheckObjectIntegrity (self)
 
def CollapseObject (self)
 
def ConvertToType (self, *args)
 
def ConvertValidity (self, *args)
 
def Display (self, *args)
 
def DispParams (self)
 
def Eval (self, *args)
 
def FreeChannels (self, *args)
 
def GetClassID (self)
 
def GetClassName (self, *args)
 
def GetDeformBBox (self, *args)
 
def GetDisplacement (self)
 
def GetDisplacementDisable (self)
 
def GetDisplacementParameters (self)
 
def GetDisplacementSplit (self)
 
def GetLocalBoundBox (self, *args)
 
def GetMesh (self)
 
def GetObjectDisplayRequirement (self)
 
def GetObjectName (self)
 
def GetPoint (self, *args)
 
def GetRenderMesh (self, *args)
 
def GetSubselState (self)
 
def GetWorldBoundBox (self, *args)
 
def HasUVW (self, *args)
 
def HitTest (self, *args)
 
def IntersectRay (self, *args)
 
def InvalidateChannels (self, *args)
 
def IsDeformable (self)
 
def IsKeyable (self)
 
def IsMappable (self)
 
def IsPointSelected (self, *args)
 
def MakeShallowCopy (self, *args)
 
def NewAndCopyChannels (self, *args)
 
def NumMapChannels (self)
 
def NumMapsUsed (self)
 
def NumPoints (self)
 
def ObjectValidity (self, *args)
 
def PartValidity (self, *args)
 
def PointSelection (self, *args)
 
def PointsWereChanged (self)
 
def PolygonCount (self, *args)
 
def ReduceDisplayCaches (self)
 
def RescaleWorldUnits (self, *args)
 
def SetChannelValidity (self, *args)
 
def SetDisplacement (self, *args)
 
def SetDisplacementApproxToPreset (self, *args)
 
def SetDisplacementDisable (self, *args)
 
def SetDisplacementParameters (self, *args)
 
def SetDisplacementSplit (self, *args)
 
def SetPartValidity (self, *args)
 
def SetPoint (self, *args)
 
def SetSubSelState (self, *args)
 
def ShallowCopy (self, *args)
 
def TopologyChanged (self)
 
def Update (self, *args)
 
- Public Member Functions inherited from GeomObject
def IsInstanceDependent (self)
 
def NumberOfRenderMeshes (self)
 
- Public Member Functions inherited from Object
def AsParticleObject (self, *args)
 
def AsShapeObject (self, *args)
 
def AsSplineShape (self, *args)
 
def AsTriObject (self, *args)
 
def BranchDeleted (self, *args)
 
def CanCacheObject (self)
 
def ContainedShapeSelectionArray (self)
 
def ConvertToDerivedObject (self)
 
def CopyAdditionalChannels (self, *args)
 
def CopyChannelLocks (self, *args)
 
def DeleteAllAdditionalChannels (self)
 
def DoOwnSelectHilite (self)
 
def FindBaseObject (self)
 
def GetBranchINode (self, *args)
 
def GetChannelLocks (self, *args)
 
def GetChannelValidity (self, *args)
 
def GetContainedShape (self, *args)
 
def GetContainedShapeMatrix (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 GetSurfacePoint (self, *args)
 
def GetWeight (self, *args)
 
def GetWorldSpaceObjectNode (self)
 
def HasWeights (self)
 
def InitNodeName (self, *args)
 
def IsBaseClassOwnedChannel (self, *args)
 
def IsManipulator (self)
 
def IsObjectLocked (self)
 
def IsParamSurface (self)
 
def IsParticleSystem (self)
 
def IsRenderable (self)
 
def IsShapeObject (self)
 
def IsWorldSpaceObject (self)
 
def LockChannels (self, *args)
 
def LockObject (self)
 
def MergeAdditionalChannels (self, *args)
 
def NormalAlignVector (self, *args)
 
def PreferredCollapseType (self)
 
def ReadyChannelsForMod (self, *args)
 
def ReduceCaches (self, *args)
 
def SetChannelLocks (self, *args)
 
def SetNoEvalInterval (self, *args)
 
def SetWeight (self, *args)
 
def SurfaceClosedU (self, *args)
 
def SurfaceClosedV (self, *args)
 
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 GetNamedSelSetName (self, *args)
 
def GetNumNamedSelSets (self)
 
def GetNumSubObjTypes (self)
 
def GetSubObjectLevel (self)
 
def GetSubObjType (self, *args)
 
def GetSubObjTypeName (self, *args)
 
def HasViewDependentBoundingBox (self)
 
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)
 
- 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 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

 ClassID = _swig_property(GetClassID)
 
 mnmesh = _swig_property(GetMesh)
 
 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 polygon-based mesh object.

Member Function Documentation

◆ ApplyUVWMap()

def ApplyUVWMap (   self,
args 
)
ApplyUVWMap(PolyObject self, int type, float utile, float vtile, float wtile, int uflip, int vflip, int wflip, 
    int cap, Matrix3 tm, int channel=1)
ApplyUVWMap(PolyObject self, int type, float utile, float vtile, float wtile, int uflip, int vflip, int wflip, 
    int cap, Matrix3 tm)

Reimplemented from Object.

◆ CanConvertToType()

def CanConvertToType (   self,
args 
)
CanConvertToType(PolyObject self, Class_ID obtype) -> int

Reimplemented from Object.

◆ CanDoDisplacementMapping()

def CanDoDisplacementMapping (   self)
CanDoDisplacementMapping(PolyObject self) -> bool

Reimplemented from GeomObject.

◆ ChannelValidity()

def ChannelValidity (   self,
args 
)
ChannelValidity(PolyObject self, TimeValue t, int nchan) -> Interval

◆ CheckMesh()

def CheckMesh (   self,
args 
)
CheckMesh(PolyObject self, INode inode)

◆ CheckObjectIntegrity()

def CheckObjectIntegrity (   self)
CheckObjectIntegrity(PolyObject self) -> bool

Reimplemented from Object.

◆ CollapseObject()

def CollapseObject (   self)
CollapseObject(PolyObject self) -> Object

Reimplemented from Object.

◆ ConvertToType()

def ConvertToType (   self,
args 
)
ConvertToType(PolyObject self, TimeValue t, Class_ID obtype) -> Object

Reimplemented from Object.

◆ ConvertValidity()

def ConvertValidity (   self,
args 
)
ConvertValidity(PolyObject self, TimeValue t) -> Interval

◆ Display()

def Display (   self,
args 
)
Display(PolyObject self, TimeValue t, INode inode, ViewExp vpt, int flags) -> int

◆ DispParams()

def DispParams (   self)
DispParams(PolyObject self) -> TessApprox

◆ Eval()

def Eval (   self,
args 
)
Eval(PolyObject self, TimeValue time) -> ObjectState

Reimplemented from Object.

◆ FreeChannels()

def FreeChannels (   self,
args 
)
FreeChannels(PolyObject self, ChannelMask chan)

Reimplemented from Object.

◆ GetClassID()

def GetClassID (   self)
GetClassID(PolyObject self) -> Class_ID

Reimplemented from Animatable.

◆ GetClassName()

def GetClassName (   self,
args 
)
GetClassName(PolyObject self, WStr s)

◆ GetDeformBBox()

def GetDeformBBox (   self,
args 
)
GetDeformBBox(PolyObject self, TimeValue t, Box3 box, Matrix3 tm=None, BOOL useSel=True)
GetDeformBBox(PolyObject self, TimeValue t, Box3 box, Matrix3 tm=None)
GetDeformBBox(PolyObject self, TimeValue t, Box3 box)

Reimplemented from Object.

◆ GetDisplacement()

def GetDisplacement (   self)
GetDisplacement(PolyObject self) -> bool

◆ GetDisplacementDisable()

def GetDisplacementDisable (   self)
GetDisplacementDisable(PolyObject self) -> bool

◆ GetDisplacementParameters()

def GetDisplacementParameters (   self)
GetDisplacementParameters(PolyObject self) -> TessApprox

◆ GetDisplacementSplit()

def GetDisplacementSplit (   self)
GetDisplacementSplit(PolyObject self) -> bool

◆ GetLocalBoundBox()

def GetLocalBoundBox (   self,
args 
)
GetLocalBoundBox(PolyObject self, TimeValue t, INode inode, ViewExp vpt, Box3 box)

Reimplemented from BaseObject.

◆ GetMesh()

def GetMesh (   self)
GetMesh(PolyObject self) -> MNMesh

◆ GetObjectDisplayRequirement()

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

◆ GetObjectName()

def GetObjectName (   self)
GetObjectName(PolyObject self) -> wchar_t const *

Reimplemented from BaseObject.

◆ GetPoint()

def GetPoint (   self,
args 
)
GetPoint(PolyObject self, int i) -> Point3

Reimplemented from Object.

◆ GetRenderMesh()

def GetRenderMesh (   self,
args 
)
GetRenderMesh(PolyObject self, TimeValue t, INode inode, View & view, BOOL & needDelete) -> Mesh

◆ GetSubselState()

def GetSubselState (   self)
GetSubselState(PolyObject self) -> DWORD

Reimplemented from Object.

◆ GetWorldBoundBox()

def GetWorldBoundBox (   self,
args 
)
GetWorldBoundBox(PolyObject self, TimeValue t, INode inode, ViewExp vpt, Box3 box)

Reimplemented from BaseObject.

◆ HasUVW()

def HasUVW (   self,
args 
)
HasUVW(PolyObject self) -> bool
HasUVW(PolyObject self, int mapChannel) -> bool

Reimplemented from BaseObject.

◆ HitTest()

def HitTest (   self,
args 
)
HitTest(PolyObject self, TimeValue t, INode inode, int type, int crossing, int flags, IPoint2 p, ViewExp vpt) -> int

Reimplemented from BaseObject.

◆ IntersectRay()

def IntersectRay (   self,
args 
)
IntersectRay(PolyObject self, TimeValue t, Ray ray, float & at, Point3 norm) -> int

Reimplemented from Object.

◆ InvalidateChannels()

def InvalidateChannels (   self,
args 
)
InvalidateChannels(PolyObject self, ChannelMask channels)

Reimplemented from Object.

◆ IsDeformable()

def IsDeformable (   self)
IsDeformable(PolyObject self) -> int

Reimplemented from Object.

◆ IsKeyable()

def IsKeyable (   self)
IsKeyable(PolyObject self) -> int

◆ IsMappable()

def IsMappable (   self)
IsMappable(PolyObject self) -> int

Reimplemented from Object.

◆ IsPointSelected()

def IsPointSelected (   self,
args 
)
IsPointSelected(PolyObject self, int i) -> bool

Reimplemented from Object.

◆ MakeShallowCopy()

def MakeShallowCopy (   self,
args 
)
MakeShallowCopy(PolyObject self, ChannelMask channels) -> Object

Reimplemented from Object.

◆ NewAndCopyChannels()

def NewAndCopyChannels (   self,
args 
)
NewAndCopyChannels(PolyObject self, ChannelMask channels)

Reimplemented from Object.

◆ NumMapChannels()

def NumMapChannels (   self)
NumMapChannels(PolyObject self) -> int

◆ NumMapsUsed()

def NumMapsUsed (   self)
NumMapsUsed(PolyObject self) -> int

◆ NumPoints()

def NumPoints (   self)
NumPoints(PolyObject self) -> int

◆ ObjectValidity()

def ObjectValidity (   self,
args 
)
ObjectValidity(PolyObject self, TimeValue t) -> Interval

◆ PartValidity()

def PartValidity (   self,
args 
)
PartValidity(PolyObject self, ChannelMask channels) -> Interval

◆ PointSelection()

def PointSelection (   self,
args 
)
PointSelection(PolyObject self, int i) -> float

Reimplemented from Object.

◆ PointsWereChanged()

def PointsWereChanged (   self)
PointsWereChanged(PolyObject self)

Reimplemented from Object.

◆ PolygonCount()

def PolygonCount (   self,
args 
)
PolygonCount(PolyObject self, TimeValue t, int & numFaces, int & numVerts) -> BOOL

◆ ReduceDisplayCaches()

def ReduceDisplayCaches (   self)
ReduceDisplayCaches(PolyObject self)

◆ RescaleWorldUnits()

def RescaleWorldUnits (   self,
args 
)
RescaleWorldUnits(PolyObject self, float f)

Reimplemented from ReferenceMaker.

◆ SetChannelValidity()

def SetChannelValidity (   self,
args 
)
SetChannelValidity(PolyObject self, int i, Interval v)

Reimplemented from Object.

◆ SetDisplacement()

def SetDisplacement (   self,
args 
)
SetDisplacement(PolyObject self, bool displace)

◆ SetDisplacementApproxToPreset()

def SetDisplacementApproxToPreset (   self,
args 
)
SetDisplacementApproxToPreset(PolyObject self, int preset)

◆ SetDisplacementDisable()

def SetDisplacementDisable (   self,
args 
)
SetDisplacementDisable(PolyObject self, bool disable)

◆ SetDisplacementParameters()

def SetDisplacementParameters (   self,
args 
)
SetDisplacementParameters(PolyObject self, TessApprox params)

◆ SetDisplacementSplit()

def SetDisplacementSplit (   self,
args 
)
SetDisplacementSplit(PolyObject self, bool split)

◆ SetPartValidity()

def SetPartValidity (   self,
args 
)
SetPartValidity(PolyObject self, ChannelMask channels, Interval v)

◆ SetPoint()

def SetPoint (   self,
args 
)
SetPoint(PolyObject self, int i, Point3 p)

Reimplemented from Object.

◆ SetSubSelState()

def SetSubSelState (   self,
args 
)
SetSubSelState(PolyObject self, DWORD s)

Reimplemented from Object.

◆ ShallowCopy()

def ShallowCopy (   self,
args 
)
ShallowCopy(PolyObject self, Object fromOb, ChannelMask channels)

Reimplemented from Object.

◆ TopologyChanged()

def TopologyChanged (   self)
TopologyChanged(PolyObject self)

Reimplemented from Object.

◆ Update()

def Update (   self,
args 
)
Update(PolyObject self, TimeValue t) -> int