home *** CD-ROM | disk | FTP | other *** search
/ AmigActive 6 / AACD06.ISO / AACD / Programming / ImageManager / Developer / ImageManager.Doc < prev   
Text File  |  2000-01-27  |  7KB  |  280 lines
  1. TABLE OF CONTENTS
  2.  
  3. ImageManager.library/--introduction--
  4. ImageManager.library/IM_CreateChainA
  5. ImageManager.library/IM_DeleteChain
  6. ImageManager.library/IM_DisposeObject
  7. ImageManager.library/IM_GetClass
  8. ImageManager.library/IM_FreeClass
  9. ImageManager.library/IM_NewObjectA
  10. ImageManager.library/IM_ObtainColourCube
  11. ImageManager.library/IM_ReleaseColourCube
  12.  
  13. ImageManager.library/--introduction--
  14.  
  15. This is a PRELIMINARY autodoc. Don't expect anything to remain as it currently
  16. is...
  17.  
  18. Feedback: Allan Odgaard <Duff@DIKU.DK>
  19.  
  20. ImageManager.library/IM_CreateChainA
  21.  
  22.    NAME
  23.       IM_CreateChainA -- Create a chain of objects
  24.       IM_CreateChain -- Varargs stub for IM_CreateChainA().
  25.  
  26.    SYNOPSIS
  27.       objects = IM_CreateChainA(flags, chain)
  28.       D0                        D0     A0
  29.  
  30.       Object **IM_CreateChainA(ULONG, APTR);
  31.  
  32.       objects = IM_CreateChain(flags, chain_element, ...)
  33.  
  34.       Object **IM_CreateChain(ULONG, ULONG, ...);
  35.  
  36.    FUNCTION
  37.       This function allows you to create an entire chain of object.
  38.  
  39.    INPUTS
  40.       flags = Currently no flags are defined.
  41.  
  42.       chain = The chain is an array that describe the chain which must be
  43.               created. A chain command can be:
  44.  
  45.        IMC_NewObject -- followed by a STRPTR and a taglist.
  46.        IMC_CustomObject -- followed by a struct IClass * and a taglist.
  47.        IMC_EndChain -- terminates the list.
  48.  
  49.    RESULT
  50.       An array of objects where the first one is the first in the chain etc.
  51.       NULL for failure.
  52.  
  53.    EXAMPLE
  54.  
  55.          Object **objects = IM_CreateChain(0L,
  56.  
  57.             IMC_NewObject, "File",
  58.                TAG_DONE,
  59.             IMC_NewObject, "Decoder",
  60.                TAG_DONE,
  61.             IMC_NewObject, "ScaleX",
  62.                IMA_ScaleX_Percent, 150,
  63.                TAG_DONE,
  64.             IMC_NewObject, "ScaleY",
  65.                IMA_ScaleY_Percent, 150
  66.                TAG_DONE,
  67.             IMC_CustomObject, myclass,
  68.                IMA_MyClass_Window, win,
  69.                TAG_DONE,
  70.             IMC_NewObject, "Container",
  71.                IMA_Container_Screen, scr,
  72.                TAG_DONE,
  73.             IMC_NewObject, "Raster",
  74.                TAG_DONE,
  75.  
  76.             IMC_EndChain);
  77.  
  78.          if(objects)
  79.          {
  80.             DoMethod(objects[0], IMM_File_Load, filename);
  81.             ...
  82.             IM_DeleteChain(objects);
  83.          }
  84.  
  85.    SEE ALSO
  86.       IM_DeleteChain()
  87.  
  88. ImageManager.library/IM_DeleteChain
  89.  
  90.    NAME
  91.       IM_DeleteChain -- Delete a chain of objects
  92.  
  93.    SYNOPSIS
  94.       IM_DeleteChain(chain)
  95.                      A0
  96.  
  97.       VOID IM_DeleteChain(Object **);
  98.  
  99.    FUNCTION
  100.       This function will delete all the objects in the chain previously
  101.       created by IM_CrateChain(). It will also free the array used for the
  102.       object pointers.
  103.  
  104.    INPUTS
  105.       chain = An array of objects as returned by IM_CrateChain()
  106.  
  107.    RESULT
  108.       None.
  109.  
  110.    SEE ALSO
  111.       IM_CreateChainA()
  112.  
  113. ImageManager.library/IM_DisposeObject
  114.  
  115.    NAME
  116.       IM_DisposeObject -- Delete an IM object.
  117.  
  118.    SYNOPSIS
  119.       IM_DisposeObject(object)
  120.                        A0
  121.  
  122.       VOID MUI_DisposeObject(Object *);
  123.  
  124.    FUNCTION
  125.       Deletes an IM object and all of it's auxiliary data.
  126.       These objects are all created by IM_NewObject() or NewObject().
  127.  
  128.    INPUTS
  129.       object = abstract pointer to an IM object returned by
  130.                MUI_NewObject(). The pointer may be NULL, in which case
  131.                this function has no effect.
  132.  
  133.    RESULT
  134.       None.
  135.  
  136.    SEE ALSO
  137.       IM_NewObjectA()
  138.  
  139. ImageManager.library/IM_GetClass
  140.  
  141.    NAME
  142.       IM_GetClass -- Get a pointer to an IM class.
  143.  
  144.    SYNOPSIS
  145.       class = IM_GetClass(classID)
  146.       D0                  A0
  147.  
  148.       struct IClass *IM_GetClass(STRPTR);
  149.  
  150.    FUNCTION
  151.       Obtain a pointer to the class of a certain classID.
  152.       You need this pointer if you want to create a subclass.
  153.  
  154.    INPUTS
  155.       classID = the name/ID string of a IM class, e.g. "Decoder".
  156.  
  157.    RESULT
  158.       A pointer to the class or NULL for failure.
  159.  
  160.    SEE ALSO
  161.       FreeClass(), intuiton.library/MakeClass()
  162.  
  163. ImageManager.library/IM_FreeClass
  164.  
  165.    NAME
  166.       IM_FreeClass -- Free a class obtained from IM_GetClass()
  167.  
  168.    SYNOPSIS
  169.       IM_FreeClass(class)
  170.                    A0
  171.  
  172.         VOID IM_FreeClass(struct IClass *);
  173.  
  174.    FUNCTION
  175.       Free a class previously obtained using IM_GetClass(),
  176.  
  177.    INPUTS
  178.       class = pointer to class.
  179.  
  180.    SEE ALSO
  181.       GetClass()
  182.  
  183. ImageManager.library/IM_NewObjectA
  184.  
  185.    NAME
  186.       IM_NewObjectA -- Create an object from a class.
  187.       IM_NewObject -- Varargs stub for IM_NewObjectA().
  188.  
  189.    SYNOPSIS
  190.       object = IM_NewObjectA(classID, tags)
  191.       D0                     A0       A1
  192.  
  193.       Object *IM_NewObjectA(STRPTR, struct TagItem *);
  194.  
  195.       object = IM_NewObject(classID, Tag1, ...)
  196.  
  197.       Object *IM_NewObject(STRPTR, ULONG, ...);
  198.  
  199.    FUNCTION
  200.       This is the general method of creating objects from IM classes.
  201.       You specify a class by its ID string. If the class is not
  202.       already in memory or built into imagemanager.library, it will be
  203.       loaded using OpenLibrary("ImageManager/%s",0).
  204.  
  205.       You further specify initial "create-time" attributes for the
  206.       object via a TagItem list, and they are applied to the resulting
  207.       generic data object that is returned. The attributes, their meanings,
  208.       attributes applied only at create-time, and required attributes
  209.       are all defined and documented on a class-by-class basis.
  210.  
  211.    INPUTS
  212.       classID = the name/ID string of a IM class, e.g. "Decoder".
  213.                 Class names are case sensitive!
  214.  
  215.       tagList = pointer to array of TagItems containing attribute/value
  216.                 pairs to be applied to the object being created.
  217.  
  218.    RESULT
  219.       An IM object, which may be used on its own or added to a chain of
  220.       objects for serial processing of (image) data.
  221.       The object may be manipulated by generic functions such as SetAttrs(),
  222.       GetAttr(), DoMethod() etc.
  223.       You eventually free the object using IM_DisposeObject().
  224.  
  225.    SEE ALSO
  226.       IM_DisposeObject(), SetAttrs(), GetAttr().
  227.  
  228. ImageManager.library/IM_ObtainColourCube
  229.  
  230.    NAME
  231.       IM_ObtainColourCube -- Obtain a screen specific colour cube
  232.  
  233.    SYNOPSIS
  234.       cube = IM_ObtainColourCube(screen)
  235.       D0                         A0
  236.  
  237.       APTR IM_ObtainColourCube(struct Screen *);
  238.  
  239.    FUNCTION
  240.       Obtain a colour cube for the specified screen.
  241.  
  242.    INPUTS
  243.       screen = Pointer to the screen for which you want a colour cube.
  244.  
  245.    RESULT
  246.       A blockbox colour cube, which can be used with the remap or
  247.       floyd steinberg dither objects.
  248.  
  249.    SEE ALSO
  250.       IM_ReleaseColourCube()
  251.  
  252. ImageManager.library/IM_ReleaseColourCube
  253.  
  254.    NAME
  255.       IM_ReleaseColourCube -- Release a colour cube object
  256.  
  257.    SYNOPSIS
  258.       IM_ReleaseColourCube(cube)
  259.  
  260.       VOID IM_ReleaseColourCube(APTR)
  261.  
  262.    FUNCTION
  263.       Release a previously obtained colour cube object.
  264.  
  265.    INPUTS
  266.       cube = A colour cube obtained with IM_ObtainColourCube() or NULL.
  267.  
  268.    RESULT
  269.       None.
  270.  
  271.    NOTE
  272.       Releasing a colour cube object for a screen will free all pens that may
  273.       have been locked. So you generally shouldn't free this object, while
  274.       you're displaying image data that makes use of the colours obtained
  275.       through it.
  276.  
  277.    SEE ALSO
  278.       IM_ObtainColourCube
  279.  
  280.