x.__init__(...) initializes x; see help(type(x)) for signature
Member Function Documentation
OpenMayaRender.MSceneRender.addPostUIDrawables
(
)
addPostUIDrawables(drawManager, frameContext) -> self
Provides access to the MUIDrawManager, which can be used to queue up operations to draw simple UI shapes like lines, circles, text, etc.
This method will only be called when hasUIDrawables() is overridden to return true and kRenderPostSceneUIItems is set in the MSceneFilterOption mask returned by renderFilterOverride().
UI drawables added in this method will be rendered after the scene render.
* drawManager (MUIDrawManager) - The UI draw manager, it can be used to draw some simple geometry including text.
* frameContext (MFrameContext) - Frame level context information
OpenMayaRender.MSceneRender.addPreUIDrawables
(
)
addPreUIDrawables(drawManager, frameContext) -> self
Provides access to the MUIDrawManager, which can be used to queue up operations to draw simple UI shapes like lines, circles, text, etc.
This method will only be called when hasUIDrawables() is overridden to return true and kRenderPreSceneUIItems is set in the MSceneFilterOption mask returned by renderFilterOverride().
UI drawables added in this method will be rendered before the scene render.
* drawManager (MUIDrawManager) - The UI draw manager, it can be used to draw some simple geometry including text.
* frameContext (MFrameContext) - Frame level context information
OpenMayaRender.MSceneRender.cameraOverride
(
)
cameraOverride() -> MCameraOverride
Query for a camera override.
OpenMayaRender.MSceneRender.clearOperation
(
)
clearOperation() -> MClearOperation
Get the scene clear operation.
OpenMayaRender.MSceneRender.cullingOverride
(
)
cullingOverride() -> int
Query for a face culling override.
MSceneRender.kNoCullingOverride No culling override
MSceneRender.kCullNone Don't perform culling
MSceneRender.kCullBackFaces Cull back faces
MSceneRender.kCullFrontFaces Cull front faces
OpenMayaRender.MSceneRender.displayModeOverride
(
)
displayModeOverride() -> int
Query for any display mode override.
MSceneRender.kNoDisplayModeOverride No display mode override
MSceneRender.kWireFrame Display wireframe
MSceneRender.kShade Display shaded textured
MSceneRender.kFlatShaded Display flat shaded
MSceneRender.kShadeActiveOnly Shade active objects. Only applicable if kShade or kFlatShaded is enabled.
MSceneRender.kBoundingBox Display bounding boxes
MSceneRender.kDefaultMaterial Use default material. Only applicable if kShade or kFlatShaded is enabled.
MSceneRender.kTextured Display textured. Only applicable if kShade or kFlatShaded is enabled.
OpenMayaRender.MSceneRender.fragmentName
(
)
fragmentName() -> String
Query the name of the fragment used to render the scene.
getParameters() -> MRenderParameters
Method to return the operation's parameter set.
OpenMayaRender.MSceneRender.hasUIDrawables
(
)
hasUIDrawables() -> bool
Query whether addUIDrawables() should be called or not.
OpenMayaRender.MSceneRender.lightModeOverride
(
)
lightModeOverride() -> int
Query for any lighting mode override.
MSceneRender.kNoLightingModeOverride No lighting mode override
MSceneRender.kNoLight Use no light
MSceneRender.kAmbientLight Use global ambient light
MSceneRender.kLightDefault Use default light
MSceneRender.kSelectedLights Use lights which are selected
MSceneRender.kSceneLights Use all lights in the scene
OpenMayaRender.MSceneRender.objectSetOverride
(
)
objectSetOverride() -> MSelectionList
Query for override for the set of objects to view.
Visibility takes into account the current states of each object, any displayfilters, and camera frustum culling.
Note that the override only applies to rendering but not selection.
By default NULL is returned which indicates that no override is present.
OpenMayaRender.MSceneRender.objectTypeExclusions
(
)
objectTypeExclusions() -> int
Query for any object type exclusions.
Refer to the MObjectTypeExclusions enumeration on MSceneRender for possible values
This method is deprecated. Use getObjectTypeExclusions instead.
OpenMayaRender.MSceneRender.postEffectsOverride
(
)
postEffectsOverride() -> int
Query for post effects override.
MSceneRender.kPostEffectDisableNone Use current render settings options
MSceneRender.kPostEffectDisableSSAO Disable SSAO post effect
MSceneRender.kPostEffectDisableMotionBlur Disable motion blur post effect
MSceneRender.kPostEffectDisableDOF Disable depth-of-field post effect
MSceneRender.kPostEffectDisableAll Disable all post effects
OpenMayaRender.MSceneRender.postRender
(
)
postRender() -> self
Method to allow for the operation to clean up itself after being executed.
By default this method performs no action
OpenMayaRender.MSceneRender.postSceneRender
(
)
postSceneRender(context) -> self
Method to allow for the operation to update itself after a scene rendering ends.
This method will be called after computing shadow maps, and after a color pass.
* context (MDrawContext) - Draw context after rendering has completed
By default this method performs no action
OpenMayaRender.MSceneRender.preRender
(
)
preRender() -> self
Method to allow for the operation to update itself before being executed. In general this would be used to update any operation parameters.
No context information is available at this point.
By default this method performs no action
OpenMayaRender.MSceneRender.preSceneRender
(
)
preSceneRender(context) -> self
Method to allow for the operation to update itself before a scene rendering begins.
This method will be called before computing shadow maps, and before a color pass.
* context (MDrawContext) - Draw context before rendering begins
By default this method performs no action
OpenMayaRender.MSceneRender.renderFilterOverride
(
)
renderFilterOverride() -> int
Query which elements of a scene render will be drawn based on semantic meaning.
MSceneRender.kNoSceneFilterOverride
MSceneRender.kRenderPreSceneUIItems Render UI items before scene render like grid or user added pre-scene UI items
MSceneRender.kRenderOpaqueShadedItems Render only opaque shaded objects but not their wireframe or components
MSceneRender.kRenderTransparentShadedItems Render only transparent shaded objects but not their wireframe or components
MSceneRender.kRenderShadedItems Render only shaded (opaque and transparent) objects but not their wireframe or components
MSceneRender.kRenderPostSceneUIItems Render UI items after scene render like wireframe and components for surfaces as well as non-surface objects.
MSceneRender.kRenderUIItems kRenderPreSceneUIItems | kRenderPostSceneUIItems
MSceneRender.kRenderAllItems Render all items.
OpenMayaRender.MSceneRender.shaderOverride
(
)
shaderOverride() -> MShaderInstance
Query for a scene level shader override.
OpenMayaRender.MSceneRender.shadowEnableOverride
(
)
shadowEnableOverride() -> bool/None
Query for shadow display override.
By default a None value is returned indicating that no override is specified.