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

Public Member Functions

def AttachShape (self, *args)
 
def CanMakeBezier (self)
 
def CopyBaseData (self, *args)
 
def CurveClosed (self, *args)
 
def GenerateMesh (self, *args)
 
def GetAngle (self, *args)
 
def GetDispRenderMesh (self)
 
def GetGenUVs (self)
 
def GetLengthOfCurve (self, *args)
 
def GetMatID (self, *args)
 
def GetNumberOfCurves (self, *args)
 
def GetNumberOfPieces (self, *args)
 
def GetNumberOfVertices (self, *args)
 
def GetObjectDisplayRequirement (self)
 
def GetRenderable (self)
 
def GetShapeObjValidity (self, *args)
 
def GetSides (self, *args)
 
def GetThickness (self, *args)
 
def GetUsePhysicalScaleUVs (self)
 
def GetUseViewport (self)
 
def GetViewportAngle (self)
 
def GetViewportOrRenderer (self)
 
def GetViewportSides (self)
 
def GetViewportThickness (self)
 
def InterpCurve3D (self, *args)
 
def InterpPiece3D (self, *args)
 
def MakeBezier (self, *args)
 
def MakePolyShape (self, *args)
 
def PrepareDisplay (self, *args)
 
def SetAngle (self, *args)
 
def SetDispRenderMesh (self, *args)
 
def SetGenUVs (self, *args)
 
def SetRenderable (self, *args)
 
def SetSides (self, *args)
 
def SetThickness (self, *args)
 
def SetUsePhysicalScaleUVs (self, *args)
 
def SetUseViewport (self, *args)
 
def SetViewportAngle (self, *args)
 
def SetViewportOrRenderer (self, *args)
 
def SetViewportSides (self, *args)
 
def SetViewportThickness (self, *args)
 
def TangentCurve3D (self, *args)
 
def TangentPiece3D (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

An open or closed hierarchical shape made up of one or more parts such as bezier splines or poly lines.

Member Function Documentation

◆ AttachShape()

def AttachShape (   self,
args 
)
AttachShape(ShapeObject self, INode thisNode, INode attachNode, bool weldEnds=True, float weldThreshold=0.0, TimeValue t=Autodesk::Max::Now()) -> bool
AttachShape(ShapeObject self, INode thisNode, INode attachNode, bool weldEnds=True, float weldThreshold=0.0) -> bool
AttachShape(ShapeObject self, INode thisNode, INode attachNode, bool weldEnds=True) -> bool
AttachShape(ShapeObject self, INode thisNode, INode attachNode) -> bool

◆ CanMakeBezier()

def CanMakeBezier (   self)
CanMakeBezier(ShapeObject self) -> bool

◆ CopyBaseData()

def CopyBaseData (   self,
args 
)
CopyBaseData(ShapeObject self, ShapeObject other)

◆ CurveClosed()

def CurveClosed (   self,
args 
)
CurveClosed(ShapeObject self, int curve, TimeValue t=Autodesk::Max::Now()) -> bool
CurveClosed(ShapeObject self, int curve) -> bool

◆ GenerateMesh()

def GenerateMesh (   self,
args 
)
GenerateMesh(ShapeObject self, int option, Mesh mesh, TimeValue t=Autodesk::Max::Now())
GenerateMesh(ShapeObject self, int option, Mesh mesh)

◆ GetAngle()

def GetAngle (   self,
args 
)
GetAngle(ShapeObject self, Interval ivalid=Autodesk::Max::Forever(), TimeValue t=Autodesk::Max::Now()) -> float
GetAngle(ShapeObject self, Interval ivalid=Autodesk::Max::Forever()) -> float
GetAngle(ShapeObject self) -> float

◆ GetDispRenderMesh()

def GetDispRenderMesh (   self)
GetDispRenderMesh(ShapeObject self) -> bool

◆ GetGenUVs()

def GetGenUVs (   self)
GetGenUVs(ShapeObject self) -> bool

◆ GetLengthOfCurve()

def GetLengthOfCurve (   self,
args 
)
GetLengthOfCurve(ShapeObject self, int curve, TimeValue t=Autodesk::Max::Now()) -> float
GetLengthOfCurve(ShapeObject self, int curve) -> float

◆ GetMatID()

def GetMatID (   self,
args 
)
GetMatID(ShapeObject self, int curve, int piece, TimeValue t=Autodesk::Max::Now()) -> MtlID
GetMatID(ShapeObject self, int curve, int piece) -> MtlID

◆ GetNumberOfCurves()

def GetNumberOfCurves (   self,
args 
)
GetNumberOfCurves(ShapeObject self, TimeValue t) -> int

◆ GetNumberOfPieces()

def GetNumberOfPieces (   self,
args 
)
GetNumberOfPieces(ShapeObject self, int curve, TimeValue t=Autodesk::Max::Now()) -> int
GetNumberOfPieces(ShapeObject self, int curve) -> int

◆ GetNumberOfVertices()

def GetNumberOfVertices (   self,
args 
)
GetNumberOfVertices(ShapeObject self, int curve=-1, TimeValue t=Autodesk::Max::Now()) -> int
GetNumberOfVertices(ShapeObject self, int curve=-1) -> int
GetNumberOfVertices(ShapeObject self) -> int

◆ GetObjectDisplayRequirement()

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

◆ GetRenderable()

def GetRenderable (   self)
GetRenderable(ShapeObject self) -> bool

◆ GetShapeObjValidity()

def GetShapeObjValidity (   self,
args 
)
GetShapeObjValidity(ShapeObject self, TimeValue t=Autodesk::Max::Now()) -> Interval
GetShapeObjValidity(ShapeObject self) -> Interval

◆ GetSides()

def GetSides (   self,
args 
)
GetSides(ShapeObject self, Interval ivalid=Autodesk::Max::Forever(), TimeValue t=Autodesk::Max::Now()) -> int
GetSides(ShapeObject self, Interval ivalid=Autodesk::Max::Forever()) -> int
GetSides(ShapeObject self) -> int

◆ GetThickness()

def GetThickness (   self,
args 
)
GetThickness(ShapeObject self, Interval ivalid=Autodesk::Max::Forever(), TimeValue t=Autodesk::Max::Now()) -> float
GetThickness(ShapeObject self, Interval ivalid=Autodesk::Max::Forever()) -> float
GetThickness(ShapeObject self) -> float

◆ GetUsePhysicalScaleUVs()

def GetUsePhysicalScaleUVs (   self)
GetUsePhysicalScaleUVs(ShapeObject self) -> bool

◆ GetUseViewport()

def GetUseViewport (   self)
GetUseViewport(ShapeObject self) -> bool

◆ GetViewportAngle()

def GetViewportAngle (   self)
GetViewportAngle(ShapeObject self) -> float

◆ GetViewportOrRenderer()

def GetViewportOrRenderer (   self)
GetViewportOrRenderer(ShapeObject self) -> bool

◆ GetViewportSides()

def GetViewportSides (   self)
GetViewportSides(ShapeObject self) -> int

◆ GetViewportThickness()

def GetViewportThickness (   self)
GetViewportThickness(ShapeObject self) -> float

◆ InterpCurve3D()

def InterpCurve3D (   self,
args 
)
InterpCurve3D(ShapeObject self, int curve, float param, int ptype=PARAM_SIMPLE, TimeValue t=Autodesk::Max::Now()) -> Point3
InterpCurve3D(ShapeObject self, int curve, float param, int ptype=PARAM_SIMPLE) -> Point3
InterpCurve3D(ShapeObject self, int curve, float param) -> Point3

◆ InterpPiece3D()

def InterpPiece3D (   self,
args 
)
InterpPiece3D(ShapeObject self, int curve, int piece, float param, int ptype=PARAM_SIMPLE, TimeValue t=Autodesk::Max::Now()) -> Point3
InterpPiece3D(ShapeObject self, int curve, int piece, float param, int ptype=PARAM_SIMPLE) -> Point3
InterpPiece3D(ShapeObject self, int curve, int piece, float param) -> Point3

◆ MakeBezier()

def MakeBezier (   self,
args 
)
MakeBezier(ShapeObject self, BezierShape shape, TimeValue t=Autodesk::Max::Now())
MakeBezier(ShapeObject self, BezierShape shape)

◆ MakePolyShape()

def MakePolyShape (   self,
args 
)
MakePolyShape(ShapeObject self, PolyShape shape, int steps=PSHAPE_BUILTIN_STEPS, bool optimize=True, TimeValue t=Autodesk::Max::Now())
MakePolyShape(ShapeObject self, PolyShape shape, int steps=PSHAPE_BUILTIN_STEPS, bool optimize=True)
MakePolyShape(ShapeObject self, PolyShape shape, int steps=PSHAPE_BUILTIN_STEPS)
MakePolyShape(ShapeObject self, PolyShape shape)

◆ PrepareDisplay()

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

◆ SetAngle()

def SetAngle (   self,
args 
)
SetAngle(ShapeObject self, float a, TimeValue t=Autodesk::Max::Now())
SetAngle(ShapeObject self, float a)

◆ SetDispRenderMesh()

def SetDispRenderMesh (   self,
args 
)
SetDispRenderMesh(ShapeObject self, bool sw)

◆ SetGenUVs()

def SetGenUVs (   self,
args 
)
SetGenUVs(ShapeObject self, bool sw)

◆ SetRenderable()

def SetRenderable (   self,
args 
)
SetRenderable(ShapeObject self, bool sw)

◆ SetSides()

def SetSides (   self,
args 
)
SetSides(ShapeObject self, int s, TimeValue t=Autodesk::Max::Now())
SetSides(ShapeObject self, int s)

◆ SetThickness()

def SetThickness (   self,
args 
)
SetThickness(ShapeObject self, float thick, TimeValue t=Autodesk::Max::Now())
SetThickness(ShapeObject self, float thick)

◆ SetUsePhysicalScaleUVs()

def SetUsePhysicalScaleUVs (   self,
args 
)
SetUsePhysicalScaleUVs(ShapeObject self, bool flag)

◆ SetUseViewport()

def SetUseViewport (   self,
args 
)
SetUseViewport(ShapeObject self, bool sw)

◆ SetViewportAngle()

def SetViewportAngle (   self,
args 
)
SetViewportAngle(ShapeObject self, float a)

◆ SetViewportOrRenderer()

def SetViewportOrRenderer (   self,
args 
)
SetViewportOrRenderer(ShapeObject self, bool sw)

◆ SetViewportSides()

def SetViewportSides (   self,
args 
)
SetViewportSides(ShapeObject self, int s)

◆ SetViewportThickness()

def SetViewportThickness (   self,
args 
)
SetViewportThickness(ShapeObject self, float thick)

◆ TangentCurve3D()

def TangentCurve3D (   self,
args 
)
TangentCurve3D(ShapeObject self, int curve, float param, int ptype=PARAM_SIMPLE, TimeValue t=Autodesk::Max::Now()) -> Point3
TangentCurve3D(ShapeObject self, int curve, float param, int ptype=PARAM_SIMPLE) -> Point3
TangentCurve3D(ShapeObject self, int curve, float param) -> Point3

◆ TangentPiece3D()

def TangentPiece3D (   self,
args 
)
TangentPiece3D(ShapeObject self, int curve, int piece, float param, int ptype=PARAM_SIMPLE, TimeValue t=Autodesk::Max::Now()) -> Point3
TangentPiece3D(ShapeObject self, int curve, int piece, float param, int ptype=PARAM_SIMPLE) -> Point3
TangentPiece3D(ShapeObject self, int curve, int piece, float param) -> Point3

◆ UpdatePerNodeItems()

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

◆ UpdatePerViewItems()

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