VEX_VexResolver Class Reference

#include <VEX_VexResolver.h>

Inheritance diagram for VEX_VexResolver:

VOP_CodeVexResolver

List of all members.

Static Public Member Functions

static bool needsVexResolver (const char *shader)
static bool needsVexResolverForMantraOutput (const char *shader)
static bool getVflCode (const char *shader, ostream &os, const char *shadername=0)
static bool getVexCode (const char *shader, ostream &os, const char *shadername=0)
static bool getVexContext (const char *shader, UT_String &ctx)
static bool convertToCanonicalPath (const char *shader, UT_String &canonical_shader)

Protected Member Functions

 VEX_VexResolver ()
virtual ~VEX_VexResolver ()
virtual bool canResolveCode (const char *shader)=0
virtual bool supportedByMantra ()=0
virtual bool resolveVflCode (const char *shader, ostream &os, const char *shadername)=0
virtual bool resolveVexCode (const char *shader, ostream &os, const char *shadername)=0
virtual bool resolveVexContext (const char *shader, UT_String &ctx)=0
virtual bool resolveCanonicalPath (const char *shader, UT_String &canonical_shader)=0


Detailed Description

Definition at line 33 of file VEX_VexResolver.h.


Constructor & Destructor Documentation

VEX_VexResolver::VEX_VexResolver (  )  [protected]

virtual VEX_VexResolver::~VEX_VexResolver (  )  [protected, virtual]


Member Function Documentation

virtual bool VEX_VexResolver::canResolveCode ( const char *  shader  )  [protected, pure virtual]

Implemented in VOP_CodeVexResolver.

static bool VEX_VexResolver::convertToCanonicalPath ( const char *  shader,
UT_String canonical_shader 
) [static]

Resolvers may support relative paths in the shader string. Sometimes, however, you'll want to use the shader string as an identifier. For example, you might want to cache the resolved result. To safely do so you'll need a canonical string with the relative paths resolved. This method performs this conversion, returning true and setting the output string only when some resolution had to be performed.

static bool VEX_VexResolver::getVexCode ( const char *  shader,
ostream &  os,
const char *  shadername = 0 
) [static]

static bool VEX_VexResolver::getVexContext ( const char *  shader,
UT_String ctx 
) [static]

static bool VEX_VexResolver::getVflCode ( const char *  shader,
ostream &  os,
const char *  shadername = 0 
) [static]

static bool VEX_VexResolver::needsVexResolver ( const char *  shader  )  [static]

static bool VEX_VexResolver::needsVexResolverForMantraOutput ( const char *  shader  )  [static]

virtual bool VEX_VexResolver::resolveCanonicalPath ( const char *  shader,
UT_String canonical_shader 
) [protected, pure virtual]

Implemented in VOP_CodeVexResolver.

virtual bool VEX_VexResolver::resolveVexCode ( const char *  shader,
ostream &  os,
const char *  shadername 
) [protected, pure virtual]

Implemented in VOP_CodeVexResolver.

virtual bool VEX_VexResolver::resolveVexContext ( const char *  shader,
UT_String ctx 
) [protected, pure virtual]

Implemented in VOP_CodeVexResolver.

virtual bool VEX_VexResolver::resolveVflCode ( const char *  shader,
ostream &  os,
const char *  shadername 
) [protected, pure virtual]

Implemented in VOP_CodeVexResolver.

virtual bool VEX_VexResolver::supportedByMantra (  )  [protected, pure virtual]

Implemented in VOP_CodeVexResolver.


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

Generated on Fri May 25 00:10:56 2012 for HDK by  doxygen 1.5.9