Go to: Synopsis. Return value. Keywords. Flags. Python examples.

Synopsis

ogs([reset=boolean])

Note: Strings representing object names and arguments must be separated by commas. This is not depicted in the synopsis.

ogs is NOT undoable, queryable, and NOT editable.

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.

Return value

string

In query mode, return type is based on queried flag.

Keywords

ogs, debug

Flags

reset
Long name (short name) Argument types Properties
reset(r) boolean createquery
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 command Flag can appear in Edit mode of command
Flag can appear in Query mode of command Flag can have multiple arguments, passed either as a tuple or a list.

Python examples

import maya.cmds as cmds

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