## File: Montage_mpp.tex

package info (click to toggle)
imagemagick 6:6.0.6.2-2.9
 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284 \section{} \scriptsize{ \begin{verbatim} Magick::Montage Class A montage is a single image which is composed of thumbnail images composed in a uniform grid. The size of the montage image is determined by the size of the individual thumbnails and the number of rows and columns in the grid. The following illustration shows a montage consisting of three columns and two rows of thumbnails rendered on a gray background: [montage-sample-framed.jpg] Montages may be either "plain" (undecorated thumbnails) or "framed" (decorated thumbnails). In order to more easily understand the options supplied to MontageImages(), montage options are supplied by two different classes: Magick::Montage and Magick::MontageFramed. Plain Montages Magick::Montage is the base class to provide montage options and provides methods to set all options required to render simple (un-framed) montages. See Magick::MontageFramedif you would like to create a framed montage. Un-framed thumbnails consist of four components: the thumbnail image, the thumbnail border, an optional thumbnail shadow, and an optional thumbnail label area. [thumbnail-anatomy-plain.jpg] Montage Methods Method Return Type Signature(s) Description Montage void Default constructor Specifies the backgroundColor void const Color background color &backgroundColor_ that thumbnails are imaged upon. Color void Specifies the image composition algorithm for thumbnails. This controls the algorithm by which the thumbnail image is placed on the compose void CompositeOperator background. Use of compose_ OverCompositeOp is recommended for use with images that have transparency. This option may have negative side-effects for images without transparency. CompositeOperator void Specifies the image filename to be used for the generated montage images. To handle the case were multiple montage images are generated, a printf-style format fileName void std::string may be embedded fileName_ within the filename. For example, a filename specification of image%02d.miff names the montage images as image00.miff, image01.miff, etc. std::string void Specifies the fill fill void const Color &pen_ color to use for the label text. Color void Specifies the font void std::string font_ thumbnail label font. std::string void Specifies the size geometry void const Geometry of the generated &geometry_ thumbnail. Geometry void Specifies the thumbnail positioning within the specified geometry area. If gravity void GravityType gravity_the thumbnail is smaller in any dimension than the geometry, then it is placed according to this specification. GravityType void Specifies the format used for the image label. Special format label void std::string label_ characters may be embedded in the format string to include information about the image. std::string void Specifies the pen penColor void const Color &pen_ color to use for the label text (same as fill). Color void Specifies the pointSize void unsigned int thumbnail label pointSize_ font size. unsigned int void Enable/disable shadow void bool shadow_ drop-shadow on thumbnails. bool void Specifies the stroke void const Color &pen_ stroke color to use for the label text . Color void Specifies a texture image to use as montage background. The built-in texture void std::string texture_textures "granite:" and "plasma:" are available. A texture is the same as a background image. std::string void Specifies the maximum number of montage columns and rows in the montage. The montage is built by filling out all tile void const Geometry cells in a row &tile_ before advancing to the next row. Once the montage has reached the maximum number of columns and rows, a new montage image is started. Geometry void Specifies a montage color to set transparent. This option can be set the same as the background color in order for the thumbnails to transparentColor void const Color appear without a &transparentColor_ background when rendered on an HTML page. For best effect, ensure that the transparent color selected does not occur in the rendered thumbnail colors. Color void Framed Montages Magick::MontageFramed provides the means to specify montage options when it is desired to have decorative frames around the image thumbnails. MontageFramed inherits from Montage and therefore provides all the methods of Montage as well as those shown in the table "MontageFramed Methods". Framed thumbnails consist of four components: the thumbnail image, the thumbnail frame, the thumbnail border, an optional thumbnail shadow, and an optional thumbnail label area. [thumbnail-anatomy-framed.jpg] MontageFramed Methods Method Return Signature(s) Description Type MontageFramed void Default constructor (enable frame via frameGeometry). Specifies the background borderColor void const Color color within the thumbnail &borderColor_ frame. Color void Specifies the border (in pixels) to place between a thumbnail and its surrounding frame. This option only takes effect if thumbnail frames borderWidth void unsigned int are enabled (via borderWidth_ frameGeometry) and the thumbnail geometry specification doesn't also specify the thumbnail border width. unsigned void int Specifies the geometry specification for frame to frameGeometry void const Geometry place around thumbnail. If &frame_ this parameter is not specified, then the montage is un-framed. Geometry void matteColor void const Color Specifies the thumbnail frame &matteColor_ color. Color void \end{verbatim} }