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

#include <VOP_OperatorInfo.h>

+ Inheritance diagram for VOP_OperatorInfo:

Public Member Functions

 VOP_OperatorInfo ()
 
 ~VOP_OperatorInfo () override
 
const VOP_OperatorInfo & operator= (const VOP_OperatorInfo &other)
 
void setCode (const UT_String &code)
 
const UT_String & getCode () const
 
void setOuterCode (const UT_String &code)
 
const UT_String & getOuterCode () const
 
void setVopnetMask (const char *mask)
 
const UT_String & getVopnetMask () const
 
void setRenderMask (const char *mask)
 
const UT_String & getRenderMask () const
 
UT_ValArray< VOP_InOutInfo * > & getOutputInfos ()
 
const UT_ValArray
< VOP_InOutInfo * > & 		getOutputInfos () const
 
UT_ValArray< VOP_InOutInfo * > & getInputInfos ()
 
const UT_ValArray
< VOP_InOutInfo * > & 		getInputInfos () const
 
UT_StringArray & getInputSetNames ()
 
const UT_StringArray & getInputSetNames () const
 
UT_StringArray & getInputSetLabels ()
 
const UT_StringArray & getInputSetLabels () const
 
UT_StringArray & getInputSetScriptNames ()
 
const UT_StringArray & getInputSetScriptNames () const
 
bool & getForceCodeGeneration ()
 
const bool & getForceCodeGeneration () const
 
bool & getExternalShader ()
 
const bool & getExternalShader () const
 
VOP_Type getShaderType () const
 
void setShaderType (VOP_Type t)
 
void clearInOutInfo ()
 
void saveToDialogScript (std::ostream &os) const override
 
void updateExtraInfoBuffer (OP_ExtraInfoBuffer &b) const override
 
VOP_LanguageContextTypeList * newLanguageContextTypeList () const
 
bool hasExtraParameters () const
 Check if the code has extra parameters. More...
 
const UT_StringArray & getExtraParametersFormat () const
 Returns the extra parameters tokens parsed from the code string. More...
 
bool getHideInputsUsingParameterVisibleState () const
 Returns true if the scripted vop node uses the parameter visible state. More...
 
UT_StringHolder getParmNameFromInput (const char *input_name, int input_set_index) const
 
void getParmNameFromInput (UT_String &parm_name, const char *input_name, int input_set_index) const
 
void getParmNameFromInput (UT_WorkBuffer &parm_name, const char *input_name, int input_set_index) const
 
UT_StringHolder getInputNameFromParm (const UT_StringRef &parm_name) const
 
UT_StringHolder getInputSetNameFromParm (const UT_StringRef &parm_name) const
 
- Public Member Functions inherited from OP_SpecificData
 OP_SpecificData ()
 
virtual ~OP_SpecificData ()
 

Static Protected Member Functions

static void saveInOutInfoToDialogScript (std::ostream &os, const UT_ValArray< VOP_InOutInfo * > &infoarray, const char *infotype)
 
static void saveInputFlags (std::ostream &os, const UT_ValArray< VOP_InOutInfo * > &inoutarray, const char *token, bool only_nonzero_flags)
 

Detailed Description

Definition at line 156 of file VOP_OperatorInfo.h.

Constructor & Destructor Documentation

VOP_OperatorInfo::VOP_OperatorInfo ( )
VOP_OperatorInfo::~VOP_OperatorInfo ( )
override

Member Function Documentation

void VOP_OperatorInfo::clearInOutInfo ( )
const UT_String& VOP_OperatorInfo::getCode ( ) const
inline

Definition at line 165 of file VOP_OperatorInfo.h.

bool& VOP_OperatorInfo::getExternalShader ( )
inline

Definition at line 200 of file VOP_OperatorInfo.h.

const bool& VOP_OperatorInfo::getExternalShader ( ) const
inline

Definition at line 202 of file VOP_OperatorInfo.h.

const UT_StringArray& VOP_OperatorInfo::getExtraParametersFormat ( ) const
inline

Returns the extra parameters tokens parsed from the code string.

Definition at line 242 of file VOP_OperatorInfo.h.

bool& VOP_OperatorInfo::getForceCodeGeneration ( )
inline

Definition at line 196 of file VOP_OperatorInfo.h.

const bool& VOP_OperatorInfo::getForceCodeGeneration ( ) const
inline

Definition at line 198 of file VOP_OperatorInfo.h.

bool VOP_OperatorInfo::getHideInputsUsingParameterVisibleState ( ) const
inline

Returns true if the scripted vop node uses the parameter visible state.

Definition at line 249 of file VOP_OperatorInfo.h.

UT_ValArray<VOP_InOutInfo *>& VOP_OperatorInfo::getInputInfos ( )
inline

Definition at line 180 of file VOP_OperatorInfo.h.

const UT_ValArray<VOP_InOutInfo *>& VOP_OperatorInfo::getInputInfos ( ) const
inline

Definition at line 182 of file VOP_OperatorInfo.h.

UT_StringHolder VOP_OperatorInfo::getInputNameFromParm ( const UT_StringRef &  parm_name) const

Returns an input and a signature names, given parameter name, considering the available signatures in this class.

UT_StringArray& VOP_OperatorInfo::getInputSetLabels ( )
inline

Definition at line 188 of file VOP_OperatorInfo.h.

const UT_StringArray& VOP_OperatorInfo::getInputSetLabels ( ) const
inline

Definition at line 190 of file VOP_OperatorInfo.h.

UT_StringHolder VOP_OperatorInfo::getInputSetNameFromParm ( const UT_StringRef &  parm_name) const

Returns an input and a signature names, given parameter name, considering the available signatures in this class.

UT_StringArray& VOP_OperatorInfo::getInputSetNames ( )
inline

Definition at line 184 of file VOP_OperatorInfo.h.

const UT_StringArray& VOP_OperatorInfo::getInputSetNames ( ) const
inline

Definition at line 186 of file VOP_OperatorInfo.h.

UT_StringArray& VOP_OperatorInfo::getInputSetScriptNames ( )
inline

Definition at line 192 of file VOP_OperatorInfo.h.

const UT_StringArray& VOP_OperatorInfo::getInputSetScriptNames ( ) const
inline

Definition at line 194 of file VOP_OperatorInfo.h.

const UT_String& VOP_OperatorInfo::getOuterCode ( ) const
inline

Definition at line 168 of file VOP_OperatorInfo.h.

UT_ValArray<VOP_InOutInfo *>& VOP_OperatorInfo::getOutputInfos ( )
inline

Definition at line 176 of file VOP_OperatorInfo.h.

const UT_ValArray<VOP_InOutInfo *>& VOP_OperatorInfo::getOutputInfos ( ) const
inline

Definition at line 178 of file VOP_OperatorInfo.h.

UT_StringHolder VOP_OperatorInfo::getParmNameFromInput ( const char *  input_name,
int  input_set_index 
) const

Obtains a name of a node parameter that corresponds to a given input name when the node uses the given signature.

void VOP_OperatorInfo::getParmNameFromInput ( UT_String &  parm_name,
const char *  input_name,
int  input_set_index 
) const

Obtains a name of a node parameter that corresponds to a given input name when the node uses the given signature.

void VOP_OperatorInfo::getParmNameFromInput ( UT_WorkBuffer &  parm_name,
const char *  input_name,
int  input_set_index 
) const

Obtains a name of a node parameter that corresponds to a given input name when the node uses the given signature.

const UT_String& VOP_OperatorInfo::getRenderMask ( ) const
inline

Definition at line 174 of file VOP_OperatorInfo.h.

VOP_Type VOP_OperatorInfo::getShaderType ( ) const
inline

Definition at line 204 of file VOP_OperatorInfo.h.

const UT_String& VOP_OperatorInfo::getVopnetMask ( ) const
inline

Definition at line 171 of file VOP_OperatorInfo.h.

bool VOP_OperatorInfo::hasExtraParameters ( ) const
inline

Check if the code has extra parameters.

Definition at line 238 of file VOP_OperatorInfo.h.

VOP_LanguageContextTypeList* VOP_OperatorInfo::newLanguageContextTypeList ( ) const

Returns a new language context object based on this operator info. Caller is responsible for deleting the returned object.

const VOP_OperatorInfo& VOP_OperatorInfo::operator= ( const VOP_OperatorInfo &  other)
static void VOP_OperatorInfo::saveInOutInfoToDialogScript ( std::ostream &  os,
const UT_ValArray< VOP_InOutInfo * > &  infoarray,
const char *  infotype 
)
staticprotected
static void VOP_OperatorInfo::saveInputFlags ( std::ostream &  os,
const UT_ValArray< VOP_InOutInfo * > &  inoutarray,
const char *  token,
bool  only_nonzero_flags 
)
staticprotected
void VOP_OperatorInfo::saveToDialogScript ( std::ostream &  os) const
overridevirtual

Implements OP_SpecificData.

void VOP_OperatorInfo::setCode ( const UT_String &  code)
void VOP_OperatorInfo::setOuterCode ( const UT_String &  code)
void VOP_OperatorInfo::setRenderMask ( const char *  mask)
void VOP_OperatorInfo::setShaderType ( VOP_Type  t)
inline

Definition at line 206 of file VOP_OperatorInfo.h.

void VOP_OperatorInfo::setVopnetMask ( const char *  mask)
void VOP_OperatorInfo::updateExtraInfoBuffer ( OP_ExtraInfoBuffer &  b) const
overridevirtual

Reimplemented from OP_SpecificData.

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