HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Classes | Public Types | Public Member Functions | Protected Member Functions | List of all members
TIL_ImageSource Class Referenceabstract

#include <TIL_ImageSource.h>

+ Inheritance diagram for TIL_ImageSource:

Classes

struct  ColorSpace
 

Public Types

enum  ColorSpaceMode { CS_HOUDINI, CS_OCIO_SPACE, CS_OCIO_DISPLAY_VIEW }
 

Public Member Functions

 TIL_ImageSource ()
 
void bumpRefCount (int i)
 
void invalidate ()
 
bool isValid () const
 
virtual fpreal getGlobalTime ()=0
 
virtual fpreal getSampleRate ()=0
 
virtual fpreal getStartTime ()=0
 
virtual fpreal getEndTime ()=0
 
virtual UT_StringHolder getBottomLeftCaption () const
 
virtual UT_StringHolder getTopRightCaption () const
 
int getImageIndexFromTime (fpreal t)
 
int getFrameFromTime (fpreal t)
 
virtual int doesImageExist (int, bool=true)
 
virtual int getActualFrame (int frame)
 
virtual void removeFrame (int)
 
virtual void addFrame (int)
 
virtual void removeSequence ()
 
virtual bool canAddFrame ()
 
virtual bool isNetwork ()
 
virtual fpreal getFrameTime (fpreal t, bool=false, const TIL_Sequence *=0)
 
virtual int getFrameShift (int fr, bool=false, const TIL_Sequence *=0)
 
virtual int getApparentFrame (int fr)
 
virtual const char * getName ()=0
 
virtual void getFullName (UT_String &name)=0
 
virtual void getFrameName (int frame, UT_String &name)
 
virtual int equals (const TIL_ImageSource *)=0
 
virtual int open (short &, int=0, fpreal=TIL_GLOBAL_TIME)
 
virtual void close (short)
 
virtual bool isConstantSequence () const
 
virtual const TIL_Sequence * getSequence (fpreal t, const UT_Options &options)=0
 
virtual UT_Options getDefaultOptions () const
 
const TIL_Sequence * getSequence (fpreal t)
 
virtual UT_TokenString * getID (fpreal t, int xres, int yres, const TIL_Plane &plane, int array_index, const UT_Options &options)=0
 
virtual void getImageBounds (const TIL_Plane &plane, int array_index, fpreal t, int xres, int yres, const UT_Options &options, int &x1, int &y1, int &x2, int &y2)
 
virtual void getCookRegions (TIL_CookRegionList &region)=0
 
virtual bool getPriorityCircle (float &centrex, float &centrey, float &radius) const
 
virtual int getID () const =0
 
virtual int getImage (TIL_Raster *image, fpreal t, int xres, int yres, const TIL_Plane &plane, int array_index, int xstart, int ystart, int xend, int yend, float gamma, const UT_Options &, bool include_alpha=false, bool is_interactive=false, int fxres=0, int fyres=0)=0
 
virtual void getInfo (UT_WorkBuffer &infotext)
 
virtual void getComment (UT_String &comment, fpreal t)
 
virtual void setComment (const UT_String &comment, fpreal t)
 
virtual int writeImage (const char *filename, const IMG_TileOptions *finfo, const TIL_Sequence *, int step, const ColorSpace &cspace, void(*info)(void *, const char *), void *data, bool suppress_summary_dialog, bool overwrite)
 
virtual int writeImage (const char *filename, const IMG_TileOptions *finfo, int xres, int yres, const char *color, const char *alpha, int start, int end, int step, const ColorSpace &cspace, void(*info)(void *, const char *), void *data, bool suppress_summary_dialog, bool overwrite)
 
virtual void writeImageComplete (int successcount, int failcount, const UT_String &failedfiles)
 
virtual bool isCachingNeeded (int) const
 
virtual size_t getVersion ()
 
virtual int isFrameLocked (fpreal)
 
virtual int isAnythingLocked ()
 
virtual int isPlaneLocked (const TIL_Plane *, fpreal)
 
virtual const TIL_Plane * getPreviewPlane (int)
 
virtual void setMouseLocation (int mx, int my, float radius=64.0f)
 
virtual void bumpVersion (bool)
 
virtual bool isSlowOperation () const
 
virtual bool getColorCurves (const char *planename, int array, fpreal t, TIL_ColorCurves &curves, UT_String &first, bool allnodes, int comp=-1, bool natural_range=true, float start=0.0f, float end=1.0f, int evalpoints=0)
 
virtual bool allowUserSelection () const
 
virtual TIL_ImageSource * selectParentSource (int px, int py, const char *planename, int array_index)
 
virtual bool hasPixelScript (int slot) const
 
virtual bool runPixelScript (int px, int py, int slot)
 
virtual bool isStereoscopicSource (fpreal t) const
 
virtual int getLeftPlaneIndex (fpreal t) const
 
virtual const char * getLeftPlaneName (fpreal t) const
 
virtual int getRightPlaneIndex (fpreal t) const
 
virtual const char * getRightPlaneName (fpreal t) const
 
virtual int64 getMemoryUsage (bool inclusive) const =0
 
virtual fpreal getRenderTime (int frame) const
 
virtual int64 getPeakMemUsage (int frame) const
 
virtual OP_Node * getOp () const
 
virtual bool getPreferredViewingPlane (UT_WorkBuffer &buf) const
 
virtual bool getStyleSheetJSON (int x, int y, UT_StringHolder &str)
 
virtual STY_StyleSheet * getStyleSheet (int x, int y)
 
virtual OP_Node * getMaterialNode (int x, int y)
 
virtual void onAutoUpdate ()
 

Protected Member Functions

virtual ~TIL_ImageSource ()
 

Detailed Description

Definition at line 57 of file TIL_ImageSource.h.

Member Enumeration Documentation

enum TIL_ImageSource::ColorSpaceMode
Enumerator
CS_HOUDINI 
CS_OCIO_SPACE 
CS_OCIO_DISPLAY_VIEW 

Definition at line 61 of file TIL_ImageSource.h.

Constructor & Destructor Documentation

TIL_ImageSource::TIL_ImageSource ( )
virtual TIL_ImageSource::~TIL_ImageSource ( )
protectedvirtual

Member Function Documentation

virtual void TIL_ImageSource::addFrame ( int  )
inlinevirtual

Definition at line 159 of file TIL_ImageSource.h.

virtual bool TIL_ImageSource::allowUserSelection ( ) const
inlinevirtual

Reimplemented in COP2_ImageSource.

Definition at line 315 of file TIL_ImageSource.h.

void TIL_ImageSource::bumpRefCount ( int  i)
virtual void TIL_ImageSource::bumpVersion ( bool  )
inlinevirtual

Definition at line 302 of file TIL_ImageSource.h.

virtual bool TIL_ImageSource::canAddFrame ( )
inlinevirtual

Definition at line 161 of file TIL_ImageSource.h.

virtual void TIL_ImageSource::close ( short  )
inlinevirtual

Reimplemented in COP2_ImageSource.

Definition at line 195 of file TIL_ImageSource.h.

virtual int TIL_ImageSource::doesImageExist ( int  ,
bool  = true 
)
inlinevirtual

Reimplemented in COP2_ImageSource.

Definition at line 153 of file TIL_ImageSource.h.

virtual int TIL_ImageSource::equals ( const TIL_ImageSource *  )
pure virtual

Implemented in COP2_ImageSource.

virtual int TIL_ImageSource::getActualFrame ( int  frame)
inlinevirtual

Definition at line 157 of file TIL_ImageSource.h.

virtual int TIL_ImageSource::getApparentFrame ( int  fr)
inlinevirtual

Definition at line 177 of file TIL_ImageSource.h.

virtual UT_StringHolder TIL_ImageSource::getBottomLeftCaption ( ) const
inlinevirtual

Definition at line 145 of file TIL_ImageSource.h.

virtual bool TIL_ImageSource::getColorCurves ( const char *  planename,
int  array,
fpreal  t,
TIL_ColorCurves &  curves,
UT_String &  first,
bool  allnodes,
int  comp = -1,
bool  natural_range = true,
float  start = 0.0f,
float  end = 1.0f,
int  evalpoints = 0 
)
virtual

Reimplemented in COP2_ImageSource.

virtual void TIL_ImageSource::getComment ( UT_String &  comment,
fpreal  t 
)
virtual
virtual void TIL_ImageSource::getCookRegions ( TIL_CookRegionList &  region)
pure virtual

Implemented in COP2_ImageSource.

virtual UT_Options TIL_ImageSource::getDefaultOptions ( ) const
inlinevirtual

Definition at line 203 of file TIL_ImageSource.h.

virtual fpreal TIL_ImageSource::getEndTime ( )
pure virtual

Implemented in COP2_ImageSource.

int TIL_ImageSource::getFrameFromTime ( fpreal  t)
virtual void TIL_ImageSource::getFrameName ( int  frame,
UT_String &  name 
)
virtual

Reimplemented in COP2_ImageSource.

virtual int TIL_ImageSource::getFrameShift ( int  fr,
bool  = false,
const TIL_Sequence *  = 0 
)
inlinevirtual

Reimplemented in COP2_ImageSource.

Definition at line 170 of file TIL_ImageSource.h.

virtual fpreal TIL_ImageSource::getFrameTime ( fpreal  t,
bool  = false,
const TIL_Sequence *  = 0 
)
inlinevirtual

Reimplemented in COP2_ImageSource.

Definition at line 166 of file TIL_ImageSource.h.

virtual void TIL_ImageSource::getFullName ( UT_String &  name)
pure virtual

Implemented in COP2_ImageSource.

virtual fpreal TIL_ImageSource::getGlobalTime ( )
pure virtual

Implemented in COP2_ImageSource.

virtual UT_TokenString* TIL_ImageSource::getID ( fpreal  t,
int  xres,
int  yres,
const TIL_Plane &  plane,
int  array_index,
const UT_Options &  options 
)
pure virtual

Implemented in COP2_ImageSource.

virtual int TIL_ImageSource::getID ( ) const
pure virtual

Implemented in COP2_ImageSource.

virtual int TIL_ImageSource::getImage ( TIL_Raster *  image,
fpreal  t,
int  xres,
int  yres,
const TIL_Plane &  plane,
int  array_index,
int  xstart,
int  ystart,
int  xend,
int  yend,
float  gamma,
const UT_Options &  ,
bool  include_alpha = false,
bool  is_interactive = false,
int  fxres = 0,
int  fyres = 0 
)
pure virtual

Implemented in COP2_ImageSource.

virtual void TIL_ImageSource::getImageBounds ( const TIL_Plane &  plane,
int  array_index,
fpreal  t,
int  xres,
int  yres,
const UT_Options &  options,
int &  x1,
int &  y1,
int &  x2,
int &  y2 
)
virtual

Reimplemented in COP2_ImageSource.

int TIL_ImageSource::getImageIndexFromTime ( fpreal  t)
virtual void TIL_ImageSource::getInfo ( UT_WorkBuffer &  infotext)
virtual

Reimplemented in COP2_ImageSource.

virtual int TIL_ImageSource::getLeftPlaneIndex ( fpreal  t) const
virtual
virtual const char* TIL_ImageSource::getLeftPlaneName ( fpreal  t) const
virtual
virtual OP_Node* TIL_ImageSource::getMaterialNode ( int  x,
int  y 
)
inlinevirtual

Definition at line 360 of file TIL_ImageSource.h.

virtual int64 TIL_ImageSource::getMemoryUsage ( bool  inclusive) const
pure virtual

Implemented in COP2_ImageSource.

virtual const char* TIL_ImageSource::getName ( )
pure virtual

Implemented in COP2_ImageSource.

virtual OP_Node* TIL_ImageSource::getOp ( ) const
inlinevirtual

Reimplemented in COP2_ImageSource.

Definition at line 343 of file TIL_ImageSource.h.

virtual int64 TIL_ImageSource::getPeakMemUsage ( int  frame) const
inlinevirtual

Definition at line 340 of file TIL_ImageSource.h.

virtual bool TIL_ImageSource::getPreferredViewingPlane ( UT_WorkBuffer &  buf) const
inlinevirtual

Reimplemented in COP2_ImageSource.

Definition at line 346 of file TIL_ImageSource.h.

virtual const TIL_Plane* TIL_ImageSource::getPreviewPlane ( int  )
inlinevirtual

Reimplemented in COP2_ImageSource.

Definition at line 297 of file TIL_ImageSource.h.

virtual bool TIL_ImageSource::getPriorityCircle ( float &  centrex,
float &  centrey,
float &  radius 
) const
inlinevirtual

Returns true iff there is currently a priority circle active. If there is, centrex, centrey, and radius are set to those of the circle.

Definition at line 232 of file TIL_ImageSource.h.

virtual fpreal TIL_ImageSource::getRenderTime ( int  frame) const
inlinevirtual

Definition at line 337 of file TIL_ImageSource.h.

virtual int TIL_ImageSource::getRightPlaneIndex ( fpreal  t) const
virtual
virtual const char* TIL_ImageSource::getRightPlaneName ( fpreal  t) const
virtual
virtual fpreal TIL_ImageSource::getSampleRate ( )
pure virtual

Implemented in COP2_ImageSource.

virtual const TIL_Sequence* TIL_ImageSource::getSequence ( fpreal  t,
const UT_Options &  options 
)
pure virtual

Implemented in COP2_ImageSource.

const TIL_Sequence* TIL_ImageSource::getSequence ( fpreal  t)
inline

Definition at line 208 of file TIL_ImageSource.h.

virtual fpreal TIL_ImageSource::getStartTime ( )
pure virtual

Implemented in COP2_ImageSource.

virtual STY_StyleSheet* TIL_ImageSource::getStyleSheet ( int  x,
int  y 
)
inlinevirtual

Definition at line 356 of file TIL_ImageSource.h.

virtual bool TIL_ImageSource::getStyleSheetJSON ( int  x,
int  y,
UT_StringHolder &  str 
)
inlinevirtual

Definition at line 351 of file TIL_ImageSource.h.

virtual UT_StringHolder TIL_ImageSource::getTopRightCaption ( ) const
inlinevirtual

Definition at line 146 of file TIL_ImageSource.h.

virtual size_t TIL_ImageSource::getVersion ( )
inlinevirtual

Reimplemented in COP2_ImageSource.

Definition at line 292 of file TIL_ImageSource.h.

virtual bool TIL_ImageSource::hasPixelScript ( int  slot) const
virtual
void TIL_ImageSource::invalidate ( )
inline

Definition at line 136 of file TIL_ImageSource.h.

virtual int TIL_ImageSource::isAnythingLocked ( )
inlinevirtual

Reimplemented in COP2_ImageSource.

Definition at line 294 of file TIL_ImageSource.h.

virtual bool TIL_ImageSource::isCachingNeeded ( int  ) const
inlinevirtual

Definition at line 289 of file TIL_ImageSource.h.

virtual bool TIL_ImageSource::isConstantSequence ( ) const
inlinevirtual

Reimplemented in COP2_ImageSource.

Definition at line 198 of file TIL_ImageSource.h.

virtual int TIL_ImageSource::isFrameLocked ( fpreal  )
inlinevirtual

Reimplemented in COP2_ImageSource.

Definition at line 293 of file TIL_ImageSource.h.

virtual bool TIL_ImageSource::isNetwork ( )
inlinevirtual

Reimplemented in COP2_ImageSource.

Definition at line 163 of file TIL_ImageSource.h.

virtual int TIL_ImageSource::isPlaneLocked ( const TIL_Plane *  ,
fpreal   
)
inlinevirtual

Reimplemented in COP2_ImageSource.

Definition at line 295 of file TIL_ImageSource.h.

virtual bool TIL_ImageSource::isSlowOperation ( ) const
inlinevirtual

Reimplemented in COP2_ImageSource.

Definition at line 303 of file TIL_ImageSource.h.

virtual bool TIL_ImageSource::isStereoscopicSource ( fpreal  t) const
virtual
bool TIL_ImageSource::isValid ( ) const
inline

Definition at line 137 of file TIL_ImageSource.h.

virtual void TIL_ImageSource::onAutoUpdate ( )
inlinevirtual

Definition at line 364 of file TIL_ImageSource.h.

virtual int TIL_ImageSource::open ( short &  ,
int  = 0,
fpreal  = TIL_GLOBAL_TIME 
)
inlinevirtual

Reimplemented in COP2_ImageSource.

Definition at line 189 of file TIL_ImageSource.h.

virtual void TIL_ImageSource::removeFrame ( int  )
inlinevirtual

Definition at line 158 of file TIL_ImageSource.h.

virtual void TIL_ImageSource::removeSequence ( )
inlinevirtual

Definition at line 160 of file TIL_ImageSource.h.

virtual bool TIL_ImageSource::runPixelScript ( int  px,
int  py,
int  slot 
)
virtual
virtual TIL_ImageSource* TIL_ImageSource::selectParentSource ( int  px,
int  py,
const char *  planename,
int  array_index 
)
virtual

Reimplemented in COP2_ImageSource.

virtual void TIL_ImageSource::setComment ( const UT_String &  comment,
fpreal  t 
)
virtual
virtual void TIL_ImageSource::setMouseLocation ( int  mx,
int  my,
float  radius = 64.0f 
)
virtual
virtual int TIL_ImageSource::writeImage ( const char *  filename,
const IMG_TileOptions *  finfo,
const TIL_Sequence *  ,
int  step,
const ColorSpace &  cspace,
void(*)(void *, const char *)  info,
void *  data,
bool  suppress_summary_dialog,
bool  overwrite 
)
virtual

Reimplemented in COP2_ImageSource.

virtual int TIL_ImageSource::writeImage ( const char *  filename,
const IMG_TileOptions *  finfo,
int  xres,
int  yres,
const char *  color,
const char *  alpha,
int  start,
int  end,
int  step,
const ColorSpace &  cspace,
void(*)(void *, const char *)  info,
void *  data,
bool  suppress_summary_dialog,
bool  overwrite 
)
virtual

Reimplemented in COP2_ImageSource.

virtual void TIL_ImageSource::writeImageComplete ( int  successcount,
int  failcount,
const UT_String &  failedfiles 
)
virtual
The documentation for this class was generated from the following file: