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

#include <SOP_NodeParmsOptions.h>

+ Inheritance diagram for SOP_NodeCacheOptions:

Public Types

typedef GOP_Manager::GroupCreator GroupCreator
 Typedef to help make use of GroupCreator less verbose. More...
 

Public Member Functions

 SOP_NodeCacheOptions ()
 
virtual ~SOP_NodeCacheOptions ()
 
void doCook (const SOP_NodeVerb *verb, const SOP_NodeVerb::CookParms &cookparms)
 
fpreal evalFloat (const char *parm, int vi, fpreal time) const
 
exint evalInt (const char *parm, int vi, fpreal time) const
 
void evalString (UT_String &value, const char *parm, int vi, fpreal time) const
 
fpreal evalFloatInst (const char *parm, const int *instance, int vi, fpreal time, int nestlevel=1) const
 
exint evalIntInst (const char *parm, const int *instance, int vi, fpreal time, int nestlevel=1) const
 
void evalStringInst (const char *parm, const int *instance, UT_String &val, int vi, fpreal time, int nestlevel=1) const
 
exint nInputs () const
 
bool hasInput (exint idx) const
 
const GU_DetailinputGeo (exint idx, const OP_Context &context) const
 
const GU_DetailinputGeo (exint idx) const
 
OP_ERROR error ()
 
void addError (int code, const char *msg=0)
 
void addWarning (int code, const char *msg=0)
 
void addMessage (int code, const char *msg=0)
 
void addTransformError (const OP_Node &node, const char *label=0) const
 
void notifyGroupParmListeners (int groupparm_idx, int grouptype_idx, const GU_Detail *parm_gdp, const GA_Group *parm_group) const
 
void select (GA_GroupType gtype=GA_GROUP_PRIMITIVE)
 
void select (GU_SelectionHandle selection, bool add_to_sel=false)
 
void select (const GA_Group &group, bool use_gtype=true, bool add_to_sel=false)
 
void select (const GEO_Primitive &prim, bool sel_prim=true, bool add_to_sel=false)
 
void selectPoint (GA_Offset ptoff, bool point_sel=true, bool add_to_sel=false)
 
void selectFrom (const GEO_Primitive &prim, bool sel_prim=true, bool add_to_sel=false)
 
void selectPointsFrom (GA_Offset ptoff, bool point_sel=true, bool add_to_sel=false)
 
void select (const GA_Range &range, bool use_rtype=true, bool add_to_sel=false)
 
void selectInputGroup (const GA_Group *group, GA_GroupType grouptype)
 
void clearSelection ()
 
void clearSelection (GA_GroupType gtype)
 
bool destroySelection ()
 
bool selectionEnabled () const
 
void addExtraInput (OP_Node *op, OP_InterestType type)
 
- Public Member Functions inherited from SOP_NodeCache
 SOP_NodeCache ()
 
virtual ~SOP_NodeCache ()
 
virtual int64 getMemoryUsage (bool inclusive) const
 
CVEX_ContextgetVexContext (const char *vexpression)
 
CVEX_ContextbuildVexContext (const char *vexpression)
 
void setVexFunction (const CVEX_Function &function)
 
void clearVexContext ()
 

Protected Member Functions

virtual OP_ERROR cook (OP_Context &context)=0
 
const SOP_NodeVerb::CookParmscookparms () const
 

Protected Attributes

GU_Detailgdp
 These are transitory for the duration of the cook. More...
 
- Protected Attributes inherited from SOP_NodeCache
CVEX_ContextmyVexContext
 
CVEX_FunctionmyVexFunction
 
UT_StringHolder myVEXpression
 
UT_Array< SOP_CVEXDataBackingmyReadBacking
 
UT_Array< SOP_CVEXDataBackingmyWriteBacking
 

Detailed Description

Provides a mostly drop-in replacement for SOP_Node, along with a local GU_Detail * to write to.

Definition at line 81 of file SOP_NodeParmsOptions.h.

Member Typedef Documentation

Typedef to help make use of GroupCreator less verbose.

Definition at line 198 of file SOP_NodeParmsOptions.h.

Constructor & Destructor Documentation

SOP_NodeCacheOptions::SOP_NodeCacheOptions ( )
virtual SOP_NodeCacheOptions::~SOP_NodeCacheOptions ( )
virtual

Member Function Documentation

void SOP_NodeCacheOptions::addError ( int  code,
const char *  msg = 0 
)
inline

Definition at line 109 of file SOP_NodeParmsOptions.h.

void SOP_NodeCacheOptions::addExtraInput ( OP_Node op,
OP_InterestType  type 
)
inline

Definition at line 200 of file SOP_NodeParmsOptions.h.

void SOP_NodeCacheOptions::addMessage ( int  code,
const char *  msg = 0 
)
inline

Definition at line 113 of file SOP_NodeParmsOptions.h.

void SOP_NodeCacheOptions::addTransformError ( const OP_Node node,
const char *  label = 0 
) const
inline

Registers an error for cooking the given node's transform. If label is supplied, then it will be used as a label of the transform error.

Definition at line 118 of file SOP_NodeParmsOptions.h.

void SOP_NodeCacheOptions::addWarning ( int  code,
const char *  msg = 0 
)
inline

Definition at line 111 of file SOP_NodeParmsOptions.h.

void SOP_NodeCacheOptions::clearSelection ( )
inline

Definition at line 178 of file SOP_NodeParmsOptions.h.

void SOP_NodeCacheOptions::clearSelection ( GA_GroupType  gtype)
inline

If the cook selection group is not of the given type, create an empty cook selection group of that type. Otherwise, clear the existing cook selection group.

Definition at line 184 of file SOP_NodeParmsOptions.h.

virtual OP_ERROR SOP_NodeCacheOptions::cook ( OP_Context context)
protectedpure virtual

Implemented in SOP_AttribCompositeCache.

const SOP_NodeVerb::CookParms* SOP_NodeCacheOptions::cookparms ( ) const
inlineprotected

Definition at line 215 of file SOP_NodeParmsOptions.h.

bool SOP_NodeCacheOptions::destroySelection ( )
inline

Definition at line 190 of file SOP_NodeParmsOptions.h.

void SOP_NodeCacheOptions::doCook ( const SOP_NodeVerb verb,
const SOP_NodeVerb::CookParms cookparms 
)
OP_ERROR SOP_NodeCacheOptions::error ( )
fpreal SOP_NodeCacheOptions::evalFloat ( const char *  parm,
int  vi,
fpreal  time 
) const
fpreal SOP_NodeCacheOptions::evalFloatInst ( const char *  parm,
const int instance,
int  vi,
fpreal  time,
int  nestlevel = 1 
) const
exint SOP_NodeCacheOptions::evalInt ( const char *  parm,
int  vi,
fpreal  time 
) const
exint SOP_NodeCacheOptions::evalIntInst ( const char *  parm,
const int instance,
int  vi,
fpreal  time,
int  nestlevel = 1 
) const
void SOP_NodeCacheOptions::evalString ( UT_String value,
const char *  parm,
int  vi,
fpreal  time 
) const
void SOP_NodeCacheOptions::evalStringInst ( const char *  parm,
const int instance,
UT_String val,
int  vi,
fpreal  time,
int  nestlevel = 1 
) const
bool SOP_NodeCacheOptions::hasInput ( exint  idx) const
inline

Definition at line 101 of file SOP_NodeParmsOptions.h.

const GU_Detail* SOP_NodeCacheOptions::inputGeo ( exint  idx,
const OP_Context context 
) const
inline

Definition at line 103 of file SOP_NodeParmsOptions.h.

const GU_Detail* SOP_NodeCacheOptions::inputGeo ( exint  idx) const
inline

Definition at line 105 of file SOP_NodeParmsOptions.h.

exint SOP_NodeCacheOptions::nInputs ( ) const
inline

Definition at line 99 of file SOP_NodeParmsOptions.h.

void SOP_NodeCacheOptions::notifyGroupParmListeners ( int  groupparm_idx,
int  grouptype_idx,
const GU_Detail parm_gdp,
const GA_Group parm_group 
) const
inline

Definition at line 134 of file SOP_NodeParmsOptions.h.

void SOP_NodeCacheOptions::select ( GA_GroupType  gtype = GA_GROUP_PRIMITIVE)
inline

Definition at line 141 of file SOP_NodeParmsOptions.h.

void SOP_NodeCacheOptions::select ( GU_SelectionHandle  selection,
bool  add_to_sel = false 
)
inline

Definition at line 144 of file SOP_NodeParmsOptions.h.

void SOP_NodeCacheOptions::select ( const GA_Group group,
bool  use_gtype = true,
bool  add_to_sel = false 
)
inline

Definition at line 149 of file SOP_NodeParmsOptions.h.

void SOP_NodeCacheOptions::select ( const GEO_Primitive prim,
bool  sel_prim = true,
bool  add_to_sel = false 
)
inline

Definition at line 153 of file SOP_NodeParmsOptions.h.

void SOP_NodeCacheOptions::select ( const GA_Range range,
bool  use_rtype = true,
bool  add_to_sel = false 
)
inline

Definition at line 165 of file SOP_NodeParmsOptions.h.

void SOP_NodeCacheOptions::selectFrom ( const GEO_Primitive prim,
bool  sel_prim = true,
bool  add_to_sel = false 
)
inline

Definition at line 159 of file SOP_NodeParmsOptions.h.

void SOP_NodeCacheOptions::selectInputGroup ( const GA_Group group,
GA_GroupType  grouptype 
)
inline

Definition at line 172 of file SOP_NodeParmsOptions.h.

bool SOP_NodeCacheOptions::selectionEnabled ( ) const
inline

Definition at line 194 of file SOP_NodeParmsOptions.h.

void SOP_NodeCacheOptions::selectPoint ( GA_Offset  ptoff,
bool  point_sel = true,
bool  add_to_sel = false 
)
inline

Definition at line 156 of file SOP_NodeParmsOptions.h.

void SOP_NodeCacheOptions::selectPointsFrom ( GA_Offset  ptoff,
bool  point_sel = true,
bool  add_to_sel = false 
)
inline

Definition at line 162 of file SOP_NodeParmsOptions.h.

Member Data Documentation

GU_Detail* SOP_NodeCacheOptions::gdp
protected

These are transitory for the duration of the cook.

Definition at line 213 of file SOP_NodeParmsOptions.h.


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