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

#include <COP2_ImageSource.h>

+ Inheritance diagram for COP2_ImageSource:

Public Member Functions

 COP2_ImageSource (COP2_Node *)
 
fpreal getGlobalTime () override
 
fpreal getSampleRate () override
 
fpreal getStartTime () override
 
fpreal getEndTime () override
 
const char * getName () override
 
void getFrameName (int frame, UT_String &name) override
 
void getFullName (UT_String &name) override
 
bool doesImageExist (int frame, bool adjust=true) override
 
bool equals (const TIL_ImageSource *) const override
 
bool open (short &key, int reset=0, fpreal t=TIL_GLOBAL_TIME) override
 
void close (short key) override
 
bool isNetwork () override
 
bool isConstantSequence () const override
 
const TIL_Sequence * getSourceSequence (fpreal t, const UT_Options &options) override
 Return a completed TIL_Sequence structure without postprocessing. More...
 
int getID () const override
 
UT_TokenString * getID (fpreal t, int xres, int yres, const TIL_Plane &plane, int array_index, const UT_Options &options) override
 
void getSourceImageBounds (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) override
 
void getCookRegions (TIL_CookRegionList &regions) override
 
int getSourceImage (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) override
 
void getInfo (UT_WorkBuffer &infotext) override
 
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) override
 
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) override
 
size_t getVersion () override
 
bool isFrameLocked (fpreal t) const override
 
bool isAnythingLocked () const override
 
bool isPlaneLocked (const TIL_Plane *, fpreal t) const override
 
const TIL_Plane * getPreviewPlane (int index) override
 
virtual bool canModifyImage ()
 
virtual bool useHandles ()
 
COP2_Node * getCop2 () const
 
COP2_Node * getCop2 ()
 
bool isSlowOperation () const override
 
fpreal getFrameTime (fpreal t, bool shift_only=false, const TIL_Sequence *ref=0) override
 
int getFrameShift (int fr, bool shift_only=false, const TIL_Sequence *ref=0) override
 
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) override
 
bool allowUserSelection () const override
 
TIL_ImageSource * selectParentSource (int px, int py, const char *planename, int array_index) override
 
bool getPreferredViewingPlane (UT_WorkBuffer &buf) const override
 
int64 getMemoryUsage (bool inclusive) const override
 
const IMG_Metadata * getMetadata (int frame) const override
 
OP_Node * getOp () const override
 
- Public Member Functions inherited from TIL_ImageSource
 TIL_ImageSource ()
 
void bumpRefCount (int i)
 
void invalidate ()
 
bool isValid () const
 
virtual bool willProvideFetcher () const
 
virtual UT_StringHolder getBottomLeftCaption () const
 
virtual UT_StringHolder getTopRightCaption () const
 
int getImageIndexFromTime (fpreal t)
 
int getFrameFromTime (fpreal t)
 
virtual int getActualFrame (int frame)
 
virtual void removeFrame (int)
 
virtual void addFrame (int)
 
virtual void removeSequence ()
 
virtual bool canAddFrame ()
 
virtual int getApparentFrame (int fr)
 
const TIL_Sequence * getSequence (fpreal t, const UT_Options &options, bool skip_postprocessor=false)
 Return a completed TIL_Sequence structure with postprocessing, if any. More...
 
virtual UT_Options getDefaultOptions () const
 
const TIL_Sequence * getSequence (fpreal t, bool skip_postprocessor=false)
 
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, bool skip_postprocessor=false)
 
virtual bool getPriorityCircle (float &centrex, float &centrey, float &radius) const
 
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 &options, bool include_alpha=false, bool is_interactive=false, int fxres=0, int fyres=0, bool skip_postprocessor=false)
 
virtual void getComment (UT_String &comment, fpreal t)
 
virtual void setComment (const UT_String &comment, fpreal t)
 
virtual void writeImageComplete (int successcount, int failcount, const UT_String &failedfiles)
 
virtual bool isCachingNeeded (int) const
 
virtual void setMouseLocation (int mx, int my, float radius=64.0f)
 
virtual void bumpVersion (bool)
 
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 const IMG_Metadata * getPlaneMetadata (int frame, const UT_StringRef &planename) const
 
virtual fpreal getRenderTime (int frame) const
 
virtual int64 getPeakMemUsage (int frame) 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 ()
 
template<typename T , typename... Args>
T * setPostprocessor (Args &&...args)
 
const
TIL_ImageSourcePostprocessor * 		getPostprocessor () const
 
TIL_ImageSourcePostprocessor * getPostprocessor ()
 

Protected Member Functions

 ~COP2_ImageSource () override
 
- Protected Member Functions inherited from TIL_ImageSource
virtual ~TIL_ImageSource ()
 

Additional Inherited Members

- Public Types inherited from TIL_ImageSource
enum  ColorSpaceMode { CS_HOUDINI, CS_OCIO_SPACE, CS_OCIO_DISPLAY_VIEW }
 

Detailed Description

Definition at line 18 of file COP2_ImageSource.h.

Constructor & Destructor Documentation

COP2_ImageSource::COP2_ImageSource ( COP2_Node *  )
COP2_ImageSource::~COP2_ImageSource ( )
overrideprotected

Member Function Documentation

bool COP2_ImageSource::allowUserSelection ( ) const
inlineoverridevirtual

Reimplemented from TIL_ImageSource.

Definition at line 142 of file COP2_ImageSource.h.

virtual bool COP2_ImageSource::canModifyImage ( )
inlinevirtual

Definition at line 116 of file COP2_ImageSource.h.

void COP2_ImageSource::close ( short  key)
overridevirtual

Reimplemented from TIL_ImageSource.

bool COP2_ImageSource::doesImageExist ( int  frame,
bool  adjust = true 
)
overridevirtual

Reimplemented from TIL_ImageSource.

bool COP2_ImageSource::equals ( const TIL_ImageSource *  ) const
overridevirtual

Implements TIL_ImageSource.

bool COP2_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 
)
overridevirtual

Reimplemented from TIL_ImageSource.

void COP2_ImageSource::getCookRegions ( TIL_CookRegionList &  regions)
inlineoverridevirtual

Implements TIL_ImageSource.

Definition at line 68 of file COP2_ImageSource.h.

COP2_Node* COP2_ImageSource::getCop2 ( ) const
inline

Definition at line 119 of file COP2_ImageSource.h.

COP2_Node* COP2_ImageSource::getCop2 ( )
inline

Definition at line 120 of file COP2_ImageSource.h.

fpreal COP2_ImageSource::getEndTime ( )
overridevirtual

Implements TIL_ImageSource.

void COP2_ImageSource::getFrameName ( int  frame,
UT_String &  name 
)
overridevirtual

Reimplemented from TIL_ImageSource.

int COP2_ImageSource::getFrameShift ( int  fr,
bool  shift_only = false,
const TIL_Sequence *  ref = 0 
)
overridevirtual

Reimplemented from TIL_ImageSource.

fpreal COP2_ImageSource::getFrameTime ( fpreal  t,
bool  shift_only = false,
const TIL_Sequence *  ref = 0 
)
overridevirtual

Reimplemented from TIL_ImageSource.

void COP2_ImageSource::getFullName ( UT_String &  name)
overridevirtual

Implements TIL_ImageSource.

fpreal COP2_ImageSource::getGlobalTime ( )
overridevirtual

Implements TIL_ImageSource.

int COP2_ImageSource::getID ( ) const
inlineoverridevirtual

Implements TIL_ImageSource.

Definition at line 54 of file COP2_ImageSource.h.

UT_TokenString* COP2_ImageSource::getID ( fpreal  t,
int  xres,
int  yres,
const TIL_Plane &  plane,
int  array_index,
const UT_Options &  options 
)
overridevirtual

Implements TIL_ImageSource.

void COP2_ImageSource::getInfo ( UT_WorkBuffer &  infotext)
overridevirtual

Reimplemented from TIL_ImageSource.

int64 COP2_ImageSource::getMemoryUsage ( bool  inclusive) const
overridevirtual

Implements TIL_ImageSource.

const IMG_Metadata* COP2_ImageSource::getMetadata ( int  frame) const
overridevirtual

Implements TIL_ImageSource.

const char* COP2_ImageSource::getName ( )
overridevirtual

Implements TIL_ImageSource.

OP_Node* COP2_ImageSource::getOp ( ) const
inlineoverridevirtual

Reimplemented from TIL_ImageSource.

Definition at line 156 of file COP2_ImageSource.h.

bool COP2_ImageSource::getPreferredViewingPlane ( UT_WorkBuffer &  buf) const
overridevirtual

Reimplemented from TIL_ImageSource.

const TIL_Plane* COP2_ImageSource::getPreviewPlane ( int  index)
overridevirtual

Reimplemented from TIL_ImageSource.

fpreal COP2_ImageSource::getSampleRate ( )
overridevirtual

Implements TIL_ImageSource.

int COP2_ImageSource::getSourceImage ( 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 
)
overridevirtual

Implements TIL_ImageSource.

void COP2_ImageSource::getSourceImageBounds ( 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 
)
overridevirtual

Reimplemented from TIL_ImageSource.

const TIL_Sequence* COP2_ImageSource::getSourceSequence ( fpreal  t,
const UT_Options &  options 
)
overridevirtual

Return a completed TIL_Sequence structure without postprocessing.

Implements TIL_ImageSource.

fpreal COP2_ImageSource::getStartTime ( )
overridevirtual

Implements TIL_ImageSource.

size_t COP2_ImageSource::getVersion ( )
overridevirtual

Reimplemented from TIL_ImageSource.

bool COP2_ImageSource::isAnythingLocked ( ) const
overridevirtual

Reimplemented from TIL_ImageSource.

bool COP2_ImageSource::isConstantSequence ( ) const
inlineoverridevirtual

Reimplemented from TIL_ImageSource.

Definition at line 48 of file COP2_ImageSource.h.

bool COP2_ImageSource::isFrameLocked ( fpreal  t) const
overridevirtual

Reimplemented from TIL_ImageSource.

bool COP2_ImageSource::isNetwork ( )
overridevirtual

Reimplemented from TIL_ImageSource.

bool COP2_ImageSource::isPlaneLocked ( const TIL_Plane *  ,
fpreal  t 
) const
overridevirtual

Reimplemented from TIL_ImageSource.

bool COP2_ImageSource::isSlowOperation ( ) const
inlineoverridevirtual

Reimplemented from TIL_ImageSource.

Definition at line 122 of file COP2_ImageSource.h.

bool COP2_ImageSource::open ( short &  key,
int  reset = 0,
fpreal  t = TIL_GLOBAL_TIME 
)
overridevirtual

Reimplemented from TIL_ImageSource.

TIL_ImageSource* COP2_ImageSource::selectParentSource ( int  px,
int  py,
const char *  planename,
int  array_index 
)
overridevirtual

Reimplemented from TIL_ImageSource.

virtual bool COP2_ImageSource::useHandles ( )
inlinevirtual

Definition at line 117 of file COP2_ImageSource.h.

int COP2_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 
)
overridevirtual

Reimplemented from TIL_ImageSource.

int COP2_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 
)
overridevirtual

Reimplemented from TIL_ImageSource.

The documentation for this class was generated from the following file: