rfm2.ui.shelf Namespace Reference

Functions
def	not_implemented
def	build_shelf

Variables
string	_SHELFLABEL_ = 'RenderMan %s'
tuple	_SHELFNAME_ = re.sub(r'[ab]\d+$', '', re.sub(r'[^\w_]', '_', _SHELFLABEL_))

Detailed Description

Parse json shelf descritions, build and update the RenderMan shelf.

All shelf descriptions are contained in one or more shelf.json file in the usual
locations:
    . ~/rfm/config/shelf.json
    . $RFM_SHOW_PATH/config/shelf.json
    . RFM_SITE_PATH/config/shelf.json

Each file will be considered to add items to the shelf.

When the shelf is rebuilt (because the plugin being loaded is newer than the
shelf version), all buttons that were manually added to the RenderMan shelf
will be removed and only those described through one of the json files will be
restored.

Function Documentation

def rfm2.ui.shelf.build_shelf

(

rebuild = False

)

Build the RenderMan shelf.

- We will always check the last built shelf version versus the current rfm
version and rebuild the shelf if they are not in sync.
- The version string will be displayed in the shelf's label.

Kwargs:
- rebuild:  force rebuilding the shelf if True.

Here is the caller graph for this function:

def rfm2.ui.shelf.not_implemented

(

)

Output a 'NOT IMPLEMENTED YET' warning.

Here is the call graph for this function:

Variable Documentation

string rfm2.ui.shelf._SHELFLABEL_ = 'RenderMan %s'

tuple rfm2.ui.shelf._SHELFNAME_ = re.sub(r'[ab]\d+$', '', re.sub(r'[^\w_]', '_', _SHELFLABEL_))