ImageResizer.Plugins.PsdComposer.PsdComposerPlugin Class Reference

Inheritance diagram for ImageResizer.Plugins.PsdComposer.PsdComposerPlugin:

Collaboration diagram for ImageResizer.Plugins.PsdComposer.PsdComposerPlugin:

Public Member Functions
IPlugin	Install (Config c)
	Installs the plugin in the specified Config instance. The plugin must handle all the work of loading settings, registering the plugin etc. More...
bool	Uninstall (Config c)
	Uninstalls the plugin. Should reverse all changes made during Install More...
bool	FileExists (string virtualPath, NameValueCollection queryString)
	Returns true if the specified file and querystring indicate a PSD composition request More...
IVirtualFile	GetFile (string virtualPath, NameValueCollection queryString)
	Returns a virtual file instance for the specified specified file and querystring, if they indicate a PSD composition request. Otherwise, null is returned. More...
IEnumerable< string >	GetSupportedQuerystringKeys ()
	If the plugin reads any values from the querystring, the names of the keys should be specified here. This information is required so that the HttpModule knows when to handle an image request. More...
IEnumerable< string >	GetSupportedFileExtensions ()
	If the plugin adds support for new file extensions (such as "psd"), they should be returned by this method. More...
Stream	ComposeStream (string virtualPath, NameValueCollection queryString)
	Returns a stream to the composed file, encoded in the format requested by the querystring or fake extension More...
System.Drawing.Bitmap	ComposeBitmap (string virtualPath, NameValueCollection queryString)
	Returns a Bitmap instance of the composed result More...
Size	GetPsdDimensions (string virtualPath, NameValueCollection queryString)
	Returns the size of the PSD More...
IList< IPsdLayer >	GetAllLayers (string virtualPath, NameValueCollection queryString)
	Returns a collection of all the layers for the specified file (memcached) More...
IList< IPsdLayer >	GetVisibleTextLayers (string virtualPath, NameValueCollection queryString)
	Returns a collection of all visible text layers for the file (memcached). Useful for building image maps More...

Protected Member Functions
bool	isStrictMode ()
IPsdRenderer	GetSelectedRenderer (NameValueCollection queryString)
	Returns the renderer object selected in the querystring More...
KeyValuePair< Size, IList < IPsdLayer > >	GetFileMetadata (string virtualPath, NameValueCollection queryString)
	Returns a collection of all the layers for the specified file and the size of the file (memcached) More...
bool	IsPathPSDToCompose (string virtualPath, NameValueCollection queryString=null)
	True if the file is a .psd.jpeg, .psd.png, etc file. More...

Detailed Description

Definition at line 23 of file PsdComposerPlugin.cs.

Member Function Documentation

System.Drawing.Bitmap ImageResizer.Plugins.PsdComposer.PsdComposerPlugin.ComposeBitmap ( string  virtualPath, NameValueCollection  queryString  )

inline

Returns a Bitmap instance of the composed result

Parameters

id

Returns

Definition at line 123 of file PsdComposerPlugin.cs.

                                                                                                        {
            //Renderer object
            IPsdRenderer renderer = GetSelectedRenderer(queryString);

            //Bitmap we will render to
            System.Drawing.Bitmap b = null;

            MemCachedFile file = MemCachedFile.GetCachedVirtualFile(StripFakeExtension(virtualPath),c.Pipeline, new NameValueCollection());
            using (Stream s = file.GetStream()) {
                //Time just the parsing/rendering
                Stopwatch swRender = new Stopwatch();
                swRender.Start();

                IList<IPsdLayer> layers = null;
                Size size = Size.Empty;
                //Use the selected renderer to parse the file and compose the layers, using this delegate callback to determine which layers to show.
                b = renderer.Render(s, out layers, out size, BuildLayerCallback(queryString), BuildModifyLayerCallback(queryString));

                //Save layers & size for later use
                file.SetSubkey("layers_" + renderer.ToString(), layers);
                file.SetSubkey("size_" + renderer.ToString(), size);

                //How fast?
                swRender.Stop();
                trace("Using encoder " + renderer.ToString() + ", rendering stream to a composed Bitmap instance took " + swRender.ElapsedMilliseconds.ToString() + "ms");
            }


            return b;
        }

Stream ImageResizer.Plugins.PsdComposer.PsdComposerPlugin.ComposeStream ( string  virtualPath, NameValueCollection  queryString  )

inline

Returns a stream to the composed file, encoded in the format requested by the querystring or fake extension

Parameters

id

Returns

Definition at line 94 of file PsdComposerPlugin.cs.

                                                                                         {

            Stopwatch sw = new Stopwatch();
            sw.Start();

        
            System.Drawing.Bitmap b = ComposeBitmap(virtualPath, queryString);
            //Memory stream for encoding the file
            MemoryStream ms = new MemoryStream();
            //Encode image to memory stream, then seek the stream to byte 0
            using (b) {
                //Use whatever settings appear in the URL 
                IEncoder encoder = c.Plugins.GetEncoder(new ImageResizer.ResizeSettings(queryString), virtualPath);
                encoder.Write(b, ms);
                ms.Seek(0, SeekOrigin.Begin); //Reset stream for reading
            }


            sw.Stop();
            trace("Total time, including encoding: " + sw.ElapsedMilliseconds.ToString() + "ms");

            return ms;
        }

bool ImageResizer.Plugins.PsdComposer.PsdComposerPlugin.FileExists ( string  virtualPath, NameValueCollection  queryString  )

inline

Returns true if the specified file and querystring indicate a PSD composition request

Parameters

virtualPath
queryString

Returns

Implements ImageResizer.Plugins.IVirtualImageProvider.

Definition at line 46 of file PsdComposerPlugin.cs.

                                                                                    {
            return IsPathPSDToCompose(virtualPath,queryString) && c.Pipeline.FileExists(StripFakeExtension(virtualPath),new NameValueCollection());
        }

IList<IPsdLayer> ImageResizer.Plugins.PsdComposer.PsdComposerPlugin.GetAllLayers ( string  virtualPath, NameValueCollection  queryString  )

inline

Returns a collection of all the layers for the specified file (memcached)

Parameters

virtualPath
queryString

Returns

Definition at line 170 of file PsdComposerPlugin.cs.

                                                                                                  {
            return GetFileMetadata(virtualPath, queryString).Value;
        }

IVirtualFile ImageResizer.Plugins.PsdComposer.PsdComposerPlugin.GetFile ( string  virtualPath, NameValueCollection  queryString  )

inline

Returns a virtual file instance for the specified specified file and querystring, if they indicate a PSD composition request. Otherwise, null is returned.

Parameters

virtualPath
queryString

Returns

Implements ImageResizer.Plugins.IVirtualImageProvider.

Definition at line 57 of file PsdComposerPlugin.cs.

                                                                                         {
            if (IsPathPSDToCompose(virtualPath, queryString) && c.Pipeline.FileExists(StripFakeExtension(virtualPath), new NameValueCollection()))
                return new PsdVirtualFile(virtualPath, queryString, this);
            else
                return null;
        }

KeyValuePair<Size,IList<IPsdLayer> > ImageResizer.Plugins.PsdComposer.PsdComposerPlugin.GetFileMetadata ( string  virtualPath, NameValueCollection  queryString  )

inlineprotected

Returns a collection of all the layers for the specified file and the size of the file (memcached)

Parameters

virtualPath
queryString

Returns

Definition at line 179 of file PsdComposerPlugin.cs.

                                                                                                                           {
            Stopwatch sw = new Stopwatch();
            sw.Start();


            //Renderer object
            IPsdRenderer renderer = GetSelectedRenderer(queryString);
            //File
            MemCachedFile file = MemCachedFile.GetCachedVirtualFile(StripFakeExtension(virtualPath), c.Pipeline, new NameValueCollection());
            //key
            string layersKey = "layers_" + renderer.ToString();
            string sizeKey = "size_" + renderer.ToString();

            //Try getting from the cache first
            IList<IPsdLayer> layers = file.GetSubkey(layersKey) as IList<IPsdLayer>;
            Size size = file.GetSubkey(sizeKey) is Size ? (Size)file.GetSubkey(sizeKey) : Size.Empty;
            if (layers == null) {
                //Time just the parsing
                Stopwatch swRender = new Stopwatch();
                swRender.Start();

                layers = renderer.GetLayersAndSize(file.GetStream(), out size);

                //Save to cache for later
                file.SetSubkey(layersKey, layers);
                file.SetSubkey(sizeKey, size);
                //How fast?
                swRender.Stop();
                trace("Using decoder " + renderer.ToString() + ",parsing file and enumerating layers took " + swRender.ElapsedMilliseconds.ToString() + "ms");
            }


            sw.Stop();
            trace("Total time for enumerating, including file reading: " + sw.ElapsedMilliseconds.ToString(NumberFormatInfo.InvariantInfo) + "ms");
            return new KeyValuePair<Size,IList<IPsdLayer>>(size,layers);
        }

Size ImageResizer.Plugins.PsdComposer.PsdComposerPlugin.GetPsdDimensions ( string  virtualPath, NameValueCollection  queryString  )

inline

Returns the size of the PSD

Parameters

virtualPath
queryString

Returns

Definition at line 160 of file PsdComposerPlugin.cs.

                                                                                          {
            return GetFileMetadata(virtualPath, queryString).Key;
        }

IPsdRenderer ImageResizer.Plugins.PsdComposer.PsdComposerPlugin.GetSelectedRenderer ( NameValueCollection  queryString )

inlineprotected

Returns the renderer object selected in the querystring

Returns

Definition at line 83 of file PsdComposerPlugin.cs.

        {
            return new PsdPluginRenderer(); //There is only ONE renderer now - The Agurigma one was horrible
        }

IEnumerable<string> ImageResizer.Plugins.PsdComposer.PsdComposerPlugin.GetSupportedFileExtensions ( )

inline

If the plugin adds support for new file extensions (such as "psd"), they should be returned by this method.

Returns

Implements ImageResizer.Plugins.IFileExtensionPlugin.

Definition at line 69 of file PsdComposerPlugin.cs.

                                                                {
            return new string[] { "psd" };
        }

IEnumerable<string> ImageResizer.Plugins.PsdComposer.PsdComposerPlugin.GetSupportedQuerystringKeys ( )

inline

If the plugin reads any values from the querystring, the names of the keys should be specified here. This information is required so that the HttpModule knows when to handle an image request.

Returns

Implements ImageResizer.Plugins.IQuerystringPlugin.

Definition at line 65 of file PsdComposerPlugin.cs.

                                                                 {
            return PsdCommandBuilder.GetSupportedQuerystringKeys();
        }

IList<IPsdLayer> ImageResizer.Plugins.PsdComposer.PsdComposerPlugin.GetVisibleTextLayers ( string  virtualPath, NameValueCollection  queryString  )

inline

Returns a collection of all visible text layers for the file (memcached). Useful for building image maps

Parameters

virtualPath
queryString

Returns

Definition at line 222 of file PsdComposerPlugin.cs.

                                                                                                          {

            //Get all layers
            IList<IPsdLayer> layers = GetAllLayers(virtualPath, queryString);


            Stopwatch sw = new Stopwatch();
            sw.Start();
            //Now, time to filter layers to those that would be showing on the image right now.
            IList<IPsdLayer> filtered = new List<IPsdLayer>();

            //Generate a callback just like the one used in the renderer for filtering
            ShowLayerDelegate callback = BuildLayerCallback(queryString);

            for (int i = 0; i < layers.Count; i++) {
                if (layers[i].IsTextLayer && callback(layers[i].Index, layers[i].Name, layers[i].Visible)) {
                    filtered.Add(layers[i]);
                }
            }

            sw.Stop();
            trace("Time for filtering layers: " + sw.ElapsedMilliseconds.ToString() + "ms");
            return filtered;

        }

IPlugin ImageResizer.Plugins.PsdComposer.PsdComposerPlugin.Install ( Config  c )

inline

Installs the plugin in the specified Config instance. The plugin must handle all the work of loading settings, registering the plugin etc.

Parameters

c

Returns

Implements ImageResizer.Plugins.IPlugin.

Definition at line 29 of file PsdComposerPlugin.cs.

                                         {
            this.c = c;
            this.c.Plugins.add_plugin(this);
            return this;
        }

bool ImageResizer.Plugins.PsdComposer.PsdComposerPlugin.IsPathPSDToCompose ( string  virtualPath, NameValueCollection  queryString = null  )

inlineprotected

True if the file is a .psd.jpeg, .psd.png, etc file.

Definition at line 364 of file PsdComposerPlugin.cs.

        {
            string fileName = System.IO.Path.GetFileName(virtualPath); //Exclude the folders, just looking at the filename here.
            int psd = fileName.IndexOf(".psd",StringComparison.OrdinalIgnoreCase);
            if (psd > -1){
                //We always take the .psd. syntax
                if (fileName.IndexOf(".psd.",StringComparison.OrdinalIgnoreCase) > -1) return true;

                if (queryString == null) queryString = c.Pipeline.ModifiedQueryString;
                //But we only grab the .psd syntax if we detect our commands
                foreach(string s in PsdCommandBuilder.GetSupportedQuerystringKeys()){
                    if (!string.IsNullOrEmpty(queryString[s])) return true;
                }
            }
            return false;
        }

bool ImageResizer.Plugins.PsdComposer.PsdComposerPlugin.Uninstall ( Config  c )

inline

Uninstalls the plugin. Should reverse all changes made during Install

Parameters

c

Returns

Implements ImageResizer.Plugins.IPlugin.

Definition at line 35 of file PsdComposerPlugin.cs.

                                        {
            c.Plugins.remove_plugin(this);
            return true;
        }

---

The documentation for this class was generated from the following file:

• C:/Users/nathanael/Documents/resizer/Plugins/PsdComposer/PsdComposerPlugin.cs