Nuke binary plugins 15.0.5
 
Loading...
Searching...
No Matches
DD::Image::File_KnobI Class Referenceabstract

#include <File_KnobI.h>

Public Types

enum  ChangeContext {
  ChangedFromScript , ChangedFromUser , ChangedFromUserOverride , ChangedFromScriptOverride ,
  ChangedNone
}
 

Public Member Functions

virtual ChangeContext getLastChangeContext () const =0
 
virtual void cooked_frame (const OutputContext &context, int &frame, bool &black, int &offset)=0
 
virtual bool isReadKnob () const =0
 

Detailed Description

Abstract base class for File Knob-specific methods.

Member Enumeration Documentation

◆ ChangeContext

This enum gives File knobs information about what triggered the last filename change

Member Function Documentation

◆ getLastChangeContext()

virtual ChangeContext DD::Image::File_KnobI::getLastChangeContext ( ) const
pure virtual

Get the reason for the last change to this knob's value

◆ cooked_frame()

virtual void DD::Image::File_KnobI::cooked_frame ( const OutputContext context,
int &  frame,
bool &  black,
int &  offset 
)
pure virtual

Provide information about the cooked frame based on settings used alongside file path, such as first frame in the sequence, what to do before and after specified range, etc.

Parameters
contextThe current context
frameOutput parameter providing actual cooked frame number
blackOutput parameter indicating whether cooked frame is outside specified sequence range
offsetOutput parameter providing the offset from the specified first frame in the sequence

◆ isReadKnob()

virtual bool DD::Image::File_KnobI::isReadKnob ( ) const
pure virtual

True if the knob implementing this interface is pointing to a file which used for reading only



©2024 The Foundry Visionmongers, Ltd. All Rights Reserved.
www.foundry.com