Inheritance |
|
You can’t instantiate this object directly, call hou.shelves.newShelf instead.
Methods ¶
destroy()
Removes this shelf tab from Houdini and deletes it from the shelf defintion file.
setTools(tools)
Replaces the current contents of the shelf with the given list of hou.Tool objects.
tools()
→ tuple
of hou.Tool
Returns the tools on this shelf tab.
Methods from hou.ShelfElement ¶
setFilePath(file_path)
Sets the path string for where this object’s definition is stored.
filePath()
→ str
Returns the file that contains the definition of this object.
fileLocation()
→ str
Returns the file location description in a human readable format. For example, it is a file path for disk files, and information about an HDA if the element is stored in an HDA tool section.
setName(name)
Sets this object’s internal name. This is how you refer to the object in scripts.
The name has similar rules to naming Houdini nodes: it must not start with a number, and can only contain letters, numbers, an underscores.
For example, if a Tool objects name is foo
, you can get a reference
to it using:
footool = shelves.tool("foo")
name()
→ str
Returns the internal name of this object.
Multiple objects may have the same name (for example, two
different assets might both provide a hammer
tool), but only one will
be active at a time in a Houdini session.
setLabel(label)
Sets the object’s human-readable label. This is what’s displayed in the UI.
label()
→ str
Returns the object’s human-readable label.
setReadOnly(on)
# Get a reference to a tool t = hou.shelves.tool("geometry_sphere") # Prevent the tool from being modified t.setReadOnly(True) # Allow the tool to be modified t.setReadOnly(False)
isReadOnly()
→ bool
Returns True
if the element is read-only (can’t be edited).