inViewMessage

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

Synopsis

inViewMessage([alpha=float], [assistMessage=string], [backColor=uint], [clear=string], [clickKill=boolean], [dragKill=boolean], [fade=boolean], [fadeInTime=uint], [fadeOutTime=uint], [fadeStayTime=uint], [font=string], [fontSize=uint], [frameOffset=uint], [hide=boolean], [message=string], [minimize=boolean], [position=string], [restore=boolean], [show=boolean], [statusMessage=string], [textAlpha=float], [textOffset=uint], [uvEditor=boolean])

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

inViewMessage is undoable, NOT queryable, and NOT editable.

Note: On Linux, the alpha and textAlpha flags for inViewMessage are only supported when running a window manager that supports compositing (transparency and opacity). Otherwise, they are ignored. In addition, the flags for message fading: -fade, -fadeInTime, -fadeStay and -fadeOutTime are supported, but the message will display without a fade effect if the window manager doesn't support compositing.

Return value

None

Related

Flags

Long name (short name)	Argument types	Properties
alpha(a)	float
Sets the maximum alpha transparency for the message box.
assistMessage(amg)	string
The user assistance message to be displayed, can be html format.
backColor(bkc)	uint
Sets the background color for the message using the format 0xAARRGGBB, alpha is not taken into account.
clear(cl)	string
Use this flag to clear the message at a specified position. The supported positions are the same as for the -pos/position flag.
clickKill(ck)	boolean
Use this flag if the message needs to be deleted on mouse click.
dragKill(dk)	boolean
Use this flag if the message needs to be deleted on mouse drag.
fade(f)	boolean
Whether the message will fade after a time interval or not.
fadeInTime(fit)	uint
Sets how long it takes for the image to fade in (milliseconds).
fadeOutTime(fot)	uint
Sets how long it takes for the image to fade out (milliseconds).
fadeStayTime(fst)	uint
Sets how long the image stays at max opacity (milliseconds).
font(ft)	string
Sets the message to a font (eg. "Arial").
fontSize(fts)	uint
Sets the message font size.
frameOffset(fof)	uint
Sets how far the message appears from the edge of the viewport in pixels.
hide(hd)	boolean
Hides all messages.
message(msg)	string
The message to be displayed, can be html format. General message, inherited by -amg/assistMessage and -smg/statusMessage.
minimize(min)	boolean
Minimize all messages.
position(pos)	string
The position that the message will appear at relative to the active viewport. The supported positions are: "topLeft" "topCenter" "topRight" "midLeft" "midCenter" "midCenterTop" "midCenterBot" "midRight" "botLeft" "botCenter" "botRight"
restore(res)	boolean
Restore all messages.
show(sh)	boolean
Shows all messages.
statusMessage(smg)	string
The status info message to be displayed, can be html format.
textAlpha(ta)	float
Sets the maximum alpha transparency for the message text.
textOffset(tof)	uint
Sets how far the text appears from the edge of the message box in pixels.
uvEditor(uv)	boolean
Show the message in the active UV editor view.

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

# Create a user assist message in the center of the viewport with some of the text highlighted in yellow.
# The message will fade out after the default time.
cmds.inViewMessage( amg='In-view message <hl>test</hl>.', pos='midCenter', fade=True )