DD::Image::PathExpression_KnobI Class Reference

Abstract base class for PathExpression knobs. More...

#include <PathExpressionKnobI.h>

Public Member Functions
virtual usg::PathArray	match (const usg::StageRef &stage, const std::string &pattern, const usg::GeomEngine *engine=nullptr)=0
virtual void	reportErrorsDuringMatch (bool report)=0
virtual void	setExpressionTypes (const std::vector< ExpressionType > &types)=0
virtual const std::vector< ExpressionType > &	getExpressionTypes ()=0
virtual void	setDefaultFallbackMask (const std::string &mask, const std::string &description)=0
virtual void	setPredicate (const usg::Prim::FlagsPredicate &predicate)=0
	Sets a predicate that is used during the stage traversal for matching.

Detailed Description

Abstract base class for PathExpression knobs.

Member Function Documentation

match()

virtual usg::PathArray DD::Image::PathExpression_KnobI::match ( const usg::StageRef &  stage, const std::string &  pattern, const usg::GeomEngine *  engine = nullptr  )

pure virtual

Returns all paths in stage which match pattern. This will display any errors that occur. The engine parameter is used for matching tokens such as {lastmodified}. If engine is null, the input engine at the UI context, if any, will be used.

reportErrorsDuringMatch()

virtual void DD::Image::PathExpression_KnobI::reportErrorsDuringMatch ( bool  report )

pure virtual

This can be used to turn on/off error reporting during a call to match. By default, errors are reported on calls to match.

Referenced by DD::Image::LightSceneOp::addScanlineRenderMaskingKnobs(), and DD::Image::LightSceneOp::addScanlineRenderShadowKnobs().

setExpressionTypes()

virtual void DD::Image::PathExpression_KnobI::setExpressionTypes ( const std::vector< ExpressionType > &  types )

pure virtual

Sets selectable expression types that can be picked from a drop down for this knob. Note that a expression type with the label "Custom" is always present and does not need to be specified here. It will be ignored if given in the types vector passed in.

Referenced by DD::Image::LightSceneOp::addScanlineRenderMaskingKnobs(), and DD::Image::LightSceneOp::addScanlineRenderShadowKnobs().

getExpressionTypes()

virtual const std::vector< ExpressionType > & DD::Image::PathExpression_KnobI::getExpressionTypes ( )

pure virtual

Gets the selectable expression types that can be picked from a drop down for this knob. Note that a expression type with the label "Custom" is always the last element here.

setDefaultFallbackMask()

virtual void DD::Image::PathExpression_KnobI::setDefaultFallbackMask ( const std::string &  mask, const std::string &  description  )

pure virtual

Sets the path mask to replace '{default}' with when no paths have been injected from an upstream node. The description will be used for UI purposes. By default the mask is "/*" and the description is "All Roots".