DD::Image::ShaderOpCutoutControlsI Class Reference

#include <ShaderOp.h>

Inheritance diagram for DD::Image::ShaderOpCutoutControlsI:

Public Member Functions
bool	cutoutModeEnabled () const
bool	cutoutModeRemovesDataAovs () const
virtual void	addCutoutKnobs (Knob_Callback f)
virtual void	updateCutoutOverrides (ShaderOp *ownerShaderOp, const MaterialOpI::MaterialContext &rtx, usg::ShaderDesc &shaderDesc)

Protected Attributes
bool	_cutoutModeEnabled
	Surface acts as a cutout/holdout/matte.
bool	_cutoutModeRemovesDataAovsEnabled
	If cutout surface enabled, does depth & aovs get cut as well.

Detailed Description

Extension interface that adds cutout knob controls and the mappings to the shader parameters.

Member Function Documentation

addCutoutKnobs()

void DD::Image::ShaderOpCutoutControlsI::addCutoutKnobs ( Knob_Callback  f )

virtual

Adds cutout option controls. Call this from a ShaderOp::knobs() method.

References DD::Image::Bool_knob(), DD::Image::SetFlags(), and DD::Image::Tooltip().

updateCutoutOverrides()

void DD::Image::ShaderOpCutoutControlsI::updateCutoutOverrides ( ShaderOp *  ownerShaderOp, const MaterialOpI::MaterialContext &  rtx, usg::ShaderDesc &  shaderDesc  )

virtual

Apply overrides to the shader cutout properties on shaderDesc. Call this from a ShaderOp::updateShaderGraphOverrides() method.

References DD::Image::MaterialOpI::overrideShaderDescInput().