HDK: HOM/HOM_NetworkBox.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_NetworkBox_h__
00017 #define __HOM_NetworkBox_h__
00018 
00019 #include "HOM_API.h"
00020 #include "HOM_Defines.h"
00021 #include "HOM_EnumModules.h"
00022 #include "HOM_Errors.h"
00023 #include "HOM_Module.h"
00024 #include <string>
00025 
00026 class HOM_Color;
00027 class HOM_Vector2;
00028 
00029 SWIGOUT(%rename(NetworkBox) HOM_NetworkBox;)
00030 
00031 class HOM_API HOM_NetworkBox
00032 {
00033 public:
00034     HOM_NetworkBox()
00035     { HOM_CONSTRUCT_OBJECT(this) }
00036     HOM_NetworkBox(const HOM_NetworkBox &net_box)
00037     { HOM_CONSTRUCT_OBJECT(this) }
00038     virtual ~HOM_NetworkBox()
00039     { HOM_DESTRUCT_OBJECT(this) }
00040 
00041     virtual std::string __repr__() 
00042         throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
00043 
00044     virtual std::string name() throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
00045     virtual void setName(const char* name)
00046         throw(HOM_ObjectWasDeleted, HOM_TypeError, HOM_OperationFailed,
00047               HOM_Error) = 0;
00048 
00049     SWIGOUT(%newobject parent;)
00050     virtual HOM_Node *parent()
00051         throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;
00052 
00053     SWIGOUT(%newobject position;)
00054     virtual HOM_Vector2 *position()
00055         throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
00056     virtual void setPosition(const std::vector<float> &position)
00057         throw(HOM_ObjectWasDeleted, HOM_InvalidSize, HOM_InvalidInput, 
00058               HOM_Error) = 0;
00059     virtual void move(const std::vector<float> &amount)
00060         throw(HOM_ObjectWasDeleted, HOM_InvalidSize, HOM_InvalidInput, 
00061               HOM_Error) = 0;
00062 
00063     SWIGOUT(%newobject size;)
00064     virtual HOM_Vector2 *size()
00065         throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
00066     virtual void setSize(const std::vector<float> &size)
00067         throw(HOM_ObjectWasDeleted, HOM_InvalidSize, HOM_InvalidInput, 
00068               HOM_Error) = 0;
00069     virtual void resize(const std::vector<float> &amount)
00070         throw(HOM_ObjectWasDeleted, HOM_InvalidSize, HOM_InvalidInput, 
00071               HOM_Error) = 0;
00072     virtual void fitAroundContents()
00073         throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
00074 
00075     virtual bool isMinimized()
00076         throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
00077     virtual void setMinimized(bool on)
00078         throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
00079     virtual bool isPicked()
00080         throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
00081     virtual void setPicked(bool on)
00082         throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
00083 
00084     SWIGOUT(%newobject color;)
00085     virtual HOM_Color *color()
00086         throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
00087     virtual void setColor(HOM_Color &color) 
00088         throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
00089 
00090     SWIGPYTHONOUT(%feature("autodoc",
00091         "nodes(self) -> tuple of Nodes") nodes;)
00092     SWIGOUT(%newobject nodes;)
00093     virtual std::vector<HOM_ElemPtr<HOM_Node> > nodes()
00094         throw(HOM_ObjectWasDeleted, HOM_Error) = 0;
00095     virtual void addNode(HOM_Node &node)
00096         throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;
00097     virtual void removeNode(HOM_Node &node)
00098         throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;
00099     virtual void removeAllNodes()
00100         throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;
00101 
00102     virtual void destroy(bool destroy_contents=false)
00103         throw(HOM_ObjectWasDeleted, HOM_OperationFailed, HOM_Error) = 0;
00104 
00105     SWIGOUT(%kwargs asCode;)
00106     virtual std::string asCode(bool brief=false,
00107                                bool recurse=false,
00108                                bool save_box_contents=false,
00109                                bool save_channels_only=false,
00110                                bool save_creation_commands=true,
00111                                bool save_keys_in_frames=false,
00112                                bool save_parm_values_only=false,
00113                                bool save_spare_parms=false,
00114                                const char *function_name=NULL)
00115         throw(HOM_ObjectWasDeleted, HOM_TypeError, HOM_Error) = 0;
00116 };
00117 
00118 #endif