LOP_PRMShared.h File Reference

#include "LOP_API.h"
#include <HUSD/HUSD_Merge.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_CollectionParmSet

Typedefs
typedef UT_Array < LOP_CollectionParmSet >	LOP_CollectionParms

Enumerations
enum	{ LOP_SETSTAGEMETADATA_AUTO, LOP_SETSTAGEMETADATA_YES, LOP_SETSTAGEMETADATA_NO }
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, bool allow_instance_proxies, const UT_String &primpattern, PRM_Name *menu_entries, int max_menu_entries)
LOP_API void	lopBuildUsdPrimVariantsMenu (LOP_Node &node, int which_input, bool allow_instance_proxies, 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 HUSD_MergeStyle	lopMergeStyleFromString (const UT_StringRef &merge_style_str)
LOP_API const PRM_Template *	lopXformTemplates ()
LOP_API const PRM_Template *	lopMultiparmXformTemplates ()
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 bool	lopSetStageMetadata (LOP_Node *node, fpreal t)
LOP_API const PRM_Template &	lopContextOptionsTemplate ()
LOP_API void	lopSetContextOptions (OP_Node &node, OP_Context &context, OP_ContextOptionsWriteScope &options)
LOP_API const PRM_Template &	lopTimeBasedContextOptionsTemplate ()
LOP_API bool	lopSetTimeBasedContextOptions (OP_Node &node, OP_Context &context, OP_ContextOptionsWriteScope &options)
LOP_API const PRM_Template &	lopPatternMatchingContextOptionsTemplate ()
LOP_API void	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, const char *default_prim_pattern=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 const PRM_Template &	lopResolverContextStringsTemplate ()
LOP_API bool	lopGetResolverContextStringsFromMultiparm (OP_Node &node, UT_StringMap< UT_StringHolder > &resolverstrings, const PRM_Name *asset_path_parm)
LOP_API const PRM_Template &	lopVariantSelectionFallbackTemplate ()
LOP_API bool	lopApplyVariantSelectionFallbacksFromMultiparm (OP_Node &node, UT_StringMap< UT_StringArray > &variantselections, bool add_empty_selections=false)
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 bool	lopTokenizePrimitivePaths (const UT_StringRef &str, UT_StringArray &primpaths, UT_StringSet *uniqueprimpaths=nullptr)

Variables
LOP_API const UT_StringHolder	lopAttrControlNoneToken
LOP_API const UT_StringHolder	lopAttrControlSetToken
LOP_API const UT_StringHolder	lopAttrControlAddToken
LOP_API const UT_StringHolder	lopAttrControlAppendToken
LOP_API const UT_StringHolder	lopAttrControlPrependToken
LOP_API const UT_StringHolder	lopAttrControlRemoveToken
LOP_API const UT_StringHolder	lopAttrControlMultiplyToken
LOP_API const UT_StringHolder	lopAttrControlSetExistingToken
LOP_API const UT_StringHolder	lopAttrControlSetNotAuthoredToken
LOP_API const UT_StringHolder	lopAttrControlBlockToken
LOP_API const UT_StringHolder	lopAttrControlConnectInputToken
LOP_API const UT_StringHolder	lopAttrControlDisconnectInputToken
LOP_API const UT_StringHolder	lopMultiPrimSelectTooltip
LOP_API const UT_StringHolder	lopSinglePrimSelectTooltip
LOP_API const UT_StringHolder	lopErrorOnMissingFilesToken
LOP_API const UT_StringHolder	lopWarnOnMissingFilesToken
LOP_API const UT_StringHolder	lopIgnoreMissingFilesToken
LOP_API const UT_StringHolder	lopAllowMissingFilesToken
LOP_API PRM_Name	lopResolverContextAssetPathName
LOP_API PRM_Name	lopInsertionPointDescriptorName
LOP_API PRM_Name	lopModifiedPrimCountToStartNewLayerName
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	lopPrimSpecifierName
LOP_API PRM_Name	lopParentPrimTypeName
LOP_API PRM_Name	lopCollectionCollapserName
LOP_API PRM_Name	lopCollectionName
LOP_API PRM_Name	lopHandleMissingFilesName
LOP_API PRM_Name	lopLoadPayloadsName
LOP_API PRM_Name	lopSetStageMetadataName
LOP_API PRM_Name	lopEditRootLayerName
LOP_API PRM_Name	lopShowLopStageName
LOP_API PRM_Name	lopInEditLayerBlockLabelName
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	lopPrimSpecifierDefault
LOP_API PRM_Default	lopParentPrimTypeDefault
LOP_API PRM_Default	lopParentPrimTypeScopeDefault
LOP_API PRM_Default	lopHandleMissingFilesDefault
LOP_API PRM_Default	lopSetStageMetadataDefault
LOP_API PRM_Default	lopInEditLayerBlockLabelDefault
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_ChoiceList	lopMergeStyleMenu
LOP_API PRM_ChoiceList	lopSetStageMetadataMenu
LOP_API PRM_ChoiceList	lopTargetLayerMenu
LOP_API PRM_ChoiceList	lopParentLayerMenu
LOP_API PRM_SpareData	lopPrimPathSpareData
LOP_API PRM_SpareData	lopNonVisualPrimPathSpareData
LOP_API PRM_SpareData	lopMultiPrimPathSpareData
LOP_API PRM_SpareData	lopPrimPatternSpareData
LOP_API PRM_SpareData	lopMultilinePrimPatternSpareData
LOP_API PRM_SpareData	lopNonVisualPrimPatternSpareData
LOP_API PRM_SpareData	lopPrimPatternWithProxiesSpareData
LOP_API PRM_SpareData	lopMultilinePrimPatternWithProxiesSpareData
LOP_API PRM_SpareData	lopUsdReadFilePathSpareData
LOP_API PRM_SpareData	lopUsdWriteFilePathSpareData
LOP_API PRM_SpareData	lopPrimPathDialogSpareData
LOP_API PRM_Name	lopMatBindPurposeMultiName
LOP_API PRM_Default	lopMatBindPurposeDefault
LOP_API PRM_ChoiceList	lopMatBindPurposeMenu
LOP_API PRM_Name	lopRefRenderVarsName

Typedef Documentation

typedef UT_Array<LOP_CollectionParmSet> LOP_CollectionParms

Definition at line 262 of file LOP_PRMShared.h.

Enumeration Type Documentation

anonymous enum

Enumerator
LOP_SETSTAGEMETADATA_AUTO
LOP_SETSTAGEMETADATA_YES
LOP_SETSTAGEMETADATA_NO

Definition at line 38 of file LOP_PRMShared.h.

enum LOP_XformParms

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 178 of file LOP_PRMShared.h.

Function Documentation

LOP_API bool lopApplyVariantSelectionFallbacksFromMultiparm	(	OP_Node &	node,
		UT_StringMap< UT_StringArray > &	variantselections,
		bool	add_empty_selections = false
	)

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,
		bool	allow_instance_proxies,
		const UT_String &	primpattern,
		PRM_Name *	menu_entries,
		int	max_menu_entries
	)

LOP_API void lopBuildUsdPrimVariantsMenu	(	LOP_Node &	node,
		int	which_input,
		bool	allow_instance_proxies,
		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,
		const char *	default_prim_pattern = nullptr
	)

LOP_API const PRM_Template& lopContextOptionsTemplate

(

)

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 bool lopGetResolverContextStringsFromMultiparm	(	OP_Node &	node,
		UT_StringMap< UT_StringHolder > &	resolverstrings,
		const PRM_Name *	asset_path_parm
	)

LOP_API HUSD_MergeStyle lopMergeStyleFromString

(

const UT_StringRef &

merge_style_str

)

LOP_API const PRM_Template* lopMultiparmXformTemplates

(

)

LOP_API const PRM_Template& lopPatternMatchingContextOptionsTemplate

(

)

LOP_API const PRM_Template& lopResolverContextStringsTemplate

(

)

LOP_API void lopSetContextOptions	(	OP_Node &	node,
		OP_Context &	context,
		OP_ContextOptionsWriteScope &	options
	)

LOP_API void lopSetPatternMatchingContextOptions	(	OP_Node &	node,
		OP_Context &	context,
		OP_ContextOptionsWriteScope &	options
	)

LOP_API bool lopSetStageMetadata	(	LOP_Node *	node,
		fpreal	t
	)

LOP_API bool lopSetTimeBasedContextOptions	(	OP_Node &	node,
		OP_Context &	context,
		OP_ContextOptionsWriteScope &	options
	)

LOP_API const PRM_Template& lopTimeBasedContextOptionsTemplate

(

)

LOP_API bool lopTokenizePrimitivePaths	(	const UT_StringRef &	str,
		UT_StringArray &	primpaths,
		UT_StringSet *	uniqueprimpaths = nullptr
	)

LOP_API const PRM_Template& lopVariantSelectionFallbackTemplate

(

)

LOP_API const PRM_Template* lopXformTemplates

(

)

Variable Documentation

LOP_API PRM_Default lopAddPrimPathDefault

LOP_API const UT_StringHolder lopAllowMissingFilesToken

LOP_API PRM_ChoiceList lopAllPrimTypeMenu

LOP_API const UT_StringHolder lopAttrControlAddToken

LOP_API const UT_StringHolder lopAttrControlAppendToken

LOP_API const UT_StringHolder lopAttrControlBlockToken

LOP_API const UT_StringHolder lopAttrControlConnectInputToken

LOP_API const UT_StringHolder lopAttrControlDisconnectInputToken

LOP_API const UT_StringHolder lopAttrControlMultiplyToken

LOP_API const UT_StringHolder lopAttrControlNoneToken

LOP_API const UT_StringHolder lopAttrControlPrependToken

LOP_API const UT_StringHolder lopAttrControlRemoveToken

LOP_API const UT_StringHolder lopAttrControlSetExistingToken

LOP_API const UT_StringHolder lopAttrControlSetNotAuthoredToken

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_Name lopEditRootLayerName

LOP_API const UT_StringHolder lopErrorOnMissingFilesToken

LOP_API PRM_ChoiceList lopFirstInputCollectionsMenu

LOP_API PRM_Default lopHandleMissingFilesDefault

LOP_API PRM_ChoiceList lopHandleMissingFilesMenu

LOP_API PRM_Name lopHandleMissingFilesName

LOP_API const UT_StringHolder lopIgnoreMissingFilesToken

LOP_API PRM_Default lopInEditLayerBlockLabelDefault

LOP_API PRM_Name lopInEditLayerBlockLabelName

LOP_API PRM_Name lopInsertionPointDescriptorName

LOP_API PRM_Name lopLoadPayloadsName

LOP_API PRM_Default lopMatBindPurposeDefault

LOP_API PRM_ChoiceList lopMatBindPurposeMenu

LOP_API PRM_Name lopMatBindPurposeMultiName

LOP_API PRM_ChoiceList lopMergeStyleMenu

LOP_API PRM_Name lopModifiedPrimCountToStartNewLayerName

LOP_API PRM_SpareData lopMultilinePrimPatternSpareData

LOP_API PRM_SpareData lopMultilinePrimPatternWithProxiesSpareData

LOP_API PRM_SpareData lopMultiPrimPathSpareData

LOP_API const UT_StringHolder lopMultiPrimSelectTooltip

LOP_API PRM_SpareData lopNonVisualPrimPathSpareData

LOP_API PRM_SpareData lopNonVisualPrimPatternSpareData

LOP_API PRM_ChoiceList lopParentLayerMenu

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

LOP_API PRM_ChoiceList lopPrimPathMenu

LOP_API PRM_Name lopPrimPathName

LOP_API PRM_SpareData lopPrimPathSpareData

LOP_API PRM_Default lopPrimPatternDefault

LOP_API PRM_Name lopPrimPatternName

LOP_API PRM_SpareData lopPrimPatternSpareData

LOP_API PRM_SpareData lopPrimPatternWithProxiesSpareData

LOP_API PRM_Default lopPrimPurposeDefault

LOP_API PRM_ChoiceList lopPrimPurposeMenu

LOP_API PRM_Default lopPrimSpecifierDefault

LOP_API PRM_ChoiceList lopPrimSpecifierMenu

LOP_API PRM_Name lopPrimSpecifierName

LOP_API PRM_Name lopPropPatternName

LOP_API PRM_Default lopRefPrimDefault

LOP_API PRM_ChoiceList lopRefPrimMenu

LOP_API PRM_Name lopRefRenderVarsName

LOP_API PRM_Name lopResolverContextAssetPathName

LOP_API PRM_ChoiceList lopSecondInputCollectionsMenu

LOP_API PRM_Default lopSetStageMetadataDefault

LOP_API PRM_ChoiceList lopSetStageMetadataMenu

LOP_API PRM_Name lopSetStageMetadataName

LOP_API PRM_Name lopShowLopStageName

LOP_API const UT_StringHolder lopSinglePrimSelectTooltip

LOP_API PRM_ChoiceList lopTargetLayerMenu

LOP_API PRM_SpareData lopUsdReadFilePathSpareData

LOP_API PRM_SpareData lopUsdWriteFilePathSpareData

LOP_API const UT_StringHolder lopWarnOnMissingFilesToken