HOM_Module Class Reference

#include <HOM_Module.h>

List of all members.

Public Member Functions
virtual	~HOM_Module ()
virtual std::vector< std::string >	_getArgumentAutoComplete (const char *method_name, const char *arguments)=0 throw (HOM_Error)
virtual void	setRelativeNodeForAutoComplete (OP_Node *node)=0
virtual HOM_ui &	ui ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual HOM_audio &	audio ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual bool	isUIAvailable ()=0 throw (HOM_Error)
virtual HOM_galleries &	galleries ()=0 throw (HOM_Error)
virtual HOM_hda &	hda ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual HOM_hipFile &	hipFile ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual HOM_playbar &	playbar ()=0 throw (HOM_Error)
virtual HOM_hmath &	hmath ()=0 throw (HOM_Error)
virtual HOM_dop &	dop ()=0 throw (HOM_Error)
virtual HOM_shelves &	shelves ()=0 throw (HOM_Error)
virtual void	exit (int exit_code=0, bool suppress_save_prompt=false)=0 throw (HOM_SystemExit, HOM_Error)
virtual bool	isExiting ()=0 throw (HOM_Error)
virtual std::string	applicationName ()=0 throw (HOM_Error)
virtual std::vector< int >	applicationVersion ()=0 throw (HOM_Error)
virtual std::string	applicationVersionString ()=0 throw (HOM_Error)
virtual std::string	applicationCompilationDate ()=0 throw (HOM_Error)
virtual HOM_EnumValue &	licenseCategory ()=0 throw (HOM_Error)
virtual bool	isApprentice ()=0 throw (HOM_Error)
virtual void	releaseLicense ()=0 throw (HOM_OperationFailed, HOM_Error)
virtual HOM_Node *	root ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual HOM_Node *	pwd ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual void	setPwd (HOM_Node &newpwd)=0 throw (HOM_ObjectWasDeleted, HOM_NotAvailable, HOM_Error)
virtual void	cd (const char *path)=0 throw (HOM_OperationFailed, HOM_NotAvailable, HOM_Error)
virtual HOM_DopNetNode *	currentDopNet ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual void	setCurrentDopNet (HOM_DopNetNode &dopnet)=0 throw (HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error)
virtual bool	simulationEnabled ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual void	setSimulationEnabled (bool enabled)=0 throw (HOM_NotAvailable, HOM_Error)
virtual HOM_Node *	node (const char *path)=0 throw (HOM_NotAvailable, HOM_Error)
virtual std::vector < HOM_ElemPtr< HOM_Node > >	selectedNodes (bool include_hidden=false)=0 throw (HOM_NotAvailable, HOM_Error)
virtual HOM_Parm *	parm (const char *path)=0 throw (HOM_NotAvailable, HOM_Error)
virtual HOM_ParmTuple *	parmTuple (const char *path)=0 throw (HOM_NotAvailable, HOM_Error)
virtual HOM_NodeType *	nodeType (HOM_NodeTypeCategory &category, const char *name)=0 throw (HOM_NotAvailable, HOM_Error)
virtual HOM_NodeTypeCategory &	objNodeTypeCategory ()=0
virtual HOM_NodeTypeCategory &	sopNodeTypeCategory ()=0
virtual HOM_NodeTypeCategory &	popNodeTypeCategory ()=0
virtual HOM_NodeTypeCategory &	dopNodeTypeCategory ()=0
virtual HOM_NodeTypeCategory &	cop2NodeTypeCategory ()=0
virtual HOM_NodeTypeCategory &	shopNodeTypeCategory ()=0
virtual HOM_NodeTypeCategory &	vopNodeTypeCategory ()=0
virtual HOM_NodeTypeCategory &	ropNodeTypeCategory ()=0
virtual HOM_NodeTypeCategory &	chopNodeTypeCategory ()=0
virtual HOM_NodeTypeCategory &	popNetNodeTypeCategory ()=0
virtual HOM_NodeTypeCategory &	cop2NetNodeTypeCategory ()=0
virtual HOM_NodeTypeCategory &	vopNetNodeTypeCategory ()=0
virtual HOM_NodeTypeCategory &	chopNetNodeTypeCategory ()=0
virtual HOM_NodeTypeCategory &	managerNodeTypeCategory ()=0
virtual HOM_NodeTypeCategory &	rootNodeTypeCategory ()=0
virtual std::map< std::string, HOM_NodeTypeCategory * >	nodeTypeCategories ()=0
virtual std::vector < HOM_ElemPtr< HOM_Node > >	copyNodesTo (const std::vector< HOM_Node * > &nodes, HOM_Node &destination_node)=0 throw (HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_TypeError, HOM_Error)
virtual std::vector < HOM_ElemPtr< HOM_Node > >	moveNodesTo (const std::vector< HOM_Node * > &nodes, HOM_Node &destination_node)=0 throw (HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_TypeError, HOM_Error)
virtual HOM_NodeBundle *	addNodeBundle (const char *name)=0 throw (HOM_OperationFailed, HOM_NotAvailable, HOM_TypeError, HOM_Error)
virtual std::vector < HOM_ElemPtr< HOM_NodeBundle > >	nodeBundles ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual std::vector < HOM_ElemPtr< HOM_NodeBundle > >	selectedNodeBundles ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual HOM_NodeBundle *	nodeBundle (const char *name)=0 throw (HOM_NotAvailable, HOM_TypeError, HOM_Error)
virtual float	getTimeWithoutAddingDependency ()=0
virtual float	time ()=0 throw (HOM_Error)
virtual void	setTime (float time)=0 throw (HOM_Error)
virtual double	frame ()=0 throw (HOM_Error)
virtual int	intFrame ()=0 throw (HOM_Error)
virtual void	setFrame (float frame)=0 throw (HOM_Error)
virtual float	fps ()=0 throw (HOM_Error)
virtual void	setFps (float fps)=0 throw (HOM_Error)
virtual float	timeToFrame (float time)=0 throw (HOM_Error)
virtual float	frameToTime (float frame)=0 throw (HOM_Error)
virtual float	bezier ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	constant ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	cubic ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	cycle (float start_frame, float end_frame)=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	cyclet (float start_time, float end_time)=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	ease ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	easein ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	easeinp (float ease_speed)=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	easeout ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	easeoutp (float ease_speed)=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	easep (float ease_bias)=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	linear ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	match ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	matchin ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	matchout ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	qlinear ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	quintic ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	repeat (float start_frame, float end_frame)=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	repeatt (float start_time, float end_time)=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	spline ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	vmatch ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	vmatchin ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual float	vmatchout ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual std::vector < HOM_ElemPtr< HOM_VexContext > >	vexContexts ()=0 throw (HOM_Error)
virtual HOM_VexContext *	vexContextForShaderType (HOM_EnumValue &shader_type)=0 throw (HOM_TypeError, HOM_Error)
virtual HOM_VexContext *	vexContextForNodeTypeCategory (HOM_NodeTypeCategory &node_type_category)=0 throw (HOM_TypeError, HOM_Error)
virtual std::string	hscriptCommandHelp (const char *command_name)=0 throw (HOM_Error)
virtual std::vector< std::string >	hscript (const char *command)=0 throw (HOM_Error)
virtual bool	almostEqual (double x, double y)=0 throw (HOM_Error)
virtual std::vector< std::pair < HOM_ElemPtr< HOM_Parm > , std::string > >	fileReferences (const char *project_dir_variable="HIP")=0 throw (HOM_TypeError, HOM_Error)
virtual std::string	findFile (const char *file_name)=0 throw (HOM_OperationFailed, HOM_Error)
virtual std::vector< std::string >	findFiles (const char *file_name)=0 throw (HOM_OperationFailed, HOM_Error)
virtual std::string	findDirectory (const char *directory_name)=0 throw (HOM_OperationFailed, HOM_Error)
virtual std::vector< std::string >	findDirectories (const char *directory_name)=0 throw (HOM_OperationFailed, HOM_Error)
virtual std::vector< std::string >	houdiniPath ()=0 throw (HOM_Error)
virtual std::string	homeHoudiniDirectory ()=0 throw (HOM_Error)
virtual std::string	readFile (const char *file_path)=0 throw (HOM_OperationFailed, HOM_Error)
virtual UI_Value *	getSessionModuleSourceForceUpdateValue ()=0
virtual void	forceUpdateFromSessionModuleSource ()=0
virtual void	forceSetSessionModuleSource (const char *source)=0 throw ()
virtual void	setSessionModuleSource (const char *source)=0 throw (HOM_OperationFailed, HOM_Error)
virtual void	appendSessionModuleSource (const char *source)=0 throw (HOM_OperationFailed, HOM_Error)
virtual std::string	sessionModuleSource ()=0 throw (HOM_Error)
virtual int	sessionModuleSourceChangeCount ()=0
virtual std::string	chsop (const char *path)=0 throw (HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error)
virtual boost::any	hscriptExpression (const char *expression)=0 throw (HOM_OperationFailed, HOM_Error)
virtual float	hscriptFloatExpression (const char *expression)=0 throw (HOM_OperationFailed, HOM_Error)
virtual std::string	hscriptStringExpression (const char *expression)=0 throw (HOM_OperationFailed, HOM_Error)
virtual std::vector< float >	hscriptVectorExpression (const char *expression)=0 throw (HOM_OperationFailed, HOM_Error)
virtual std::vector < std::vector< float > >	hscriptMatrixExpression (const char *expression)=0 throw (HOM_OperationFailed, HOM_Error)
virtual std::string	expandString (const char *str)=0 throw (HOM_OperationFailed, HOM_NotAvailable, HOM_Error)
virtual std::string	expandStringAtFrame (const char *str, float frame)=0 throw (HOM_OperationFailed, HOM_NotAvailable, HOM_Error)
virtual float	lvar (const char *name)=0 throw (HOM_NotAvailable, HOM_OperationFailed, HOM_Error)
virtual char *	getenv (const char *name, const char *default_value=NULL)=0 throw (HOM_TypeError, HOM_Error)
virtual void	putenv (const char *name, const char *value)=0 throw (HOM_TypeError, HOM_Error)
virtual void	unsetenv (const char *name)=0 throw (HOM_TypeError, HOM_Error)
virtual void	allowEnvironmentToOverwriteVariable (const char *name, bool onoff)=0 throw (HOM_TypeError, HOM_Error)
virtual void *	expressionGlobals ()=0 throw (HOM_Error)
virtual void	pushTime (float t)=0
virtual void	popTime ()=0
virtual bool	updateProgressAndCheckForInterrupt (int percentage=-1)=0 throw (HOM_Error)
virtual HOM_EnumValue &	updateModeSetting ()=0 throw (HOM_NotAvailable, HOM_Error)
virtual void	setUpdateMode (HOM_EnumValue &mode)=0 throw (HOM_NotAvailable, HOM_TypeError, HOM_Error)
virtual void	pushAccessPrivilege (const char *key)=0 throw (HOM_Error)
virtual void	popAccessPrivilege (const char *key)=0 throw (HOM_Error)
virtual std::string	currentPythonModuleKey ()=0 throw (HOM_Error)
virtual void	registerAccessPrivilegePyClient (void *opaque_python_object)=0 throw (HOM_Error)
virtual HOM_FloatParmTemplate *	newFloatParmTemplate (const char *name, const char *label, int num_components, const std::vector< float > &default_value, float min, float max, bool min_is_strict, bool max_is_strict, HOM_EnumValue &look, HOM_EnumValue &naming_scheme, const char *disable_when, bool is_hidden, bool join_with_next, const char *help, const std::map< std::string, std::string > &tags)=0 throw (HOM_OperationFailed, HOM_TypeError, HOM_Error)
virtual HOM_IntParmTemplate *	newIntParmTemplate (const char *name, const char *label, int num_components, const std::vector< int > &default_value, int min, int max, bool min_is_strict, bool max_is_strict, HOM_EnumValue &naming_scheme, const char *disable_when, bool is_hidden, bool join_with_next, const char *help, const std::map< std::string, std::string > &tags)=0 throw (HOM_OperationFailed, HOM_TypeError, HOM_Error)
virtual HOM_StringParmTemplate *	newStringParmTemplate (const char *name, const char *label, int num_components, const std::vector< std::string > &default_value, HOM_EnumValue &naming_scheme, HOM_EnumValue &string_type, const char *disable_when, bool is_hidden, bool join_with_next, const char *help, const std::map< std::string, std::string > &tags)=0 throw (HOM_OperationFailed, HOM_TypeError, HOM_Error)
virtual HOM_ToggleParmTemplate *	newToggleParmTemplate (const char *name, const char *label, bool default_value, const char *disable_when, bool is_hidden, bool join_with_next, const char *help, const std::map< std::string, std::string > &tags)=0 throw (HOM_OperationFailed, HOM_TypeError, HOM_Error)
virtual HOM_MenuParmTemplate *	newMenuParmTemplate (const char *name, const char *label, const std::vector< std::string > &menu_items, const std::vector< std::string > &menu_labels, bool default_index, const std::vector< std::string > &icon_names, const std::string &item_generator_script, const char *disable_when, bool is_hidden, bool join_with_next, const char *help, const std::map< std::string, std::string > &tags)=0 throw (HOM_OperationFailed, HOM_TypeError, HOM_Error)
virtual HOM_ButtonParmTemplate *	newButtonParmTemplate (const char *name, const char *label, const char *disable_when, bool is_hidden, bool join_with_next, const char *help, const std::map< std::string, std::string > &tags)=0 throw (HOM_OperationFailed, HOM_TypeError, HOM_Error)
virtual HOM_LabelParmTemplate *	newLabelParmTemplate (const char *name, const char *label, bool is_hidden, bool join_with_next, const char *help, const std::map< std::string, std::string > &tags)=0 throw (HOM_OperationFailed, HOM_TypeError, HOM_Error)
virtual HOM_SeparatorParmTemplate *	newSeparatorParmTemplate (const char *name, bool is_hidden, const std::map< std::string, std::string > &tags)=0 throw (HOM_OperationFailed, HOM_TypeError, HOM_Error)
virtual HOM_FolderSetParmTemplate *	newFolderSetParmTemplate (const char *name, const std::vector< std::string > &folder_names, HOM_EnumValue &folder_style, const std::map< std::string, std::string > &tags)=0 throw (HOM_OperationFailed, HOM_TypeError, HOM_Error)
virtual HOM_RampParmTemplate *	newRampParmTemplate (const char *name, const char *label, HOM_EnumValue &ramp_parm_type, int default_value, HOM_EnumValue *default_basis, bool show_controls, HOM_EnumValue *color_type, const char *disable_when, bool is_hidden, const char *help, const std::map< std::string, std::string > &tags)=0 throw (HOM_OperationFailed, HOM_TypeError, HOM_Error)
virtual HOM_MultiParmTemplate *	newMultiParmTemplate (const char *name, const char *label, int default_value, bool is_hidden, const char *help, const std::map< std::string, std::string > &tags)=0 throw (HOM_OperationFailed, HOM_TypeError, HOM_Error)
virtual HOM_Keyframe *	newKeyframe ()=0
virtual HOM_Keyframe *	newKeyframe (double value)=0
virtual HOM_Keyframe *	newKeyframe (double value, double time)=0
virtual HOM_Keyframe *	newKeyframe (const HOM_Keyframe &keyframe)=0
virtual HOM_StringKeyframe *	newStringKeyframe ()=0
virtual HOM_StringKeyframe *	newStringKeyframe (const std::string &value, HOM_EnumValue &language)=0
virtual HOM_StringKeyframe *	newStringKeyframe (const std::string &value, double time, HOM_EnumValue &language)=0
virtual HOM_StringKeyframe *	newStringKeyframe (const HOM_StringKeyframe &string_keyframe)=0
virtual HOM_HDAOptions *	newHDAOptions ()=0
virtual void	constructObject (void *pointer, const std::type_info &type)=0
virtual void	destructObject (void *pointer, const std::type_info &type)=0
virtual std::map< std::string, int >	objectCounts ()=0
Static Public Member Functions
static bool	isImplementationSet ()
Friends
class	HOMF_Module
HOM_API HOM_Module &	HOM () throw (HOM_Error)

---

Detailed Description

Examples:

HOM/SOP_HOMWave.C.

Definition at line 84 of file HOM_Module.h.

---

Constructor & Destructor Documentation

virtual HOM_Module::~HOM_Module

(

)

[inline, virtual]

Definition at line 87 of file HOM_Module.h.

---

Member Function Documentation

virtual std::vector<std::string> HOM_Module::_getArgumentAutoComplete	(	const char *	method_name,
		const char *	arguments
	)			throw (HOM_Error) [pure virtual]

virtual HOM_NodeBundle* HOM_Module::addNodeBundle

(

const char *

name

)

throw (HOM_OperationFailed, HOM_NotAvailable, HOM_TypeError, HOM_Error) [pure virtual]

virtual void HOM_Module::allowEnvironmentToOverwriteVariable	(	const char *	name,
		bool	onoff
	)			throw (HOM_TypeError, HOM_Error) [pure virtual]

virtual bool HOM_Module::almostEqual	(	double	x,
		double	y
	)			throw (HOM_Error) [pure virtual]

virtual void HOM_Module::appendSessionModuleSource

(

const char *

source

)

throw (HOM_OperationFailed, HOM_Error) [pure virtual]

virtual std::string HOM_Module::applicationCompilationDate

(

)

throw (HOM_Error) [pure virtual]

virtual std::string HOM_Module::applicationName

(

)

throw (HOM_Error) [pure virtual]

virtual std::vector<int> HOM_Module::applicationVersion

(

)

throw (HOM_Error) [pure virtual]

virtual std::string HOM_Module::applicationVersionString

(

)

throw (HOM_Error) [pure virtual]

virtual HOM_audio& HOM_Module::audio

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual float HOM_Module::bezier

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual void HOM_Module::cd

(

const char *

path

)

throw (HOM_OperationFailed, HOM_NotAvailable, HOM_Error) [pure virtual]

virtual HOM_NodeTypeCategory& HOM_Module::chopNetNodeTypeCategory

(

)

[pure virtual]

virtual HOM_NodeTypeCategory& HOM_Module::chopNodeTypeCategory

(

)

[pure virtual]

virtual std::string HOM_Module::chsop

(

const char *

path

)

throw (HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) [pure virtual]

virtual float HOM_Module::constant

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual void HOM_Module::constructObject	(	void *	pointer,
		const std::type_info &	type
	)			[pure virtual]

virtual HOM_NodeTypeCategory& HOM_Module::cop2NetNodeTypeCategory

(

)

[pure virtual]

virtual HOM_NodeTypeCategory& HOM_Module::cop2NodeTypeCategory

(

)

[pure virtual]

virtual std::vector<HOM_ElemPtr<HOM_Node> > HOM_Module::copyNodesTo	(	const std::vector< HOM_Node * > &	nodes,
		HOM_Node &	destination_node
	)			throw (HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_TypeError, HOM_Error) [pure virtual]

virtual float HOM_Module::cubic

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual HOM_DopNetNode* HOM_Module::currentDopNet

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual std::string HOM_Module::currentPythonModuleKey

(

)

throw (HOM_Error) [pure virtual]

virtual float HOM_Module::cycle	(	float	start_frame,
		float	end_frame
	)			throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual float HOM_Module::cyclet	(	float	start_time,
		float	end_time
	)			throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual void HOM_Module::destructObject	(	void *	pointer,
		const std::type_info &	type
	)			[pure virtual]

virtual HOM_dop& HOM_Module::dop

(

)

throw (HOM_Error) [pure virtual]

virtual HOM_NodeTypeCategory& HOM_Module::dopNodeTypeCategory

(

)

[pure virtual]

virtual float HOM_Module::ease

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual float HOM_Module::easein

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual float HOM_Module::easeinp

(

float

ease_speed

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual float HOM_Module::easeout

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual float HOM_Module::easeoutp

(

float

ease_speed

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual float HOM_Module::easep

(

float

ease_bias

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual void HOM_Module::exit	(	int	exit_code = 0,
		bool	suppress_save_prompt = false
	)			throw (HOM_SystemExit, HOM_Error) [pure virtual]

virtual std::string HOM_Module::expandString

(

const char *

str

)

throw (HOM_OperationFailed, HOM_NotAvailable, HOM_Error) [pure virtual]

virtual std::string HOM_Module::expandStringAtFrame	(	const char *	str,
		float	frame
	)			throw (HOM_OperationFailed, HOM_NotAvailable, HOM_Error) [pure virtual]

virtual void* HOM_Module::expressionGlobals

(

)

throw (HOM_Error) [pure virtual]

virtual std::vector<std::pair<HOM_ElemPtr<HOM_Parm>, std::string> > HOM_Module::fileReferences

(

const char *

project_dir_variable = "HIP"

)

throw (HOM_TypeError, HOM_Error) [pure virtual]

virtual std::vector<std::string> HOM_Module::findDirectories

(

const char *

directory_name

)

throw (HOM_OperationFailed, HOM_Error) [pure virtual]

virtual std::string HOM_Module::findDirectory

(

const char *

directory_name

)

throw (HOM_OperationFailed, HOM_Error) [pure virtual]

virtual std::string HOM_Module::findFile

(

const char *

file_name

)

throw (HOM_OperationFailed, HOM_Error) [pure virtual]

virtual std::vector<std::string> HOM_Module::findFiles

(

const char *

file_name

)

throw (HOM_OperationFailed, HOM_Error) [pure virtual]

virtual void HOM_Module::forceSetSessionModuleSource

(

const char *

source

)

throw () [pure virtual]

virtual void HOM_Module::forceUpdateFromSessionModuleSource

(

)

[pure virtual]

virtual float HOM_Module::fps

(

)

throw (HOM_Error) [pure virtual]

virtual double HOM_Module::frame

(

)

throw (HOM_Error) [pure virtual]

Examples:

HOM/SOP_HOMWave.C.

virtual float HOM_Module::frameToTime

(

float

frame

)

throw (HOM_Error) [pure virtual]

virtual HOM_galleries& HOM_Module::galleries

(

)

throw (HOM_Error) [pure virtual]

virtual char* HOM_Module::getenv	(	const char *	name,
		const char *	default_value = NULL
	)			throw (HOM_TypeError, HOM_Error) [pure virtual]

virtual UI_Value* HOM_Module::getSessionModuleSourceForceUpdateValue

(

)

[pure virtual]

virtual float HOM_Module::getTimeWithoutAddingDependency

(

)

[pure virtual]

virtual HOM_hda& HOM_Module::hda

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual HOM_hipFile& HOM_Module::hipFile

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual HOM_hmath& HOM_Module::hmath

(

)

throw (HOM_Error) [pure virtual]

virtual std::string HOM_Module::homeHoudiniDirectory

(

)

throw (HOM_Error) [pure virtual]

virtual std::vector<std::string> HOM_Module::houdiniPath

(

)

throw (HOM_Error) [pure virtual]

virtual std::vector<std::string> HOM_Module::hscript

(

const char *

command

)

throw (HOM_Error) [pure virtual]

virtual std::string HOM_Module::hscriptCommandHelp

(

const char *

command_name

)

throw (HOM_Error) [pure virtual]

virtual boost::any HOM_Module::hscriptExpression

(

const char *

expression

)

throw (HOM_OperationFailed, HOM_Error) [pure virtual]

virtual float HOM_Module::hscriptFloatExpression

(

const char *

expression

)

throw (HOM_OperationFailed, HOM_Error) [pure virtual]

virtual std::vector<std::vector<float> > HOM_Module::hscriptMatrixExpression

(

const char *

expression

)

throw (HOM_OperationFailed, HOM_Error) [pure virtual]

virtual std::string HOM_Module::hscriptStringExpression

(

const char *

expression

)

throw (HOM_OperationFailed, HOM_Error) [pure virtual]

virtual std::vector<float> HOM_Module::hscriptVectorExpression

(

const char *

expression

)

throw (HOM_OperationFailed, HOM_Error) [pure virtual]

virtual int HOM_Module::intFrame

(

)

throw (HOM_Error) [pure virtual]

virtual bool HOM_Module::isApprentice

(

)

throw (HOM_Error) [pure virtual]

virtual bool HOM_Module::isExiting

(

)

throw (HOM_Error) [pure virtual]

static bool HOM_Module::isImplementationSet

(

)

[inline, static]

Definition at line 327 of file HOM_Module.h.

virtual bool HOM_Module::isUIAvailable

(

)

throw (HOM_Error) [pure virtual]

virtual HOM_EnumValue& HOM_Module::licenseCategory

(

)

throw (HOM_Error) [pure virtual]

virtual float HOM_Module::linear

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual float HOM_Module::lvar

(

const char *

name

)

throw (HOM_NotAvailable, HOM_OperationFailed, HOM_Error) [pure virtual]

virtual HOM_NodeTypeCategory& HOM_Module::managerNodeTypeCategory

(

)

[pure virtual]

virtual float HOM_Module::match

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual float HOM_Module::matchin

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual float HOM_Module::matchout

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual std::vector<HOM_ElemPtr<HOM_Node> > HOM_Module::moveNodesTo	(	const std::vector< HOM_Node * > &	nodes,
		HOM_Node &	destination_node
	)			throw (HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_TypeError, HOM_Error) [pure virtual]

virtual HOM_ButtonParmTemplate* HOM_Module::newButtonParmTemplate	(	const char *	name,
		const char *	label,
		const char *	disable_when,
		bool	is_hidden,
		bool	join_with_next,
		const char *	help,
		const std::map< std::string, std::string > &	tags
	)			throw (HOM_OperationFailed, HOM_TypeError, HOM_Error) [pure virtual]

virtual HOM_FloatParmTemplate* HOM_Module::newFloatParmTemplate	(	const char *	name,
		const char *	label,
		int	num_components,
		const std::vector< float > &	default_value,
		float	min,
		float	max,
		bool	min_is_strict,
		bool	max_is_strict,
		HOM_EnumValue &	look,
		HOM_EnumValue &	naming_scheme,
		const char *	disable_when,
		bool	is_hidden,
		bool	join_with_next,
		const char *	help,
		const std::map< std::string, std::string > &	tags
	)			throw (HOM_OperationFailed, HOM_TypeError, HOM_Error) [pure virtual]

virtual HOM_FolderSetParmTemplate* HOM_Module::newFolderSetParmTemplate	(	const char *	name,
		const std::vector< std::string > &	folder_names,
		HOM_EnumValue &	folder_style,
		const std::map< std::string, std::string > &	tags
	)			throw (HOM_OperationFailed, HOM_TypeError, HOM_Error) [pure virtual]

virtual HOM_HDAOptions* HOM_Module::newHDAOptions

(

)

[pure virtual]

virtual HOM_IntParmTemplate* HOM_Module::newIntParmTemplate	(	const char *	name,
		const char *	label,
		int	num_components,
		const std::vector< int > &	default_value,
		int	min,
		int	max,
		bool	min_is_strict,
		bool	max_is_strict,
		HOM_EnumValue &	naming_scheme,
		const char *	disable_when,
		bool	is_hidden,
		bool	join_with_next,
		const char *	help,
		const std::map< std::string, std::string > &	tags
	)			throw (HOM_OperationFailed, HOM_TypeError, HOM_Error) [pure virtual]

virtual HOM_Keyframe* HOM_Module::newKeyframe

(

const HOM_Keyframe &

keyframe

)

[pure virtual]

virtual HOM_Keyframe* HOM_Module::newKeyframe	(	double	value,
		double	time
	)			[pure virtual]

virtual HOM_Keyframe* HOM_Module::newKeyframe

(

double

value

)

[pure virtual]

virtual HOM_Keyframe* HOM_Module::newKeyframe

(

)

[pure virtual]

virtual HOM_LabelParmTemplate* HOM_Module::newLabelParmTemplate	(	const char *	name,
		const char *	label,
		bool	is_hidden,
		bool	join_with_next,
		const char *	help,
		const std::map< std::string, std::string > &	tags
	)			throw (HOM_OperationFailed, HOM_TypeError, HOM_Error) [pure virtual]

virtual HOM_MenuParmTemplate* HOM_Module::newMenuParmTemplate	(	const char *	name,
		const char *	label,
		const std::vector< std::string > &	menu_items,
		const std::vector< std::string > &	menu_labels,
		bool	default_index,
		const std::vector< std::string > &	icon_names,
		const std::string &	item_generator_script,
		const char *	disable_when,
		bool	is_hidden,
		bool	join_with_next,
		const char *	help,
		const std::map< std::string, std::string > &	tags
	)			throw (HOM_OperationFailed, HOM_TypeError, HOM_Error) [pure virtual]

virtual HOM_MultiParmTemplate* HOM_Module::newMultiParmTemplate	(	const char *	name,
		const char *	label,
		int	default_value,
		bool	is_hidden,
		const char *	help,
		const std::map< std::string, std::string > &	tags
	)			throw (HOM_OperationFailed, HOM_TypeError, HOM_Error) [pure virtual]

virtual HOM_RampParmTemplate* HOM_Module::newRampParmTemplate	(	const char *	name,
		const char *	label,
		HOM_EnumValue &	ramp_parm_type,
		int	default_value,
		HOM_EnumValue *	default_basis,
		bool	show_controls,
		HOM_EnumValue *	color_type,
		const char *	disable_when,
		bool	is_hidden,
		const char *	help,
		const std::map< std::string, std::string > &	tags
	)			throw (HOM_OperationFailed, HOM_TypeError, HOM_Error) [pure virtual]

virtual HOM_SeparatorParmTemplate* HOM_Module::newSeparatorParmTemplate	(	const char *	name,
		bool	is_hidden,
		const std::map< std::string, std::string > &	tags
	)			throw (HOM_OperationFailed, HOM_TypeError, HOM_Error) [pure virtual]

virtual HOM_StringKeyframe* HOM_Module::newStringKeyframe

(

const HOM_StringKeyframe &

string_keyframe

)

[pure virtual]

virtual HOM_StringKeyframe* HOM_Module::newStringKeyframe	(	const std::string &	value,
		double	time,
		HOM_EnumValue &	language
	)			[pure virtual]

virtual HOM_StringKeyframe* HOM_Module::newStringKeyframe	(	const std::string &	value,
		HOM_EnumValue &	language
	)			[pure virtual]

virtual HOM_StringKeyframe* HOM_Module::newStringKeyframe

(

)

[pure virtual]

virtual HOM_StringParmTemplate* HOM_Module::newStringParmTemplate	(	const char *	name,
		const char *	label,
		int	num_components,
		const std::vector< std::string > &	default_value,
		HOM_EnumValue &	naming_scheme,
		HOM_EnumValue &	string_type,
		const char *	disable_when,
		bool	is_hidden,
		bool	join_with_next,
		const char *	help,
		const std::map< std::string, std::string > &	tags
	)			throw (HOM_OperationFailed, HOM_TypeError, HOM_Error) [pure virtual]

virtual HOM_ToggleParmTemplate* HOM_Module::newToggleParmTemplate	(	const char *	name,
		const char *	label,
		bool	default_value,
		const char *	disable_when,
		bool	is_hidden,
		bool	join_with_next,
		const char *	help,
		const std::map< std::string, std::string > &	tags
	)			throw (HOM_OperationFailed, HOM_TypeError, HOM_Error) [pure virtual]

virtual HOM_Node* HOM_Module::node

(

const char *

path

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual HOM_NodeBundle* HOM_Module::nodeBundle

(

const char *

name

)

throw (HOM_NotAvailable, HOM_TypeError, HOM_Error) [pure virtual]

virtual std::vector<HOM_ElemPtr<HOM_NodeBundle> > HOM_Module::nodeBundles

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual HOM_NodeType* HOM_Module::nodeType	(	HOM_NodeTypeCategory &	category,
		const char *	name
	)			throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual std::map<std::string, HOM_NodeTypeCategory *> HOM_Module::nodeTypeCategories

(

)

[pure virtual]

virtual std::map<std::string, int> HOM_Module::objectCounts

(

)

[pure virtual]

virtual HOM_NodeTypeCategory& HOM_Module::objNodeTypeCategory

(

)

[pure virtual]

virtual HOM_Parm* HOM_Module::parm

(

const char *

path

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual HOM_ParmTuple* HOM_Module::parmTuple

(

const char *

path

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual HOM_playbar& HOM_Module::playbar

(

)

throw (HOM_Error) [pure virtual]

virtual void HOM_Module::popAccessPrivilege

(

const char *

key

)

throw (HOM_Error) [pure virtual]

virtual HOM_NodeTypeCategory& HOM_Module::popNetNodeTypeCategory

(

)

[pure virtual]

virtual HOM_NodeTypeCategory& HOM_Module::popNodeTypeCategory

(

)

[pure virtual]

virtual void HOM_Module::popTime

(

)

[pure virtual]

virtual void HOM_Module::pushAccessPrivilege

(

const char *

key

)

throw (HOM_Error) [pure virtual]

virtual void HOM_Module::pushTime

(

float

t

)

[pure virtual]

virtual void HOM_Module::putenv	(	const char *	name,
		const char *	value
	)			throw (HOM_TypeError, HOM_Error) [pure virtual]

virtual HOM_Node* HOM_Module::pwd

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

Examples:

HOM/SOP_HOMWave.C.

virtual float HOM_Module::qlinear

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual float HOM_Module::quintic

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual std::string HOM_Module::readFile

(

const char *

file_path

)

throw (HOM_OperationFailed, HOM_Error) [pure virtual]

virtual void HOM_Module::registerAccessPrivilegePyClient

(

void *

opaque_python_object

)

throw (HOM_Error) [pure virtual]

virtual void HOM_Module::releaseLicense

(

)

throw (HOM_OperationFailed, HOM_Error) [pure virtual]

virtual float HOM_Module::repeat	(	float	start_frame,
		float	end_frame
	)			throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual float HOM_Module::repeatt	(	float	start_time,
		float	end_time
	)			throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual HOM_Node* HOM_Module::root

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual HOM_NodeTypeCategory& HOM_Module::rootNodeTypeCategory

(

)

[pure virtual]

virtual HOM_NodeTypeCategory& HOM_Module::ropNodeTypeCategory

(

)

[pure virtual]

virtual std::vector<HOM_ElemPtr<HOM_NodeBundle> > HOM_Module::selectedNodeBundles

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual std::vector<HOM_ElemPtr<HOM_Node> > HOM_Module::selectedNodes

(

bool

include_hidden = false

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual std::string HOM_Module::sessionModuleSource

(

)

throw (HOM_Error) [pure virtual]

virtual int HOM_Module::sessionModuleSourceChangeCount

(

)

[pure virtual]

virtual void HOM_Module::setCurrentDopNet

(

HOM_DopNetNode &

dopnet

)

throw (HOM_NotAvailable, HOM_ObjectWasDeleted, HOM_Error) [pure virtual]

virtual void HOM_Module::setFps

(

float

fps

)

throw (HOM_Error) [pure virtual]

virtual void HOM_Module::setFrame

(

float

frame

)

throw (HOM_Error) [pure virtual]

virtual void HOM_Module::setPwd

(

HOM_Node &

newpwd

)

throw (HOM_ObjectWasDeleted, HOM_NotAvailable, HOM_Error) [pure virtual]

virtual void HOM_Module::setRelativeNodeForAutoComplete

(

OP_Node *

node

)

[pure virtual]

virtual void HOM_Module::setSessionModuleSource

(

const char *

source

)

throw (HOM_OperationFailed, HOM_Error) [pure virtual]

virtual void HOM_Module::setSimulationEnabled

(

bool

enabled

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual void HOM_Module::setTime

(

float

time

)

throw (HOM_Error) [pure virtual]

virtual void HOM_Module::setUpdateMode

(

HOM_EnumValue &

mode

)

throw (HOM_NotAvailable, HOM_TypeError, HOM_Error) [pure virtual]

virtual HOM_shelves& HOM_Module::shelves

(

)

throw (HOM_Error) [pure virtual]

virtual HOM_NodeTypeCategory& HOM_Module::shopNodeTypeCategory

(

)

[pure virtual]

virtual bool HOM_Module::simulationEnabled

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual HOM_NodeTypeCategory& HOM_Module::sopNodeTypeCategory

(

)

[pure virtual]

virtual float HOM_Module::spline

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual float HOM_Module::time

(

)

throw (HOM_Error) [pure virtual]

virtual float HOM_Module::timeToFrame

(

float

time

)

throw (HOM_Error) [pure virtual]

virtual HOM_ui& HOM_Module::ui

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual void HOM_Module::unsetenv

(

const char *

name

)

throw (HOM_TypeError, HOM_Error) [pure virtual]

virtual HOM_EnumValue& HOM_Module::updateModeSetting

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual bool HOM_Module::updateProgressAndCheckForInterrupt

(

int

percentage = -1

)

throw (HOM_Error) [pure virtual]

virtual HOM_VexContext* HOM_Module::vexContextForNodeTypeCategory

(

HOM_NodeTypeCategory &

node_type_category

)

throw (HOM_TypeError, HOM_Error) [pure virtual]

virtual HOM_VexContext* HOM_Module::vexContextForShaderType

(

HOM_EnumValue &

shader_type

)

throw (HOM_TypeError, HOM_Error) [pure virtual]

virtual std::vector<HOM_ElemPtr<HOM_VexContext> > HOM_Module::vexContexts

(

)

throw (HOM_Error) [pure virtual]

virtual float HOM_Module::vmatch

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual float HOM_Module::vmatchin

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual float HOM_Module::vmatchout

(

)

throw (HOM_NotAvailable, HOM_Error) [pure virtual]

virtual HOM_NodeTypeCategory& HOM_Module::vopNetNodeTypeCategory

(

)

[pure virtual]

virtual HOM_NodeTypeCategory& HOM_Module::vopNodeTypeCategory

(

)

[pure virtual]

---

Friends And Related Function Documentation

HOM_API HOM_Module& HOM

(

)

throw (HOM_Error) [friend]

friend class HOMF_Module [friend]

Definition at line 563 of file HOM_Module.h.

---

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

• HOM/HOM_Module.h