DD::Image::SceneGraph_KnobI Class Referenceabstract

Public Member Functions

virtual void addItems (const std::map< std::string, std::vector< std::string >> &e, bool selected=false)=0
 
virtual void setItems (const std::map< std::string, std::vector< std::string >> &e, bool selected=false)=0
 
virtual void removeItems (const std::vector< std::string > &e)=0
 
virtual void clear ()=0
 
virtual std::vector< std::string > getItemNames () const =0
 
virtual std::map< std::string, std::vector< std::string > > getItems () const =0
 
virtual void setSelectedItems (const std::vector< std::string > &items)=0
 set the selected items
 
virtual std::vector< std::string > getSelectedItems () const =0
 get the selected items
 
virtual void viewAllNodes (bool view)=0
 
virtual void setColumnHeader (const std::string &title)=0
 

Detailed Description

Abstract base class for Scenegraph Knob-specific methods.

Member Function Documentation

virtual void DD::Image::SceneGraph_KnobI::addItems ( const std::map< std::string, std::vector< std::string >> &  e,
bool  selected = false 
)
pure virtual

augments the menu items on the knob with the given list. accepted keys: "name" - the name of the item in the list "type" - the type of the item

virtual void DD::Image::SceneGraph_KnobI::setItems ( const std::map< std::string, std::vector< std::string >> &  e,
bool  selected = false 
)
pure virtual

sets the items in the tree, removing any that no longer exist

Parameters
evalues to insert into the tree accepted keys: "name" - the name of the item in the list "type" - the type of the item
selectedset this to true to overwrite the value of already existing menu items
virtual void DD::Image::SceneGraph_KnobI::removeItems ( const std::vector< std::string > &  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 std::vector<std::string> DD::Image::SceneGraph_KnobI::getItemNames ( ) const
pure virtual

get the menu items names set to the knob.

virtual std::map<std::string, std::vector<std::string> > DD::Image::SceneGraph_KnobI::getItems ( ) const
pure virtual

get the menu items names set to the knob.

virtual void DD::Image::SceneGraph_KnobI::setColumnHeader ( const std::string &  title)
pure virtual

set the title of the nodelist column



©2020 The Foundry Visionmongers, Ltd. All Rights Reserved.
www.thefoundry.co.uk