HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OP_AutoLockInputs Class Reference

#include <OP_AutoLockInputs.h>

Public Member Functions

 OP_AutoLockInputs (OP_Node *node=NULL)
 
 ~OP_AutoLockInputs ()
 Destructor unlocks any locked inputs. More...
 
void setNode (OP_Node *node)
 Unlocks any locked inputs and sets the node. More...
 
OP_ERROR lock (OP_Context &context)
 Locks all inputs. More...
 
OP_ERROR lockInput (exint input, OP_Context &context)
 Locks a single input. More...
 
OP_NodegetLockedNode () const
 Returns the node associated with this auto-unlocker. More...
 
const UT_BitArraygetLockedInputs () const
 Returns a bit array of successfully locked inputs. More...
 
void unlock ()
 
void unlockInput (exint input)
 
void markInputUnlocked (exint input)
 

Detailed Description

Constructor & Destructor Documentation

OP_AutoLockInputs::OP_AutoLockInputs ( OP_Node node = NULL)
inline

Constructor accepting a node. NOTE: This does NOT lock the inputs! Call lock(). Must call setNode() before locking if NULL.

Definition at line 28 of file OP_AutoLockInputs.h.

OP_AutoLockInputs::~OP_AutoLockInputs ( )
inline

Destructor unlocks any locked inputs.

Definition at line 34 of file OP_AutoLockInputs.h.

Member Function Documentation

const UT_BitArray& OP_AutoLockInputs::getLockedInputs ( ) const
inline

Returns a bit array of successfully locked inputs.

Definition at line 59 of file OP_AutoLockInputs.h.

OP_Node* OP_AutoLockInputs::getLockedNode ( ) const
inline

Returns the node associated with this auto-unlocker.

Definition at line 55 of file OP_AutoLockInputs.h.

OP_ERROR OP_AutoLockInputs::lock ( OP_Context context)

Locks all inputs.

OP_ERROR OP_AutoLockInputs::lockInput ( exint  input,
OP_Context context 
)

Locks a single input.

void OP_AutoLockInputs::markInputUnlocked ( exint  input)

Explicilty marks the given input as unlocked. This is used if another function outside of the auto-lock has explicilty unlocked that input.

void OP_AutoLockInputs::setNode ( OP_Node node)
inline

Unlocks any locked inputs and sets the node.

Definition at line 40 of file OP_AutoLockInputs.h.

void OP_AutoLockInputs::unlock ( )

Explicitly unlock all locked inputs. NOTE: Only call this directly if you need to unlock early!

void OP_AutoLockInputs::unlockInput ( exint  input)

Explicitly unlock the specified locked input. NOTE: Only call this directly if you need to unlock early!


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