HDK: HOM/HOM_CopNode.h Source File

00001 /*
00002  * PROPRIETARY INFORMATION.  This software is proprietary to
00003  * Side Effects Software Inc., and is not to be reproduced,
00004  * transmitted, or disclosed in any way without written permission.
00005  *
00006  * Produced by:
00007  *      Side Effects Software Inc
00008  *      123 Front Street West, Suite 1401
00009  *      Toronto, Ontario
00010  *      Canada   M5J 2M2
00011  *      416-504-9876
00012  *
00013  * COMMENTS:
00014  */
00015 
00016 #ifndef __HOM_CopNode_h__
00017 #define __HOM_CopNode_h__
00018 
00019 #include "HOM_API.h"
00020 #include "HOM_Defines.h"
00021 #include "HOM_Errors.h"
00022 #include "HOM_Node.h"
00023 #include "HOM_Track.h"
00024 
00025 SWIGOUT(%rename(CopNode) HOM_CopNode;)
00026 
00027 class HOM_API HOM_CopNode : virtual public HOM_Node
00028 {
00029 public:
00030     HOM_CopNode()
00031     { HOM_CONSTRUCT_OBJECT(this) }
00032     HOM_CopNode(const HOM_CopNode &cop_node)
00033     : HOM_Node(cop_node)
00034     { HOM_CONSTRUCT_OBJECT(this) }
00035     virtual ~HOM_CopNode()
00036     { HOM_DESTRUCT_OBJECT(this) }
00037 
00038     // Let swig know we're overriding __repr__ for this class so it doesn't
00039     // provide its own __repr__.
00040     SWIGOUT(virtual std::string __repr__()
00041         throw(HOM_ObjectWasDeleted, HOM_Error) = 0;)
00042 
00043     virtual bool isBypassed()
00044         throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
00045     virtual void bypass(bool on)
00046         throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;
00047     virtual bool isDisplayFlagSet()
00048         throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
00049     virtual void setDisplayFlag(bool on)
00050         throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;
00051     virtual bool isRenderFlagSet()
00052         throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
00053     virtual void setRenderFlag(bool on)
00054         throw(HOM_PermissionError, HOM_ObjectWasDeleted, HOM_Error) = 0;
00055 
00056     SWIGPYTHONOUT(%feature("autodoc",
00057         "planes(self) -> tuple of strings") planes;)
00058     virtual std::vector<std::string> planes()
00059         throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;
00060     SWIGPYTHONOUT(%feature("autodoc",
00061         "components(self, plane) -> tuple of strings") components;)
00062     virtual std::vector<std::string> components(const char *plane)
00063         throw(HOM_ObjectWasDeleted, HOM_ValueError, HOM_OperationFailed, 
00064               HOM_Error) = 0;
00065 
00066     SWIGPYTHONOUT(%feature("autodoc",
00067         "getPixelByUV(self, plane, u, v, component=None, "
00068         "interpolate=True) -> tuple of floats") getPixelByUV;)
00069     SWIGOUT(%kwargs getPixelByUV);
00070     virtual std::vector<float> getPixelByUV(const char *plane,
00071         double u, double v, const char *component=NULL,  
00072         bool interpolate=true)
00073         throw(HOM_ObjectWasDeleted, HOM_OperationFailed, 
00074               HOM_ValueError, HOM_Error) = 0;
00075     SWIGPYTHONOUT(%feature("autodoc",
00076         "getPixelHSVByUV(self, u, v, interpolate=True) -> tuple of floats") 
00077         getPixelHSVByUV;)
00078     SWIGOUT(%kwargs getPixelHSVByUV);
00079     virtual std::vector<float> getPixelHSVByUV(double u, double v, 
00080                                                bool interpolate=true)
00081         throw(HOM_ObjectWasDeleted, HOM_OperationFailed, 
00082               HOM_ValueError, HOM_Error) = 0;
00083     SWIGOUT(%kwargs getPixelLuminanceByUV);
00084     virtual float getPixelLuminanceByUV(double u, double v, 
00085                                         bool interpolate=true)
00086         throw(HOM_ObjectWasDeleted, HOM_OperationFailed, 
00087               HOM_ValueError, HOM_Error) = 0;
00088 
00089     SWIGPYTHONOUT(%feature("autodoc",
00090         "imageBounds(self, plane=\"C\") -> tuple of ints")
00091         imageBounds;)
00092     SWIGOUT(%kwargs imageBounds);
00093     virtual std::vector<int> imageBounds(const char *plane="C") 
00094         throw(HOM_ObjectWasDeleted, HOM_OperationFailed, 
00095               HOM_ValueError, HOM_Error) = 0;
00096     virtual int xRes()
00097         throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;
00098     virtual int yRes()
00099         throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;
00100 
00101     virtual float sequenceStartFrame()
00102         throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;
00103     virtual float sequenceEndFrame()
00104         throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;
00105     virtual float sequenceFrameLength()
00106         throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;
00107 
00108     virtual bool isSingleImage()
00109         throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;
00110 
00111     SWIGPYTHONOUT(%feature("autodoc",
00112         "saveImage(self, file_name, frame_range=())") saveImage;)
00113     virtual void saveImage(const char *file_name, 
00114             const std::vector<int> frame_range = std::vector<int>())
00115         throw(HOM_ObjectWasDeleted, HOM_InvalidSize,
00116               HOM_OperationFailed, HOM_ValueError, HOM_Error) = 0;
00117 };
00118 
00119 #endif