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

Public Member Functions

def CommitImplicitGrid (self, *args)
 
def GetAdaptiveDegCameraDistancePriority (self)
 
def GetAdaptiveDegDegradeLight (self)
 
def GetAdaptiveDegDisplayModeBox (self)
 
def GetAdaptiveDegDisplayModeCurrent (self)
 
def GetAdaptiveDegDisplayModeFastShaded (self)
 
def GetAdaptiveDegDisplayModeHide (self)
 
def GetAdaptiveDegDisplayModePoint (self)
 
def GetAdaptiveDegDisplayModeWire (self)
 
def GetAdaptiveDegDrawBackface (self)
 
def GetAdaptiveDegGoalFPS (self)
 
def GetAdaptiveDegMinSize (self)
 
def GetAdaptiveDegNeverDegradeSelected (self)
 
def GetAdaptiveDegNeverRedrawAfterDegrade (self)
 
def GetAdaptiveDegScreenSizePriority (self)
 
def GetBkgImageDsp (self)
 
def GetConstructionTM (self, *args)
 
def GetCPDisp (self, *args)
 
def GetDamageRect (self)
 
def GetDIB (self, *args)
 
def GetEdgedFaces (self)
 
def GetFocalDist (self)
 
def GetFOV (self)
 
def GetFPS (self)
 
def GetGridSize (self)
 
def GetGridType (self)
 
def getGW (self)
 
def GetHither (self)
 
def GetHWnd (self)
 
def GetPointOnCP (self, *args)
 
def GetScreenScaleFactor (self, *args)
 
def GetSFDisplay (self)
 
def GetSingleDefaultLight (self)
 
def GetViewCamera (self)
 
def GetViewMatrix (self)
 
def GetViewportClipScale (self)
 
def GetViewportFPS (self)
 
def GetViewSpot (self)
 
def GetViewType (self)
 
def GetVPWorldWidth (self, *args)
 
def GetYon (self)
 
def GetZoom (self)
 
def Invalidate (self, bForegroundOnly=False)
 
def InvalidateRect (self, *args)
 
def IsActive (self)
 
def IsDegrading (self)
 
def IsEnabled (self)
 
def IsGridVisible (self)
 
def IsPerspView (self)
 
def IsValid (self)
 
def IsWire (self)
 
def MapCPToWorld (self, *args)
 
def MapScreenToView (self, *args)
 
def MapScreenToWorldRay (self, *args)
 
def NonScalingObjectSize (self)
 
def Pan (self, *args)
 
def ReleaseImplicitGrid (self)
 
def Rotate (self, *args)
 
def SetAdaptiveDegCameraDistancePriority (self, *args)
 
def SetAdaptiveDegDegradeLight (self, *args)
 
def SetAdaptiveDegDisplayModeBox (self, *args)
 
def SetAdaptiveDegDisplayModeCurrent (self, *args)
 
def SetAdaptiveDegDisplayModeFastShaded (self, *args)
 
def SetAdaptiveDegDisplayModeHide (self, *args)
 
def SetAdaptiveDegDisplayModePoint (self, *args)
 
def SetAdaptiveDegDisplayModeWire (self, *args)
 
def SetAdaptiveDegDrawBackface (self, *args)
 
def SetAdaptiveDegGoalFPS (self, *args)
 
def SetAdaptiveDegMinSize (self, *args)
 
def SetAdaptiveDegNeverDegradeSelected (self, *args)
 
def SetAdaptiveDegNeverRedrawAfterDegrade (self, *args)
 
def SetAdaptiveDegScreenSizePriority (self, *args)
 
def SetBkgImageDsp (self, *args)
 
def SetEdgedFaces (self, *args)
 
def SetFocalDist (self, *args)
 
def SetFocalDistance (self, *args)
 
def SetFOV (self, *args)
 
def SetGridSize (self, *args)
 
def SetSFDisplay (self, *args)
 
def SetViewCamera (self, *args)
 
def SetViewMatrix (self, *args)
 
def SetViewportClipScale (self, *args)
 
def SetViewSpot (self, *args)
 
def SetViewUser (self, *args)
 
def SnapLength (self, *args)
 
def SnapPoint (self, *args)
 
def SnapPreview (self, *args)
 
def TrackImplicitGrid (self, *args)
 
def UndoAccept (self)
 
def UndoBegin (self)
 
def UpdateLabel (self)
 
def Zoom (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 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

Represents a UI viewport used for displaying and interacting with the scene.

Member Function Documentation

◆ CommitImplicitGrid()

def CommitImplicitGrid (   self,
args 
)
CommitImplicitGrid(Viewport self, IPoint2 m, int mouseflags, Matrix3 mat)
CommitImplicitGrid(Viewport self, IPoint2 m, int mouseflags)

◆ GetAdaptiveDegCameraDistancePriority()

def GetAdaptiveDegCameraDistancePriority (   self)
GetAdaptiveDegCameraDistancePriority(Viewport self) -> float

◆ GetAdaptiveDegDegradeLight()

def GetAdaptiveDegDegradeLight (   self)
GetAdaptiveDegDegradeLight(Viewport self) -> bool

◆ GetAdaptiveDegDisplayModeBox()

def GetAdaptiveDegDisplayModeBox (   self)
GetAdaptiveDegDisplayModeBox(Viewport self) -> bool

◆ GetAdaptiveDegDisplayModeCurrent()

def GetAdaptiveDegDisplayModeCurrent (   self)
GetAdaptiveDegDisplayModeCurrent(Viewport self) -> bool

◆ GetAdaptiveDegDisplayModeFastShaded()

def GetAdaptiveDegDisplayModeFastShaded (   self)
GetAdaptiveDegDisplayModeFastShaded(Viewport self) -> bool

◆ GetAdaptiveDegDisplayModeHide()

def GetAdaptiveDegDisplayModeHide (   self)
GetAdaptiveDegDisplayModeHide(Viewport self) -> bool

◆ GetAdaptiveDegDisplayModePoint()

def GetAdaptiveDegDisplayModePoint (   self)
GetAdaptiveDegDisplayModePoint(Viewport self) -> bool

◆ GetAdaptiveDegDisplayModeWire()

def GetAdaptiveDegDisplayModeWire (   self)
GetAdaptiveDegDisplayModeWire(Viewport self) -> bool

◆ GetAdaptiveDegDrawBackface()

def GetAdaptiveDegDrawBackface (   self)
GetAdaptiveDegDrawBackface(Viewport self) -> bool

◆ GetAdaptiveDegGoalFPS()

def GetAdaptiveDegGoalFPS (   self)
GetAdaptiveDegGoalFPS(Viewport self) -> float

◆ GetAdaptiveDegMinSize()

def GetAdaptiveDegMinSize (   self)
GetAdaptiveDegMinSize(Viewport self) -> int

◆ GetAdaptiveDegNeverDegradeSelected()

def GetAdaptiveDegNeverDegradeSelected (   self)
GetAdaptiveDegNeverDegradeSelected(Viewport self) -> bool

◆ GetAdaptiveDegNeverRedrawAfterDegrade()

def GetAdaptiveDegNeverRedrawAfterDegrade (   self)
GetAdaptiveDegNeverRedrawAfterDegrade(Viewport self) -> bool

◆ GetAdaptiveDegScreenSizePriority()

def GetAdaptiveDegScreenSizePriority (   self)
GetAdaptiveDegScreenSizePriority(Viewport self) -> float

◆ GetBkgImageDsp()

def GetBkgImageDsp (   self)
GetBkgImageDsp(Viewport self) -> bool

◆ GetConstructionTM()

def GetConstructionTM (   self,
args 
)
GetConstructionTM(Viewport self, Matrix3 tm)

◆ GetCPDisp()

def GetCPDisp (   self,
args 
)
GetCPDisp(Viewport self, Point3 base, Point3 dir, IPoint2 sp1, IPoint2 sp2, bool snap=True) -> float
GetCPDisp(Viewport self, Point3 base, Point3 dir, IPoint2 sp1, IPoint2 sp2) -> float

◆ GetDamageRect()

def GetDamageRect (   self)
GetDamageRect(Viewport self) -> Box2

◆ GetDIB()

def GetDIB (   self,
args 
)
GetDIB(Viewport self, BitmapInfo bi, Bitmap bmp) -> bool

◆ GetEdgedFaces()

def GetEdgedFaces (   self)
GetEdgedFaces(Viewport self) -> bool

◆ GetFocalDist()

def GetFocalDist (   self)
GetFocalDist(Viewport self) -> float

◆ GetFOV()

def GetFOV (   self)
GetFOV(Viewport self) -> float

◆ GetFPS()

def GetFPS (   self)
GetFPS(Viewport self) -> float

◆ GetGridSize()

def GetGridSize (   self)
GetGridSize(Viewport self) -> float

◆ GetGridType()

def GetGridType (   self)
GetGridType(Viewport self) -> int

◆ getGW()

def getGW (   self)
getGW(Viewport self) -> GraphicsWindow

◆ GetHither()

def GetHither (   self)
GetHither(Viewport self) -> float

◆ GetHWnd()

def GetHWnd (   self)
GetHWnd(Viewport self) -> HWND

◆ GetPointOnCP()

def GetPointOnCP (   self,
args 
)
GetPointOnCP(Viewport self, IPoint2 ps) -> Point3

◆ GetScreenScaleFactor()

def GetScreenScaleFactor (   self,
args 
)
GetScreenScaleFactor(Viewport self, Point3 worldPoint) -> float

◆ GetSFDisplay()

def GetSFDisplay (   self)
GetSFDisplay(Viewport self) -> bool

◆ GetSingleDefaultLight()

def GetSingleDefaultLight (   self)
GetSingleDefaultLight(Viewport self) -> bool

◆ GetViewCamera()

def GetViewCamera (   self)
GetViewCamera(Viewport self) -> INode

◆ GetViewMatrix()

def GetViewMatrix (   self)
GetViewMatrix(Viewport self) -> Matrix3

◆ GetViewportClipScale()

def GetViewportClipScale (   self)
GetViewportClipScale(Viewport self) -> float

◆ GetViewportFPS()

def GetViewportFPS (   self)
GetViewportFPS(Viewport self) -> float

◆ GetViewSpot()

def GetViewSpot (   self)
GetViewSpot(Viewport self) -> INode

◆ GetViewType()

def GetViewType (   self)
GetViewType(Viewport self) -> int

◆ GetVPWorldWidth()

def GetVPWorldWidth (   self,
args 
)
GetVPWorldWidth(Viewport self, Point3 wPoint) -> float

◆ GetYon()

def GetYon (   self)
GetYon(Viewport self) -> float

◆ GetZoom()

def GetZoom (   self)
GetZoom(Viewport self) -> float

◆ Invalidate()

def Invalidate (   self,
  bForegroundOnly = False 
)
Invalidate(Viewport self, bool bForegroundOnly=False)
Invalidate(Viewport self)

◆ InvalidateRect()

def InvalidateRect (   self,
args 
)
InvalidateRect(Viewport self, Box2 rect)

◆ IsActive()

def IsActive (   self)
IsActive(Viewport self) -> bool

◆ IsDegrading()

def IsDegrading (   self)
IsDegrading(Viewport self) -> bool

◆ IsEnabled()

def IsEnabled (   self)
IsEnabled(Viewport self) -> bool

◆ IsGridVisible()

def IsGridVisible (   self)
IsGridVisible(Viewport self) -> bool

◆ IsPerspView()

def IsPerspView (   self)
IsPerspView(Viewport self) -> bool

◆ IsValid()

def IsValid (   self)
IsValid(Viewport self) -> bool

◆ IsWire()

def IsWire (   self)
IsWire(Viewport self) -> int

◆ MapCPToWorld()

def MapCPToWorld (   self,
args 
)
MapCPToWorld(Viewport self, Point3 cpPoint) -> Point3

◆ MapScreenToView()

def MapScreenToView (   self,
args 
)
MapScreenToView(Viewport self, IPoint2 sp, float depth) -> Point3

◆ MapScreenToWorldRay()

def MapScreenToWorldRay (   self,
args 
)
MapScreenToWorldRay(Viewport self, float sx, float sy, Ray ray)

◆ NonScalingObjectSize()

def NonScalingObjectSize (   self)
NonScalingObjectSize(Viewport self) -> float

◆ Pan()

def Pan (   self,
args 
)
Pan(Viewport self, Point2 screenDelta)

◆ ReleaseImplicitGrid()

def ReleaseImplicitGrid (   self)
ReleaseImplicitGrid(Viewport self)

◆ Rotate()

def Rotate (   self,
args 
)
Rotate(Viewport self, Quat rotData, Point3 center=Autodesk::Max::Point3())
Rotate(Viewport self, Quat rotData)

◆ SetAdaptiveDegCameraDistancePriority()

def SetAdaptiveDegCameraDistancePriority (   self,
args 
)
SetAdaptiveDegCameraDistancePriority(Viewport self, float fPriority)

◆ SetAdaptiveDegDegradeLight()

def SetAdaptiveDegDegradeLight (   self,
args 
)
SetAdaptiveDegDegradeLight(Viewport self, bool bDegradeLight)

◆ SetAdaptiveDegDisplayModeBox()

def SetAdaptiveDegDisplayModeBox (   self,
args 
)
SetAdaptiveDegDisplayModeBox(Viewport self, bool bMode)

◆ SetAdaptiveDegDisplayModeCurrent()

def SetAdaptiveDegDisplayModeCurrent (   self,
args 
)
SetAdaptiveDegDisplayModeCurrent(Viewport self, bool bMode)

◆ SetAdaptiveDegDisplayModeFastShaded()

def SetAdaptiveDegDisplayModeFastShaded (   self,
args 
)
SetAdaptiveDegDisplayModeFastShaded(Viewport self, bool bMode)

◆ SetAdaptiveDegDisplayModeHide()

def SetAdaptiveDegDisplayModeHide (   self,
args 
)
SetAdaptiveDegDisplayModeHide(Viewport self, bool bMode)

◆ SetAdaptiveDegDisplayModePoint()

def SetAdaptiveDegDisplayModePoint (   self,
args 
)
SetAdaptiveDegDisplayModePoint(Viewport self, bool bMode)

◆ SetAdaptiveDegDisplayModeWire()

def SetAdaptiveDegDisplayModeWire (   self,
args 
)
SetAdaptiveDegDisplayModeWire(Viewport self, bool bMode)

◆ SetAdaptiveDegDrawBackface()

def SetAdaptiveDegDrawBackface (   self,
args 
)
SetAdaptiveDegDrawBackface(Viewport self, bool bDraw)

◆ SetAdaptiveDegGoalFPS()

def SetAdaptiveDegGoalFPS (   self,
args 
)
SetAdaptiveDegGoalFPS(Viewport self, float fFPS)

◆ SetAdaptiveDegMinSize()

def SetAdaptiveDegMinSize (   self,
args 
)
SetAdaptiveDegMinSize(Viewport self, int iMinSize)

◆ SetAdaptiveDegNeverDegradeSelected()

def SetAdaptiveDegNeverDegradeSelected (   self,
args 
)
SetAdaptiveDegNeverDegradeSelected(Viewport self, bool bNeverDegrade)

◆ SetAdaptiveDegNeverRedrawAfterDegrade()

def SetAdaptiveDegNeverRedrawAfterDegrade (   self,
args 
)
SetAdaptiveDegNeverRedrawAfterDegrade(Viewport self, bool bNeverRedraw)

◆ SetAdaptiveDegScreenSizePriority()

def SetAdaptiveDegScreenSizePriority (   self,
args 
)
SetAdaptiveDegScreenSizePriority(Viewport self, float fPriority)

◆ SetBkgImageDsp()

def SetBkgImageDsp (   self,
args 
)
SetBkgImageDsp(Viewport self, bool onOff) -> bool

◆ SetEdgedFaces()

def SetEdgedFaces (   self,
args 
)
SetEdgedFaces(Viewport self, bool md)

◆ SetFocalDist()

def SetFocalDist (   self,
args 
)
SetFocalDist(Viewport self, float fd)

◆ SetFocalDistance()

def SetFocalDistance (   self,
args 
)
SetFocalDistance(Viewport self, float dist)

◆ SetFOV()

def SetFOV (   self,
args 
)
SetFOV(Viewport self, float fov) -> bool

◆ SetGridSize()

def SetGridSize (   self,
args 
)
SetGridSize(Viewport self, float size)

◆ SetSFDisplay()

def SetSFDisplay (   self,
args 
)
SetSFDisplay(Viewport self, bool onOff)

◆ SetViewCamera()

def SetViewCamera (   self,
args 
)
SetViewCamera(Viewport self, INode camNode)

◆ SetViewMatrix()

def SetViewMatrix (   self,
args 
)
SetViewMatrix(Viewport self, Matrix3 m) -> bool

◆ SetViewportClipScale()

def SetViewportClipScale (   self,
args 
)
SetViewportClipScale(Viewport self, float fScale)

◆ SetViewSpot()

def SetViewSpot (   self,
args 
)
SetViewSpot(Viewport self, INode spotNode)

◆ SetViewUser()

def SetViewUser (   self,
args 
)
SetViewUser(Viewport self, bool persp)

◆ SnapLength()

def SnapLength (   self,
args 
)
SnapLength(Viewport self, float inValue) -> float

◆ SnapPoint()

def SnapPoint (   self,
args 
)
SnapPoint(Viewport self, IPoint2 inValue, IPoint2 outValue, Matrix3 plane2d, DWORD flags=0) -> Point3
SnapPoint(Viewport self, IPoint2 inValue, IPoint2 outValue, Matrix3 plane2d) -> Point3
SnapPoint(Viewport self, IPoint2 inValue, IPoint2 outValue, DWORD flags=0) -> Point3
SnapPoint(Viewport self, IPoint2 inValue, IPoint2 outValue) -> Point3

◆ SnapPreview()

def SnapPreview (   self,
args 
)
SnapPreview(Viewport self, IPoint2 inValue, IPoint2 outValue, Matrix3 plane2d, DWORD flags=0)
SnapPreview(Viewport self, IPoint2 inValue, IPoint2 outValue, Matrix3 plane2d)
SnapPreview(Viewport self, IPoint2 inValue, IPoint2 outValue, DWORD flags=0)
SnapPreview(Viewport self, IPoint2 inValue, IPoint2 outValue)

◆ TrackImplicitGrid()

def TrackImplicitGrid (   self,
args 
)
TrackImplicitGrid(Viewport self, IPoint2 m, Matrix3 mat, ULONG hitTestFlags=0)
TrackImplicitGrid(Viewport self, IPoint2 m, Matrix3 mat)
TrackImplicitGrid(Viewport self, IPoint2 m, ULONG hitTestFlags=0)
TrackImplicitGrid(Viewport self, IPoint2 m)

◆ UndoAccept()

def UndoAccept (   self)
UndoAccept(Viewport self) -> bool

◆ UndoBegin()

def UndoBegin (   self)
UndoBegin(Viewport self) -> bool

◆ UpdateLabel()

def UpdateLabel (   self)
UpdateLabel(Viewport self)

◆ Zoom()

def Zoom (   self,
args 
)
Zoom(Viewport self, float zoomFactor)