home *** CD-ROM | disk | FTP | other *** search
/ Hackers Magazine 57 / CdHackersMagazineNr57.iso / Software / Multimedia / k3d-setup-0.7.11.0.exe / lib / site-packages / cgkit / Interfaces / isceneitem.py < prev    next >
Encoding:
Python Source  |  2007-01-11  |  2.6 KB  |  73 lines
  1. # ***** BEGIN LICENSE BLOCK *****
  2. # Version: MPL 1.1/GPL 2.0/LGPL 2.1
  3. #
  4. # The contents of this file are subject to the Mozilla Public License Version
  5. # 1.1 (the "License"); you may not use this file except in compliance with
  6. # the License. You may obtain a copy of the License at
  7. # http://www.mozilla.org/MPL/
  8. #
  9. # Software distributed under the License is distributed on an "AS IS" basis,
  10. # WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11. # for the specific language governing rights and limitations under the
  12. # License.
  13. #
  14. # The Original Code is the Python Computer Graphics Kit.
  15. #
  16. # The Initial Developer of the Original Code is Matthias Baas.
  17. # Portions created by the Initial Developer are Copyright (C) 2004
  18. # the Initial Developer. All Rights Reserved.
  19. #
  20. # Contributor(s):
  21. #
  22. # Alternatively, the contents of this file may be used under the terms of
  23. # either the GNU General Public License Version 2 or later (the "GPL"), or
  24. # the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  25. # in which case the provisions of the GPL or the LGPL are applicable instead
  26. # of those above. If you wish to allow use of your version of this file only
  27. # under the terms of either the GPL or the LGPL, and not to allow others to
  28. # use your version of this file under the terms of the MPL, indicate your
  29. # decision by deleting the provisions above and replace them with the notice
  30. # and other provisions required by the GPL or the LGPL. If you do not delete
  31. # the provisions above, a recipient may use your version of this file under
  32. # the terms of any one of the MPL, the GPL or the LGPL.
  33. #
  34. # ***** END LICENSE BLOCK *****
  35. # $Id: isceneitem.py,v 1.1.1.1 2004/12/12 14:31:43 mbaas Exp $
  36.  
  37. from protocols import Interface
  38.  
  39. class ISceneItem(Interface):
  40.     """The base scene item protocol that must be supported by all scene items.
  41.  
  42.     A scene item must have an attribute \c name of type \c str which
  43.     contains its name.
  44.     """
  45.  
  46.     def protocols(self):
  47.         """Return a list of supported protocols."""
  48.         
  49.  
  50. class ISceneItemContainer(ISceneItem):
  51.     """This interface must be supported by scene items that can contain children.
  52.  
  53.     The children must support the ISceneItem protocol.
  54.     """
  55.  
  56.     def lenChilds(self):
  57.         """Return the number of children."""
  58.  
  59.     def iterChilds(self):
  60.         """Return an iterator that iterates over all children."""
  61.  
  62.     def addChild(self, child):
  63.         """Add a children."""
  64.  
  65.     def removeChild(self, child):
  66.         """Remove an existing children."""
  67.  
  68.     def findChildByName(self, name):
  69.         """Return the children with the specified name.
  70.  
  71.         \return Child or None.
  72.         """
  73.