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

#include <PRM_SpareData.h>

Public Member Functions

 PRM_SpareData (const PRM_SpareArgs &args)
 
 PRM_SpareData (const PRM_SpareToken &pair)
 A single token value pair. More...
 
 PRM_SpareData ()
 
 ~PRM_SpareData ()
 
 PRM_SpareData (const PRM_SpareData &copy)
 
PRM_SpareData & operator= (const PRM_SpareData &copy)
 
uint entries () const
 
void clear ()
 
void mergeFrom (const PRM_SpareData &ref)
 
void copyFrom (const PRM_SpareData &ref)
 
bool containsAny (const PRM_SpareData &ref) const
 
bool containsAll (const PRM_SpareData &ref) const
 
const char * getValue (const UT_StringRef &token) const
 
void traverseConst (PRM_SpareCallback f) const
 
void traverseConst (PRM_SpareCallbackWithData f, void *data) const
 
void addTokenValue (const UT_StringHolder &token, const char *value)
 
void deleteTokenValue (const UT_StringRef &token)
 
void setCallbackData (const char *str)
 
const char * getCallbackData () const
 
void setCallbackLanguage (CH_ScriptLanguage language)
 
CH_ScriptLanguage getCallbackLanguage () const
 
void setRenderManType (const char *str)
 
const char * getRenderManType () const
 
void setOpFilter (const char *str)
 
const char * getOpFilter () const
 
void setOpRelative (const char *str)
 
const char * getOpRelative () const
 
void setUnquotedState ()
 
bool getUnquotedState () const
 
void setMultiStartOffset (int value)
 
int getMultiStartOffset () const
 
void setVisibleTabs (const UT_BitArray &values)
 
void getVisibleTabs (UT_BitArray &values) const
 
bool getVisibleTab (int tabidx) const
 
void setRampBasisDefault (const char *value)
 
const char * getRampBasisDefault () const
 
void setRampShowControlsDefault (bool value)
 
bool getRampShowControlsDefault () const
 
void setRampGrayscaleDefault (bool value)
 
bool getRampGrayscaleDefault () const
 
void setRampColorType (UT_ColorType color_type)
 
UT_ColorType getRampColorType () const
 
void setRampBasisVar (const char *value)
 
const char * getRampBasisVar () const
 
void setRampKeysVar (const char *value)
 
const char * getRampKeysVar () const
 
void setRampValuesVar (const char *value)
 
const char * getRampValuesVar () const
 
const char * getColorRampDefaultValue () const
 
const char * getFloatRampDefaultValue () const
 
void setRampDefaultFromParm (const PRM_Parm &ramp_parm)
 
void getRampDefaultToParm (PRM_Parm &ramp_parm) const
 
void setColorType (PRM_ColorType color_type)
 
PRM_ColorType getColorType () const
 
void setColorWheel (bool value)
 
bool getColorWheel () const
 
void setColorDynamic (bool value)
 
bool getColorDynamic () const
 
void setKeyValueDictKeyLabel (const char *label)
 
const char * getKeyValueDictKeyLabel () const
 
void setKeyValueDictValueLabel (const char *label)
 
const char * getKeyValueDictValueLabel () const
 
void setKeyValueDictUseChooser (bool use_chooser)
 
bool getKeyValueDictUseChooser () const
 
void setKeyValueDictChooserLabel (const char *label)
 
const char * getKeyValueDictChooserLabel () const
 
void setKeyValueDictChooserCallback (const char *label)
 
const char * getKeyValueDictChooserCallback () const
 
void setXCFMode (const char *value)
 
const char * getXCFMode () const
 
const char * getScriptAction () const
 
const char * getScriptActionHelp () const
 
const char * getScriptActionIcon () const
 
const char * getButtonIcon () const
 
bool getUseEditor () const
 
const char * getEditorLanguage () const
 
const char * getEditorLanguagePrologue () const
 
void getEditorLinesRange (int &lines_min, int &lines_max) const
 
bool getCookDependent () const
 
void setCookDependent (bool flag)
 
bool getCodeGenDependent () const
 
void setCodeGenDependent (bool flag)
 
int64 getMemoryUsage (bool inclusive) const
 
bool getHasVaryingDefault () const
 
void setHasVaryingDefault (bool f)
 
const char * getUsdPathType () const
 
const char * getUsdPathInput () const
 
const char * getSaveValue () const
 
void setSaveValue (bool flag)
 
const char * getLookValue () const
 
void setLookValue (const char *value)
 
const char * getLayoutHeightValue () const
 
void setLayoutHeightValue (const char *value)
 

Static Public Member Functions

static const char * getScriptCallbackToken ()
 
static const char * getScriptCallbackLanguageToken ()
 
static const char * getUnquotedStateToken ()
 
static const char * getRampBasisDefaultToken ()
 
static const char * getRampShowControlsDefaultToken ()
 
static const char * getRampGrayscaleDefaultToken ()
 
static const char * getRampColorTypeToken ()
 
static const char * getRampColorTypeValueToken (UT_ColorType color_type)
 
static const char * getRampBasisVarToken ()
 
static const char * getRampKeysVarToken ()
 
static const char * getRampValuesVarToken ()
 
static const char * getColorRampDefaultToken ()
 
static const char * getFloatRampDefaultToken ()
 
static const char * getColorTypeToken ()
 
static const char * getColorTypeValueToken (PRM_ColorType color_type)
 
static const char * getColorWheelToken ()
 
static const char * getColorDynamicToken ()
 
static const char * getKeyValueDictKeyLabelToken ()
 
static const char * getKeyValueDictValueLabelToken ()
 
static const char * getKeyValueDictUseChooserToken ()
 
static const char * getKeyValueDictChooserLabelToken ()
 
static const char * getKeyValueDictChooserCallbackToken ()
 
static int getEditorLinesRangeDefaultMin ()
 
static int getEditorLinesRangeDefaultMax ()
 
static const char * getXCFModeFloatValToken ()
 
static const char * getCookDependentToken ()
 
static const char * getCodeGenDependentToken ()
 
static const char * getOpFilterKeyFromName (const char *name)
 
static const char * getOpFilterKeyFromLabel (const char *name)
 
static const char * getOpFilterNameFromKey (const char *key)
 
static const char * getOpFilterLabelFromKey (const char *key)
 
static const char * getFileChooserPatternToken ()
 
static const char * getFileChooserModeToken ()
 
static const char * getFileChooserModeValRead ()
 
static const char * getFileChooserModeValWrite ()
 
static const char * getFileChooserModeValReadAndWrite ()
 
static const char * getScriptActionToken ()
 
static const char * getScriptActionHelpToken ()
 
static const char * getScriptActionIconToken ()
 
static const char * getButtonIconToken ()
 
static const char * getEditorToken ()
 
static const char * getEditorLanguageToken ()
 
static const char * getEditorLinesRangeToken ()
 
static const char * getParmVopVarToken ()
 
static const char * getShaderParmContextsToken ()
 
static const char * getOpPathKeywordsToken ()
 
static const char * getUnitsToken ()
 
static const char * getGroupTypeToken ()
 
static const char * getGroupDefaultToken ()
 
static const char * getVaryingDefaultToken ()
 
static const char * getUsdPathTypeToken ()
 
static const char * getUsdPathInputToken ()
 
static const char * getIsShaderParmToken ()
 
static const char * getForceParmValueToken ()
 
static const char * getSaveValueToken ()
 
static const char * getMayaComponentSelectionTypeToken ()
 
static const char * getLookToken ()
 
static const char * getLayoutHeightToken ()
 
static const char * getHeaderToggleToken ()
 
static const char * getHeaderParmToken ()
 
static const char * getHeaderLabelToken ()
 
static const char * getSliderToken ()
 
static const char * getSwitcherBaseToken ()
 
static const char * getImageAllowVideoToken ()
 
static bool isBuiltInToken (const UT_StringRef &token)
 
static void builtInTokens (UT_StringArray &tokens)
 Return a range of the built-in tags names. More...
 

Static Public Attributes

static PRM_SpareData objNetRef
 
static PRM_SpareData chNetRef
 
static PRM_SpareData ropNetRef
 
static PRM_SpareData objPath
 
static PRM_SpareData objGeometryPath
 
static PRM_SpareData objLightPath
 
static PRM_SpareData objBonePath
 
static PRM_SpareData objMusclePath
 
static PRM_SpareData objCameraPath
 
static PRM_SpareData dopPath
 
static PRM_SpareData sopPath
 
static PRM_SpareData popPath
 
static PRM_SpareData ropPath
 
static PRM_SpareData copPath
 
static PRM_SpareData cop2Path
 
static PRM_SpareData chopPath
 
static PRM_SpareData constraintsPath
 
static PRM_SpareData shopPath
 
static PRM_SpareData shopProperties
 
static PRM_SpareData shopMaterial
 
static PRM_SpareData shopSurface
 
static PRM_SpareData shopDisplacement
 
static PRM_SpareData shopSurfaceShadow
 
static PRM_SpareData shopBackground
 
static PRM_SpareData shopGeometry
 
static PRM_SpareData shopAtmosphere
 
static PRM_SpareData shopPhoton
 
static PRM_SpareData shopPhotonVolume
 
static PRM_SpareData shopContour
 
static PRM_SpareData shopLight
 
static PRM_SpareData shopEmitter
 
static PRM_SpareData shopLightShadow
 
static PRM_SpareData shopLens
 
static PRM_SpareData shopOutput
 
static PRM_SpareData shopContourStore
 
static PRM_SpareData shopContourContrast
 
static PRM_SpareData shopImage3d
 
static PRM_SpareData shopCVEX
 
static PRM_SpareData shopCoShader
 
static PRM_SpareData vopPath
 
static PRM_SpareData lopPath
 
static PRM_SpareData topPath
 
static PRM_SpareData topSchedulerPath
 
static PRM_SpareData topProcessorPath
 
static PRM_SpareData topPartitionerPath
 
static PRM_SpareData topMapperPath
 
static PRM_SpareData filterMaterial
 
static PRM_SpareData autoScope
 
static PRM_SpareData multiStartOffsetZero
 
static PRM_SpareData multiStartOffsetOne
 
static PRM_SpareData unitsLength
 
static PRM_SpareData unitsPerLength
 
static PRM_SpareData unitsPerArea
 
static PRM_SpareData unitsMass
 
static PRM_SpareData unitsPerMass
 
static PRM_SpareData unitsTime
 
static PRM_SpareData unitsPerTime
 
static PRM_SpareData unitsPerSquareTime
 
static PRM_SpareData unitsVelocity
 
static PRM_SpareData unitsAngVelocity
 
static PRM_SpareData unitsAcceleration
 
static PRM_SpareData unitsAngAcceleration
 
static PRM_SpareData unitsForce
 
static PRM_SpareData unitsForceDensity
 
static PRM_SpareData unitsImpulse
 
static PRM_SpareData unitsTorque
 
static PRM_SpareData unitsDrag
 
static PRM_SpareData unitsAngDrag
 
static PRM_SpareData unitsPressure
 
static PRM_SpareData unitsSpringConstant
 
static PRM_SpareData unitsLinearDensity
 
static PRM_SpareData unitsLinearDensityPerTime
 
static PRM_SpareData unitsLinearDensityPerSquareTime
 
static PRM_SpareData unitsAreaDensity
 
static PRM_SpareData unitsAreaDensityPerTime
 
static PRM_SpareData unitsAreaDensityPerSquareTime
 
static PRM_SpareData unitsDensity
 
static PRM_SpareData unitsDensityPerTime
 
static PRM_SpareData unitsDensityPerSquareTime
 
static PRM_SpareData unitsNone
 
static PRM_SpareData rampBasisDefault
 
static PRM_SpareData rampKeysDefault
 
static PRM_SpareData rampValuesDefault
 
static PRM_SpareData attribAccessR
 
static PRM_SpareData attribAccessW
 
static PRM_SpareData attribAccessRW
 
static PRM_SpareData connectorKindNone
 
static PRM_SpareData connectorKindIn
 
static PRM_SpareData connectorKindOut
 
static PRM_SpareData connectorKindInOut
 
static PRM_SpareData shaderIsShaderParm
 
static PRM_SpareData shaderIsNotShaderParm
 
static PRM_SpareData fileChooserModeRead
 
static PRM_SpareData fileChooserModeWrite
 
static PRM_SpareData fileChooserModeReadAndWrite
 
static PRM_SpareData imageAllowsVideo
 
static PRM_SpareData imageDisallowsVideo
 
static PRM_SpareData stringFloatXCF
 
static PRM_SpareData stringEditor
 
static PRM_SpareData stringEditorLangVex
 
static PRM_SpareData stringEditorLangPython
 
static PRM_SpareData stringEditorLangHScript
 
static PRM_SpareData stringEditorLangExpr
 
static PRM_SpareData stringEditorLangOpenCL
 
static PRM_SpareToken groupTypeSimpleToken
 
static PRM_SpareToken groupTypeCollapsibleToken
 
static PRM_SpareData groupTypeSimple
 
static PRM_SpareData groupTypeCollapsible
 
static PRM_SpareData groupTypeCollapsibleExpanded
 
static PRM_SpareData varyingDefault
 
static PRM_SpareToken usdPathTypePrim
 
static PRM_SpareToken usdPathTypePrimList
 
static PRM_SpareToken usdPathInputFirst
 
static PRM_SpareToken usdPathInputSecond
 
static PRM_SpareData saveValueAlways
 
static PRM_SpareData saveValueNever
 
static PRM_SpareData mayaComponentSelectionTypeVertex
 
static PRM_SpareData mayaComponentSelectionTypeEdge
 
static PRM_SpareData mayaComponentSelectionTypeFace
 
static PRM_SpareData mayaComponentSelectionTypeUV
 
static PRM_SpareData lookBlank
 
static PRM_SpareData lookClassic
 
static PRM_SpareData lookIcon
 
static PRM_SpareData lookHeading
 
static PRM_SpareData lookBlock
 
static PRM_SpareData lookTooltip
 
static PRM_SpareData layoutHeightSmall
 
static PRM_SpareData layoutHeightMedium
 
static PRM_SpareData layoutHeightLarge
 
static PRM_SpareData layoutLabelIgnoreTextWidth
 
static PRM_SpareData sliderSnapToInt
 
static PRM_SpareData sliderNone
 

Detailed Description

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

Definition at line 160 of file PRM_SpareData.h.

Constructor & Destructor Documentation

PRM_SpareData::PRM_SpareData ( const PRM_SpareArgs &  args)
explicit

The constructor for the PRM_SpareData should takes a variadic number of token/value pairs. For example: static PRM_SpareData(PRM_SpareArgs() << PRM_SpareToken("token1", "value1") << PRM_SpareToken("token2", "value2") ...);

PRM_SpareData::PRM_SpareData ( const PRM_SpareToken &  pair)
explicit

A single token value pair.

PRM_SpareData::PRM_SpareData ( )
PRM_SpareData::~PRM_SpareData ( )
PRM_SpareData::PRM_SpareData ( const PRM_SpareData &  copy)

Member Function Documentation

void PRM_SpareData::addTokenValue ( const UT_StringHolder &  token,
const char *  value 
)
static void PRM_SpareData::builtInTokens ( UT_StringArray &  tokens)
static

Return a range of the built-in tags names.

void PRM_SpareData::clear ( )
bool PRM_SpareData::containsAll ( const PRM_SpareData &  ref) const
bool PRM_SpareData::containsAny ( const PRM_SpareData &  ref) const
void PRM_SpareData::copyFrom ( const PRM_SpareData &  ref)
void PRM_SpareData::deleteTokenValue ( const UT_StringRef &  token)
uint PRM_SpareData::entries ( ) const
const char* PRM_SpareData::getButtonIcon ( ) const
static const char* PRM_SpareData::getButtonIconToken ( )
inlinestatic

Definition at line 551 of file PRM_SpareData.h.

const char* PRM_SpareData::getCallbackData ( ) const
inline

Definition at line 208 of file PRM_SpareData.h.

CH_ScriptLanguage PRM_SpareData::getCallbackLanguage ( ) const
bool PRM_SpareData::getCodeGenDependent ( ) const
static const char* PRM_SpareData::getCodeGenDependentToken ( )
inlinestatic

Definition at line 401 of file PRM_SpareData.h.

bool PRM_SpareData::getColorDynamic ( ) const
static const char* PRM_SpareData::getColorDynamicToken ( )
inlinestatic

Definition at line 338 of file PRM_SpareData.h.

static const char* PRM_SpareData::getColorRampDefaultToken ( )
inlinestatic

Definition at line 315 of file PRM_SpareData.h.

const char* PRM_SpareData::getColorRampDefaultValue ( ) const
inline

Definition at line 317 of file PRM_SpareData.h.

PRM_ColorType PRM_SpareData::getColorType ( ) const
static const char* PRM_SpareData::getColorTypeToken ( )
inlinestatic

Definition at line 327 of file PRM_SpareData.h.

static const char* PRM_SpareData::getColorTypeValueToken ( PRM_ColorType  color_type)
static
bool PRM_SpareData::getColorWheel ( ) const
static const char* PRM_SpareData::getColorWheelToken ( )
inlinestatic

Definition at line 333 of file PRM_SpareData.h.

bool PRM_SpareData::getCookDependent ( ) const
static const char* PRM_SpareData::getCookDependentToken ( )
inlinestatic

Definition at line 389 of file PRM_SpareData.h.

const char* PRM_SpareData::getEditorLanguage ( ) const
inline

The string will be treated as this language for syntax highlighting and and completion. NOTE: Language names are case insensitive, you should accept both VEX, Vex, and vex.

Definition at line 378 of file PRM_SpareData.h.

const char* PRM_SpareData::getEditorLanguagePrologue ( ) const
inline

Definition at line 380 of file PRM_SpareData.h.

static const char* PRM_SpareData::getEditorLanguageToken ( )
inlinestatic

Definition at line 558 of file PRM_SpareData.h.

void PRM_SpareData::getEditorLinesRange ( int &  lines_min,
int &  lines_max 
) const
static int PRM_SpareData::getEditorLinesRangeDefaultMax ( )
inlinestatic

Definition at line 384 of file PRM_SpareData.h.

static int PRM_SpareData::getEditorLinesRangeDefaultMin ( )
inlinestatic

Definition at line 383 of file PRM_SpareData.h.

static const char* PRM_SpareData::getEditorLinesRangeToken ( )
inlinestatic

Number of lines to show by default. This value can be set as either a single number or a range, e.g. '10-50'. The minimum number is what the editor will originally show up as, but will attempt to expand up to the maximum.

Definition at line 570 of file PRM_SpareData.h.

static const char* PRM_SpareData::getEditorToken ( )
inlinestatic

Definition at line 554 of file PRM_SpareData.h.

static const char* PRM_SpareData::getFileChooserModeToken ( )
inlinestatic

Definition at line 527 of file PRM_SpareData.h.

static const char* PRM_SpareData::getFileChooserModeValRead ( )
inlinestatic

Definition at line 529 of file PRM_SpareData.h.

static const char* PRM_SpareData::getFileChooserModeValReadAndWrite ( )
inlinestatic

Definition at line 533 of file PRM_SpareData.h.

static const char* PRM_SpareData::getFileChooserModeValWrite ( )
inlinestatic

Definition at line 531 of file PRM_SpareData.h.

static const char* PRM_SpareData::getFileChooserPatternToken ( )
inlinestatic

Used to set a space- or comma-separated list of globs to use as file filter for parameters of type PRM_FILE (e.g. "*.txt *.log").

Definition at line 524 of file PRM_SpareData.h.

static const char* PRM_SpareData::getFloatRampDefaultToken ( )
inlinestatic

Definition at line 319 of file PRM_SpareData.h.

const char* PRM_SpareData::getFloatRampDefaultValue ( ) const
inline

Definition at line 321 of file PRM_SpareData.h.

static const char* PRM_SpareData::getForceParmValueToken ( )
inlinestatic

Definition at line 636 of file PRM_SpareData.h.

static const char* PRM_SpareData::getGroupDefaultToken ( )
inlinestatic

Definition at line 602 of file PRM_SpareData.h.

static const char* PRM_SpareData::getGroupTypeToken ( )
inlinestatic

Definition at line 595 of file PRM_SpareData.h.

bool PRM_SpareData::getHasVaryingDefault ( ) const
static const char* PRM_SpareData::getHeaderLabelToken ( )
inlinestatic

Definition at line 687 of file PRM_SpareData.h.

static const char* PRM_SpareData::getHeaderParmToken ( )
inlinestatic

Definition at line 683 of file PRM_SpareData.h.

static const char* PRM_SpareData::getHeaderToggleToken ( )
inlinestatic

Definition at line 679 of file PRM_SpareData.h.

static const char* PRM_SpareData::getImageAllowVideoToken ( )
inlinestatic

Definition at line 701 of file PRM_SpareData.h.

static const char* PRM_SpareData::getIsShaderParmToken ( )
inlinestatic

Definition at line 632 of file PRM_SpareData.h.

const char* PRM_SpareData::getKeyValueDictChooserCallback ( ) const
static const char* PRM_SpareData::getKeyValueDictChooserCallbackToken ( )
inlinestatic

Definition at line 359 of file PRM_SpareData.h.

const char* PRM_SpareData::getKeyValueDictChooserLabel ( ) const
static const char* PRM_SpareData::getKeyValueDictChooserLabelToken ( )
inlinestatic

Definition at line 355 of file PRM_SpareData.h.

const char* PRM_SpareData::getKeyValueDictKeyLabel ( ) const
static const char* PRM_SpareData::getKeyValueDictKeyLabelToken ( )
inlinestatic

Definition at line 343 of file PRM_SpareData.h.

bool PRM_SpareData::getKeyValueDictUseChooser ( ) const
static const char* PRM_SpareData::getKeyValueDictUseChooserToken ( )
inlinestatic

Definition at line 351 of file PRM_SpareData.h.

const char* PRM_SpareData::getKeyValueDictValueLabel ( ) const
static const char* PRM_SpareData::getKeyValueDictValueLabelToken ( )
inlinestatic

Definition at line 347 of file PRM_SpareData.h.

static const char* PRM_SpareData::getLayoutHeightToken ( )
inlinestatic

Definition at line 660 of file PRM_SpareData.h.

const char* PRM_SpareData::getLayoutHeightValue ( ) const
static const char* PRM_SpareData::getLookToken ( )
inlinestatic

Definition at line 658 of file PRM_SpareData.h.

const char* PRM_SpareData::getLookValue ( ) const
static const char* PRM_SpareData::getMayaComponentSelectionTypeToken ( )
inlinestatic

Definition at line 649 of file PRM_SpareData.h.

int64 PRM_SpareData::getMemoryUsage ( bool  inclusive) const
int PRM_SpareData::getMultiStartOffset ( ) const
const char* PRM_SpareData::getOpFilter ( ) const
inline

Definition at line 223 of file PRM_SpareData.h.

static const char* PRM_SpareData::getOpFilterKeyFromLabel ( const char *  name)
static
static const char* PRM_SpareData::getOpFilterKeyFromName ( const char *  name)
static
static const char* PRM_SpareData::getOpFilterLabelFromKey ( const char *  key)
static
static const char* PRM_SpareData::getOpFilterNameFromKey ( const char *  key)
static
static const char* PRM_SpareData::getOpPathKeywordsToken ( )
inlinestatic

Definition at line 587 of file PRM_SpareData.h.

const char* PRM_SpareData::getOpRelative ( ) const
inline

Definition at line 228 of file PRM_SpareData.h.

static const char* PRM_SpareData::getParmVopVarToken ( )
inlinestatic

Definition at line 575 of file PRM_SpareData.h.

const char* PRM_SpareData::getRampBasisDefault ( ) const
inline

Definition at line 250 of file PRM_SpareData.h.

static const char* PRM_SpareData::getRampBasisDefaultToken ( )
inlinestatic

Definition at line 246 of file PRM_SpareData.h.

const char* PRM_SpareData::getRampBasisVar ( ) const
inline

Definition at line 304 of file PRM_SpareData.h.

static const char* PRM_SpareData::getRampBasisVarToken ( )
inlinestatic

Definition at line 295 of file PRM_SpareData.h.

UT_ColorType PRM_SpareData::getRampColorType ( ) const
static const char* PRM_SpareData::getRampColorTypeToken ( )
inlinestatic

Definition at line 289 of file PRM_SpareData.h.

static const char* PRM_SpareData::getRampColorTypeValueToken ( UT_ColorType  color_type)
static
void PRM_SpareData::getRampDefaultToParm ( PRM_Parm &  ramp_parm) const
bool PRM_SpareData::getRampGrayscaleDefault ( ) const
inline

Definition at line 278 of file PRM_SpareData.h.

static const char* PRM_SpareData::getRampGrayscaleDefaultToken ( )
inlinestatic

Definition at line 271 of file PRM_SpareData.h.

const char* PRM_SpareData::getRampKeysVar ( ) const
inline

Definition at line 308 of file PRM_SpareData.h.

static const char* PRM_SpareData::getRampKeysVarToken ( )
inlinestatic

Definition at line 297 of file PRM_SpareData.h.

bool PRM_SpareData::getRampShowControlsDefault ( ) const
inline

Definition at line 260 of file PRM_SpareData.h.

static const char* PRM_SpareData::getRampShowControlsDefaultToken ( )
inlinestatic

Definition at line 253 of file PRM_SpareData.h.

const char* PRM_SpareData::getRampValuesVar ( ) const
inline

Definition at line 312 of file PRM_SpareData.h.

static const char* PRM_SpareData::getRampValuesVarToken ( )
inlinestatic

Definition at line 299 of file PRM_SpareData.h.

const char* PRM_SpareData::getRenderManType ( ) const
inline

Definition at line 218 of file PRM_SpareData.h.

const char* PRM_SpareData::getSaveValue ( ) const
static const char* PRM_SpareData::getSaveValueToken ( )
inlinestatic

Definition at line 640 of file PRM_SpareData.h.

const char* PRM_SpareData::getScriptAction ( ) const
const char* PRM_SpareData::getScriptActionHelp ( ) const
static const char* PRM_SpareData::getScriptActionHelpToken ( )
inlinestatic

Definition at line 547 of file PRM_SpareData.h.

const char* PRM_SpareData::getScriptActionIcon ( ) const
static const char* PRM_SpareData::getScriptActionIconToken ( )
inlinestatic

Definition at line 549 of file PRM_SpareData.h.

static const char* PRM_SpareData::getScriptActionToken ( )
inlinestatic

Definition at line 545 of file PRM_SpareData.h.

static const char* PRM_SpareData::getScriptCallbackLanguageToken ( )
inlinestatic

Definition at line 211 of file PRM_SpareData.h.

static const char* PRM_SpareData::getScriptCallbackToken ( )
inlinestatic

Definition at line 204 of file PRM_SpareData.h.

static const char* PRM_SpareData::getShaderParmContextsToken ( )
inlinestatic

Definition at line 582 of file PRM_SpareData.h.

static const char* PRM_SpareData::getSliderToken ( )
inlinestatic

Definition at line 691 of file PRM_SpareData.h.

static const char* PRM_SpareData::getSwitcherBaseToken ( )
inlinestatic

Definition at line 697 of file PRM_SpareData.h.

static const char* PRM_SpareData::getUnitsToken ( )
inlinestatic

Definition at line 591 of file PRM_SpareData.h.

bool PRM_SpareData::getUnquotedState ( ) const
inline

Definition at line 235 of file PRM_SpareData.h.

static const char* PRM_SpareData::getUnquotedStateToken ( )
inlinestatic

Definition at line 231 of file PRM_SpareData.h.

const char* PRM_SpareData::getUsdPathInput ( ) const
static const char* PRM_SpareData::getUsdPathInputToken ( )
inlinestatic

Definition at line 625 of file PRM_SpareData.h.

const char* PRM_SpareData::getUsdPathType ( ) const
static const char* PRM_SpareData::getUsdPathTypeToken ( )
inlinestatic

Definition at line 615 of file PRM_SpareData.h.

bool PRM_SpareData::getUseEditor ( ) const
const char* PRM_SpareData::getValue ( const UT_StringRef &  token) const
static const char* PRM_SpareData::getVaryingDefaultToken ( )
inlinestatic

Definition at line 607 of file PRM_SpareData.h.

bool PRM_SpareData::getVisibleTab ( int  tabidx) const
void PRM_SpareData::getVisibleTabs ( UT_BitArray &  values) const
const char* PRM_SpareData::getXCFMode ( ) const
inline

Definition at line 366 of file PRM_SpareData.h.

static const char* PRM_SpareData::getXCFModeFloatValToken ( )
inlinestatic

Definition at line 386 of file PRM_SpareData.h.

static bool PRM_SpareData::isBuiltInToken ( const UT_StringRef &  token)
static

Return true if the given token is a built-in (internally used) spare data token.

void PRM_SpareData::mergeFrom ( const PRM_SpareData &  ref)
PRM_SpareData& PRM_SpareData::operator= ( const PRM_SpareData &  copy)
void PRM_SpareData::setCallbackData ( const char *  str)
inline

Definition at line 206 of file PRM_SpareData.h.

void PRM_SpareData::setCallbackLanguage ( CH_ScriptLanguage  language)
void PRM_SpareData::setCodeGenDependent ( bool  flag)
void PRM_SpareData::setColorDynamic ( bool  value)
void PRM_SpareData::setColorType ( PRM_ColorType  color_type)
void PRM_SpareData::setColorWheel ( bool  value)
void PRM_SpareData::setCookDependent ( bool  flag)
void PRM_SpareData::setHasVaryingDefault ( bool  f)
void PRM_SpareData::setKeyValueDictChooserCallback ( const char *  label)
void PRM_SpareData::setKeyValueDictChooserLabel ( const char *  label)
void PRM_SpareData::setKeyValueDictKeyLabel ( const char *  label)
void PRM_SpareData::setKeyValueDictUseChooser ( bool  use_chooser)
void PRM_SpareData::setKeyValueDictValueLabel ( const char *  label)
void PRM_SpareData::setLayoutHeightValue ( const char *  value)
void PRM_SpareData::setLookValue ( const char *  value)
void PRM_SpareData::setMultiStartOffset ( int  value)
void PRM_SpareData::setOpFilter ( const char *  str)
inline

Definition at line 221 of file PRM_SpareData.h.

void PRM_SpareData::setOpRelative ( const char *  str)
inline

Definition at line 226 of file PRM_SpareData.h.

void PRM_SpareData::setRampBasisDefault ( const char *  value)
inline

Definition at line 248 of file PRM_SpareData.h.

void PRM_SpareData::setRampBasisVar ( const char *  value)
inline

Definition at line 302 of file PRM_SpareData.h.

void PRM_SpareData::setRampColorType ( UT_ColorType  color_type)
void PRM_SpareData::setRampDefaultFromParm ( const PRM_Parm &  ramp_parm)
void PRM_SpareData::setRampGrayscaleDefault ( bool  value)
inline

Definition at line 273 of file PRM_SpareData.h.

void PRM_SpareData::setRampKeysVar ( const char *  value)
inline

Definition at line 306 of file PRM_SpareData.h.

void PRM_SpareData::setRampShowControlsDefault ( bool  value)
inline

Definition at line 255 of file PRM_SpareData.h.

void PRM_SpareData::setRampValuesVar ( const char *  value)
inline

Definition at line 310 of file PRM_SpareData.h.

void PRM_SpareData::setRenderManType ( const char *  str)
inline

Definition at line 216 of file PRM_SpareData.h.

void PRM_SpareData::setSaveValue ( bool  flag)
void PRM_SpareData::setUnquotedState ( )
inline

Definition at line 233 of file PRM_SpareData.h.

void PRM_SpareData::setVisibleTabs ( const UT_BitArray &  values)
void PRM_SpareData::setXCFMode ( const char *  value)
inline

Definition at line 364 of file PRM_SpareData.h.

void PRM_SpareData::traverseConst ( PRM_SpareCallback  f) const
void PRM_SpareData::traverseConst ( PRM_SpareCallbackWithData  f,
void *  data 
) const

Member Data Documentation

PRM_SpareData PRM_SpareData::attribAccessR
static

Definition at line 510 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::attribAccessRW
static

Definition at line 512 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::attribAccessW
static

Definition at line 511 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::autoScope
static

Definition at line 470 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::chNetRef
static

Definition at line 422 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::chopPath
static

Definition at line 437 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::connectorKindIn
static

Definition at line 515 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::connectorKindInOut
static

Definition at line 517 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::connectorKindNone
static

Definition at line 514 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::connectorKindOut
static

Definition at line 516 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::constraintsPath
static

Definition at line 438 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::cop2Path
static
Examples:
SOP/SOP_CopRaster.C.

Definition at line 436 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::copPath
static

Definition at line 435 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::dopPath
static

Definition at line 431 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::fileChooserModeRead
static
Examples:
SOP/SOP_CopRaster.C.

Definition at line 536 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::fileChooserModeReadAndWrite
static

Definition at line 538 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::fileChooserModeWrite
static
Examples:
field3d/ROP_Field3D.C.

Definition at line 537 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::filterMaterial
static

Definition at line 468 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::groupTypeCollapsible
static

Definition at line 600 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::groupTypeCollapsibleExpanded
static

Definition at line 601 of file PRM_SpareData.h.

PRM_SpareToken PRM_SpareData::groupTypeCollapsibleToken
static

Definition at line 598 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::groupTypeSimple
static

Definition at line 599 of file PRM_SpareData.h.

PRM_SpareToken PRM_SpareData::groupTypeSimpleToken
static

Definition at line 597 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::imageAllowsVideo
static

Definition at line 540 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::imageDisallowsVideo
static

Definition at line 541 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::layoutHeightLarge
static

Definition at line 675 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::layoutHeightMedium
static

Definition at line 674 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::layoutHeightSmall
static

Definition at line 673 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::layoutLabelIgnoreTextWidth
static

Definition at line 676 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::lookBlank
static

Definition at line 667 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::lookBlock
static

Definition at line 671 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::lookClassic
static

Definition at line 668 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::lookHeading
static

Definition at line 670 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::lookIcon
static

Definition at line 669 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::lookTooltip
static

Definition at line 672 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::lopPath
static

Definition at line 462 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::mayaComponentSelectionTypeEdge
static

Definition at line 652 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::mayaComponentSelectionTypeFace
static

Definition at line 653 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::mayaComponentSelectionTypeUV
static

Definition at line 654 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::mayaComponentSelectionTypeVertex
static

Definition at line 651 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::multiStartOffsetOne
static

Definition at line 473 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::multiStartOffsetZero
static
Examples:
VOP/VOP_CustomContext.C.

Definition at line 472 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::objBonePath
static

Definition at line 428 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::objCameraPath
static

Definition at line 430 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::objGeometryPath
static

Definition at line 426 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::objLightPath
static

Definition at line 427 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::objMusclePath
static

Definition at line 429 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::objNetRef
static

Definition at line 421 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::objPath
static
Examples:
SOP/SOP_HDKObject.C.

Definition at line 425 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::popPath
static

Definition at line 433 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::rampBasisDefault
static

Definition at line 506 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::rampKeysDefault
static

Definition at line 507 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::rampValuesDefault
static

Definition at line 508 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::ropNetRef
static

Definition at line 423 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::ropPath
static

Definition at line 434 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::saveValueAlways
static

Definition at line 642 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::saveValueNever
static

Definition at line 643 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shaderIsNotShaderParm
static

Definition at line 520 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shaderIsShaderParm
static

Definition at line 519 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopAtmosphere
static

Definition at line 447 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopBackground
static

Definition at line 445 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopContour
static

Definition at line 450 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopContourContrast
static

Definition at line 457 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopContourStore
static

Definition at line 456 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopCoShader
static

Definition at line 460 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopCVEX
static
Examples:
SOP/SOP_PrimVOP.C.

Definition at line 459 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopDisplacement
static

Definition at line 443 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopEmitter
static

Definition at line 452 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopGeometry
static

Definition at line 446 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopImage3d
static

Definition at line 458 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopLens
static

Definition at line 454 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopLight
static

Definition at line 451 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopLightShadow
static

Definition at line 453 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopMaterial
static

Definition at line 441 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopOutput
static

Definition at line 455 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopPath
static

Definition at line 439 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopPhoton
static

Definition at line 448 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopPhotonVolume
static

Definition at line 449 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopProperties
static

Definition at line 440 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopSurface
static

Definition at line 442 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::shopSurfaceShadow
static

Definition at line 444 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::sliderNone
static

Definition at line 694 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::sliderSnapToInt
static

Definition at line 693 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::sopPath
static
Examples:
field3d/ROP_Field3D.C, and SOP/SOP_HDKObject.C.

Definition at line 432 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::stringEditor
static

Definition at line 556 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::stringEditorLangExpr
static

Definition at line 563 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::stringEditorLangHScript
static

Definition at line 562 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::stringEditorLangOpenCL
static

Definition at line 564 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::stringEditorLangPython
static

Definition at line 561 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::stringEditorLangVex
static

Definition at line 560 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::stringFloatXCF
static

Definition at line 543 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::topMapperPath
static

Definition at line 467 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::topPartitionerPath
static

Definition at line 466 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::topPath
static

Definition at line 463 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::topProcessorPath
static

Definition at line 465 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::topSchedulerPath
static

Definition at line 464 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsAcceleration
static

Definition at line 485 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsAngAcceleration
static

Definition at line 486 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsAngDrag
static

Definition at line 492 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsAngVelocity
static

Definition at line 484 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsAreaDensity
static

Definition at line 498 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsAreaDensityPerSquareTime
static

Definition at line 500 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsAreaDensityPerTime
static

Definition at line 499 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsDensity
static

Definition at line 501 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsDensityPerSquareTime
static

Definition at line 503 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsDensityPerTime
static

Definition at line 502 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsDrag
static

Definition at line 491 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsForce
static

Definition at line 487 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsForceDensity
static

Definition at line 488 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsImpulse
static

Definition at line 489 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsLength
static
Examples:
SIM/GAS_NetVDBSliceExchange.C.

Definition at line 475 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsLinearDensity
static

Definition at line 495 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsLinearDensityPerSquareTime
static

Definition at line 497 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsLinearDensityPerTime
static

Definition at line 496 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsMass
static

Definition at line 478 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsNone
static

Definition at line 504 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsPerArea
static

Definition at line 477 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsPerLength
static

Definition at line 476 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsPerMass
static

Definition at line 479 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsPerSquareTime
static

Definition at line 482 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsPerTime
static

Definition at line 481 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsPressure
static

Definition at line 493 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsSpringConstant
static

Definition at line 494 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsTime
static

Definition at line 480 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsTorque
static

Definition at line 490 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::unitsVelocity
static

Definition at line 483 of file PRM_SpareData.h.

PRM_SpareToken PRM_SpareData::usdPathInputFirst
static

Definition at line 627 of file PRM_SpareData.h.

PRM_SpareToken PRM_SpareData::usdPathInputSecond
static

Definition at line 628 of file PRM_SpareData.h.

PRM_SpareToken PRM_SpareData::usdPathTypePrim
static

Definition at line 617 of file PRM_SpareData.h.

PRM_SpareToken PRM_SpareData::usdPathTypePrimList
static

Definition at line 618 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::varyingDefault
static

Definition at line 609 of file PRM_SpareData.h.

PRM_SpareData PRM_SpareData::vopPath
static

Definition at line 461 of file PRM_SpareData.h.

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