Python API 2.0 Reference
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
OpenMayaRender.MDrawContext Class Reference
+ Inheritance diagram for OpenMayaRender.MDrawContext:

Public Member Functions

def __init__ ()
 
def copyCurrentColorRenderTarget ()
 
def copyCurrentColorRenderTargetToTexture ()
 
def copyCurrentDepthRenderTarget ()
 
def copyCurrentDepthRenderTargetToTexture ()
 
def getDepthRange ()
 
def getFrameStamp ()
 
def getFrustumBox ()
 
def getLightInformation ()
 
def getLightParameterInformation ()
 
def getPassContext ()
 
def getRenderTargetSize ()
 
def getSceneBox ()
 
def getStateManager ()
 
def numberOfActiveLights ()
 
def viewDirectionAlongNegZ ()
 
- Public Member Functions inherited from OpenMayaRender.MFrameContext
def __init__ ()
 
def classificationExclusions ()
 
def getBackgroundParameters ()
 
def getCurrentCameraPath ()
 
def getCurrentColorRenderTarget ()
 
def getCurrentDepthRenderTarget ()
 
def getDOFParameters ()
 
def getDisplayStyle ()
 
def getEnvironmentParameters ()
 
def getGlobalLineWidth ()
 
def getHwFogParameters ()
 
def getLightLimit ()
 
def getLightingMode ()
 
def getMatrix ()
 
def getPostEffectEnabled ()
 
def getRenderOverrideInformation ()
 
def getTransparencyAlgorithm ()
 
def getTuple ()
 
def getViewportDimensions ()
 
def objectTypeExclusions ()
 
def renderingDestination ()
 

Static Public Member Functions

def __new__ ()
 
- Static Public Member Functions inherited from OpenMayaRender.MFrameContext
def __new__ ()
 
def inUserInteraction ()
 
def semanticToMatrixType ()
 
def semanticToTupleType ()
 
def shadeTemplates ()
 
def userChangingViewContext ()
 
def wireOnShadedMode ()
 

Static Public Attributes

int kFilteredIgnoreLightLimit = 1
 
int kFilteredToLightLimit = 0
 
- Static Public Attributes inherited from OpenMayaRender.MFrameContext
int k2dViewport = 1
 
int k3dViewport = 0
 
int kAmbientLight = 1
 
int kAmbientOcclusion = 0
 
int kAntiAliasing = 4
 
int kBackfaceCulling = 2048
 
int kBoundingBox = 4
 
int kCustomLights = 5
 
int kDefaultMaterial = 16
 
int kDepthOfField = 3
 
int kDepthPeeling = 3
 
int kExcludeAll = 18446744073709551615
 
int kExcludeCVs = 131072
 
int kExcludeCameras = 32
 
int kExcludeClipGhosts = 17179869184
 
int kExcludeControllers = 68719476736
 
int kExcludeDeformers = 256
 
int kExcludeDimensions = 4096
 
int kExcludeDynamicConstraints = 134217728
 
int kExcludeDynamics = 512
 
int kExcludeFluids = 2097152
 
int kExcludeFollicles = 4194304
 
int kExcludeGreasePencils = 34359738368
 
int kExcludeGrid = 65536
 
int kExcludeHUD = 8589934592
 
int kExcludeHairSystems = 8388608
 
int kExcludeHoldOuts = 2147483648
 
int kExcludeHulls = 262144
 
int kExcludeIkHandles = 128
 
int kExcludeImagePlane = 16777216
 
int kExcludeJoints = 64
 
int kExcludeLights = 16
 
int kExcludeLocators = 2048
 
int kExcludeManipulators = 268435456
 
int kExcludeMeshes = 4
 
int kExcludeMotionTrails = 1073741824
 
int kExcludeNCloths = 33554432
 
int kExcludeNParticles = 536870912
 
int kExcludeNRigids = 67108864
 
int kExcludeNone = 0
 
int kExcludeNurbsCurves = 1
 
int kExcludeNurbsSurfaces = 2
 
int kExcludeParticleInstancers = 1024
 
int kExcludePivots = 16384
 
int kExcludePlanes = 8
 
int kExcludePluginShapes = 4294967296
 
int kExcludeSelectHandles = 8192
 
int kExcludeStrokes = 524288
 
int kExcludeSubdivSurfaces = 1048576
 
int kExcludeTextures = 32768
 
int kFlatShaded = 256
 
int kFogExp = 1
 
int kFogExp2 = 2
 
int kFogLinear = 0
 
int kGammaCorrection = 2
 
int kGouraudShaded = 1
 
int kImage = 2
 
int kLightDefault = 2
 
int kMotionBlur = 1
 
int kNoLighting = 0
 
int kObjectSorting = 1
 
int kProjectionInverseMtx = 10
 
int kProjectionMtx = 8
 
int kProjectionTranposeMtx = 9
 
int kProjectionTranspInverseMtx = 11
 
int kSceneLights = 4
 
int kSelectedLights = 3
 
int kShadeActiveOnly = 512
 
int kSmoothWireframe = 4096
 
int kTextured = 8
 
int kTwoSidedLighting = 128
 
int kUnsorted = 0
 
int kViewColorTransformEnabled = 2
 
int kViewDirection = 1
 
int kViewFarClipValue = 6
 
int kViewInverseMtx = 6
 
int kViewMtx = 4
 
int kViewNearClipValue = 5
 
int kViewPosition = 0
 
int kViewProjInverseMtx = 14
 
int kViewProjMtx = 12
 
int kViewProjTranposeMtx = 13
 
int kViewProjTranspInverseMtx = 15
 
int kViewRight = 3
 
int kViewTranspInverseMtx = 7
 
int kViewTransposeMtx = 5
 
int kViewUnnormalizedFarClipValue = 8
 
int kViewUnnormlizedNearClipValue = 7
 
int kViewUp = 2
 
int kViewportPixelSize = 4
 
int kWeightedAverage = 2
 
int kWireFrame = 2
 
int kWireFrameOnShadedNone = 2
 
int kWireFrameOnShadedReduced = 1
 
int kWireframeOnShadedFull = 0
 
int kWorldInverseMtx = 2
 
int kWorldMtx = 0
 
int kWorldTranspInverseMtx = 3
 
int kWorldTransposeMtx = 1
 
int kWorldViewInverseMtx = 18
 
int kWorldViewMtx = 16
 
int kWorldViewProjInverseMtx = 22
 
int kWorldViewProjMtx = 20
 
int kWorldViewProjTranspInverseMtx = 23
 
int kWorldViewProjTransposeMtx = 21
 
int kWorldViewTranspInverseMtx = 19
 
int kWorldViewTransposeMtx = 17
 
int kXray = 64
 
int kXrayActiveComponents = 1024
 
int kXrayJoint = 32
 

Detailed Description

Class to allow access to hardware draw context information.

Method resolution order:
-   MDrawContext
-   MFrameContext
-   builtins.object

Constructor & Destructor Documentation

def OpenMayaRender.MDrawContext.__init__ ( ) 
Initialize self.  See help(type(self)) for accurate signature.

Member Function Documentation

def OpenMayaRender.MDrawContext.__new__ ( )
static 
Create and return a new object.  See help(type) for accurate signature.
def OpenMayaRender.MDrawContext.copyCurrentColorRenderTarget ( ) 
copyCurrentColorRenderTarget(string) -> MRenderTarget

Get a copy of the current color render target.
When the object is no longer needed, MRenderTargetManager::releaseRenderTarget() should be called
to notify the target manager that the caller is done with the render target.
def OpenMayaRender.MDrawContext.copyCurrentColorRenderTargetToTexture ( ) 
copyCurrentColorRenderTargetToTexture() -> MTexture

Get a copy of the current color render target as a texture.
When the texture is no longer needed, MTextureManager::releaseTexture() should be called.
def OpenMayaRender.MDrawContext.copyCurrentDepthRenderTarget ( ) 
copyCurrentDepthRenderTarget(string) -> MRenderTarget

Get a copy of the current depth render target.
When the object is no longer needed, MRenderTargetManager::releaseRenderTarget() should be called
to notify the target manager that the caller is done with the render target.
def OpenMayaRender.MDrawContext.copyCurrentDepthRenderTargetToTexture ( ) 
copyCurrentDepthRenderTargetToTexture() -> MTexture

Get a copy of the current depth render target as a texture.
When the texture is no longer needed, MTextureManager::releaseTexture() should be called.
def OpenMayaRender.MDrawContext.getDepthRange ( ) 
getDepthRange() -> [float, float]

Get the depth range which specifies the mapping of depth values from normalized device coordinates to window coordinates.
The depth range values are normally 0.0 and 1.0.
def OpenMayaRender.MDrawContext.getFrameStamp ( ) 
getFrameStamp() -> long

Returns the current frame stamp.
def OpenMayaRender.MDrawContext.getFrustumBox ( ) 
getFrustumBox() -> MBoundingBox

Get the bounding box of the current view frustum in world space.
def OpenMayaRender.MDrawContext.getLightInformation ( ) 
getLightInformation(lightNumber, lightFilter=kFilteredToLightLimit) -> [positions, direction, intensity, color, hasDirection, hasPosition]

Return common lighting information for a given active light.
def OpenMayaRender.MDrawContext.getLightParameterInformation ( ) 
getLightParameterInformation(lightNumber, lightFilter=kFilteredToLightLimit) -> MLightParameterInformation

Return parameter information for a given active light.
def OpenMayaRender.MDrawContext.getPassContext ( ) 
getPassContext() -> MPassContext

Access the current pass context.
def OpenMayaRender.MDrawContext.getRenderTargetSize ( ) 
getRenderTargetSize() -> [int, int]

Get the size of the render target (output buffer) being rendered into.
The dimensions of the target are in pixels
def OpenMayaRender.MDrawContext.getSceneBox ( ) 
getSceneBox() -> MBoundingBox

Get a bounding box of the scene in world space.
def OpenMayaRender.MDrawContext.getStateManager ( ) 
getStateManager() -> MStateManager

Access the GPU state manager for the current draw context.
def OpenMayaRender.MDrawContext.numberOfActiveLights ( ) 
numberOfActiveLights(lightFilter=kFilteredToLightLimit) -> int

Return the number of available lights to render the scene,
only considering lights which pass the filter option.
def OpenMayaRender.MDrawContext.viewDirectionAlongNegZ ( ) 
viewDirectionAlongNegZ() -> bool

Return whether the view direction is pointing down the -Z axis.