HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
HOM_HDADefinition Class Referenceabstract

#include <HOM_HDADefinition.h>

Public Member Functions

 HOM_HDADefinition ()
 
 HOM_HDADefinition (const HOM_HDADefinition &)
 
virtual ~HOM_HDADefinition ()
 
virtual bool operator== (HOM_PtrOrNull< HOM_HDADefinition > hda_definition)=0
 
virtual bool operator!= (HOM_PtrOrNull< HOM_HDADefinition > hda_definition)=0
 
virtual int __hash__ ()=0
 
virtual std::string __repr__ ()=0
 
virtual HOM_NodeType * nodeType ()=0
 
virtual HOM_NodeTypeCategory & nodeTypeCategory ()=0
 
virtual std::string nodeTypeName ()=0
 
virtual std::string libraryFilePath ()=0
 
virtual std::string embeddedHelp ()=0
 
virtual bool isInstalled ()=0
 
bool installed ()
 
virtual bool isCurrent ()=0
 
bool current ()
 
virtual bool isPreferred ()=0
 
bool preferred ()
 
virtual void setIsPreferred (bool preferred)=0
 
void setPreferred (bool preferred)
 
virtual void enableCreateBackups (bool create_backups)=0
 
virtual bool isCreateBackupsEnabled ()=0
 
virtual std::map< std::string,
HOM_ElemPtr< HOM_HDASection > > 		sections ()=0
 
virtual bool hasSection (const char *name)=0
 
virtual HOM_HDASection * addSection (const char *name)=0
 
virtual HOM_HDASection * addSection (const char *name, const std::string &contents, HOM_EnumValue &compression_type=HOM_compressionType::NoCompression)=0
 
virtual HOM_HDASection * addSection (const char *name, const HOM_BinaryString &contents, HOM_EnumValue &compression_type=HOM_compressionType::NoCompression)=0
 
virtual void removeSection (const char *name)=0
 
virtual std::string description ()=0
 
virtual void setDescription (const char *label)=0
 
virtual std::string icon ()=0
 
virtual void setIcon (const char *icon)=0
 
virtual int minNumInputs ()=0
 
virtual void setMinNumInputs (int min_num_inputs)=0
 
virtual int maxNumInputs ()=0
 
virtual void setMaxNumInputs (int max_num_inputs)=0
 
virtual int maxNumOutputs ()=0
 
virtual void setMaxNumOutputs (int max_num_outputs)=0
 
virtual std::string extraInfo ()=0
 
virtual void setExtraInfo (const char *extra_info)=0
 
virtual std::string extraInfoValue (const char *key)=0
 
virtual std::string userInfo ()=0
 
virtual void setUserInfo (const char *extra_info)=0
 
virtual bool hideDefaultParameters ()=0
 
virtual std::string representativeNodePath ()=0
 
virtual std::string comment ()=0
 
virtual void setComment (const char *comment)=0
 
virtual std::string version ()=0
 
virtual void setVersion (const char *version)=0
 
virtual int modificationTime ()=0
 
virtual void setModificationTime (int time=-1)=0
 
virtual HOM_HDAOptions * options ()=0
 
virtual void setOptions (HOM_HDAOptions &options)=0
 
virtual void updateFromNode (HOM_Node &node)=0
 
virtual void save (const std::string &file_name, HOM_Node *template_node=NULL, HOM_HDAOptions *options=NULL, bool black_box=false, bool create_backup=true)=0
 
virtual void copyToHDAFile (const std::string &file_name, const char *new_name=NULL, const char *new_menu_name=NULL)=0
 
virtual void destroy ()=0
 
virtual HOM_ParmTemplateGroup * parmTemplateGroup ()=0
 
virtual void setParmTemplateGroup (HOM_ParmTemplateGroup &parm_template_group, bool rename_conflicting_parms=false, bool create_backup=true)=0
 
virtual void setExtraFileOption (const char *name, HOM_UTOptionAny value, HOM_EnumValue &type_hint=HOM_fieldType::NoSuchField)=0
 
virtual void removeExtraFileOption (const char *name)=0
 
virtual void compileCodeSection (const char *source_section, const char *destination_section)=0
 
virtual void getRawExtraFileOptions (UT_Options &options)=0
 
virtual std::map< std::string,
HOM_ElemPtr< HOM_Tool > > 		tools ()=0
 

Detailed Description

Definition at line 30 of file HOM_HDADefinition.h.

Constructor & Destructor Documentation

HOM_HDADefinition::HOM_HDADefinition ( )
inline

Definition at line 33 of file HOM_HDADefinition.h.

HOM_HDADefinition::HOM_HDADefinition ( const HOM_HDADefinition &  )
inline

Definition at line 35 of file HOM_HDADefinition.h.

virtual HOM_HDADefinition::~HOM_HDADefinition ( )
inlinevirtual

Definition at line 37 of file HOM_HDADefinition.h.

Member Function Documentation

virtual int HOM_HDADefinition::__hash__ ( )
pure virtual
virtual std::string HOM_HDADefinition::__repr__ ( )
pure virtual
virtual HOM_HDASection* HOM_HDADefinition::addSection ( const char *  name)
pure virtual
virtual HOM_HDASection* HOM_HDADefinition::addSection ( const char *  name,
const std::string &  contents,
HOM_EnumValue &  compression_type = HOM_compressionType::NoCompression 
)
pure virtual
virtual HOM_HDASection* HOM_HDADefinition::addSection ( const char *  name,
const HOM_BinaryString &  contents,
HOM_EnumValue &  compression_type = HOM_compressionType::NoCompression 
)
pure virtual
virtual std::string HOM_HDADefinition::comment ( )
pure virtual
virtual void HOM_HDADefinition::compileCodeSection ( const char *  source_section,
const char *  destination_section 
)
pure virtual
virtual void HOM_HDADefinition::copyToHDAFile ( const std::string &  file_name,
const char *  new_name = NULL,
const char *  new_menu_name = NULL 
)
pure virtual
bool HOM_HDADefinition::current ( )
inline

Definition at line 63 of file HOM_HDADefinition.h.

virtual std::string HOM_HDADefinition::description ( )
pure virtual
virtual void HOM_HDADefinition::destroy ( )
pure virtual
virtual std::string HOM_HDADefinition::embeddedHelp ( )
pure virtual
virtual void HOM_HDADefinition::enableCreateBackups ( bool  create_backups)
pure virtual
virtual std::string HOM_HDADefinition::extraInfo ( )
pure virtual
virtual std::string HOM_HDADefinition::extraInfoValue ( const char *  key)
pure virtual
virtual void HOM_HDADefinition::getRawExtraFileOptions ( UT_Options &  options)
pure virtual
virtual bool HOM_HDADefinition::hasSection ( const char *  name)
pure virtual
virtual bool HOM_HDADefinition::hideDefaultParameters ( )
pure virtual
virtual std::string HOM_HDADefinition::icon ( )
pure virtual
bool HOM_HDADefinition::installed ( )
inline

Definition at line 58 of file HOM_HDADefinition.h.

virtual bool HOM_HDADefinition::isCreateBackupsEnabled ( )
pure virtual
virtual bool HOM_HDADefinition::isCurrent ( )
pure virtual
virtual bool HOM_HDADefinition::isInstalled ( )
pure virtual
virtual bool HOM_HDADefinition::isPreferred ( )
pure virtual
virtual std::string HOM_HDADefinition::libraryFilePath ( )
pure virtual
virtual int HOM_HDADefinition::maxNumInputs ( )
pure virtual
virtual int HOM_HDADefinition::maxNumOutputs ( )
pure virtual
virtual int HOM_HDADefinition::minNumInputs ( )
pure virtual
virtual int HOM_HDADefinition::modificationTime ( )
pure virtual
virtual HOM_NodeType* HOM_HDADefinition::nodeType ( )
pure virtual
virtual HOM_NodeTypeCategory& HOM_HDADefinition::nodeTypeCategory ( )
pure virtual
virtual std::string HOM_HDADefinition::nodeTypeName ( )
pure virtual
virtual bool HOM_HDADefinition::operator!= ( HOM_PtrOrNull< HOM_HDADefinition >  hda_definition)
pure virtual
virtual bool HOM_HDADefinition::operator== ( HOM_PtrOrNull< HOM_HDADefinition >  hda_definition)
pure virtual
virtual HOM_HDAOptions* HOM_HDADefinition::options ( )
pure virtual
virtual HOM_ParmTemplateGroup* HOM_HDADefinition::parmTemplateGroup ( )
pure virtual
bool HOM_HDADefinition::preferred ( )
inline

Definition at line 68 of file HOM_HDADefinition.h.

virtual void HOM_HDADefinition::removeExtraFileOption ( const char *  name)
pure virtual
virtual void HOM_HDADefinition::removeSection ( const char *  name)
pure virtual
virtual std::string HOM_HDADefinition::representativeNodePath ( )
pure virtual
virtual void HOM_HDADefinition::save ( const std::string &  file_name,
HOM_Node *  template_node = NULL,
HOM_HDAOptions *  options = NULL,
bool  black_box = false,
bool  create_backup = true 
)
pure virtual
virtual std::map<std::string, HOM_ElemPtr<HOM_HDASection> > HOM_HDADefinition::sections ( )
pure virtual
virtual void HOM_HDADefinition::setComment ( const char *  comment)
pure virtual
virtual void HOM_HDADefinition::setDescription ( const char *  label)
pure virtual
virtual void HOM_HDADefinition::setExtraFileOption ( const char *  name,
HOM_UTOptionAny  value,
HOM_EnumValue &  type_hint = HOM_fieldType::NoSuchField 
)
pure virtual
virtual void HOM_HDADefinition::setExtraInfo ( const char *  extra_info)
pure virtual
virtual void HOM_HDADefinition::setIcon ( const char *  icon)
pure virtual
virtual void HOM_HDADefinition::setIsPreferred ( bool  preferred)
pure virtual
virtual void HOM_HDADefinition::setMaxNumInputs ( int  max_num_inputs)
pure virtual
virtual void HOM_HDADefinition::setMaxNumOutputs ( int  max_num_outputs)
pure virtual
virtual void HOM_HDADefinition::setMinNumInputs ( int  min_num_inputs)
pure virtual
virtual void HOM_HDADefinition::setModificationTime ( int  time = -1)
pure virtual
virtual void HOM_HDADefinition::setOptions ( HOM_HDAOptions &  options)
pure virtual
virtual void HOM_HDADefinition::setParmTemplateGroup ( HOM_ParmTemplateGroup &  parm_template_group,
bool  rename_conflicting_parms = false,
bool  create_backup = true 
)
pure virtual
void HOM_HDADefinition::setPreferred ( bool  preferred)
inline

Definition at line 73 of file HOM_HDADefinition.h.

virtual void HOM_HDADefinition::setUserInfo ( const char *  extra_info)
pure virtual
virtual void HOM_HDADefinition::setVersion ( const char *  version)
pure virtual
virtual std::map<std::string, HOM_ElemPtr<HOM_Tool> > HOM_HDADefinition::tools ( )
pure virtual
virtual void HOM_HDADefinition::updateFromNode ( HOM_Node &  node)
pure virtual
virtual std::string HOM_HDADefinition::userInfo ( )
pure virtual
virtual std::string HOM_HDADefinition::version ( )
pure virtual
The documentation for this class was generated from the following file: