DD::Image::FrameRangeControls Class Reference

Class used to standardise frame range controls throughout NUKE. More...

Public Types

enum  FrameRangeTypeEnum {
  eFrameRangeTypeAll, eFrameRangeTypeFromStart, eFrameRangeTypeSingle, eFrameRangeTypeToEnd,
  eFrameRangeTypeFromStartToEnd
}
 Enum used to specify what kind of frame range we have.
 

Public Member Functions

 FrameRangeControls (double frameRangeStart=1.0, double frameRangeEnd=1.0, FrameRangeTypeEnum frameRangeType=eFrameRangeTypeSingle)
 Constructor.
 
void knobs (Knob_Closure &f, bool earlyStore=false, bool shortMenu=false, const char *frameRangeStartName="framerange_start", const char *frameRangeStartLabel="start", const char *frameRangeEndName="framerange_end", const char *frameRangeEndLabel="end", const char *frameRangeTypeName="framerange_type", const char *frameRangeTypeLabel="type", bool displayScriptKnobs=true, const char *unlimitedRangeScript="@Roto/UnlimitedLife;", const char *visibleFromNowOnScript="@Roto/VisibleFromNowOn;", const char *visibleCurrentFrameScript="@Roto/VisibleCurrentFrame;", const char *visibleUpTillNowScript="@Roto/VisibleUpTillNow;", const char *visibleSpecificRangeScript="@Roto/VisibleSpecificRange;")
 The owner of this object must call this in their Op::knobs() function.
 
double getFrameRangeStart () const
 The frame range start.
 
double getFrameRangeEnd () const
 The frame range end.
 
FrameRangeTypeEnum getFrameRangeType () const
 The frame range type.
 
void setFrameRangeStart (double v)
 
void setFrameRangeEnd (double v)
 
void setFrameRangeType (FrameRangeTypeEnum v)
 
KnobgetFrameRangeStartKnob ()
 
KnobgetFrameRangeEndKnob ()
 
KnobgetFrameRangeTypeKnob ()
 
KnobgetUnlimitedRangeScriptKnob ()
 
KnobgetVisibleFromNowOnScriptKnob ()
 
KnobgetVisibleCurrentFrameScriptKnob ()
 
KnobgetVisibleUpTillNowScriptKnob ()
 
KnobgetVisibleSpecificRangeScriptKnob ()
 
std::vector< DD::Image::Knob * > getAllKnobs ()
 
void append (DD::Image::Hash &hash)
 

Detailed Description

Class used to standardise frame range controls throughout NUKE.



©2021 The Foundry Visionmongers, Ltd. All Rights Reserved.
www.thefoundry.co.uk