HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
HOM_ui Class Referenceabstract

#include <HOM_ui.h>

Public Member Functions

virtual ~HOM_ui ()
 
virtual std::string __repr__ ()=0
 
virtual HOM_ShellIOshellIO ()=0
 
virtual HOM_DesktopcurDesktop ()=0
 
virtual HOM_Desktopdesktop (const char *name)=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Desktop > > 
desktops ()=0
 
virtual HOM_RadialMenuradialMenu (const std::string &name)=0
 
virtual std::vector
< HOM_ElemPtr< HOM_RadialMenu > > 
radialMenus ()=0
 
virtual HOM_RadialMenucreateRadialMenu (const std::string &name, const char *label)=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Pane > > 
panes ()=0
 
virtual std::vector
< HOM_ElemPtr< HOM_PaneTab > > 
paneTabs ()=0
 
virtual std::vector
< HOM_ElemPtr< HOM_PaneTab > > 
currentPaneTabs ()=0
 
virtual HOM_PaneTabpaneTabOfType (HOM_EnumValue &type, int index=0)=0
 
virtual HOM_PanefindPane (int pane_id)=0
 
virtual HOM_PaneTabfindPaneTab (const char *name)=0
 
virtual std::vector
< HOM_ElemPtr< HOM_PaneTab > > 
floatingPaneTabs ()=0
 
virtual std::vector
< HOM_ElemPtr
< HOM_FloatingPanel > > 
floatingPanels ()=0
 
virtual HOM_PanepaneUnderCursor ()=0
 
virtual HOM_PaneTabpaneTabUnderCursor ()=0
 
virtual HOM_EnumValueorientationUpAxis ()=0
 
virtual HOM_EnumValuehandleOrientToNormalAxis ()=0
 
virtual bool displayConfirmation (const char *text, HOM_EnumValue &severity=HOM_severityType::Message, const char *help=NULL, const char *title=NULL, const char *details=NULL, const char *details_label=NULL, HOM_EnumValue &suppress=HOM_confirmType::OverwriteFile)=0
 
virtual int displayMessage (const char *text, const std::vector< std::string > &buttons=std::vector< std::string >(1,"OK"), HOM_EnumValue &severity=HOM_severityType::Message, int default_choice=0, int close_choice=-1, const char *help=NULL, const char *title=NULL, const char *details=NULL, const char *details_label=NULL, bool details_expanded=false)=0
 
virtual std::pair< int,
std::string
readInput (const char *message, const std::vector< std::string > &buttons=std::vector< std::string >(1,"OK"), HOM_EnumValue &severity=HOM_severityType::Message, int default_choice=0, int close_choice=-1, const char *help=NULL, const char *title=NULL, const char *initial_contents=NULL)=0
 
virtual std::pair< int,
std::vector< std::string > > 
readMultiInput (const char *message, const std::vector< std::string > &input_labels, const std::vector< int > &password_input_indices=std::vector< int >(), const std::vector< std::string > &buttons=std::vector< std::string >(1,"OK"), HOM_EnumValue &severity=HOM_severityType::Message, int default_choice=0, int close_choice=-1, const char *help=NULL, const char *title=NULL, const std::vector< std::string > &initial_contents=std::vector< std::string >())=0
 
virtual std::vector< intselectFromList (const std::vector< std::string > &choices, const std::vector< int > &default_choices=std::vector< int >(), bool exclusive=false, const char *message=NULL, const char *title=NULL, const char *column_header="Choices", int num_visible_rows=10, bool clear_on_cancel=false)=0
 
virtual std::vector< std::stringselectFromTree (const std::vector< std::string > &choices, const std::vector< std::string > &picked=std::vector< std::string >(), bool exclusive=false, const char *message=NULL, const char *title=NULL, bool clear_on_cancel=false)=0
 
virtual std::string selectFile (const char *start_directory=NULL, const char *title=NULL, bool collapse_sequences=false, HOM_EnumValue &file_type=HOM_fileType::Any, const char *pattern=NULL, const char *default_value=NULL, bool multiple_select=false, bool image_chooser=false, HOM_EnumValue &chooser_mode=HOM_fileChooserMode::ReadAndWrite)=0
 
virtual char * selectNode (HOM_Node *relative_to_node=NULL, HOM_Node *initial_node=NULL, HOM_EnumValue *node_type_filter=NULL)=0
 
virtual std::vector< std::stringselectMultipleNodes (HOM_Node *relative_to_node=NULL, HOM_Node *initial_node=NULL, HOM_EnumValue *node_type_filter=NULL)=0
 
virtual std::vector< std::string_selectNodeDataInternal (const char *title=NULL, const char *message=NULL, int width=0, int height=0, const std::vector< std::string > &initial_selection=std::vector< std::string >(), HOM_EnumValue *node_type_filter=nullptr, bool multiple_select=false, bool include_data_type_headers=true, bool include_parms=true, bool include_object_transforms=true, bool include_geometry_bounding_boxes=true, bool include_geometry_attributes=true, bool expand_components=true, void *custom_data_callback=nullptr, const char *help_url=nullptr)=0
 
virtual std::vector< std::stringselectParmTag ()=0
 
virtual std::vector< std::stringselectParm (HOM_NodeTypeCategory *category=NULL, bool bound_parms_only=false, HOM_Node *relative_to_node=NULL, const char *message=NULL, const char *title=NULL, const std::vector< std::string > &initial_parms=std::vector< std::string >(), bool multiple_select=true)=0
 
virtual std::vector< std::stringselectParmTuple (HOM_NodeTypeCategory *category=NULL, bool bound_parms_only=false, HOM_Node *relative_to_node=NULL, const char *message=NULL, const char *title=NULL, const std::vector< std::string > &initial_parm_tuples=std::vector< std::string >(), bool multiple_select=true)=0
 
virtual HOM_ColorselectColor (HOM_Color *initial_color=NULL)=0
 
virtual void _openColorEditor (void *color_changed_callback, bool include_alpha=false, HOM_Color *initial_color=nullptr, float initial_alpha=1.0f)=0
 
virtual std::vector< HOM_ColorloadPaletteFile (const char *file)=0
 
virtual void savePaletteFile (const char *file, const std::vector< HOM_Color > &colors)=0
 
virtual void _openValueLadder (float initial_value, void *value_changed_callback, HOM_EnumValue &type=HOM_valueLadderType::Generic, HOM_EnumValue &data_type=HOM_valueLadderDataType::Float)=0
 
virtual void updateValueLadder (int cursor_x, int cursor_y, bool alt_key, bool shift_key)=0
 
virtual void closeValueLadder ()=0
 
virtual UT_Tuple< bool,
std::vector< std::pair
< HOM_ElemPtr< HOM_Parm >
, std::string > > > 
displayFileDependencyDialog (HOM_Node *rop_node=NULL, const std::vector< std::string > &uploaded_files=std::vector< std::string >(), const std::vector< std::string > &forced_unselected_patterns=std::vector< std::string >(), const char *project_dir_variable="HIP", bool is_standalone=true)=0
 
virtual void displayNodeHelp (HOM_NodeType &node_type)=0
 
virtual void openTypePropertiesDialog (HOM_Node &node, bool promote_spare_parms=false, bool immediately_save=false)=0
 
virtual void openTypePropertiesDialog (HOM_NodeType &node_type, bool promote_spare_parms=false, bool immediately_save=false)=0
 
virtual void openRenderDialog (HOM_RopNode &rop)=0
 
virtual void openRenameSelectedDialog (HOM_Node &network)=0
 
virtual HOM_EnumValueupdateMode ()=0
 
virtual void setUpdateMode (HOM_EnumValue &mode)=0
 
virtual void triggerUpdate ()=0
 
virtual void reloadViewportColorSchemes ()=0
 
virtual std::vector< int_getTabMenuIconSize ()=0
 
virtual void addOpaqueSelectionCallback (void *py_callback)=0
 
virtual void removeOpaqueSelectionCallback (void *py_callback)=0
 
virtual void removeAllSelectionCallbacks ()=0
 
virtual std::vector< void * > opaqueSelectionCallbacks ()=0
 
virtual void addOpaqueEventLoopCallback (void *callback)=0
 
virtual void removeOpaqueEventLoopCallback (void *callback)=0
 
virtual std::vector< void * > opaqueEventLoopCallbacks ()=0
 
virtual HOM_DialogcreateDialog (const char *ui_file_name)=0
 
virtual HOM_DialogfindDialog (const char *ui_file_name)=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Dialog > > 
dialogs ()=0
 
virtual void opaqueWaitUntil (void *condition_callback)=0
 
virtual void writePythonShellHistoryFile (const char *filename=NULL)=0
 
virtual void readPythonShellHistoryFile (const char *filename=NULL)=0
 
virtual void setStatusMessage (const char *message, HOM_EnumValue &severity=HOM_severityType::Message)=0
 
virtual void openAssetUploadDialog (HOM_Node *uploading_node, const char *session_key, HOM_Node *containing_node)=0
 
virtual void openAssetDependenciesDialog (const std::vector< HOM_Node * > &uploading_nodes, const std::vector< HOM_Node * > &uploaded_nodes, const char *session_key, HOM_Node *containing_node)=0
 
virtual bool hasDragSourceData (const char *label)=0
 
virtual HOM_DDSourceAny getDragSourceData (const char *label, int index)=0
 
virtual std::string resourceValueFromName (const char *name)=0
 
virtual HOM_Color colorFromName (const char *name)=0
 
virtual double globalScaleFactor ()=0
 
virtual int scaledSize (int size)=0
 
virtual double inchesToPixels (double inches)=0
 
virtual double pixelsToInches (double pixels)=0
 
virtual void copyTextToClipboard (const char *text)=0
 
virtual std::string getTextFromClipboard ()=0
 
virtual std::vector< std::stringhotkeys (const char *hotkey_symbol)=0
 
virtual std::string hotkeyDescription (const char *hotkey_symbol)=0
 
virtual bool isKeyMatch (const char *key, const char *hotkey_symbol)=0
 
virtual void openCaptureWeightSpreadsheet (HOM_Node *node, const char *pattern=NULL)=0
 
virtual void registerViewerState (HOM_ViewerStateTemplate &vs_templ)=0
 
virtual void unregisterViewerState (std::string const &state_typename)=0
 
virtual bool isRegisteredViewerState (std::string const &state_name)=0
 
virtual void reloadViewerState (std::string const &state_typename)=0
 
virtual void reloadViewerStates (std::vector< std::string > const &state_names=std::vector< std::string >())=0
 

Detailed Description

Definition at line 41 of file HOM_ui.h.

Constructor & Destructor Documentation

virtual HOM_ui::~HOM_ui ( )
inlinevirtual

Definition at line 44 of file HOM_ui.h.

Member Function Documentation

virtual std::string HOM_ui::__repr__ ( )
pure virtual
virtual std::vector<int> HOM_ui::_getTabMenuIconSize ( )
pure virtual
virtual void HOM_ui::_openColorEditor ( void color_changed_callback,
bool  include_alpha = false,
HOM_Color initial_color = nullptr,
float  initial_alpha = 1.0f 
)
pure virtual
virtual void HOM_ui::_openValueLadder ( float  initial_value,
void value_changed_callback,
HOM_EnumValue type = HOM_valueLadderType::Generic,
HOM_EnumValue data_type = HOM_valueLadderDataType::Float 
)
pure virtual
virtual std::vector<std::string> HOM_ui::_selectNodeDataInternal ( const char *  title = NULL,
const char *  message = NULL,
int  width = 0,
int  height = 0,
const std::vector< std::string > &  initial_selection = std::vector< std::string >(),
HOM_EnumValue node_type_filter = nullptr,
bool  multiple_select = false,
bool  include_data_type_headers = true,
bool  include_parms = true,
bool  include_object_transforms = true,
bool  include_geometry_bounding_boxes = true,
bool  include_geometry_attributes = true,
bool  expand_components = true,
void custom_data_callback = nullptr,
const char *  help_url = nullptr 
)
pure virtual
virtual void HOM_ui::addOpaqueEventLoopCallback ( void callback)
pure virtual
virtual void HOM_ui::addOpaqueSelectionCallback ( void py_callback)
pure virtual
virtual void HOM_ui::closeValueLadder ( )
pure virtual
virtual HOM_Color HOM_ui::colorFromName ( const char *  name)
pure virtual
virtual void HOM_ui::copyTextToClipboard ( const char *  text)
pure virtual
virtual HOM_Dialog* HOM_ui::createDialog ( const char *  ui_file_name)
pure virtual
virtual HOM_RadialMenu* HOM_ui::createRadialMenu ( const std::string name,
const char *  label 
)
pure virtual
virtual HOM_Desktop* HOM_ui::curDesktop ( )
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_PaneTab> > HOM_ui::currentPaneTabs ( )
pure virtual
virtual HOM_Desktop* HOM_ui::desktop ( const char *  name)
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_Desktop> > HOM_ui::desktops ( )
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_Dialog> > HOM_ui::dialogs ( )
pure virtual
virtual bool HOM_ui::displayConfirmation ( const char *  text,
HOM_EnumValue severity = HOM_severityType::Message,
const char *  help = NULL,
const char *  title = NULL,
const char *  details = NULL,
const char *  details_label = NULL,
HOM_EnumValue suppress = HOM_confirmType::OverwriteFile 
)
pure virtual
virtual UT_Tuple<bool, std::vector<std::pair<HOM_ElemPtr<HOM_Parm>, std::string> > > HOM_ui::displayFileDependencyDialog ( HOM_Node rop_node = NULL,
const std::vector< std::string > &  uploaded_files = std::vector< std::string >(),
const std::vector< std::string > &  forced_unselected_patterns = std::vector< std::string >(),
const char *  project_dir_variable = "HIP",
bool  is_standalone = true 
)
pure virtual
virtual int HOM_ui::displayMessage ( const char *  text,
const std::vector< std::string > &  buttons = std::vector< std::string >(1,"OK"),
HOM_EnumValue severity = HOM_severityType::Message,
int  default_choice = 0,
int  close_choice = -1,
const char *  help = NULL,
const char *  title = NULL,
const char *  details = NULL,
const char *  details_label = NULL,
bool  details_expanded = false 
)
pure virtual
virtual void HOM_ui::displayNodeHelp ( HOM_NodeType node_type)
pure virtual
virtual HOM_Dialog* HOM_ui::findDialog ( const char *  ui_file_name)
pure virtual
virtual HOM_Pane* HOM_ui::findPane ( int  pane_id)
pure virtual
virtual HOM_PaneTab* HOM_ui::findPaneTab ( const char *  name)
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_FloatingPanel> > HOM_ui::floatingPanels ( )
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_PaneTab> > HOM_ui::floatingPaneTabs ( )
pure virtual
virtual HOM_DDSourceAny HOM_ui::getDragSourceData ( const char *  label,
int  index 
)
pure virtual
virtual std::string HOM_ui::getTextFromClipboard ( )
pure virtual
virtual double HOM_ui::globalScaleFactor ( )
pure virtual
virtual HOM_EnumValue& HOM_ui::handleOrientToNormalAxis ( )
pure virtual
virtual bool HOM_ui::hasDragSourceData ( const char *  label)
pure virtual
virtual std::string HOM_ui::hotkeyDescription ( const char *  hotkey_symbol)
pure virtual
virtual std::vector<std::string> HOM_ui::hotkeys ( const char *  hotkey_symbol)
pure virtual
virtual double HOM_ui::inchesToPixels ( double  inches)
pure virtual
virtual bool HOM_ui::isKeyMatch ( const char *  key,
const char *  hotkey_symbol 
)
pure virtual
virtual bool HOM_ui::isRegisteredViewerState ( std::string const state_name)
pure virtual
virtual std::vector<HOM_Color> HOM_ui::loadPaletteFile ( const char *  file)
pure virtual
virtual std::vector<void *> HOM_ui::opaqueEventLoopCallbacks ( )
pure virtual
virtual std::vector<void *> HOM_ui::opaqueSelectionCallbacks ( )
pure virtual
virtual void HOM_ui::opaqueWaitUntil ( void condition_callback)
pure virtual
virtual void HOM_ui::openAssetDependenciesDialog ( const std::vector< HOM_Node * > &  uploading_nodes,
const std::vector< HOM_Node * > &  uploaded_nodes,
const char *  session_key,
HOM_Node containing_node 
)
pure virtual
virtual void HOM_ui::openAssetUploadDialog ( HOM_Node uploading_node,
const char *  session_key,
HOM_Node containing_node 
)
pure virtual
virtual void HOM_ui::openCaptureWeightSpreadsheet ( HOM_Node node,
const char *  pattern = NULL 
)
pure virtual
virtual void HOM_ui::openRenameSelectedDialog ( HOM_Node network)
pure virtual
virtual void HOM_ui::openRenderDialog ( HOM_RopNode rop)
pure virtual
virtual void HOM_ui::openTypePropertiesDialog ( HOM_Node node,
bool  promote_spare_parms = false,
bool  immediately_save = false 
)
pure virtual
virtual void HOM_ui::openTypePropertiesDialog ( HOM_NodeType node_type,
bool  promote_spare_parms = false,
bool  immediately_save = false 
)
pure virtual
virtual HOM_EnumValue& HOM_ui::orientationUpAxis ( )
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_Pane> > HOM_ui::panes ( )
pure virtual
virtual HOM_PaneTab* HOM_ui::paneTabOfType ( HOM_EnumValue type,
int  index = 0 
)
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_PaneTab> > HOM_ui::paneTabs ( )
pure virtual
virtual HOM_PaneTab* HOM_ui::paneTabUnderCursor ( )
pure virtual
virtual HOM_Pane* HOM_ui::paneUnderCursor ( )
pure virtual
virtual double HOM_ui::pixelsToInches ( double  pixels)
pure virtual
virtual HOM_RadialMenu* HOM_ui::radialMenu ( const std::string name)
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_RadialMenu> > HOM_ui::radialMenus ( )
pure virtual
virtual std::pair<int, std::string> HOM_ui::readInput ( const char *  message,
const std::vector< std::string > &  buttons = std::vector< std::string >(1,"OK"),
HOM_EnumValue severity = HOM_severityType::Message,
int  default_choice = 0,
int  close_choice = -1,
const char *  help = NULL,
const char *  title = NULL,
const char *  initial_contents = NULL 
)
pure virtual
virtual std::pair<int, std::vector<std::string> > HOM_ui::readMultiInput ( const char *  message,
const std::vector< std::string > &  input_labels,
const std::vector< int > &  password_input_indices = std::vector< int >(),
const std::vector< std::string > &  buttons = std::vector< std::string >(1,"OK"),
HOM_EnumValue severity = HOM_severityType::Message,
int  default_choice = 0,
int  close_choice = -1,
const char *  help = NULL,
const char *  title = NULL,
const std::vector< std::string > &  initial_contents = std::vector< std::string >() 
)
pure virtual
virtual void HOM_ui::readPythonShellHistoryFile ( const char *  filename = NULL)
pure virtual
virtual void HOM_ui::registerViewerState ( HOM_ViewerStateTemplate vs_templ)
pure virtual
virtual void HOM_ui::reloadViewerState ( std::string const state_typename)
pure virtual
virtual void HOM_ui::reloadViewerStates ( std::vector< std::string > const state_names = std::vector< std::string >())
pure virtual
virtual void HOM_ui::reloadViewportColorSchemes ( )
pure virtual
virtual void HOM_ui::removeAllSelectionCallbacks ( )
pure virtual
virtual void HOM_ui::removeOpaqueEventLoopCallback ( void callback)
pure virtual
virtual void HOM_ui::removeOpaqueSelectionCallback ( void py_callback)
pure virtual
virtual std::string HOM_ui::resourceValueFromName ( const char *  name)
pure virtual
virtual void HOM_ui::savePaletteFile ( const char *  file,
const std::vector< HOM_Color > &  colors 
)
pure virtual
virtual int HOM_ui::scaledSize ( int  size)
pure virtual
virtual HOM_Color* HOM_ui::selectColor ( HOM_Color initial_color = NULL)
pure virtual
virtual std::string HOM_ui::selectFile ( const char *  start_directory = NULL,
const char *  title = NULL,
bool  collapse_sequences = false,
HOM_EnumValue file_type = HOM_fileType::Any,
const char *  pattern = NULL,
const char *  default_value = NULL,
bool  multiple_select = false,
bool  image_chooser = false,
HOM_EnumValue chooser_mode = HOM_fileChooserMode::ReadAndWrite 
)
pure virtual
virtual std::vector<int> HOM_ui::selectFromList ( const std::vector< std::string > &  choices,
const std::vector< int > &  default_choices = std::vector< int >(),
bool  exclusive = false,
const char *  message = NULL,
const char *  title = NULL,
const char *  column_header = "Choices",
int  num_visible_rows = 10,
bool  clear_on_cancel = false 
)
pure virtual
virtual std::vector<std::string> HOM_ui::selectFromTree ( const std::vector< std::string > &  choices,
const std::vector< std::string > &  picked = std::vector< std::string >(),
bool  exclusive = false,
const char *  message = NULL,
const char *  title = NULL,
bool  clear_on_cancel = false 
)
pure virtual
virtual std::vector<std::string> HOM_ui::selectMultipleNodes ( HOM_Node relative_to_node = NULL,
HOM_Node initial_node = NULL,
HOM_EnumValue node_type_filter = NULL 
)
pure virtual
virtual char* HOM_ui::selectNode ( HOM_Node relative_to_node = NULL,
HOM_Node initial_node = NULL,
HOM_EnumValue node_type_filter = NULL 
)
pure virtual
virtual std::vector<std::string> HOM_ui::selectParm ( HOM_NodeTypeCategory category = NULL,
bool  bound_parms_only = false,
HOM_Node relative_to_node = NULL,
const char *  message = NULL,
const char *  title = NULL,
const std::vector< std::string > &  initial_parms = std::vector< std::string >(),
bool  multiple_select = true 
)
pure virtual
virtual std::vector<std::string> HOM_ui::selectParmTag ( )
pure virtual
virtual std::vector<std::string> HOM_ui::selectParmTuple ( HOM_NodeTypeCategory category = NULL,
bool  bound_parms_only = false,
HOM_Node relative_to_node = NULL,
const char *  message = NULL,
const char *  title = NULL,
const std::vector< std::string > &  initial_parm_tuples = std::vector< std::string >(),
bool  multiple_select = true 
)
pure virtual
virtual void HOM_ui::setStatusMessage ( const char *  message,
HOM_EnumValue severity = HOM_severityType::Message 
)
pure virtual
virtual void HOM_ui::setUpdateMode ( HOM_EnumValue mode)
pure virtual
virtual HOM_ShellIO& HOM_ui::shellIO ( )
pure virtual
virtual void HOM_ui::triggerUpdate ( )
pure virtual
virtual void HOM_ui::unregisterViewerState ( std::string const state_typename)
pure virtual
virtual HOM_EnumValue& HOM_ui::updateMode ( )
pure virtual
virtual void HOM_ui::updateValueLadder ( int  cursor_x,
int  cursor_y,
bool  alt_key,
bool  shift_key 
)
pure virtual
virtual void HOM_ui::writePythonShellHistoryFile ( const char *  filename = NULL)
pure virtual

The documentation for this class was generated from the following file: