|
Python API 2.0 Reference
|
|
Python API 2.0 Reference
|
Inheritance diagram for OpenMayaRender.MSceneRender:Public Member Functions | |
| def | __init__ () |
| def | addPostUIDrawables () |
| def | addPreUIDrawables () |
| def | cameraOverride () |
| def | clearOperation () |
| def | cullingOverride () |
| def | displayModeOverride () |
| def | fragmentName () |
| def | getObjectTypeExclusions () |
| def | getParameters () |
| def | hasUIDrawables () |
| def | lightModeOverride () |
| def | objectSetOverride () |
| def | objectTypeExclusions () |
| def | postEffectsOverride () |
| def | postRender () |
| def | postSceneRender () |
| def | preRender () |
| def | preSceneRender () |
| def | renderFilterOverride () |
| def | shaderOverride () |
| def | shadowEnableOverride () |
| Public Member Functions inherited from OpenMayaRender.MRenderOperation | |
| def | __init__ () |
| def | enableSRGBWrite () |
| def | name () |
| def | operationType () |
| def | targetOverrideList () |
| def | viewportRectangleOverride () |
Static Public Member Functions | |
| def | __new__ () |
| Static Public Member Functions inherited from OpenMayaRender.MRenderOperation | |
| def | __new__ () |
Static Public Attributes | |
| int | kAmbientLight = 2 |
| int | kBoundingBox = 16 |
| int | kCullBackFaces = 2 |
| int | kCullFrontFaces = 3 |
| int | kCullNone = 1 |
| int | kDefaultMaterial = 32 |
| int | kExcludeAll = -1 |
| int | kExcludeCVs = 131072 |
| int | kExcludeCameras = 32 |
| int | kExcludeDeformers = 256 |
| int | kExcludeDimensions = 4096 |
| int | kExcludeDynamicConstraints = 134217728 |
| int | kExcludeDynamics = 512 |
| int | kExcludeFluids = 2097152 |
| int | kExcludeFollicles = 4194304 |
| int | kExcludeGrid = 65536 |
| 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 | kExcludeSelectHandles = 8192 |
| int | kExcludeStrokes = 524288 |
| int | kExcludeSubdivSurfaces = 1048576 |
| int | kExcludeTextures = 32768 |
| int | kFlatShaded = 4 |
| int | kLightDefault = 3 |
| int | kNoCullingOverride = 0 |
| int | kNoDisplayModeOverride = 0 |
| int | kNoLight = 1 |
| int | kNoLightingModeOverride = 0 |
| int | kNoSceneFilterOverride = 0 |
| int | kPostEffectDisableAll = -1 |
| int | kPostEffectDisableDOF = 4 |
| int | kPostEffectDisableMotionBlur = 2 |
| int | kPostEffectDisableNone = 0 |
| int | kPostEffectDisableSSAO = 1 |
| int | kRenderAllItems = -1 |
| int | kRenderNonShadedItems = 9 |
| int | kRenderOpaqueShadedItems = 2 |
| int | kRenderPostSceneUIItems = 8 |
| int | kRenderPreSceneUIItems = 1 |
| int | kRenderShadedItems = 6 |
| int | kRenderTransparentShadedItems = 4 |
| int | kRenderUIItems = 9 |
| int | kSceneLights = 5 |
| int | kSelectedLights = 4 |
| int | kShadeActiveOnly = 8 |
| int | kShaded = 2 |
| int | kTextured = 64 |
| int | kWireFrame = 1 |
| Static Public Attributes inherited from OpenMayaRender.MRenderOperation | |
| int | kClear = 0 |
| int | kHUDRender = 4 |
| int | kPresentTarget = 5 |
| int | kQuadRender = 2 |
| int | kSceneRender = 1 |
| int | kUserDefined = 3 |
Properties | |
| mClearOperation = property(...) | |
Class which defines a scene render. Method resolution order: - MSceneRender - MRenderOperation - builtins.object
| def OpenMayaRender.MSceneRender.__init__ | ( | ) |
Initialize self. See help(type(self)) for accurate signature.
|
static |
Create and return a new object. See help(type) for accurate signature.
| def 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
| def 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
| def OpenMayaRender.MSceneRender.cameraOverride | ( | ) |
cameraOverride() -> MCameraOverride Query for a camera override.
| def OpenMayaRender.MSceneRender.clearOperation | ( | ) |
clearOperation() -> MClearOperation Get the scene clear operation.
| def 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
| def 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.
| def OpenMayaRender.MSceneRender.fragmentName | ( | ) |
fragmentName() -> String Query the name of the fragment used to render the scene.
| def OpenMayaRender.MSceneRender.getObjectTypeExclusions | ( | ) |
getObjectTypeExclusions() -> long Query for any object type exclusions. MFrameContext.kExcludeNone Exclude no object types MFrameContext.kExcludeNurbsCurves Exclude NURBS curves MFrameContext.kExcludeNurbsSurfaces Exclude NURBS surface MFrameContext.kExcludeMeshes Exclude polygonal meshes MFrameContext.kExcludePlanes Exclude planes MFrameContext.kExcludeLights Exclude lights MFrameContext.kExcludeCameras Exclude camera MFrameContext.kExcludeJoints Exclude joints MFrameContext.kExcludeIkHandles Exclude IK handles MFrameContext.kExcludeDeformers Exclude all deformations MFrameContext.kExcludeDynamics Exclude all dynamics objects (emiters, cloth) MFrameContext.kExcludeParticleInstancers Exclude all Particle Instancers MFrameContext.kExcludeLocators Exclude locators MFrameContext.kExcludeDimensions Exclude all measurement objects MFrameContext.kExcludeSelectHandles Exclude selection handles MFrameContext.kExcludePivots Exclude pivots MFrameContext.kExcludeTextures Exclude texure placement objects MFrameContext.kExcludeGrid Exclude grid drawing MFrameContext.kExcludeCVs Exclude NURBS control vertices MFrameContext.kExcludeHulls Exclude NURBS hulls MFrameContext.kExcludeStrokes Exclude PaintFX strokes MFrameContext.kExcludeSubdivSurfaces Exclude subdivision surfaces MFrameContext.kExcludeFluids Exclude fluid objects MFrameContext.kExcludeFollicles Exclude hair follicles MFrameContext.kExcludeHairSystems Exclude hair system MFrameContext.kExcludeImagePlane Exclude image planes MFrameContext.kExcludeNCloths Exclude N-cloth objects MFrameContext.kExcludeNRigids Exclude rigid-body objects MFrameContext.kExcludeDynamicConstraints Exclude rigid-body constraints MFrameContext.kExcludeManipulators Exclude manipulators MFrameContext.kExcludeNParticles Exclude N-particle objects MFrameContext.kExcludeMotionTrails Exclude motion trails MFrameContext.kExcludeHoldOuts Exclude Hold-Outs MFrameContext.kExcludePluginShapes Exclude plug-in shapes MFrameContext.kExcludeHUD Exclude HUD MFrameContext.kExcludeClipGhosts Exclude animation clip ghosts MFrameContext.kExcludeGreasePencils Exclude grease-pencil draw MFrameContext.kExcludeControllers Exclude controllers objects MFrameContext.kExcludeAll Exclude all listed object types
| def OpenMayaRender.MSceneRender.getParameters | ( | ) |
getParameters() -> MRenderParameters Method to return the operation's parameter set.
| def OpenMayaRender.MSceneRender.hasUIDrawables | ( | ) |
hasUIDrawables() -> bool Query whether addUIDrawables() should be called or not.
| def 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
| def 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.
| def 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.
| def 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
| def 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
| def 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
| def 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
| def 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
| def 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.
| def OpenMayaRender.MSceneRender.shaderOverride | ( | ) |
shaderOverride() -> MShaderInstance Query for a scene level shader override.
| def OpenMayaRender.MSceneRender.shadowEnableOverride | ( | ) |
shadowEnableOverride() -> bool/None Query for shadow display override. By default a None value is returned indicating that no override is specified.
|
static |
Default clear operation object.
1.8.10 
