Viewport Class Reference

Class Description

Represents a UI viewport used for displaying and interacting with the scene.
+ 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
 
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

tuple 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
tuple 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
tuple thisown = _swig_property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
 

Member Function Documentation

def CommitImplicitGrid (   self,
  args 
)
CommitImplicitGrid(Viewport self, IPoint2 m, int mouseflags, Matrix3 mat)
CommitImplicitGrid(Viewport self, IPoint2 m, int mouseflags)
def GetAdaptiveDegCameraDistancePriority (   self)
GetAdaptiveDegCameraDistancePriority(Viewport self) -> float
def GetAdaptiveDegDegradeLight (   self)
GetAdaptiveDegDegradeLight(Viewport self) -> bool
def GetAdaptiveDegDisplayModeBox (   self)
GetAdaptiveDegDisplayModeBox(Viewport self) -> bool
def GetAdaptiveDegDisplayModeCurrent (   self)
GetAdaptiveDegDisplayModeCurrent(Viewport self) -> bool
def GetAdaptiveDegDisplayModeFastShaded (   self)
GetAdaptiveDegDisplayModeFastShaded(Viewport self) -> bool
def GetAdaptiveDegDisplayModeHide (   self)
GetAdaptiveDegDisplayModeHide(Viewport self) -> bool
def GetAdaptiveDegDisplayModePoint (   self)
GetAdaptiveDegDisplayModePoint(Viewport self) -> bool
def GetAdaptiveDegDisplayModeWire (   self)
GetAdaptiveDegDisplayModeWire(Viewport self) -> bool
def GetAdaptiveDegDrawBackface (   self)
GetAdaptiveDegDrawBackface(Viewport self) -> bool
def GetAdaptiveDegGoalFPS (   self)
GetAdaptiveDegGoalFPS(Viewport self) -> float
def GetAdaptiveDegMinSize (   self)
GetAdaptiveDegMinSize(Viewport self) -> int
def GetAdaptiveDegNeverDegradeSelected (   self)
GetAdaptiveDegNeverDegradeSelected(Viewport self) -> bool
def GetAdaptiveDegNeverRedrawAfterDegrade (   self)
GetAdaptiveDegNeverRedrawAfterDegrade(Viewport self) -> bool
def GetAdaptiveDegScreenSizePriority (   self)
GetAdaptiveDegScreenSizePriority(Viewport self) -> float
def GetBkgImageDsp (   self)
GetBkgImageDsp(Viewport self) -> bool
def GetConstructionTM (   self,
  args 
)
GetConstructionTM(Viewport self, Matrix3 tm)
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
def GetDamageRect (   self)
GetDamageRect(Viewport self) -> Box2
def GetDIB (   self,
  args 
)
GetDIB(Viewport self, BitmapInfo bi, Bitmap bmp) -> bool
def GetEdgedFaces (   self)
GetEdgedFaces(Viewport self) -> bool
def GetFocalDist (   self)
GetFocalDist(Viewport self) -> float
def GetFOV (   self)
GetFOV(Viewport self) -> float
def GetFPS (   self)
GetFPS(Viewport self) -> float
def GetGridSize (   self)
GetGridSize(Viewport self) -> float
def GetGridType (   self)
GetGridType(Viewport self) -> int
def getGW (   self)
getGW(Viewport self) -> GraphicsWindow
def GetHither (   self)
GetHither(Viewport self) -> float
def GetHWnd (   self)
GetHWnd(Viewport self) -> HWND
def GetPointOnCP (   self,
  args 
)
GetPointOnCP(Viewport self, IPoint2 ps) -> Point3
def GetScreenScaleFactor (   self,
  args 
)
GetScreenScaleFactor(Viewport self, Point3 worldPoint) -> float
def GetSFDisplay (   self)
GetSFDisplay(Viewport self) -> bool
def GetSingleDefaultLight (   self)
GetSingleDefaultLight(Viewport self) -> bool
def GetViewCamera (   self)
GetViewCamera(Viewport self) -> INode
def GetViewMatrix (   self)
GetViewMatrix(Viewport self) -> Matrix3
def GetViewportClipScale (   self)
GetViewportClipScale(Viewport self) -> float
def GetViewportFPS (   self)
GetViewportFPS(Viewport self) -> float
def GetViewSpot (   self)
GetViewSpot(Viewport self) -> INode
def GetViewType (   self)
GetViewType(Viewport self) -> int
def GetVPWorldWidth (   self,
  args 
)
GetVPWorldWidth(Viewport self, Point3 wPoint) -> float
def GetYon (   self)
GetYon(Viewport self) -> float
def GetZoom (   self)
GetZoom(Viewport self) -> float
def Invalidate (   self,
  bForegroundOnly = False 
)
Invalidate(Viewport self, bool bForegroundOnly=False)
Invalidate(Viewport self)
def InvalidateRect (   self,
  args 
)
InvalidateRect(Viewport self, Box2 rect)
def IsActive (   self)
IsActive(Viewport self) -> bool
def IsDegrading (   self)
IsDegrading(Viewport self) -> bool
def IsEnabled (   self)
IsEnabled(Viewport self) -> bool
def IsGridVisible (   self)
IsGridVisible(Viewport self) -> bool
def IsPerspView (   self)
IsPerspView(Viewport self) -> bool
def IsValid (   self)
IsValid(Viewport self) -> bool
def IsWire (   self)
IsWire(Viewport self) -> int
def MapCPToWorld (   self,
  args 
)
MapCPToWorld(Viewport self, Point3 cpPoint) -> Point3
def MapScreenToView (   self,
  args 
)
MapScreenToView(Viewport self, IPoint2 sp, float depth) -> Point3
def MapScreenToWorldRay (   self,
  args 
)
MapScreenToWorldRay(Viewport self, float sx, float sy, Ray ray)
def NonScalingObjectSize (   self)
NonScalingObjectSize(Viewport self) -> float
def Pan (   self,
  args 
)
Pan(Viewport self, Point2 screenDelta)
def ReleaseImplicitGrid (   self)
ReleaseImplicitGrid(Viewport self)
def Rotate (   self,
  args 
)
Rotate(Viewport self, Quat rotData, Point3 center=Autodesk::Max::Point3())
Rotate(Viewport self, Quat rotData)
def SetAdaptiveDegCameraDistancePriority (   self,
  args 
)
SetAdaptiveDegCameraDistancePriority(Viewport self, float fPriority)
def SetAdaptiveDegDegradeLight (   self,
  args 
)
SetAdaptiveDegDegradeLight(Viewport self, bool bDegradeLight)
def SetAdaptiveDegDisplayModeBox (   self,
  args 
)
SetAdaptiveDegDisplayModeBox(Viewport self, bool bMode)
def SetAdaptiveDegDisplayModeCurrent (   self,
  args 
)
SetAdaptiveDegDisplayModeCurrent(Viewport self, bool bMode)
def SetAdaptiveDegDisplayModeFastShaded (   self,
  args 
)
SetAdaptiveDegDisplayModeFastShaded(Viewport self, bool bMode)
def SetAdaptiveDegDisplayModeHide (   self,
  args 
)
SetAdaptiveDegDisplayModeHide(Viewport self, bool bMode)
def SetAdaptiveDegDisplayModePoint (   self,
  args 
)
SetAdaptiveDegDisplayModePoint(Viewport self, bool bMode)
def SetAdaptiveDegDisplayModeWire (   self,
  args 
)
SetAdaptiveDegDisplayModeWire(Viewport self, bool bMode)
def SetAdaptiveDegDrawBackface (   self,
  args 
)
SetAdaptiveDegDrawBackface(Viewport self, bool bDraw)
def SetAdaptiveDegGoalFPS (   self,
  args 
)
SetAdaptiveDegGoalFPS(Viewport self, float fFPS)
def SetAdaptiveDegMinSize (   self,
  args 
)
SetAdaptiveDegMinSize(Viewport self, int iMinSize)
def SetAdaptiveDegNeverDegradeSelected (   self,
  args 
)
SetAdaptiveDegNeverDegradeSelected(Viewport self, bool bNeverDegrade)
def SetAdaptiveDegNeverRedrawAfterDegrade (   self,
  args 
)
SetAdaptiveDegNeverRedrawAfterDegrade(Viewport self, bool bNeverRedraw)
def SetAdaptiveDegScreenSizePriority (   self,
  args 
)
SetAdaptiveDegScreenSizePriority(Viewport self, float fPriority)
def SetBkgImageDsp (   self,
  args 
)
SetBkgImageDsp(Viewport self, bool onOff) -> bool
def SetEdgedFaces (   self,
  args 
)
SetEdgedFaces(Viewport self, bool md)
def SetFocalDist (   self,
  args 
)
SetFocalDist(Viewport self, float fd)
def SetFocalDistance (   self,
  args 
)
SetFocalDistance(Viewport self, float dist)
def SetFOV (   self,
  args 
)
SetFOV(Viewport self, float fov) -> bool
def SetGridSize (   self,
  args 
)
SetGridSize(Viewport self, float size)
def SetSFDisplay (   self,
  args 
)
SetSFDisplay(Viewport self, bool onOff)
def SetViewCamera (   self,
  args 
)
SetViewCamera(Viewport self, INode camNode)
def SetViewMatrix (   self,
  args 
)
SetViewMatrix(Viewport self, Matrix3 m) -> bool
def SetViewportClipScale (   self,
  args 
)
SetViewportClipScale(Viewport self, float fScale)
def SetViewSpot (   self,
  args 
)
SetViewSpot(Viewport self, INode spotNode)
def SetViewUser (   self,
  args 
)
SetViewUser(Viewport self, bool persp)
def SnapLength (   self,
  args 
)
SnapLength(Viewport self, float inValue) -> float
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
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)
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)
def UndoAccept (   self)
UndoAccept(Viewport self) -> bool
def UndoBegin (   self)
UndoBegin(Viewport self) -> bool
def UpdateLabel (   self)
UpdateLabel(Viewport self)
def Zoom (   self,
  args 
)
Zoom(Viewport self, float zoomFactor)