HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
OP_NodeFlags Class Reference

#include <OP_NodeFlags.h>

Public Types

enum  OP_LockTypes : char { OP_UNLOCKED = 0x0, OP_HARD_LOCKED = 0x1, OP_SOFT_LOCKED = 0x2 }
 

Public Member Functions

void setRecursion (bool val) const
 
bool getRecursion () const
 
void setUndoComment (bool on_off)
 
void setUndoInput (bool on_off)
 
void setUndoLayout (bool on_off)
 
void setUndoDelScript (bool on_off)
 
void setUndoPreTransform (bool on_off)
 
void setUndoFlagChange (bool on_off)
 
void setColorDefault (bool on_off)
 
void setCompress (bool on_off)
 
void setDisplayDescriptiveName (bool on_off)
 
void setDisplayComment (bool on_off)
 
void setAlwaysCook (bool on_off)
 
void setUnload (bool on_off)
 
void setForceCook (bool on_off)
 
void setHasCookedData (bool on_off)
 
void setTimeDep (bool on_off)
 
void setCooking (bool on_off)
 
void setDisplay (bool on_off)
 
void setRender (bool on_off)
 
void setHighlight (bool on_off)
 
void setTemplate (bool on_off)
 
void setFootprint (bool on_off)
 
void setXray (bool on_off)
 
void setBypass (bool on_off)
 
void setPicked (bool on_off)
 
void setEditPicked (bool on_off)
 
void setHardLocked (bool on_off)
 
void setSoftLocked (bool on_off)
 
void setLockState (OP_LockTypes state)
 
void setModified (bool on_off)
 
void setExpose (bool on_off)
 
void setSaveBypass (bool on_off)
 
void setSaveData (bool on_off)
 
void setOutputForView (int8 output)
 
void setTimeInterest (bool on_off)
 
void setTimeInterestCook (bool on_off)
 
void setClearDependency (bool on_off)
 
bool getUndoComment () const
 
bool getUndoInput () const
 
bool getUndoLayout () const
 
bool getUndoDelScript () const
 
bool getUndoPreTransform () const
 
bool getUndoFlagChange () const
 
bool getColorDefault () const
 
bool getCompress () const
 
bool getDisplayDescriptiveName () const
 
bool getDisplayComment () const
 
bool getAlwaysCook () const
 
bool getUnload () const
 
bool getForceCook () const
 
bool getHasCookedData () const
 
bool getTimeDep () const
 
bool getCooking () const
 
bool getDisplay () const
 
bool getRender () const
 
bool getHighlight () const
 
bool getTemplate () const
 
bool getFootprint () const
 
bool getXray () const
 
bool getBypass () const
 
bool getPicked () const
 
bool getEditPicked () const
 
bool getHardLocked () const
 
bool getSoftLocked () const
 
bool isLocked () const
 
OP_LockTypes getLockState () const
 
bool getModified () const
 
bool getExpose () const
 
bool getSaveBypass () const
 
bool getSaveData () const
 
bool getTimeInterest () const
 
bool getTimeInterestCook () const
 
bool getClearDependency () const
 
int8 getOutputForView () const
 
void clearAllTakeFlags ()
 
void setTakeFlag (uchar which, bool v)
 
bool getTakeFlag (uchar which) const
 
void setTakeValue (uchar which, bool v)
 
bool getTakeValue (uchar which) const
 
void setHasTakeData (bool on_off)
 
bool getHasTakeData () const
 
bool getTakeDisplay () const
 
bool getTakeRender () const
 
bool getTakeTemplate () const
 
bool getTakeExpose () const
 
bool getTakeBypass () const
 
bool getTakePick () const
 
bool getTakeCurrent () const
 
bool getInterrupted () const
 
void setInterrupted (bool f)
 
bool getDescendantInterrupted () const
 
void setDescendantInterrupted (bool f)
 
bool getClearingInterrupt () const
 
void setClearingInterrupt (bool f)
 
const char * getExtra () const
 
void setExtra (const char *opts, int val, const char **labels)
 
bool getExtraVal (char a) const
 
void setExtraVal (char a, bool on_off)
 
void appendCommandString (std::ostream &os, const char *flags, bool save_to_hip) const
 
void getFlagOptions (UT_String &options) const
 
bool getLastTimeDep () const
 
void setLastTimeDep ()
 

Static Public Member Functions

static const char * getFlagName (uchar token)
 
static const uchar * getTakeFlagTokens ()
 
static bool isTakeFlag (uchar token)
 
static bool isSubjectToStdPermissions (uchar token)
 
static bool isSubjectToAssetPermissions (uchar token)
 

Friends

class OP_Node
 
class OP_UndoFlag
 

Detailed Description

Definition at line 58 of file OP_NodeFlags.h.

Member Enumeration Documentation

enum OP_NodeFlags::OP_LockTypes : char
Enumerator
OP_UNLOCKED 
OP_HARD_LOCKED 
OP_SOFT_LOCKED 

Definition at line 62 of file OP_NodeFlags.h.

Member Function Documentation

void OP_NodeFlags::appendCommandString ( std::ostream &  os,
const char *  flags,
bool  save_to_hip 
) const
void OP_NodeFlags::clearAllTakeFlags ( )
bool OP_NodeFlags::getAlwaysCook ( ) const
inline

Definition at line 181 of file OP_NodeFlags.h.

bool OP_NodeFlags::getBypass ( ) const
inline

Definition at line 205 of file OP_NodeFlags.h.

bool OP_NodeFlags::getClearDependency ( ) const
inline

Definition at line 231 of file OP_NodeFlags.h.

bool OP_NodeFlags::getClearingInterrupt ( ) const
inline

Definition at line 272 of file OP_NodeFlags.h.

bool OP_NodeFlags::getColorDefault ( ) const
inline

Definition at line 173 of file OP_NodeFlags.h.

bool OP_NodeFlags::getCompress ( ) const
inline

Definition at line 175 of file OP_NodeFlags.h.

bool OP_NodeFlags::getCooking ( ) const
inline

Definition at line 191 of file OP_NodeFlags.h.

bool OP_NodeFlags::getDescendantInterrupted ( ) const
inline

Definition at line 268 of file OP_NodeFlags.h.

bool OP_NodeFlags::getDisplay ( ) const
inline

Definition at line 193 of file OP_NodeFlags.h.

bool OP_NodeFlags::getDisplayComment ( ) const
inline

Definition at line 179 of file OP_NodeFlags.h.

bool OP_NodeFlags::getDisplayDescriptiveName ( ) const
inline

Definition at line 177 of file OP_NodeFlags.h.

bool OP_NodeFlags::getEditPicked ( ) const
inline

Definition at line 209 of file OP_NodeFlags.h.

bool OP_NodeFlags::getExpose ( ) const
inline

Definition at line 221 of file OP_NodeFlags.h.

const char* OP_NodeFlags::getExtra ( ) const
inline

Definition at line 277 of file OP_NodeFlags.h.

bool OP_NodeFlags::getExtraVal ( char  a) const
static const char* OP_NodeFlags::getFlagName ( uchar  token)
static
void OP_NodeFlags::getFlagOptions ( UT_String &  options) const
bool OP_NodeFlags::getFootprint ( ) const
inline

Definition at line 201 of file OP_NodeFlags.h.

bool OP_NodeFlags::getForceCook ( ) const
inline

Definition at line 185 of file OP_NodeFlags.h.

bool OP_NodeFlags::getHardLocked ( ) const
inline

Definition at line 211 of file OP_NodeFlags.h.

bool OP_NodeFlags::getHasCookedData ( ) const
inline

Definition at line 187 of file OP_NodeFlags.h.

bool OP_NodeFlags::getHasTakeData ( ) const
inline

Definition at line 246 of file OP_NodeFlags.h.

bool OP_NodeFlags::getHighlight ( ) const
inline

Definition at line 197 of file OP_NodeFlags.h.

bool OP_NodeFlags::getInterrupted ( ) const
inline

Definition at line 264 of file OP_NodeFlags.h.

bool OP_NodeFlags::getLastTimeDep ( ) const
inline

Definition at line 297 of file OP_NodeFlags.h.

OP_LockTypes OP_NodeFlags::getLockState ( ) const
inline

Definition at line 217 of file OP_NodeFlags.h.

bool OP_NodeFlags::getModified ( ) const
inline

Definition at line 219 of file OP_NodeFlags.h.

int8 OP_NodeFlags::getOutputForView ( ) const
inline

Definition at line 233 of file OP_NodeFlags.h.

bool OP_NodeFlags::getPicked ( ) const
inline

Definition at line 207 of file OP_NodeFlags.h.

bool OP_NodeFlags::getRecursion ( ) const
inline

Definition at line 82 of file OP_NodeFlags.h.

bool OP_NodeFlags::getRender ( ) const
inline

Definition at line 195 of file OP_NodeFlags.h.

bool OP_NodeFlags::getSaveBypass ( ) const
inline

Definition at line 223 of file OP_NodeFlags.h.

bool OP_NodeFlags::getSaveData ( ) const
inline

Definition at line 225 of file OP_NodeFlags.h.

bool OP_NodeFlags::getSoftLocked ( ) const
inline

Definition at line 213 of file OP_NodeFlags.h.

bool OP_NodeFlags::getTakeBypass ( ) const
inline

Definition at line 257 of file OP_NodeFlags.h.

bool OP_NodeFlags::getTakeCurrent ( ) const
inline

Definition at line 261 of file OP_NodeFlags.h.

bool OP_NodeFlags::getTakeDisplay ( ) const
inline

Definition at line 249 of file OP_NodeFlags.h.

bool OP_NodeFlags::getTakeExpose ( ) const
inline

Definition at line 255 of file OP_NodeFlags.h.

bool OP_NodeFlags::getTakeFlag ( uchar  which) const
static const uchar* OP_NodeFlags::getTakeFlagTokens ( )
static
bool OP_NodeFlags::getTakePick ( ) const
inline

Definition at line 259 of file OP_NodeFlags.h.

bool OP_NodeFlags::getTakeRender ( ) const
inline

Definition at line 251 of file OP_NodeFlags.h.

bool OP_NodeFlags::getTakeTemplate ( ) const
inline

Definition at line 253 of file OP_NodeFlags.h.

bool OP_NodeFlags::getTakeValue ( uchar  which) const
bool OP_NodeFlags::getTemplate ( ) const
inline

Definition at line 199 of file OP_NodeFlags.h.

bool OP_NodeFlags::getTimeDep ( ) const
inline
Examples:
SOP/SOP_CopRaster.C.

Definition at line 189 of file OP_NodeFlags.h.

bool OP_NodeFlags::getTimeInterest ( ) const
inline

Definition at line 227 of file OP_NodeFlags.h.

bool OP_NodeFlags::getTimeInterestCook ( ) const
inline

Definition at line 229 of file OP_NodeFlags.h.

bool OP_NodeFlags::getUndoComment ( ) const
inline

Definition at line 161 of file OP_NodeFlags.h.

bool OP_NodeFlags::getUndoDelScript ( ) const
inline

Definition at line 167 of file OP_NodeFlags.h.

bool OP_NodeFlags::getUndoFlagChange ( ) const
inline

Definition at line 171 of file OP_NodeFlags.h.

bool OP_NodeFlags::getUndoInput ( ) const
inline

Definition at line 163 of file OP_NodeFlags.h.

bool OP_NodeFlags::getUndoLayout ( ) const
inline

Definition at line 165 of file OP_NodeFlags.h.

bool OP_NodeFlags::getUndoPreTransform ( ) const
inline

Definition at line 169 of file OP_NodeFlags.h.

bool OP_NodeFlags::getUnload ( ) const
inline

Definition at line 183 of file OP_NodeFlags.h.

bool OP_NodeFlags::getXray ( ) const
inline

Definition at line 203 of file OP_NodeFlags.h.

bool OP_NodeFlags::isLocked ( ) const
inline

Definition at line 215 of file OP_NodeFlags.h.

static bool OP_NodeFlags::isSubjectToAssetPermissions ( uchar  token)
static
static bool OP_NodeFlags::isSubjectToStdPermissions ( uchar  token)
static
static bool OP_NodeFlags::isTakeFlag ( uchar  token)
static
void OP_NodeFlags::setAlwaysCook ( bool  on_off)
inline

Definition at line 105 of file OP_NodeFlags.h.

void OP_NodeFlags::setBypass ( bool  on_off)
inline

Definition at line 129 of file OP_NodeFlags.h.

void OP_NodeFlags::setClearDependency ( bool  on_off)
inline

Definition at line 158 of file OP_NodeFlags.h.

void OP_NodeFlags::setClearingInterrupt ( bool  f)
inline

Definition at line 274 of file OP_NodeFlags.h.

void OP_NodeFlags::setColorDefault ( bool  on_off)
inline

Definition at line 97 of file OP_NodeFlags.h.

void OP_NodeFlags::setCompress ( bool  on_off)
inline

Definition at line 99 of file OP_NodeFlags.h.

void OP_NodeFlags::setCooking ( bool  on_off)
inline

Definition at line 115 of file OP_NodeFlags.h.

void OP_NodeFlags::setDescendantInterrupted ( bool  f)
inline

Definition at line 270 of file OP_NodeFlags.h.

void OP_NodeFlags::setDisplay ( bool  on_off)
inline

Definition at line 117 of file OP_NodeFlags.h.

void OP_NodeFlags::setDisplayComment ( bool  on_off)
inline

Definition at line 103 of file OP_NodeFlags.h.

void OP_NodeFlags::setDisplayDescriptiveName ( bool  on_off)
inline

Definition at line 101 of file OP_NodeFlags.h.

void OP_NodeFlags::setEditPicked ( bool  on_off)
inline

Definition at line 133 of file OP_NodeFlags.h.

void OP_NodeFlags::setExpose ( bool  on_off)
inline

Definition at line 143 of file OP_NodeFlags.h.

void OP_NodeFlags::setExtra ( const char *  opts,
int  val,
const char **  labels 
)
inline

Definition at line 280 of file OP_NodeFlags.h.

void OP_NodeFlags::setExtraVal ( char  a,
bool  on_off 
)
void OP_NodeFlags::setFootprint ( bool  on_off)
inline

Definition at line 125 of file OP_NodeFlags.h.

void OP_NodeFlags::setForceCook ( bool  on_off)
inline

Definition at line 109 of file OP_NodeFlags.h.

void OP_NodeFlags::setHardLocked ( bool  on_off)
inline

Definition at line 135 of file OP_NodeFlags.h.

void OP_NodeFlags::setHasCookedData ( bool  on_off)
inline

Definition at line 111 of file OP_NodeFlags.h.

void OP_NodeFlags::setHasTakeData ( bool  on_off)
inline

Definition at line 244 of file OP_NodeFlags.h.

void OP_NodeFlags::setHighlight ( bool  on_off)
inline

Definition at line 121 of file OP_NodeFlags.h.

void OP_NodeFlags::setInterrupted ( bool  f)
inline

Definition at line 266 of file OP_NodeFlags.h.

void OP_NodeFlags::setLastTimeDep ( )
inline

Definition at line 299 of file OP_NodeFlags.h.

void OP_NodeFlags::setLockState ( OP_LockTypes  state)
inline

Definition at line 139 of file OP_NodeFlags.h.

void OP_NodeFlags::setModified ( bool  on_off)
inline

Definition at line 141 of file OP_NodeFlags.h.

void OP_NodeFlags::setOutputForView ( int8  output)
inline

Definition at line 149 of file OP_NodeFlags.h.

void OP_NodeFlags::setPicked ( bool  on_off)
inline

Definition at line 131 of file OP_NodeFlags.h.

void OP_NodeFlags::setRecursion ( bool  val) const
inline

Definition at line 80 of file OP_NodeFlags.h.

void OP_NodeFlags::setRender ( bool  on_off)
inline

Definition at line 119 of file OP_NodeFlags.h.

void OP_NodeFlags::setSaveBypass ( bool  on_off)
inline

Definition at line 145 of file OP_NodeFlags.h.

void OP_NodeFlags::setSaveData ( bool  on_off)
inline

Definition at line 147 of file OP_NodeFlags.h.

void OP_NodeFlags::setSoftLocked ( bool  on_off)
inline

Definition at line 137 of file OP_NodeFlags.h.

void OP_NodeFlags::setTakeFlag ( uchar  which,
bool  v 
)
void OP_NodeFlags::setTakeValue ( uchar  which,
bool  v 
)
void OP_NodeFlags::setTemplate ( bool  on_off)
inline

Definition at line 123 of file OP_NodeFlags.h.

void OP_NodeFlags::setTimeDep ( bool  on_off)
inline
Examples:
OBJ/OBJ_Shake.C, SOP/SOP_CopRaster.C, SOP/SOP_CPPWave.C, SOP/SOP_PrimVOP.C, and SOP/SOP_SParticle.C.

Definition at line 113 of file OP_NodeFlags.h.

void OP_NodeFlags::setTimeInterest ( bool  on_off)
inline

Definition at line 154 of file OP_NodeFlags.h.

void OP_NodeFlags::setTimeInterestCook ( bool  on_off)
inline

Definition at line 156 of file OP_NodeFlags.h.

void OP_NodeFlags::setUndoComment ( bool  on_off)
inline

Definition at line 85 of file OP_NodeFlags.h.

void OP_NodeFlags::setUndoDelScript ( bool  on_off)
inline

Definition at line 91 of file OP_NodeFlags.h.

void OP_NodeFlags::setUndoFlagChange ( bool  on_off)
inline

Definition at line 95 of file OP_NodeFlags.h.

void OP_NodeFlags::setUndoInput ( bool  on_off)
inline

Definition at line 87 of file OP_NodeFlags.h.

void OP_NodeFlags::setUndoLayout ( bool  on_off)
inline

Definition at line 89 of file OP_NodeFlags.h.

void OP_NodeFlags::setUndoPreTransform ( bool  on_off)
inline

Definition at line 93 of file OP_NodeFlags.h.

void OP_NodeFlags::setUnload ( bool  on_off)
inline

Definition at line 107 of file OP_NodeFlags.h.

void OP_NodeFlags::setXray ( bool  on_off)
inline

Definition at line 127 of file OP_NodeFlags.h.

Friends And Related Function Documentation

friend class OP_Node
friend

Definition at line 377 of file OP_NodeFlags.h.

friend class OP_UndoFlag
friend

Definition at line 378 of file OP_NodeFlags.h.

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