hou.StickyNote class

Represents a sticky note.

To create a sticky note, use the hou.Node.createStickyNote method on the node inside which you want to create the note. To get an existing sticky note, use the hou.Node.findStickyNote method on the node containing the sticky note. To get a list of all notes in a network, use the hou.Node.stickyNotes method on the containing node.

Methods

asCode(self, brief=False, recurse=False, save_box_contents=False, save_channels_only=False, save_creation_commands=False, save_keys_in_frames=False, save_parm_values_only=False, save_spare_parms=False, function_name=None) -> string

Prints the Python code necessary to recreate a sticky note.

See hou.Node.asCode for information on the keyword arguments.

color(self) → hou.Color

Returns the color of this sticky note.

destroy(self)

Remove and delete the sticky note.

isMinimized(self) → bool

Returns whether the sticky note is minimized.

isPicked(self) → bool

Returns whether the sticky note is selected.

move(self, vector2)

Moves the sticky note by the increments in the given hou.Vector2. Use setPosition() to set the note’s absolute position.

name(self) → str

Return the name of the sticky note.

parent(self) → Node

Returns the node which contains the sticky note.

position(self) → hou.Vector2

Return the position of this sticky note.

resize(self, vector2)

Resizes a sticky note by the increments in the given hou.Vector2. Use setSize() to set the note’s absolute size.

setColor(self, color)

Set the color of this sticky note to the given hou.Color.

setMinimized(self, on)

Minimizes or restores the sticky note.

setName(self, name)

Sets the name of the sticky note.

setPicked(self, on)

Selectsor deselects the sticky note.

setPosition(self, vector2)

Sets the position of this sticky note to the given hou.Vector2. Use move() to move the note relative to its current position.

setSize(self, size)

Sets the size of this sticky note to the given hou.Vector2. Use resize() to set the note’s size relative to its current size.

setText(self, size)

Sets the text of the sticky note.

size(self) → hou.Vector2

Returns the size of this sticky note.

text(self) → str

Return the text of the sticky note.