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

#include <HOM_ParmTuple.h>

Public Member Functions

 HOM_ParmTuple ()
 
 HOM_ParmTuple (const HOM_ParmTuple &parm_tuple)
 
virtual ~HOM_ParmTuple ()
 
virtual bool operator== (HOM_PtrOrNull< HOM_ParmTuple > parm_tuple)=0
 
virtual bool operator!= (HOM_PtrOrNull< HOM_ParmTuple > parm_tuple)=0
 
virtual int __hash__ ()=0
 
virtual std::string __repr__ ()=0
 
virtual HOM_Nodenode ()=0
 
virtual HOM_ParmTemplateparmTemplate ()=0
 
virtual std::string name ()=0
 
virtual std::string description ()=0
 
virtual void _set (const std::vector< double > &float_values)=0
 
virtual void setPending (const std::vector< double > &float_values)=0
 
virtual void _set (const std::vector< std::string > &string_values)=0
 
virtual void setPending (const std::vector< std::string > &string_values)=0
 
virtual void _set (const std::vector< HOM_Ramp * > &ramp_values)=0
 
virtual void setPending (const std::vector< HOM_Ramp * > &ramp_values)=0
 
virtual void revertToDefaults ()=0
 
virtual void revertToAndRestorePermanentDefaults ()=0
 
virtual bool isAtDefault (bool compare_temporary_defaults=true, bool compare_expressions=true)=0
 
virtual std::vector< double > evalAsFloats ()=0
 
virtual std::vector< double > evalAsFloatsAtFrame (double frame)=0
 
virtual std::vector< intevalAsInts ()=0
 
virtual std::vector< intevalAsIntsAtFrame (double frame)=0
 
virtual std::vector< std::stringevalAsStrings ()=0
 
virtual std::vector< std::stringevalAsStringsAtFrame (double frame)=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Ramp > > 
evalAsRamps ()=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Ramp > > 
evalAsRampsAtFrame (double frame)=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Geometry > > 
evalAsGeometries ()=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Geometry > > 
evalAsGeometriesAtFrame (double frame)=0
 
virtual void lock (const std::vector< bool > &bool_values)=0
 
virtual void setAutoscope (const std::vector< bool > &bool_values)=0
 
virtual bool isSpare ()=0
 
virtual bool isMultiParmInstance ()=0
 
virtual HOM_ParmparentMultiParm ()=0
 
virtual std::vector< intmultiParmInstanceIndices ()=0
 
virtual std::vector
< HOM_ElemPtr< HOM_ParmTuple > > 
multiParmInstances ()=0
 
virtual void deleteAllKeyframes ()=0
 
virtual HOM_Parm__getitem__ (int index)=0
 
virtual int __len__ ()=0
 
virtual HOM_NodecreateClip (HOM_Node &parent_node, const char *name, bool create_new, bool apply_immediately, bool current_value_only=false, bool create_locked=false, bool set_value_to_default=false)=0
 
virtual void appendClip (HOM_Node &chop_node, bool apply_immediately, bool current_value_only=false, bool create_locked=false, bool set_value_to_default=false)=0
 
virtual HOM_BinaryString _clipData (double start, double end, bool binary=true, bool use_blosc_compression=true, double sample_rate=0)=0
 
virtual void setClipData (HOM_BinaryString data, bool binary=true, bool blosc_compressed=true, double sample_rate=0, double start=1)=0
 
virtual void _saveClip (std::string file_name, double start, double end, double sample_rate=0)=0
 
virtual void loadClip (std::string file_name, double sample_rate=0, double start=1)=0
 
virtual void copyToParmClipboard ()=0
 
virtual void_asVoidPointer ()=0
 
virtual std::string asCode (bool brief=false, bool save_values=true, bool save_keyframes=true, bool save_keys_in_frames=false, bool save_flag_values=true, bool save_aliases=true, const char *function_name=NULL)=0
 
virtual int parmDataTypeEnumId ()=0
 
virtual std::string help ()=0
 
virtual std::string helpUrl ()=0
 
virtual bool isDisabled ()=0
 
virtual void disable (bool on)=0
 
virtual bool isHidden ()=0
 
virtual void hide (bool on)=0
 
virtual bool isConstrained ()=0
 

Detailed Description

Definition at line 26 of file HOM_ParmTuple.h.

Constructor & Destructor Documentation

HOM_ParmTuple::HOM_ParmTuple ( )
inline

Definition at line 29 of file HOM_ParmTuple.h.

HOM_ParmTuple::HOM_ParmTuple ( const HOM_ParmTuple parm_tuple)
inline

Definition at line 31 of file HOM_ParmTuple.h.

virtual HOM_ParmTuple::~HOM_ParmTuple ( )
inlinevirtual

Definition at line 33 of file HOM_ParmTuple.h.

Member Function Documentation

virtual HOM_Parm* HOM_ParmTuple::__getitem__ ( int  index)
pure virtual
virtual int HOM_ParmTuple::__hash__ ( )
pure virtual
virtual int HOM_ParmTuple::__len__ ( )
pure virtual
virtual std::string HOM_ParmTuple::__repr__ ( )
pure virtual
virtual void* HOM_ParmTuple::_asVoidPointer ( )
pure virtual
virtual HOM_BinaryString HOM_ParmTuple::_clipData ( double  start,
double  end,
bool  binary = true,
bool  use_blosc_compression = true,
double  sample_rate = 0 
)
pure virtual
virtual void HOM_ParmTuple::_saveClip ( std::string  file_name,
double  start,
double  end,
double  sample_rate = 0 
)
pure virtual
virtual void HOM_ParmTuple::_set ( const std::vector< double > &  float_values)
pure virtual
virtual void HOM_ParmTuple::_set ( const std::vector< std::string > &  string_values)
pure virtual
virtual void HOM_ParmTuple::_set ( const std::vector< HOM_Ramp * > &  ramp_values)
pure virtual
virtual void HOM_ParmTuple::appendClip ( HOM_Node chop_node,
bool  apply_immediately,
bool  current_value_only = false,
bool  create_locked = false,
bool  set_value_to_default = false 
)
pure virtual
virtual std::string HOM_ParmTuple::asCode ( bool  brief = false,
bool  save_values = true,
bool  save_keyframes = true,
bool  save_keys_in_frames = false,
bool  save_flag_values = true,
bool  save_aliases = true,
const char *  function_name = NULL 
)
pure virtual
virtual void HOM_ParmTuple::copyToParmClipboard ( )
pure virtual
virtual HOM_Node* HOM_ParmTuple::createClip ( HOM_Node parent_node,
const char *  name,
bool  create_new,
bool  apply_immediately,
bool  current_value_only = false,
bool  create_locked = false,
bool  set_value_to_default = false 
)
pure virtual
virtual void HOM_ParmTuple::deleteAllKeyframes ( )
pure virtual
virtual std::string HOM_ParmTuple::description ( )
pure virtual
virtual void HOM_ParmTuple::disable ( bool  on)
pure virtual
virtual std::vector<double> HOM_ParmTuple::evalAsFloats ( )
pure virtual
virtual std::vector<double> HOM_ParmTuple::evalAsFloatsAtFrame ( double  frame)
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_Geometry> > HOM_ParmTuple::evalAsGeometries ( )
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_Geometry> > HOM_ParmTuple::evalAsGeometriesAtFrame ( double  frame)
pure virtual
virtual std::vector<int> HOM_ParmTuple::evalAsInts ( )
pure virtual
virtual std::vector<int> HOM_ParmTuple::evalAsIntsAtFrame ( double  frame)
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_Ramp> > HOM_ParmTuple::evalAsRamps ( )
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_Ramp> > HOM_ParmTuple::evalAsRampsAtFrame ( double  frame)
pure virtual
virtual std::vector<std::string> HOM_ParmTuple::evalAsStrings ( )
pure virtual
virtual std::vector<std::string> HOM_ParmTuple::evalAsStringsAtFrame ( double  frame)
pure virtual
virtual std::string HOM_ParmTuple::help ( )
pure virtual
virtual std::string HOM_ParmTuple::helpUrl ( )
pure virtual
virtual void HOM_ParmTuple::hide ( bool  on)
pure virtual
virtual bool HOM_ParmTuple::isAtDefault ( bool  compare_temporary_defaults = true,
bool  compare_expressions = true 
)
pure virtual
virtual bool HOM_ParmTuple::isConstrained ( )
pure virtual
virtual bool HOM_ParmTuple::isDisabled ( )
pure virtual
virtual bool HOM_ParmTuple::isHidden ( )
pure virtual
virtual bool HOM_ParmTuple::isMultiParmInstance ( )
pure virtual
virtual bool HOM_ParmTuple::isSpare ( )
pure virtual
virtual void HOM_ParmTuple::loadClip ( std::string  file_name,
double  sample_rate = 0,
double  start = 1 
)
pure virtual
virtual void HOM_ParmTuple::lock ( const std::vector< bool > &  bool_values)
pure virtual
virtual std::vector<int> HOM_ParmTuple::multiParmInstanceIndices ( )
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_ParmTuple> > HOM_ParmTuple::multiParmInstances ( )
pure virtual
virtual std::string HOM_ParmTuple::name ( )
pure virtual
virtual HOM_Node* HOM_ParmTuple::node ( )
pure virtual
virtual bool HOM_ParmTuple::operator!= ( HOM_PtrOrNull< HOM_ParmTuple parm_tuple)
pure virtual
virtual bool HOM_ParmTuple::operator== ( HOM_PtrOrNull< HOM_ParmTuple parm_tuple)
pure virtual
virtual HOM_Parm* HOM_ParmTuple::parentMultiParm ( )
pure virtual
virtual int HOM_ParmTuple::parmDataTypeEnumId ( )
pure virtual
virtual HOM_ParmTemplate* HOM_ParmTuple::parmTemplate ( )
pure virtual
virtual void HOM_ParmTuple::revertToAndRestorePermanentDefaults ( )
pure virtual
virtual void HOM_ParmTuple::revertToDefaults ( )
pure virtual
virtual void HOM_ParmTuple::setAutoscope ( const std::vector< bool > &  bool_values)
pure virtual
virtual void HOM_ParmTuple::setClipData ( HOM_BinaryString  data,
bool  binary = true,
bool  blosc_compressed = true,
double  sample_rate = 0,
double  start = 1 
)
pure virtual
virtual void HOM_ParmTuple::setPending ( const std::vector< double > &  float_values)
pure virtual
virtual void HOM_ParmTuple::setPending ( const std::vector< std::string > &  string_values)
pure virtual
virtual void HOM_ParmTuple::setPending ( const std::vector< HOM_Ramp * > &  ramp_values)
pure virtual

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