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

Synopsis

annotate( [objects] , [point=[linear, linear, linear]], [text=string])

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

annotate is undoable, NOT queryable, and NOT editable.

This command is used to create an annotation to be attached to the specified objects at the specified point.

Return value

string

Flags

point, text
Long name (short name) Argument types Properties
point(p) [linear, linear, linear] create
Specifies the point about which the annotation text is to be centered.
text(tx) string create
Specifies the annotation text.
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

# The following specifies an annotation with text "my annotation text" on
# object mySphere, with the text being centered at point [5,6,3].
cmds.sphere( name='mySphere' )
cmds.annotate( 'mySphere', tx='my annotation text', p=(5, 6, 5) )