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
	Change view mode to category view
cpuView / cpu		bool
	Change view mode to cpu view
destroy / dtr		bool
	Destroy the profiler tool Internal flag. Should not be used by user.
exists / ex		bool
	Query if the profiler tool view exists. Profiler tool can only exist after profilerTool -makeis called.
findNext / fn		bool
	This flag is used along with flag -searchEvent.
findPrevious / fp		bool
	This flag is used along with flag -searchEvent.
frameAll / fa		bool
	Frame on all events in the profilerToolView
frameSelected / fs		bool
	Frame on all selected events in the profilerToolView
isolateSegment / isolateSegment		int
	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
	Make the profiler tool and parent it to the most recent layout created Internal flag. Should not be used by user.
matchWholeWord / mww		bool
	Tells profiler tool if it should match whole word when searching event(s). The default value is false.
searchEvent / se		unicode
	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
	Returns the number of segments in the event buffer.
showAllEvent / sa		bool
	Show all events (if events were hidden by filtering) (true) or Hide all events (false)
showSelectedEvents / ss		bool
	Show only the selected events (true) or hide all selected events (false)
showSelectedEventsRepetition / ssr		bool
	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
	Change view mode to thread view
unisolateSegment / uis		bool
	Unisolate current isolated segment. If no segment is currently isolated, nothing will happen. Flag can have multiple arguments, passed either as a tuple or a list.

Derived from mel command maya.cmds.profilerTool

Example:

::

import pymel.core as pm

#First record/load a profile #Frame the tool’s view on all recorded events. pm.profilerTool( edit = True, frameAll = True )

#Frame selected events pm.profilerTool( edit = True, frameSelected = True )

#Change to cpu view pm.profilerTool( edit = True, cpuView = True )

#Show only selected events pm.profilerTool( edit = True, showSelectedEvents = True )

#Show all events pm.profilerTool( edit = True, showAllEvent = True )

#Hide all events that have same comment as selected events pm.profilerTool( edit = True, showSelectedEventsRepetition = False )

#Find all events whose name contains “abc” pm.profilerTool( query = True, searchEvent = “abc” )

#Find the first event, whose name exactly matches with “def”, next to current selected event pm.profilerTool( edit = True, matchWholeWord = True ) pm.profilerTool( query = True, searchEvent = “def”, findNext = True )

#Query segment count in buffer pm.profilerTool( query = True, segmentCount = True )

#Isolate the first segment pm.profilerTool( edit = True, isolateSegment = 0 )

#Unisolate segment pm.profilerTool( edit = True, unisolateSegment = True )