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

Per-run data for CVEX execution. More...

#include <CVEX_Context.h>

+ Inheritance diagram for CVEX_RunData:

Public Member Functions

 CVEX_RunData ()
 
 ~CVEX_RunData ()
 
void clear ()
 Resets the run data for re-use. More...
 
void setTime (fpreal time)
 
void setCWDNodeId (int id)
 
void setWorldNodeId (int id)
 
void setOpCaller (UT_OpCaller *caller)
 
UT_OpCallergetOpCaller () const
 Access to the OP_Caller. More...
 
bool isTimeDependent () const
 
void setTimeSampleEncountered (bool v)
 Set flag indicating whether there are any time samples involved. More...
 
bool isTimeSampleEncountered () const
 
void setGeoInputs (const VEX_GeoInputs *geo)
 
const VEX_GeoInputsgetGeoInputs () const
 
void setProcId (exint *procid)
 
const exintgetProcId () const
 
template<VEX_Precision PREC>
void setGeoCommandQueue (VEX_GeoCommandQueue< PREC > *geocmd)
 Sets the command queue for this context. More...
 
template<VEX_Precision PREC>
VEX_GeoCommandQueue< PREC > * getGeoCommandQueue () const
 
VEX_ChannelCache * getChannelCache ()
 
VEX_FileCache * getFileCache ()
 
CVEX_TransformgetTransform ()
 
void setTimeDependent (bool v)
 
bool timeSpecified () const
 
bool timeDependent () const
 
int cwdId () const
 
int worldId () const
 
fpreal time () const
 

Additional Inherited Members

- Protected Member Functions inherited from UT_NonCopyableNS::UT_NonCopyable
 UT_NonCopyable ()=default
 
 ~UT_NonCopyable ()=default
 
 UT_NonCopyable (const UT_NonCopyable &)=delete
 
UT_NonCopyableoperator= (const UT_NonCopyable &)=delete
 

Detailed Description

Per-run data for CVEX execution.

This class is used to set and retrieve data specific to an individual execution run using CVEX_Context::run().

Examples:
SOP/SOP_PrimVOP.C, and SOP/SOP_PrimVOP.h.

Definition at line 35 of file CVEX_Context.h.

Constructor & Destructor Documentation

CVEX_RunData::CVEX_RunData ( )
CVEX_RunData::~CVEX_RunData ( )

Member Function Documentation

void CVEX_RunData::clear ( )

Resets the run data for re-use.

int CVEX_RunData::cwdId ( ) const
inline

Accessors

Definition at line 139 of file CVEX_Context.h.

VEX_ChannelCache* CVEX_RunData::getChannelCache ( )
inline

Definition at line 124 of file CVEX_Context.h.

VEX_FileCache* CVEX_RunData::getFileCache ( )
inline

Definition at line 126 of file CVEX_Context.h.

template<VEX_Precision PREC>
VEX_GeoCommandQueue<PREC>* CVEX_RunData::getGeoCommandQueue ( ) const
inline

Definition at line 119 of file CVEX_Context.h.

const VEX_GeoInputs* CVEX_RunData::getGeoInputs ( ) const
inline

Definition at line 102 of file CVEX_Context.h.

UT_OpCaller* CVEX_RunData::getOpCaller ( ) const
inline

Access to the OP_Caller.

Definition at line 77 of file CVEX_Context.h.

const exint* CVEX_RunData::getProcId ( ) const
inline

Definition at line 110 of file CVEX_Context.h.

CVEX_Transform& CVEX_RunData::getTransform ( )
inline

Every VEX function has a transform context associated with it. This transform context is used by VEX functions like ptransform() to provide ways to transform to other spaces (like "space:world" or "space:object"). This method allows you to modify the transform context of this shader.

Definition at line 133 of file CVEX_Context.h.

bool CVEX_RunData::isTimeDependent ( ) const
inline

Returns true when, after running the CVEX_Context, a ch() function reported that it was time dependent.

Examples:
SOP/SOP_PrimVOP.C.

Definition at line 81 of file CVEX_Context.h.

bool CVEX_RunData::isTimeSampleEncountered ( ) const
inline

Returns true when, after running the CVEX_Context, a usd_attrib() function reported that it has some time samples (values at time codes).

Definition at line 91 of file CVEX_Context.h.

void CVEX_RunData::setCWDNodeId ( int  id)
inline

Sets the operator working directory. This is used by ch() style vex functions to determine where the relative path for path resolution should be. Use OP_Node::getUniqueId() to pass this in.

Definition at line 57 of file CVEX_Context.h.

template<VEX_Precision PREC>
void CVEX_RunData::setGeoCommandQueue ( VEX_GeoCommandQueue< PREC > *  geocmd)
inline

Sets the command queue for this context.

Examples:
SOP/SOP_PrimVOP.C.

Definition at line 114 of file CVEX_Context.h.

void CVEX_RunData::setGeoInputs ( const VEX_GeoInputs geo)
inline

Sets the geo input callback for controlling how opinput: references are handled

Definition at line 98 of file CVEX_Context.h.

void CVEX_RunData::setOpCaller ( UT_OpCaller caller)
inline

Sets the OP callback. This is used to setup dependencies on any referenced op: expressions. Can be applied to the context at any time.

Examples:
SOP/SOP_PrimVOP.C.

Definition at line 71 of file CVEX_Context.h.

void CVEX_RunData::setProcId ( exint procid)
inline

Sets the proc id array. Owned by the caller. Must be at least the length of your size.

Examples:
SOP/SOP_PrimVOP.C.

Definition at line 106 of file CVEX_Context.h.

void CVEX_RunData::setTime ( fpreal  time)
inline

Set the evaluation time. This is what will be used by op: references triggered by VEX commands like volumesample. If not set, the current channel time is used instead (if an OP_Director is available).

Examples:
SOP/SOP_PrimVOP.C.

Definition at line 47 of file CVEX_Context.h.

void CVEX_RunData::setTimeDependent ( bool  v)
inline

Set as time dependent flag

Examples:
SOP/SOP_PrimVOP.C.

Definition at line 144 of file CVEX_Context.h.

void CVEX_RunData::setTimeSampleEncountered ( bool  v)
inline

Set flag indicating whether there are any time samples involved.

Definition at line 84 of file CVEX_Context.h.

void CVEX_RunData::setWorldNodeId ( int  id)
inline

The world id is the node which defines the transform space for the CWD. If it's not defined the object containing the CWD will be used (or the CWD if it's not part of an object network)

Definition at line 64 of file CVEX_Context.h.

fpreal CVEX_RunData::time ( ) const
inline

Accessors

Definition at line 141 of file CVEX_Context.h.

bool CVEX_RunData::timeDependent ( ) const
inline

Accessors

Definition at line 138 of file CVEX_Context.h.

bool CVEX_RunData::timeSpecified ( ) const
inline

Accessors

Definition at line 137 of file CVEX_Context.h.

int CVEX_RunData::worldId ( ) const
inline

Accessors

Definition at line 140 of file CVEX_Context.h.


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