pymel.core.system.profilerTool — PyMEL 1.0.7 documentation

pymel.core.system.profilerTool

profilerTool(*args, **kwargs)

This script is intended to be used by the profilerPanel to interact with the profiler tool’s view (draw region). It can be used to control some behaviors about the profiler Tool. In query mode, return type is based on queried flag.

Flags:

Long Name / Short Name Argument Types Properties
categoryView / cat bool ../../../_images/edit.gif
 
Change view mode to category view
cpuView / cpu bool ../../../_images/edit.gif
 
Change view mode to cpu view
destroy / dtr bool ../../../_images/create.gif
 
Destroy the profiler tool Internal flag. Should not be used by user.
exists / ex bool ../../../_images/query.gif
 
Query if the profiler tool view exists. Profiler tool can only exist after profilerTool -makeis called.
findNext / fn bool ../../../_images/query.gif
 
This flag is used along with flag -searchEvent.
findPrevious / fp bool ../../../_images/query.gif
 
This flag is used along with flag -searchEvent.
frameAll / fa bool ../../../_images/edit.gif
 
Frame on all events in the profilerToolView
frameSelected / fs bool ../../../_images/edit.gif
 
Frame on all selected events in the profilerToolView
isolateSegment / isolateSegment int ../../../_images/edit.gif
 

Isolate a specified segment. A segment is a set of events that happened in one animation frame. You can use flag -segmentCount to query the number of segments in the event buffer. The segment index starts from 0. If the specified segment does not exist, an error will be thrown.

make / mk bool ../../../_images/create.gif
 
Make the profiler tool and parent it to the most recent layout created Internal flag. Should not be used by user.
matchWholeWord / mww bool ../../../_images/edit.gif
 
Tells profiler tool if it should match whole word when searching event(s). The default value is false.
searchEvent / se unicode ../../../_images/query.gif
 

Search event(s). You can set -matchWholeWord before you use -searchEvent. If -matchWholeWord has been set to true, the profiler tool will search event(s) whose name exactly matches with the string. If -matchWholeWord has been set to false, the profiler tool will search event(s) whose name contains the string. If -findNext is also used along with this flag, the profiler tool will find the first event next to the current selected event. If -findPrevious is also used along with this flag, the profiler tool will find the first event previous to the current selected event. If currently don’t have a selected event or there are multiple selected events, the search will start at the first event in profiler buffer. If -findNext and -findPrevious are not used along with this flag, the profiler tool will find all events.

segmentCount / sc bool ../../../_images/query.gif
 
Returns the number of segments in the event buffer. Flag can have multiple arguments, passed either as a tuple or a list.
showAllEvent / sa bool ../../../_images/edit.gif
 
Show all events (if events were hidden by filtering) (true) or Hide all events (false)
showSelectedEvents / ss bool ../../../_images/edit.gif
 
Show only the selected events (true) or hide all selected events (false)
showSelectedEventsRepetition / ssr bool ../../../_images/edit.gif
 
Show only the selected events repetition based on their comment (true) or Hide all selected events repetition based on their comment (false)
threadView / thd bool ../../../_images/edit.gif
 
Change view mode to thread view
unisolateSegment / uis bool ../../../_images/edit.gif
 
Unisolate current isolated segment. If no segment is currently isolated, nothing will happen.

Derived from mel command maya.cmds.profilerTool

Previous topic

pymel.core.system.profiler

Next topic

pymel.core.system.recordAttr

Core Modules

Type Modules

Other Modules

This Page