Public Types | |
| enum | CallbackReason { eCustomMenuOptionSelected, eItemNameChanged, eItemMoved, eItemAdded, eItemRemoved } |
| enum | SelectionMode { eSelectionModeToggle, eSelectionModeHighlight } |
| typedef std::vector< std::string > | ItemList |
| typedef std::vector< unsigned int > | IndexList |
| typedef const std::vector< int > | WidgetEventCallbackParam |
| typedef void(* | WidgetEventCallback )(CallbackReason, Knob *, WidgetEventCallbackParam &, const char *) |
Public Member Functions | |
| virtual void | menu (const ItemList &e)=0 |
| virtual void | addItems (const ItemList &e)=0 |
| virtual void | removeItems (const ItemList &e)=0 |
| virtual const ItemList & | getItemNames () const =0 |
| virtual size_t | getItemCount () const =0 |
| virtual const ItemList & | menu () const =0 |
| virtual void | getSelectedItems (IndexList &items)=0 |
| virtual void | setSelectedItems (const IndexList &items)=0 |
| virtual void | setImportedItems (const IndexList &items)=0 |
| virtual void | getImportedItems (IndexList &items)=0 |
| virtual void | viewAllNodes (bool view)=0 |
| virtual void | autoSelectItems (bool autoSelect)=0 |
| virtual void | autoExpand ()=0 |
| virtual void | setColumnHeader (const std::string &title)=0 |
| virtual std::string | getHighlightedItem () const =0 |
| virtual void | getHighlightedItems (ItemList &itemList) const =0 |
| virtual void | getHighlightedItems (IndexList &itemList) const =0 |
| virtual void | registerWidgetEventCallback (WidgetEventCallback callback, Knob *knob)=0 |
| virtual void | addCustomRightClickMenu (DD::Image::Menu *menu)=0 |
| virtual void | setSelectionMode (SelectionMode mode)=0 |
| virtual SelectionMode | getSelectionMode () const =0 |
Abstract base class for SceneView Knob-specific methods.
| typedef void(* DD::Image::SceneView_KnobI::WidgetEventCallback)(CallbackReason, Knob *, WidgetEventCallbackParam &, const char *) |
callback type passed from an op returns with the callback reason, the knob the callback was invoked for, plus two custom int and a const char* parameters.
CallbackReason - enumerated value giving the reason for the callback invocation
| Knob | - The knob invoking the callback |
| WidgetEventCallbackParam | - a vector of integer values giving context information for the callback. The values in this parameter are dependent upon the CallbackReason: eCustomMenuOptionSelected - The first element will be the index of the custom menu item selected. eItemNameChanged - The first element will be the index of the item that has changed eItemMoved - The first element will be the index that the selection is being moved to, The 2nd - n+1th elements are the indices of the n elements being moved (n can be obtained by the vector size()-1) |
| const | char* - a string giving context informtaion for the callback (can be NULL) The values in this parameter are dependent upon the CallbackReason: eCustomMenuOptionSelected - NULL eItemNameChanged - The new name of the item eItemMoved - NULL |
| virtual void DD::Image::SceneView_KnobI::menu | ( | const ItemList & | e | ) | [pure virtual] |
set the menu items on the knob to the given list. if you want this to persist you must use the SAVE_MENU flag on this knob.
| virtual void DD::Image::SceneView_KnobI::addItems | ( | const ItemList & | e | ) | [pure virtual] |
augments the menu items on the knob with the given list. if you want this to persist you must use the SAVE_MENU flag on this knob.
| virtual void DD::Image::SceneView_KnobI::removeItems | ( | const ItemList & | e | ) | [pure virtual] |
removes from the knob all menu items contained in the given list. if you want this to persist you must use the SAVE_MENU flag on this knob.
| virtual const ItemList& DD::Image::SceneView_KnobI::getItemNames | ( | ) | const [pure virtual] |
get the menu items names set to the knob.
| virtual size_t DD::Image::SceneView_KnobI::getItemCount | ( | ) | const [pure virtual] |
get the number of items in the knob
| virtual const ItemList& DD::Image::SceneView_KnobI::menu | ( | ) | const [pure virtual] |
get the list of menu items on the knob
| virtual void DD::Image::SceneView_KnobI::getSelectedItems | ( | IndexList & | items | ) | [pure virtual] |
get the list of selected items on the knob
| virtual void DD::Image::SceneView_KnobI::setSelectedItems | ( | const IndexList & | items | ) | [pure virtual] |
set the list of selected items on the knob. Note that unless you are in eSelectionModeToggle mode, only the first item will be selected
| virtual void DD::Image::SceneView_KnobI::setImportedItems | ( | const IndexList & | items | ) | [pure virtual] |
set list of items imported into this knob
| virtual void DD::Image::SceneView_KnobI::getImportedItems | ( | IndexList & | items | ) | [pure virtual] |
get list of items imported into this knob
| virtual void DD::Image::SceneView_KnobI::autoSelectItems | ( | bool | autoSelect | ) | [pure virtual] |
whether to automatically select all imported items
| virtual void DD::Image::SceneView_KnobI::autoExpand | ( | ) | [pure virtual] |
automatically expand the scene view to the first multi-child object, if it exists
| virtual void DD::Image::SceneView_KnobI::setColumnHeader | ( | const std::string & | title | ) | [pure virtual] |
set the title of the nodelist column
| virtual std::string DD::Image::SceneView_KnobI::getHighlightedItem | ( | ) | const [pure virtual] |
get the item currently being highlighted
| virtual void DD::Image::SceneView_KnobI::getHighlightedItems | ( | ItemList & | itemList | ) | const [pure virtual] |
return a vector of all item strings which are currently highlighted
| virtual void DD::Image::SceneView_KnobI::getHighlightedItems | ( | IndexList & | itemList | ) | const [pure virtual] |
return a vector of all item indices which are currently highlighted
| virtual void DD::Image::SceneView_KnobI::registerWidgetEventCallback | ( | WidgetEventCallback | callback, |
| Knob * | knob | ||
| ) | [pure virtual] |
register a callback to get notifications about changes to the knob
| virtual void DD::Image::SceneView_KnobI::addCustomRightClickMenu | ( | DD::Image::Menu * | menu | ) | [pure virtual] |
add a custom right-click menu to knob (Must be a QMenu-derived object)
| virtual void DD::Image::SceneView_KnobI::setSelectionMode | ( | SelectionMode | mode | ) | [pure virtual] |
sets the knob's selection mode
| virtual SelectionMode DD::Image::SceneView_KnobI::getSelectionMode | ( | ) | const [pure virtual] |
gets the knob's selection mode