You cannot instantiate this object directly. Call hou.anim.newBookmark instead.
Methods ¶
name()
→ str
Returns the name of this bookmark.
setName(name)
Updates the name of the bookmark.
startFrame()
→ int
Returns the start frame of this bookmark.
setStartFrame(start_frame)
Updates the start frame of the bookmark.
endFrame()
→ int
Returns the end frame of this bookmark.
setEndFrame(end_frame)
Updates the end frame of the bookmark.
comment()
→ str
Returns the comment of this bookmark.
setComment(comment)
Updates the comment of the bookmark.
setColor(color)
Updates the color of the bookmark.
The color
parameter should be a hou.Color.
visible()
→ bool
Returns whether or not this bookmark is visible.
setVisible(visible)
Updates the visibility of the bookmark.
isTemporary()
→ bool
Returns whether or not this bookmark is marked as temporary.
setTemporary(temporary)
Marks this bookmark as temporary or not. Temporary bookmarks are not saved when exporting bookmarks, nor are they saved in the .hip file by default.
isEnabled()
→ bool
Returns whether or not this bookmark is enabled.
enable(enabled)
Enable or disable this bookmark. Disabled bookmarks are greyed out on the playbar.
metadata(key, default_value=None)
→ Any
Returns the metadata associated with the given key, or default_value if no such key exists in the metadata.
key
The name of the metadata property to return.
default_value
Value to return if no property with the given key exists in the metadata.
setMetadata(key, value, type_hint = hou.fieldType.NoSuchField)
Adds a metadata property to this bookmark.
key
The name of the metadata property to add.
value
The value to store as metadata.
type_hint
Used to determine the exact hou.fieldType desired when the specified value is too ambiguous to determine the type.
sessionId()
- int
Returns the ID of the bookmark. Note that this is a per-session ID that is not guaranteed to be the same between different sessions.