HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
LOP_PRMShared.h File Reference
#include "LOP_API.h"
#include <OP/OP_Error.h>
#include <PRM/PRM_ChoiceList.h>
#include <PRM/PRM_Default.h>
#include <PRM/PRM_Name.h>
#include <PRM/PRM_SpareData.h>
#include <PRM/PRM_Template.h>
#include <UT/UT_BoundingBox.h>
#include <UT/UT_Matrix4.h>
+ Include dependency graph for LOP_PRMShared.h:

Go to the source code of this file.

Classes

class  LOP_XformComponents
 
class  LOP_CustomDataParmSet
 
class  LOP_CollectionParmSet
 

Typedefs

typedef UT_Array
< LOP_CustomDataParmSet
LOP_CustomDataParms
 
typedef UT_Array
< LOP_CollectionParmSet
LOP_CollectionParms
 

Enumerations

enum  LOP_XformParms {
  LOP_XFORM_TRS, LOP_XFORM_RXYZ, LOP_XFORM_T, LOP_XFORM_R,
  LOP_XFORM_S, LOP_XFORM_SHEAR, LOP_XFORM_USCALE, LOP_XFORM_PIVOTCONTAINER,
  LOP_XFORM_PIVOT, LOP_XFORM_PIVOTROT
}
 

Functions

LOP_API void lopBuildUsdPrimVariantSetsMenu (LOP_Node &node, int which_input, const UT_String &primpattern, PRM_Name *menu_entries, int max_menu_entries)
 
LOP_API void lopBuildUsdPrimVariantsMenu (LOP_Node &node, int which_input, const UT_String &primpattern, const UT_String &variantset, PRM_Name *menu_entries, int max_menu_entries)
 
LOP_API void lopBuildUsdExpansionRulesMenu (void *, PRM_Name *menu_entries, int max_menu_entries, const PRM_SpareData *, const PRM_Parm *)
 
LOP_API const PRM_TemplatelopXformTemplates ()
 
LOP_API const PRM_TemplatelopMultiparmXformTemplates ()
 
LOP_API UT_Matrix4D lopBuildXform (OP_Node &node, fpreal t, LOP_XformComponents *accumulate=nullptr)
 
LOP_API UT_Matrix4D lopBuildMultiparmXform (OP_Node &node, int inst, fpreal t, LOP_XformComponents *accumulate=nullptr)
 
LOP_API const PRM_TemplatelopCustomDataTemplate ()
 
LOP_API void lopGetCustomDataParms (LOP_Node &node, fpreal t, LOP_CustomDataParms &custom_data_parms)
 
LOP_API void lopSetCustomData (LOP_Node &node, const LOP_CustomDataParms &custom_data_parms, const HUSD_EditCustomData &edit_data, const HUSD_FindPrims *find_prims=nullptr, const HUSD_FindProps *find_props=nullptr)
 
LOP_API const PRM_TemplatelopContextOptionsTemplate ()
 
LOP_API bool lopSetContextOptions (OP_Node &node, OP_Context &context, OP_ContextOptionsWriteScope &options)
 
LOP_API const PRM_TemplatelopTimeBasedContextOptionsTemplate ()
 
LOP_API bool lopSetTimeBasedContextOptions (OP_Node &node, OP_Context &context, OP_ContextOptionsWriteScope &options)
 
LOP_API const PRM_TemplatelopPatternMatchingContextOptionsTemplate ()
 
LOP_API bool lopSetPatternMatchingContextOptions (OP_Node &node, OP_Context &context, OP_ContextOptionsWriteScope &options)
 
LOP_API PRM_Template lopCollectionCollapserParmTemplate (PRM_Name &collapser_parm_name)
 
LOP_API PRM_Template lopCollectionParmTemplate (PRM_Name &collection_parm_name, const char *multiparm_prefix=nullptr)
 
LOP_API void lopGetCollectionParms (LOP_Node &node, const PRM_Template &collection_parm_template, fpreal t, LOP_CollectionParms &collection_parms)
 
LOP_API bool lopGetCollection (LOP_Node &node, const LOP_CollectionParms &collection_parms, fpreal t, HUSD_FindPrims &findprims)
 
LOP_API OP_ERROR lopCheckForMissingFile (LOP_Node &node, HUSD_AutoAnyLock &lock, const UT_StringRef &filepath, const UT_StringRef &handle_missing_files, bool *skip_this_file)
 

Variables

LOP_API const UT_StringHolder lopAttrControlNoneToken
 
LOP_API const UT_StringHolder lopAttrControlSetToken
 
LOP_API const UT_StringHolder lopAttrControlAddToken
 
LOP_API const UT_StringHolder lopAttrControlMultiplyToken
 
LOP_API const UT_StringHolder lopAttrControlSetExistingToken
 
LOP_API const UT_StringHolder lopAttrControlBlockToken
 
LOP_API PRM_Name lopResolverContextAssetPathName
 
LOP_API PRM_Name lopPrimPatternName
 
LOP_API PRM_Name lopPathName
 
LOP_API PRM_Name lopPrimPathName
 
LOP_API PRM_Name lopPropPatternName
 
LOP_API PRM_Name lopPrimKindName
 
LOP_API PRM_Name lopPrimCountName
 
LOP_API PRM_Name lopParentPrimTypeName
 
LOP_API PRM_Name lopCollectionCollapserName
 
LOP_API PRM_Name lopCollectionName
 
LOP_API PRM_Name lopHandleMissingFilesName
 
LOP_API PRM_Name lopLookAtEnableName
 
LOP_API PRM_Name lopLookAtPrimName
 
LOP_API PRM_Name lopLookAtPrimPositionName
 
LOP_API PRM_Name lopLookAtPrimRotationName
 
LOP_API PRM_Name lopLookAtPositionName
 
LOP_API PRM_Name lopUpVecMethodName
 
LOP_API PRM_Name lopUpVecXAxisName
 
LOP_API PRM_Name lopUpVecYAxisName
 
LOP_API PRM_Name lopUpVecCustomName
 
LOP_API PRM_Name lopUpVecName
 
LOP_API PRM_Name lopTwistName
 
LOP_API PRM_Default lopAddPrimPathDefault
 
LOP_API PRM_Default lopEditPrimPathDefault
 
LOP_API PRM_Default lopRefPrimDefault
 
LOP_API PRM_Default lopPrimPatternDefault
 
LOP_API PRM_Default lopPrimKindDefault
 
LOP_API PRM_Default lopPrimKindWithAutoDefault
 
LOP_API PRM_Default lopPrimKindQueryDefault
 
LOP_API PRM_Default lopPrimPurposeDefault
 
LOP_API PRM_Default lopParentPrimTypeDefault
 
LOP_API PRM_Default lopParentPrimTypeScopeDefault
 
LOP_API PRM_Default lopHandleMissingFilesDefault
 
LOP_API PRM_ChoiceList lopPrimPathMenu
 
LOP_API PRM_ChoiceList lopPrimSpecifierMenu
 
LOP_API PRM_ChoiceList lopPrimKindMenu
 
LOP_API PRM_ChoiceList lopPrimKindWithAutoMenu
 
LOP_API PRM_ChoiceList lopPrimKindQueryMenu
 
LOP_API PRM_ChoiceList lopPrimPurposeMenu
 
LOP_API PRM_ChoiceList lopPrimDrawModeMenu
 
LOP_API PRM_ChoiceList lopFirstInputCollectionsMenu
 
LOP_API PRM_ChoiceList lopSecondInputCollectionsMenu
 
LOP_API PRM_ChoiceList lopParentPrimTypeMenu
 
LOP_API PRM_ChoiceList lopConcretePrimTypeMenu
 
LOP_API PRM_ChoiceList lopAllPrimTypeMenu
 
LOP_API PRM_ChoiceList lopAttributeColorSpaceMenu
 
LOP_API PRM_ChoiceList lopAttributeInterpolationMenu
 
LOP_API PRM_ChoiceList lopAttributeTypeMenu
 
LOP_API PRM_ChoiceList lopHandleMissingFilesMenu
 
LOP_API PRM_ChoiceList lopRefPrimMenu
 
LOP_API PRM_SpareData lopPrimPathSpareData
 
LOP_API PRM_SpareData lopMultiPrimPathSpareData
 
LOP_API PRM_SpareData lopPrimPatternSpareData
 
LOP_API PRM_SpareData lopPrimPathDialogSpareData
 

Typedef Documentation

Enumeration Type Documentation

Enumerator
LOP_XFORM_TRS 
LOP_XFORM_RXYZ 
LOP_XFORM_T 
LOP_XFORM_R 
LOP_XFORM_S 
LOP_XFORM_SHEAR 
LOP_XFORM_USCALE 
LOP_XFORM_PIVOTCONTAINER 
LOP_XFORM_PIVOT 
LOP_XFORM_PIVOTROT 

Definition at line 126 of file LOP_PRMShared.h.

Function Documentation

LOP_API UT_Matrix4D lopBuildMultiparmXform ( OP_Node node,
int  inst,
fpreal  t,
LOP_XformComponents accumulate = nullptr 
)
LOP_API void lopBuildUsdExpansionRulesMenu ( void ,
PRM_Name menu_entries,
int  max_menu_entries,
const PRM_SpareData ,
const PRM_Parm  
)
LOP_API void lopBuildUsdPrimVariantSetsMenu ( LOP_Node node,
int  which_input,
const UT_String primpattern,
PRM_Name menu_entries,
int  max_menu_entries 
)
LOP_API void lopBuildUsdPrimVariantsMenu ( LOP_Node node,
int  which_input,
const UT_String primpattern,
const UT_String variantset,
PRM_Name menu_entries,
int  max_menu_entries 
)
LOP_API UT_Matrix4D lopBuildXform ( OP_Node node,
fpreal  t,
LOP_XformComponents accumulate = nullptr 
)
LOP_API OP_ERROR lopCheckForMissingFile ( LOP_Node node,
HUSD_AutoAnyLock lock,
const UT_StringRef filepath,
const UT_StringRef handle_missing_files,
bool *  skip_this_file 
)
LOP_API PRM_Template lopCollectionCollapserParmTemplate ( PRM_Name collapser_parm_name)
LOP_API PRM_Template lopCollectionParmTemplate ( PRM_Name collection_parm_name,
const char *  multiparm_prefix = nullptr 
)
LOP_API const PRM_Template& lopContextOptionsTemplate ( )
LOP_API const PRM_Template& lopCustomDataTemplate ( )
LOP_API bool lopGetCollection ( LOP_Node node,
const LOP_CollectionParms collection_parms,
fpreal  t,
HUSD_FindPrims findprims 
)
LOP_API void lopGetCollectionParms ( LOP_Node node,
const PRM_Template collection_parm_template,
fpreal  t,
LOP_CollectionParms collection_parms 
)
LOP_API void lopGetCustomDataParms ( LOP_Node node,
fpreal  t,
LOP_CustomDataParms custom_data_parms 
)
LOP_API const PRM_Template* lopMultiparmXformTemplates ( )
LOP_API const PRM_Template& lopPatternMatchingContextOptionsTemplate ( )
LOP_API bool lopSetContextOptions ( OP_Node node,
OP_Context context,
OP_ContextOptionsWriteScope options 
)
LOP_API void lopSetCustomData ( LOP_Node node,
const LOP_CustomDataParms custom_data_parms,
const HUSD_EditCustomData edit_data,
const HUSD_FindPrims find_prims = nullptr,
const HUSD_FindProps find_props = nullptr 
)
LOP_API bool lopSetPatternMatchingContextOptions ( OP_Node node,
OP_Context context,
OP_ContextOptionsWriteScope options 
)
LOP_API bool lopSetTimeBasedContextOptions ( OP_Node node,
OP_Context context,
OP_ContextOptionsWriteScope options 
)
LOP_API const PRM_Template& lopTimeBasedContextOptionsTemplate ( )
LOP_API const PRM_Template* lopXformTemplates ( )

Variable Documentation

LOP_API PRM_Default lopAddPrimPathDefault
Examples:
LOP/LOP_Sphere.C.
LOP_API PRM_ChoiceList lopAllPrimTypeMenu
LOP_API const UT_StringHolder lopAttrControlAddToken
LOP_API const UT_StringHolder lopAttrControlBlockToken
LOP_API const UT_StringHolder lopAttrControlMultiplyToken
LOP_API const UT_StringHolder lopAttrControlNoneToken
LOP_API const UT_StringHolder lopAttrControlSetExistingToken
LOP_API const UT_StringHolder lopAttrControlSetToken
LOP_API PRM_ChoiceList lopAttributeColorSpaceMenu
LOP_API PRM_ChoiceList lopAttributeInterpolationMenu
LOP_API PRM_ChoiceList lopAttributeTypeMenu
LOP_API PRM_Name lopCollectionCollapserName
LOP_API PRM_Name lopCollectionName
LOP_API PRM_ChoiceList lopConcretePrimTypeMenu
LOP_API PRM_Default lopEditPrimPathDefault
LOP_API PRM_ChoiceList lopFirstInputCollectionsMenu
LOP_API PRM_Default lopHandleMissingFilesDefault
LOP_API PRM_ChoiceList lopHandleMissingFilesMenu
LOP_API PRM_Name lopHandleMissingFilesName
LOP_API PRM_Name lopLookAtEnableName
LOP_API PRM_Name lopLookAtPositionName
LOP_API PRM_Name lopLookAtPrimName
LOP_API PRM_Name lopLookAtPrimPositionName
LOP_API PRM_Name lopLookAtPrimRotationName
LOP_API PRM_SpareData lopMultiPrimPathSpareData
LOP_API PRM_Default lopParentPrimTypeDefault
LOP_API PRM_ChoiceList lopParentPrimTypeMenu
LOP_API PRM_Name lopParentPrimTypeName
LOP_API PRM_Default lopParentPrimTypeScopeDefault
LOP_API PRM_Name lopPathName
LOP_API PRM_Name lopPrimCountName
LOP_API PRM_ChoiceList lopPrimDrawModeMenu
LOP_API PRM_Default lopPrimKindDefault
LOP_API PRM_ChoiceList lopPrimKindMenu
LOP_API PRM_Name lopPrimKindName
LOP_API PRM_Default lopPrimKindQueryDefault
LOP_API PRM_ChoiceList lopPrimKindQueryMenu
LOP_API PRM_Default lopPrimKindWithAutoDefault
LOP_API PRM_ChoiceList lopPrimKindWithAutoMenu
LOP_API PRM_SpareData lopPrimPathDialogSpareData

Version of lopPrimPathSpareData that only supports selection using the primitive picker dialog. This can be used for nodes in other contexts that reference a LOP.

LOP_API PRM_ChoiceList lopPrimPathMenu
Examples:
LOP/LOP_Sphere.C.
LOP_API PRM_Name lopPrimPathName
Examples:
LOP/LOP_Sphere.C.
LOP_API PRM_SpareData lopPrimPathSpareData
Examples:
LOP/LOP_Sphere.C.
LOP_API PRM_Default lopPrimPatternDefault
LOP_API PRM_Name lopPrimPatternName
LOP_API PRM_SpareData lopPrimPatternSpareData
LOP_API PRM_Default lopPrimPurposeDefault
LOP_API PRM_ChoiceList lopPrimPurposeMenu
LOP_API PRM_ChoiceList lopPrimSpecifierMenu
LOP_API PRM_Name lopPropPatternName
LOP_API PRM_Default lopRefPrimDefault
LOP_API PRM_ChoiceList lopRefPrimMenu
LOP_API PRM_Name lopResolverContextAssetPathName
LOP_API PRM_ChoiceList lopSecondInputCollectionsMenu
LOP_API PRM_Name lopTwistName
LOP_API PRM_Name lopUpVecCustomName
LOP_API PRM_Name lopUpVecMethodName
LOP_API PRM_Name lopUpVecName
LOP_API PRM_Name lopUpVecXAxisName
LOP_API PRM_Name lopUpVecYAxisName