#include <HOM_ViewerStateTemplate.h>

Public Types
typedef std::vector< std::pair < std::string, std::string > >	Bindings

typedef std::vector< std::string >	HandleParmNames

typedef std::vector < std::vector< std::string > >	MenuItemParms

Public Member Functions
	HOM_ViewerStateTemplate ()

virtual	~HOM_ViewerStateTemplate ()

virtual std::string	__repr__ ()=0

virtual std::string	typeName () const =0

virtual std::string	categoryName () const =0

virtual std::vector < HOM_NodeTypeCategory * >	contexts () const =0

virtual void	bindFactory_internal (void *callback)=0

virtual void	bindParameter (HOM_EnumValue const &param_type, std::string const &name=std::string(), std::string const &label=std::string(), MenuItemParms const &menu_items=MenuItemParms(), bool menu_as_button_strip=false, hboost::any default_value=hboost::any(), int num_components=1, double min_limit=0, double max_limit=1, bool align=false, bool toolbox=true)=0

virtual void	bindHandle (std::string const &handle_type, std::string const &name, std::string const &settings=std::string(), bool cache_previous_parms=false, HandleParmNames const &handle_parms=HandleParmNames())=0

virtual void	bindHandleStatic (std::string const &handle_type, std::string const &name, Bindings const &bindings, std::string const &settings=std::string())=0

virtual void	bindGadget (HOM_EnumValue const &drawable_type, std::string const &name, std::string const &label=std::string())=0

virtual void	bindGeometrySelector (std::string const &prompt, bool allow_drag=false, bool quick_select=true, bool auto_start=true, bool toolbox=true, bool use_existing_selection=true, std::string const &initial_selection=std::string(), HOM_EnumValue initial_selection_type=nullptr, bool ordered=false, std::vector< HOM_EnumValue > const &geometry_types=std::vector< HOM_EnumValue * >(), std::vector< HOM_EnumValue * > const &primitive_types=std::vector< HOM_EnumValue * >(), bool allow_other_sops=true, bool consume_selection=true, HOM_EnumValue const &secure_selection=HOM_secureSelectionOption::Off, std::string const &hotkey=std::string(), std::string const &name=std::string())=0

virtual void	bindObjectSelector (std::string const &prompt, bool quick_select=true, bool auto_start=true, bool toolbox=true, bool use_existing_selection=true, bool allow_multisel=true, HOM_EnumValue const &secure_selection=HOM_secureSelectionOption::Off, std::vector< std::string > const &allowed_types=std::vector< std::string >(1,"*"), std::string const &hotkey=std::string(), std::string const &name=std::string())=0

virtual void	bindSceneGraphSelector (std::string const &prompt, bool allow_drag=true, bool quick_select=true, bool auto_start=true, bool toolbox=true, bool use_existing_selection=true, bool allow_multisel=true, bool consume_selection=false, HOM_EnumValue const &secure_selection=HOM_secureSelectionOption::Off, std::vector< std::string > const &prior_selection_paths=std::vector< std::string >(), HOM_EnumValue const &prim_mask=HOM_scenePrimMask::ViewerSetting, std::string const &path_prefix_mask=std::string(), std::string const &prim_kind=std::string(), std::string const &hotkey=std::string(), std::string const &name=std::string())=0

virtual void	bindDynamicsSelector (std::string const &prompt, bool auto_start=true, bool toolbox=true, bool allow_objects=true, bool allow_modifiers=false, bool quick_select=false, bool use_existing_selection=true, bool allow_multisel=true, HOM_EnumValue const &secure_selection=HOM_secureSelectionOption::Off, std::string const &hotkey=std::string(), std::string const &name=std::string())=0

virtual void	bindDynamicsPointSelector (std::string const &prompt, bool auto_start=true, bool toolbox=true, bool allow_objects=true, bool allow_modifiers=false, bool quick_select=false, bool use_existing_selection=true, bool allow_multisel=true, bool only_select_points=true, bool object_based_point_selection=false, bool use_last_selected_object=false, HOM_EnumValue const &secure_selection=HOM_secureSelectionOption::Off, std::string const &hotkey=std::string(), std::string const &name=std::string())=0

virtual void	bindDynamicsPolygonSelector (std::string const &prompt, bool auto_start=true, bool toolbox=true, bool quick_select=false, bool use_existing_selection=true, bool object_based_point_selection=false, bool use_last_selected_object=false, HOM_EnumValue const &secure_selection=HOM_secureSelectionOption::Off, std::string const &hotkey=std::string(), std::string const &name=std::string())=0

virtual void	bindDrawableSelector (std::string const &prompt, bool auto_start=true, bool toolbox=true, std::vector< std::string > const &drawable_mask=std::vector< std::string >(), std::string const &hotkey=std::string(), std::string const &name=std::string())=0

virtual void	bindSelector (std::string const &name, std::string const &selector_type, std::string const &prompt, std::vector< HOM_EnumValue * > primitive_types=std::vector< HOM_EnumValue * >(), std::string const &group_parm_name=std::string(), int input_index=0, bool input_required=true, bool allow_dragging=true)=0

virtual void	bindMenu (HOM_ViewerStateMenu const &menu)=0

virtual void	bindIcon (std::string const &name)=0

virtual void	bindSupportsSelectionChange (bool supports_change)=0

virtual void	bindSupportsMoveTool (bool supports_movetool)=0

virtual void	bindPlaybackChangeEvent ()=0

virtual void	bindNodeChangeEvent (const std::vector< HOM_EnumValue * > &event_types)=0

virtual void	bindNodeParmChangeEvent (const std::vector< std::string > &parm_names)=0

virtual void	bindHotkeyDefinitions (HOM_PluginHotkeyDefinitions const &definitions)=0

Detailed Description

Definition at line 28 of file HOM_ViewerStateTemplate.h.

Member Typedef Documentation

typedef std::vector< std::pair<std::string, std::string> > HOM_ViewerStateTemplate::Bindings

Definition at line 31 of file HOM_ViewerStateTemplate.h.

typedef std::vector< std::string > HOM_ViewerStateTemplate::HandleParmNames

Definition at line 32 of file HOM_ViewerStateTemplate.h.

typedef std::vector< std::vector<std::string> > HOM_ViewerStateTemplate::MenuItemParms

Definition at line 33 of file HOM_ViewerStateTemplate.h.

Constructor & Destructor Documentation

HOM_ViewerStateTemplate::HOM_ViewerStateTemplate ( )

inline

Definition at line 50 of file HOM_ViewerStateTemplate.h.

virtual HOM_ViewerStateTemplate::~HOM_ViewerStateTemplate ( )

inlinevirtual

Definition at line 54 of file HOM_ViewerStateTemplate.h.

Member Function Documentation

virtual std::string HOM_ViewerStateTemplate::__repr__ ( )

pure virtual

virtual void HOM_ViewerStateTemplate::bindDrawableSelector	(	std::string const &	prompt,
		bool	auto_start = `true`,
		bool	toolbox = `true`,
		std::vector< std::string > const &	drawable_mask = `std::vector< std::string >()`,
		std::string const &	hotkey = `std::string()`,
		std::string const &	name = `std::string()`
	)

pure virtual

virtual void HOM_ViewerStateTemplate::bindDynamicsPointSelector	(	std::string const &	prompt,
		bool	auto_start = `true`,
		bool	toolbox = `true`,
		bool	allow_objects = `true`,
		bool	allow_modifiers = `false`,
		bool	quick_select = `false`,
		bool	use_existing_selection = `true`,
		bool	allow_multisel = `true`,
		bool	only_select_points = `true`,
		bool	object_based_point_selection = `false`,
		bool	use_last_selected_object = `false`,
		HOM_EnumValue const &	secure_selection = `HOM_secureSelectionOption::Off`,
		std::string const &	hotkey = `std::string()`,
		std::string const &	name = `std::string()`
	)

pure virtual

virtual void HOM_ViewerStateTemplate::bindDynamicsPolygonSelector	(	std::string const &	prompt,
		bool	auto_start = `true`,
		bool	toolbox = `true`,
		bool	quick_select = `false`,
		bool	use_existing_selection = `true`,
		bool	object_based_point_selection = `false`,
		bool	use_last_selected_object = `false`,
		HOM_EnumValue const &	secure_selection = `HOM_secureSelectionOption::Off`,
		std::string const &	hotkey = `std::string()`,
		std::string const &	name = `std::string()`
	)

pure virtual

virtual void HOM_ViewerStateTemplate::bindDynamicsSelector	(	std::string const &	prompt,
		bool	auto_start = `true`,
		bool	toolbox = `true`,
		bool	allow_objects = `true`,
		bool	allow_modifiers = `false`,
		bool	quick_select = `false`,
		bool	use_existing_selection = `true`,
		bool	allow_multisel = `true`,
		HOM_EnumValue const &	secure_selection = `HOM_secureSelectionOption::Off`,
		std::string const &	hotkey = `std::string()`,
		std::string const &	name = `std::string()`
	)

pure virtual

virtual void HOM_ViewerStateTemplate::bindFactory_internal ( void * callback )

pure virtual

virtual void HOM_ViewerStateTemplate::bindGadget	(	HOM_EnumValue const &	drawable_type,
		std::string const &	name,
		std::string const &	label = `std::string()`
	)

pure virtual

virtual void HOM_ViewerStateTemplate::bindGeometrySelector	(	std::string const &	prompt,
		bool	allow_drag = `false`,
		bool	quick_select = `true`,
		bool	auto_start = `true`,
		bool	toolbox = `true`,
		bool	use_existing_selection = `true`,
		std::string const &	initial_selection = `std::string()`,
		HOM_EnumValue *	initial_selection_type = `nullptr`,
		bool	ordered = `false`,
		std::vector< HOM_EnumValue * > const &	geometry_types = `std::vector< HOM_EnumValue * >()`,
		std::vector< HOM_EnumValue * > const &	primitive_types = `std::vector< HOM_EnumValue * >()`,
		bool	allow_other_sops = `true`,
		bool	consume_selection = `true`,
		HOM_EnumValue const &	secure_selection = `HOM_secureSelectionOption::Off`,
		std::string const &	hotkey = `std::string()`,
		std::string const &	name = `std::string()`
	)

pure virtual

virtual void HOM_ViewerStateTemplate::bindHandle	(	std::string const &	handle_type,
		std::string const &	name,
		std::string const &	settings = `std::string()`,
		bool	cache_previous_parms = `false`,
		HandleParmNames const &	handle_parms = `HandleParmNames()`
	)

pure virtual

virtual void HOM_ViewerStateTemplate::bindHandleStatic	(	std::string const &	handle_type,
		std::string const &	name,
		Bindings const &	bindings,
		std::string const &	settings = `std::string()`
	)

pure virtual

virtual void HOM_ViewerStateTemplate::bindHotkeyDefinitions ( HOM_PluginHotkeyDefinitions const & definitions )

pure virtual

virtual void HOM_ViewerStateTemplate::bindIcon ( std::string const & name )

pure virtual

virtual void HOM_ViewerStateTemplate::bindMenu ( HOM_ViewerStateMenu const & menu )

pure virtual

virtual void HOM_ViewerStateTemplate::bindNodeChangeEvent ( const std::vector< HOM_EnumValue * > & event_types )

pure virtual

virtual void HOM_ViewerStateTemplate::bindNodeParmChangeEvent ( const std::vector< std::string > & parm_names )

pure virtual

virtual void HOM_ViewerStateTemplate::bindObjectSelector	(	std::string const &	prompt,
		bool	quick_select = `true`,
		bool	auto_start = `true`,
		bool	toolbox = `true`,
		bool	use_existing_selection = `true`,
		bool	allow_multisel = `true`,
		HOM_EnumValue const &	secure_selection = `HOM_secureSelectionOption::Off`,
		std::vector< std::string > const &	allowed_types = `std::vector< std::string >(1,"*")`,
		std::string const &	hotkey = `std::string()`,
		std::string const &	name = `std::string()`
	)

pure virtual

virtual void HOM_ViewerStateTemplate::bindParameter	(	HOM_EnumValue const &	param_type,
		std::string const &	name = `std::string()`,
		std::string const &	label = `std::string()`,
		MenuItemParms const &	menu_items = `MenuItemParms()`,
		bool	menu_as_button_strip = `false`,
		hboost::any	default_value = `hboost::any()`,
		int	num_components = `1`,
		double	min_limit = `0`,
		double	max_limit = `1`,
		bool	align = `false`,
		bool	toolbox = `true`
	)

pure virtual

virtual void HOM_ViewerStateTemplate::bindPlaybackChangeEvent ( )

pure virtual

virtual void HOM_ViewerStateTemplate::bindSceneGraphSelector	(	std::string const &	prompt,
		bool	allow_drag = `true`,
		bool	quick_select = `true`,
		bool	auto_start = `true`,
		bool	toolbox = `true`,
		bool	use_existing_selection = `true`,
		bool	allow_multisel = `true`,
		bool	consume_selection = `false`,
		HOM_EnumValue const &	secure_selection = `HOM_secureSelectionOption::Off`,
		std::vector< std::string > const &	prior_selection_paths = `std::vector< std::string >()`,
		HOM_EnumValue const &	prim_mask = `HOM_scenePrimMask::ViewerSetting`,
		std::string const &	path_prefix_mask = `std::string()`,
		std::string const &	prim_kind = `std::string()`,
		std::string const &	hotkey = `std::string()`,
		std::string const &	name = `std::string()`
	)

pure virtual

virtual void HOM_ViewerStateTemplate::bindSelector	(	std::string const &	name,
		std::string const &	selector_type,
		std::string const &	prompt,
		std::vector< HOM_EnumValue * >	primitive_types = `std::vector< HOM_EnumValue * >()`,
		std::string const &	group_parm_name = `std::string()`,
		int	input_index = `0`,
		bool	input_required = `true`,
		bool	allow_dragging = `true`
	)

pure virtual

virtual void HOM_ViewerStateTemplate::bindSupportsMoveTool ( bool supports_movetool )

pure virtual

virtual void HOM_ViewerStateTemplate::bindSupportsSelectionChange ( bool supports_change )

pure virtual

virtual std::string HOM_ViewerStateTemplate::categoryName ( ) const

pure virtual

virtual std::vector<HOM_NodeTypeCategory*> HOM_ViewerStateTemplate::contexts ( ) const

pure virtual

virtual std::string HOM_ViewerStateTemplate::typeName ( ) const

pure virtual

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

HOM/HOM_ViewerStateTemplate.h

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation