pymel.core.system.ogs

ogs(*args, **kwargs)

OGS is one of the viewport renderers. As there is a lot of effort involved in migrating functionality it will evolve over several releases. As it evolves it is prudent to provide safeguards to get the database back to a known state. That is the function of this command, similar to how ‘dgdirty’ is used to restore state to the dependency graph.

Flags:
Long name (short name) Argument Types Properties
reset (r) bool ../../../_images/create.gif ../../../_images/query.gif
 

If used then reset the entire OGS database for all viewports using it. In query mode the number of viewports that would be affected is returned but the reset is not actually done.Flag can appear in Create mode of commandFlag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.ogs

Example:

import pymel.core as pm

import maya.cmds as cmds

// Reset the database for all panels running the OGS renderer.
// Returns the number of panels affected.
pm.ogs( reset=True )
// Result: [modelPanel1] //

Previous topic

pymel.core.system.newFile

Next topic

pymel.core.system.openFile

Core

Core Modules

Other Modules

This Page