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

Helper class for reading and writing FunctionName HDA section. More...

#include <OP_ScriptOperator.h>

Public Member Functions

bool readFile (const FS_IndexFile &file)
 Reads from and writes to a file. More...
 
void writeFile (FS_IndexFile &file) const
 Reads from and writes to a file. More...
 
void readBuffer (const char *str)
 Reads from and writes to a string buffer. More...
 
void writeBuffer (UT_WorkBuffer &str) const
 Reads from and writes to a string buffer. More...
 
void setMainFunctionName (const char *name)
 The name of the main (shader) function HDA represents. More...
 
const UT_StringHoldergetMainFunctionName () const
 The name of the main (shader) function HDA represents. More...
 
void setSecondaryFunctionsMap (const UT_StringMap< UT_StringHolder > &m)
 The dictionary of additional functions stored in HDA. More...
 
const UT_StringMap
< UT_StringHolder > & 
getSecondaryFunctionsMap () const
 The dictionary of additional functions stored in HDA. More...
 

Static Public Member Functions

static void getFunctionCodeSections (UT_StringArray &section_names, const FS_IndexFile &file)
 

Detailed Description

Helper class for reading and writing FunctionName HDA section.

Definition at line 299 of file OP_ScriptOperator.h.

Member Function Documentation

static void OP_FunctionNameInfo::getFunctionCodeSections ( UT_StringArray section_names,
const FS_IndexFile file 
)
static

Utility function to obtain the function code section names referenced by a function info section.

const UT_StringHolder& OP_FunctionNameInfo::getMainFunctionName ( ) const
inline

The name of the main (shader) function HDA represents.

Definition at line 315 of file OP_ScriptOperator.h.

const UT_StringMap<UT_StringHolder>& OP_FunctionNameInfo::getSecondaryFunctionsMap ( ) const
inline

The dictionary of additional functions stored in HDA.

Definition at line 322 of file OP_ScriptOperator.h.

void OP_FunctionNameInfo::readBuffer ( const char *  str)

Reads from and writes to a string buffer.

bool OP_FunctionNameInfo::readFile ( const FS_IndexFile file)

Reads from and writes to a file.

void OP_FunctionNameInfo::setMainFunctionName ( const char *  name)
inline

The name of the main (shader) function HDA represents.

Definition at line 313 of file OP_ScriptOperator.h.

void OP_FunctionNameInfo::setSecondaryFunctionsMap ( const UT_StringMap< UT_StringHolder > &  m)
inline

The dictionary of additional functions stored in HDA.

Definition at line 320 of file OP_ScriptOperator.h.

void OP_FunctionNameInfo::writeBuffer ( UT_WorkBuffer str) const

Reads from and writes to a string buffer.

void OP_FunctionNameInfo::writeFile ( FS_IndexFile file) const

Reads from and writes to a file.


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