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

#include <HOM_Parm.h>

Public Member Functions

 HOM_Parm ()
 
 HOM_Parm (const HOM_Parm &parm)
 
virtual ~HOM_Parm ()
 
virtual bool operator== (HOM_PtrOrNull< HOM_Parm > parm)=0
 
virtual bool operator!= (HOM_PtrOrNull< HOM_Parm > parm)=0
 
virtual bool operator< (HOM_Parm *parm)=0
 
virtual int __hash__ ()=0
 
virtual std::string __repr__ ()=0
 
virtual HOM_Node * node ()=0
 
virtual HOM_ParmTuple * tuple ()=0
 
virtual HOM_ParmTemplate * parmTemplate ()=0
 
virtual std::string name ()=0
 
virtual std::string path ()=0
 
virtual std::string description ()=0
 
virtual int componentIndex ()=0
 
virtual std::vector< std::string > menuContents ()=0
 
virtual std::vector< std::string > menuLabels ()=0
 
virtual std::vector< std::string > menuItems ()=0
 
virtual bool isDynamicMenu ()=0
 
virtual void pressButton (std::map< std::string, hboost::any > const &arguments=std::map< std::string, hboost::any >())=0
 
virtual std::string referenceExpression (HOM_Parm &to_base_parm, HOM_EnumValue *language=nullptr, bool follow_parm_reference=true)=0
 
virtual void _set (double float_value)=0
 
virtual void _setPending (double float_value)=0
 
virtual void _set (int int_value)=0
 
virtual void _setPending (int int_value)=0
 
virtual void _set (const char *string_value)=0
 
virtual void _setPending (const char *string_value)=0
 
virtual void _set (HOM_Geometry *geo)=0
 
virtual void _setPending (HOM_Geometry *geo)=0
 
virtual void _set (const std::map< std::string, std::string > &map)=0
 
virtual void _setPending (const std::map< std::string, std::string > &map)=0
 
virtual void _set (HOM_Ramp *ramp_value)=0
 
virtual void _setPending (HOM_Ramp *ramp_value)=0
 
virtual void _set (HOM_Parm &parm, HOM_EnumValue *language=nullptr, bool follow_parm_reference=true)=0
 
virtual void _setNone ()=0
 
virtual void _setNonePending ()=0
 
virtual void setFromParm (HOM_Parm &src)=0
 
virtual void setFromParmDefaults (HOM_Parm &src)=0
 
virtual void revertToDefaults ()=0
 
virtual void revertToAndRestorePermanentDefaults ()=0
 
virtual void revertToRampDefaults ()=0
 
virtual bool hasTemporaryDefaults ()=0
 
virtual bool isAtDefault (bool compare_temporary_defaults=true, bool compare_expressions=true)=0
 
virtual bool isAtRampDefault ()=0
 
virtual void setExpression (const char *expression, HOM_EnumValue *language=NULL, bool replace_expression=true)=0
 
virtual std::string expression ()=0
 
virtual HOM_EnumValue * expressionLanguage ()=0
 
virtual std::string rawValue ()=0
 
virtual bool isShowingExpression ()=0
 
virtual void showExpression (bool value)=0
 
virtual void setKeyframe (HOM_BaseKeyframe &keyframe)=0
 
virtual void setKeyframes (const std::vector< HOM_BaseKeyframe * > &keyframes)=0
 
virtual std::vector
< HOM_ElemPtr
< HOM_BaseKeyframe > > 		keyframes ()=0
 
virtual std::vector
< HOM_ElemPtr
< HOM_BaseKeyframe > > 		keyframesInRange (double start_frame, double end_frame)=0
 
virtual std::vector
< HOM_ElemPtr
< HOM_BaseKeyframe > > 		keyframesBefore (double frame)=0
 
virtual std::vector
< HOM_ElemPtr
< HOM_BaseKeyframe > > 		keyframesAfter (double frame)=0
 
virtual double evalAsFloat ()=0
 
virtual double evalAsFloatAtFrame (double frame)=0
 
virtual int evalAsInt ()=0
 
virtual int evalAsIntAtFrame (double frame)=0
 
virtual std::string evalAsString ()=0
 
virtual std::string evalAsStringAtFrame (double frame)=0
 
virtual HOM_Geometry * evalAsGeometry ()=0
 
virtual HOM_Geometry * evalAsGeometryAtFrame (double frame)=0
 
virtual std::map< std::string,
std::string > 		evalAsJSONMap ()=0
 
virtual std::map< std::string,
std::string > 		evalAsJSONMapAtFrame (double frame)=0
 
virtual HOM_Ramp * evalAsRamp ()=0
 
virtual HOM_Ramp * evalAsRampAtFrame (double frame)=0
 
virtual HOM_Node * evalAsNode ()=0
 
virtual HOM_Node * evalAsNodeAtFrame (double frame)=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Node > > 		evalAsNodes ()=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Node > > 		evalAsNodesAtFrame (double frame)=0
 
virtual std::string evalAsNodePath ()=0
 
virtual std::string evalAsNodePathAtFrame (double frame)=0
 
virtual std::vector< std::string > evalAsNodePaths ()=0
 
virtual std::vector< std::string > evalAsNodePathsAtFrame (double frame)=0
 
virtual std::string unexpandedString ()=0
 
virtual void deleteKeyframeAtFrame (double frame)=0
 
virtual void deleteAllKeyframes ()=0
 
virtual HOM_Parm * getReferencedParm ()=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Parm > > 		parmsReferencingThis ()=0
 
virtual bool isLocked ()=0
 
virtual void lock (bool on)=0
 
virtual bool isAutoscoped ()=0
 
virtual void setAutoscope (bool on)=0
 
virtual bool isScoped ()=0
 
virtual void setScope (bool on)=0
 
virtual bool isAutoSelected ()=0
 
virtual void setAutoSelect (bool on)=0
 
virtual bool isSelected ()=0
 
virtual void setSelect (bool on)=0
 
virtual std::string alias ()=0
 
virtual void setAlias (const char *alias_name)=0
 
virtual bool isSpare ()=0
 
virtual bool isTimeDependent ()=0
 
virtual bool isMultiParmInstance ()=0
 
virtual bool isMultiParmParent ()=0
 
virtual HOM_Parm * parentMultiParm ()=0
 
virtual std::vector< int > multiParmInstanceIndices ()=0
 
virtual int multiParmInstancesPerItem ()=0
 
virtual int multiParmInstancesCount ()=0
 
virtual int multiParmStartOffset ()=0
 
virtual std::vector
< HOM_ElemPtr< HOM_Parm > > 		multiParmInstances ()=0
 
virtual void insertMultiParmInstance (int inst_index)=0
 
virtual void removeMultiParmInstance (int inst_index)=0
 
virtual void moveMultiParmInstances (const std::vector< int > &moves)=0
 
virtual void moveUpMultiParmInstance (int inst_index)=0
 
virtual void moveDownMultiParmInstance (int inst_index)=0
 
virtual std::vector< std::string > containingFolders ()=0
 
virtual std::vector< int > containingFolderIndices ()=0
 
virtual std::vector
< HOM_ElemPtr< HOM_ParmTuple > > 		containingFolderSetParmTuples ()=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 int dataParmTypeEnumId ()=0
 
virtual HOM_Node * 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)=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=HOM_MIN_NEGATIVE_DOUBLE)=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=HOM_MIN_NEGATIVE_DOUBLE)=0
 
virtual HOM_Track * overrideTrack ()=0
 
virtual bool isOverrideTrackActive ()=0
 
virtual void copyToParmClipboard ()=0
 
virtual bool isDisabled ()=0
 
virtual void disable (bool on)=0
 
virtual bool isHidden ()=0
 
virtual void hide (bool on)=0
 
virtual bool isVisible ()=0
 
virtual bool isConstrained ()=0
 
virtual bool isPending ()=0
 
virtual HOM_EnumValue & keyframeExtrapolation (bool before)=0
 
virtual void setKeyframeExtrapolation (bool before, HOM_EnumValue &e)=0
 
virtual void keyframesRefit (bool refit, double refit_tol, bool refit_preserve_extrema, bool refit_bezier, bool resample, double resample_rate, double resample_tol, bool range, double range_start, double range_end, HOM_EnumValue &bake_chop, const char *expression="", bool refit_smooth=false)=0
 
virtual HOM_Color * uiBackgroundColor ()=0
 
virtual void _moveKeyframes (const std::vector< int > &keyframe_ids, const std::vector< double > &time_offsets, const std::vector< double > &value_offsets)=0
 
virtual void _deleteKeyframes (const std::vector< int > &keyframe_ids)=0
 
virtual void _moveAllKeyframes (double time_offset, double value_offset)=0
 

Detailed Description

Definition at line 31 of file HOM_Parm.h.

Constructor & Destructor Documentation

HOM_Parm::HOM_Parm ( )
inline

Definition at line 34 of file HOM_Parm.h.

HOM_Parm::HOM_Parm ( const HOM_Parm &  parm)
inline

Definition at line 36 of file HOM_Parm.h.

virtual HOM_Parm::~HOM_Parm ( )
inlinevirtual

Definition at line 38 of file HOM_Parm.h.

Member Function Documentation

virtual int HOM_Parm::__hash__ ( )
pure virtual
virtual std::string HOM_Parm::__repr__ ( )
pure virtual
virtual HOM_BinaryString HOM_Parm::_clipData ( double  start,
double  end,
bool  binary = true,
bool  use_blosc_compression = true,
double  sample_rate = 0 
)
pure virtual
virtual void HOM_Parm::_deleteKeyframes ( const std::vector< int > &  keyframe_ids)
pure virtual
virtual void HOM_Parm::_loadClip ( std::string  file_name,
double  sample_rate = 0,
double  start = HOM_MIN_NEGATIVE_DOUBLE 
)
pure virtual
virtual void HOM_Parm::_moveAllKeyframes ( double  time_offset,
double  value_offset 
)
pure virtual
virtual void HOM_Parm::_moveKeyframes ( const std::vector< int > &  keyframe_ids,
const std::vector< double > &  time_offsets,
const std::vector< double > &  value_offsets 
)
pure virtual
virtual void HOM_Parm::_saveClip ( std::string  file_name,
double  start,
double  end,
double  sample_rate = 0 
)
pure virtual
virtual void HOM_Parm::_set ( double  float_value)
pure virtual
virtual void HOM_Parm::_set ( int  int_value)
pure virtual
virtual void HOM_Parm::_set ( const char *  string_value)
pure virtual
virtual void HOM_Parm::_set ( HOM_Geometry *  geo)
pure virtual
virtual void HOM_Parm::_set ( const std::map< std::string, std::string > &  map)
pure virtual
virtual void HOM_Parm::_set ( HOM_Ramp *  ramp_value)
pure virtual
virtual void HOM_Parm::_set ( HOM_Parm &  parm,
HOM_EnumValue *  language = nullptr,
bool  follow_parm_reference = true 
)
pure virtual
virtual void HOM_Parm::_setClipData ( HOM_BinaryString  data,
bool  binary = true,
bool  blosc_compressed = true,
double  sample_rate = 0,
double  start = HOM_MIN_NEGATIVE_DOUBLE 
)
pure virtual
virtual void HOM_Parm::_setNone ( )
pure virtual
virtual void HOM_Parm::_setNonePending ( )
pure virtual
virtual void HOM_Parm::_setPending ( double  float_value)
pure virtual
virtual void HOM_Parm::_setPending ( int  int_value)
pure virtual
virtual void HOM_Parm::_setPending ( const char *  string_value)
pure virtual
virtual void HOM_Parm::_setPending ( HOM_Geometry *  geo)
pure virtual
virtual void HOM_Parm::_setPending ( const std::map< std::string, std::string > &  map)
pure virtual
virtual void HOM_Parm::_setPending ( HOM_Ramp *  ramp_value)
pure virtual
virtual std::string HOM_Parm::alias ( )
pure virtual
virtual void HOM_Parm::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_Parm::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 int HOM_Parm::componentIndex ( )
pure virtual
virtual std::vector<int> HOM_Parm::containingFolderIndices ( )
pure virtual
virtual std::vector<std::string> HOM_Parm::containingFolders ( )
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_ParmTuple> > HOM_Parm::containingFolderSetParmTuples ( )
pure virtual
virtual void HOM_Parm::copyToParmClipboard ( )
pure virtual
virtual HOM_Node* HOM_Parm::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 int HOM_Parm::dataParmTypeEnumId ( )
pure virtual
virtual void HOM_Parm::deleteAllKeyframes ( )
pure virtual
virtual void HOM_Parm::deleteKeyframeAtFrame ( double  frame)
pure virtual
virtual std::string HOM_Parm::description ( )
pure virtual
virtual void HOM_Parm::disable ( bool  on)
pure virtual
virtual double HOM_Parm::evalAsFloat ( )
pure virtual
virtual double HOM_Parm::evalAsFloatAtFrame ( double  frame)
pure virtual
virtual HOM_Geometry* HOM_Parm::evalAsGeometry ( )
pure virtual
virtual HOM_Geometry* HOM_Parm::evalAsGeometryAtFrame ( double  frame)
pure virtual
virtual int HOM_Parm::evalAsInt ( )
pure virtual
virtual int HOM_Parm::evalAsIntAtFrame ( double  frame)
pure virtual
virtual std::map<std::string, std::string> HOM_Parm::evalAsJSONMap ( )
pure virtual
virtual std::map<std::string, std::string> HOM_Parm::evalAsJSONMapAtFrame ( double  frame)
pure virtual
virtual HOM_Node* HOM_Parm::evalAsNode ( )
pure virtual
virtual HOM_Node* HOM_Parm::evalAsNodeAtFrame ( double  frame)
pure virtual
virtual std::string HOM_Parm::evalAsNodePath ( )
pure virtual
virtual std::string HOM_Parm::evalAsNodePathAtFrame ( double  frame)
pure virtual
virtual std::vector<std::string> HOM_Parm::evalAsNodePaths ( )
pure virtual
virtual std::vector<std::string> HOM_Parm::evalAsNodePathsAtFrame ( double  frame)
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_Node> > HOM_Parm::evalAsNodes ( )
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_Node> > HOM_Parm::evalAsNodesAtFrame ( double  frame)
pure virtual
virtual HOM_Ramp* HOM_Parm::evalAsRamp ( )
pure virtual
virtual HOM_Ramp* HOM_Parm::evalAsRampAtFrame ( double  frame)
pure virtual
virtual std::string HOM_Parm::evalAsString ( )
pure virtual
virtual std::string HOM_Parm::evalAsStringAtFrame ( double  frame)
pure virtual
virtual std::string HOM_Parm::expression ( )
pure virtual
virtual HOM_EnumValue* HOM_Parm::expressionLanguage ( )
pure virtual
virtual HOM_Parm* HOM_Parm::getReferencedParm ( )
pure virtual
virtual bool HOM_Parm::hasTemporaryDefaults ( )
pure virtual
virtual void HOM_Parm::hide ( bool  on)
pure virtual
virtual void HOM_Parm::insertMultiParmInstance ( int  inst_index)
pure virtual
virtual bool HOM_Parm::isAtDefault ( bool  compare_temporary_defaults = true,
bool  compare_expressions = true 
)
pure virtual
virtual bool HOM_Parm::isAtRampDefault ( )
pure virtual
virtual bool HOM_Parm::isAutoscoped ( )
pure virtual
virtual bool HOM_Parm::isAutoSelected ( )
pure virtual
virtual bool HOM_Parm::isConstrained ( )
pure virtual
virtual bool HOM_Parm::isDisabled ( )
pure virtual
virtual bool HOM_Parm::isDynamicMenu ( )
pure virtual
virtual bool HOM_Parm::isHidden ( )
pure virtual
virtual bool HOM_Parm::isLocked ( )
pure virtual
virtual bool HOM_Parm::isMultiParmInstance ( )
pure virtual
virtual bool HOM_Parm::isMultiParmParent ( )
pure virtual
virtual bool HOM_Parm::isOverrideTrackActive ( )
pure virtual
virtual bool HOM_Parm::isPending ( )
pure virtual
virtual bool HOM_Parm::isScoped ( )
pure virtual
virtual bool HOM_Parm::isSelected ( )
pure virtual
virtual bool HOM_Parm::isShowingExpression ( )
pure virtual
virtual bool HOM_Parm::isSpare ( )
pure virtual
virtual bool HOM_Parm::isTimeDependent ( )
pure virtual
virtual bool HOM_Parm::isVisible ( )
pure virtual
virtual HOM_EnumValue& HOM_Parm::keyframeExtrapolation ( bool  before)
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_BaseKeyframe> > HOM_Parm::keyframes ( )
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_BaseKeyframe> > HOM_Parm::keyframesAfter ( double  frame)
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_BaseKeyframe> > HOM_Parm::keyframesBefore ( double  frame)
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_BaseKeyframe> > HOM_Parm::keyframesInRange ( double  start_frame,
double  end_frame 
)
pure virtual
virtual void HOM_Parm::keyframesRefit ( bool  refit,
double  refit_tol,
bool  refit_preserve_extrema,
bool  refit_bezier,
bool  resample,
double  resample_rate,
double  resample_tol,
bool  range,
double  range_start,
double  range_end,
HOM_EnumValue &  bake_chop,
const char *  expression = "",
bool  refit_smooth = false 
)
pure virtual
virtual void HOM_Parm::lock ( bool  on)
pure virtual
virtual std::vector<std::string> HOM_Parm::menuContents ( )
pure virtual
virtual std::vector<std::string> HOM_Parm::menuItems ( )
pure virtual
virtual std::vector<std::string> HOM_Parm::menuLabels ( )
pure virtual
virtual void HOM_Parm::moveDownMultiParmInstance ( int  inst_index)
pure virtual
virtual void HOM_Parm::moveMultiParmInstances ( const std::vector< int > &  moves)
pure virtual
virtual void HOM_Parm::moveUpMultiParmInstance ( int  inst_index)
pure virtual
virtual std::vector<int> HOM_Parm::multiParmInstanceIndices ( )
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_Parm> > HOM_Parm::multiParmInstances ( )
pure virtual
virtual int HOM_Parm::multiParmInstancesCount ( )
pure virtual
virtual int HOM_Parm::multiParmInstancesPerItem ( )
pure virtual
virtual int HOM_Parm::multiParmStartOffset ( )
pure virtual
virtual std::string HOM_Parm::name ( )
pure virtual
virtual HOM_Node* HOM_Parm::node ( )
pure virtual
virtual bool HOM_Parm::operator!= ( HOM_PtrOrNull< HOM_Parm >  parm)
pure virtual
virtual bool HOM_Parm::operator< ( HOM_Parm *  parm)
pure virtual
virtual bool HOM_Parm::operator== ( HOM_PtrOrNull< HOM_Parm >  parm)
pure virtual
virtual HOM_Track* HOM_Parm::overrideTrack ( )
pure virtual
virtual HOM_Parm* HOM_Parm::parentMultiParm ( )
pure virtual
virtual int HOM_Parm::parmDataTypeEnumId ( )
pure virtual
virtual std::vector<HOM_ElemPtr<HOM_Parm> > HOM_Parm::parmsReferencingThis ( )
pure virtual
virtual HOM_ParmTemplate* HOM_Parm::parmTemplate ( )
pure virtual
virtual std::string HOM_Parm::path ( )
pure virtual
virtual void HOM_Parm::pressButton ( std::map< std::string, hboost::any > const &  arguments = std::map< std::string, hboost::any >())
pure virtual
virtual std::string HOM_Parm::rawValue ( )
pure virtual
virtual std::string HOM_Parm::referenceExpression ( HOM_Parm &  to_base_parm,
HOM_EnumValue *  language = nullptr,
bool  follow_parm_reference = true 
)
pure virtual
virtual void HOM_Parm::removeMultiParmInstance ( int  inst_index)
pure virtual
virtual void HOM_Parm::revertToAndRestorePermanentDefaults ( )
pure virtual
virtual void HOM_Parm::revertToDefaults ( )
pure virtual
virtual void HOM_Parm::revertToRampDefaults ( )
pure virtual
virtual void HOM_Parm::setAlias ( const char *  alias_name)
pure virtual
virtual void HOM_Parm::setAutoscope ( bool  on)
pure virtual
virtual void HOM_Parm::setAutoSelect ( bool  on)
pure virtual
virtual void HOM_Parm::setExpression ( const char *  expression,
HOM_EnumValue *  language = NULL,
bool  replace_expression = true 
)
pure virtual
virtual void HOM_Parm::setFromParm ( HOM_Parm &  src)
pure virtual
virtual void HOM_Parm::setFromParmDefaults ( HOM_Parm &  src)
pure virtual
virtual void HOM_Parm::setKeyframe ( HOM_BaseKeyframe &  keyframe)
pure virtual
virtual void HOM_Parm::setKeyframeExtrapolation ( bool  before,
HOM_EnumValue &  e 
)
pure virtual
virtual void HOM_Parm::setKeyframes ( const std::vector< HOM_BaseKeyframe * > &  keyframes)
pure virtual
virtual void HOM_Parm::setScope ( bool  on)
pure virtual
virtual void HOM_Parm::setSelect ( bool  on)
pure virtual
virtual void HOM_Parm::showExpression ( bool  value)
pure virtual
virtual HOM_ParmTuple* HOM_Parm::tuple ( )
pure virtual
virtual HOM_Color* HOM_Parm::uiBackgroundColor ( )
pure virtual
virtual std::string HOM_Parm::unexpandedString ( )
pure virtual
The documentation for this class was generated from the following file: