Inheritance diagram for ImageResizer.Plugins.Watermark.Layer:

Public Types
enum	LayerPlacement { Overlay, Background }

Public Member Functions
	Layer (NameValueCollection settings)

virtual void	CopyTo (Layer other)

virtual object[]	GetHashBasis ()

int	GetDataHash ()

delegate Size	CalculateLayerContentSize (double maxwidth, double maxheight)

RectangleF	CalculateLayerCoordinates (ImageState s, CalculateLayerContentSize actualSizeCalculator, bool forceInsideCanvas)
	Returns a rectangle with canvas-relative coordinates. A callback is required to calculate the actual size of the content based on the specified bounds. The callback may be passed double.NaN for one or more paramters to indicate that they are not specified. More...

double	Resolve (DistanceUnit value, double relativeToValue, double percentRelativeTo, bool invert)

virtual void	RenderTo (ImageState s)

Properties
DistanceUnit	Top `[get, set]`
	The offset from the top of the container. Percentages are relative to the container height. Defines the upper boundary for the layer. If null, Bottom will be used to calcuate the value based on the height. If Bottom is not specified, defaults to 0. Positive values are inside the container, negative values outside it. More...

DistanceUnit	Left `[get, set]`
	The offset from the left of the container. Percentages are relative to the container width. Defines the leftmost boundary for the layer. If null, Right will be used to calcuate the value based on the width. If Right is not specified, defaults to 0. Positive values are inside the container, negative values outside it. More...

DistanceUnit	Right `[get, set]`
	The offset relative to the right side of the container. Percentages are relative to the container width. Defines the rightmost boundary for the layer. If null, Top will be used to calcuate the value based on the height. If Top is not specified, defaults to 0. Positive values are inside the container, negative values outside it. More...

DistanceUnit	Bottom `[get, set]`
	The offset relative to the bottom of the container. Percentages are relative to the container height. Defines the bottom-most boundary for the layer. If null, Top will be used to calcuate the value based on the height. If Top is not specified, defaults to 0. Positive values are inside the container, negative values outside it. More...

DistanceUnit	Width `[get, set]`
	The width of the layer. If used with both Left and Right, the smaller result wins. I.e, with a 100px container, width=50, left=30, right=30, the resulting width will be 40. If null, Left and Right will be used to calcuate the value. If both Left and Right are not specified, the natural width of the layer's contents will be used. Percentages are relative to the container width. More...

DistanceUnit	Height `[get, set]`
	The height of the layer. If used with both Top and Bottom, the smaller result wins. I.e, with a 100px container, height=50, top=30, top=30, the resulting height will be 40. If null, Top and Bottom will be used to calcuate the value. If both Top and Bottom are not specified, the natural height of the layer's contents will be used. Percentages are relative to the container height. More...

string	RelativeTo `[get, set]`
	Specifies the container that the position values (top,left,right,bottom,width,heght) are relative to. The default is 'image' (the innermost square, which contains the original photo). Additional valid values include 'imageArea' (includes whitespace added to preserve aspect ratio), 'padding', 'border', 'margin', and 'canvas'. More...

ContentAlignment	Align `[get, set]`
	The alignment to use when (a) all 3 horizontal or vertical values are specified, and they need to be resolved, (b) when only width/height are specified, (c) when no positioning values are specified, or (d) when the content doesn't precisely fill they layer bounds. More...

bool	Fill `[get, set]`
	(defaults false). When true, the image or text will attempt to fill 1 of the layer's bounds, even if upscaling is required. When Width is not specified, and both left and right are not specififed, this causes the image to fill the container width (if possible). When Height is not specified, and both top and bottom are not specififed, this causes the image to fill the container height (if possible). This causes &scale=both to be used on images unless another setting is specified in imageQuery. More...

LayerPlacement	DrawAs `[get, set]`
	The z-order at which to draw the layer. Curret options are Overlay (over everything) and Background (over the background color). More...

Detailed Description

Definition at line 11 of file Layer.cs.

Member Function Documentation

RectangleF ImageResizer.Plugins.Watermark.Layer.CalculateLayerCoordinates	(	ImageState	s,
		CalculateLayerContentSize	actualSizeCalculator,
		bool	forceInsideCanvas
	)

inline

Returns a rectangle with canvas-relative coordinates. A callback is required to calculate the actual size of the content based on the specified bounds. The callback may be passed double.NaN for one or more paramters to indicate that they are not specified.

Parameters

s

Returns

Definition at line 184 of file Layer.cs.

                                                                                                                                           {
             //Find container 
             RectangleF cont;
             if (s.layout.ContainsRing(RelativeTo))
                 cont = PolygonMath.GetBoundingBox(s.layout[RelativeTo]);
             else if ("canvas".Equals(RelativeTo, StringComparison.OrdinalIgnoreCase)) 
                 cont = new RectangleF(new PointF(), s.destSize);
             else 
                 cont = PolygonMath.GetBoundingBox(s.layout["image"]);
             
             //Calculate layer coords
             RectangleF rect = new RectangleF();
 
             //Resolve all values to the same coordinate plane, null values will be transformed to NaN
             double left = Resolve(Left, cont.X, cont.Width, false);
             double top = Resolve(Top, cont.Y, cont.Height, false);
             double right = Resolve(Right, cont.Right, cont.Width, true);
             double bottom = Resolve(Bottom, cont.Bottom, cont.Height, true);
             double width = Resolve(Width, 0, cont.Width, false);
             double height = Resolve(Height, 0, cont.Height, false);
 
             //Force all values to be within the canvas area.
             if (forceInsideCanvas) {
                 SizeF canvas = s.destSize;
                 if (!double.IsNaN(left)) left = Math.Min(Math.Max(0, left), canvas.Width);
                 if (!double.IsNaN(right)) right = Math.Min(Math.Max(0, right), canvas.Width);
                 if (!double.IsNaN(width)) width = Math.Min(Math.Max(0, width), canvas.Width);
                 if (!double.IsNaN(bottom)) bottom = Math.Min(Math.Max(0, bottom), canvas.Height);
                 if (!double.IsNaN(top)) top = Math.Min(Math.Max(0, top), canvas.Height);
                 if (!double.IsNaN(height)) height = Math.Min(Math.Max(0, height), canvas.Height);
             }
 
             //If right and left (or top and bottom) are inverted, avg them and set them equal.
             if (!double.IsNaN(left) && !double.IsNaN(right) && right < left) left = right = ((left + right) / 2);
             if (!double.IsNaN(top) && !double.IsNaN(bottom) && bottom < top) bottom = top = ((bottom + top) / 2);
 
 
             //Fill in width/height if enough stuff is specified
             if (!double.IsNaN(left) && !double.IsNaN(right) && double.IsNaN(width))  width = Math.Max(right - left,0);
             if (!double.IsNaN(top) && !double.IsNaN(bottom) && double.IsNaN(height)) height = Math.Max(bottom - top,0);
 
   
             //Execute the callback to get the actual size. Update the width and height values if the actual size is smaller. 
             SizeF normalSize = actualSizeCalculator((double.IsNaN(width) && Fill) ? cont.Width : width, (double.IsNaN(height) && Fill) ? cont.Height : height);
             if (double.IsNaN(width) || width > normalSize.Width) width = normalSize.Width;
             if (double.IsNaN(height) || height > normalSize.Height) height = normalSize.Height;
 
 
 
             //If only width and height are specified, set the other values to match the container, and let alignment sort it out.
             if (double.IsNaN(left) && double.IsNaN(right)) { left = cont.X; right = cont.Right; }//Handle situations where neither left nor right is specified, pretend left=0
             if (double.IsNaN(top) && double.IsNaN(bottom)) { top = cont.X; bottom = cont.Bottom; } //Handle situations where neither top nor bottom is specified, pretend top=0
 
 
             //When all 3 values are specified in either direction, we must use the alignment setting to determine which direction to snap to.
             if (!double.IsNaN(left) && !double.IsNaN(right) && !double.IsNaN(width)) {
                 if (width > right - left) width = right - left; //Use the smaller value in this case, no need to align.
                 else {
                     if (Align == ContentAlignment.BottomLeft || Align == ContentAlignment.MiddleLeft || Align == ContentAlignment.TopLeft)
                         right = left + width;
                     if (Align == ContentAlignment.BottomCenter || Align == ContentAlignment.MiddleCenter || Align == ContentAlignment.TopCenter){
                         left += (right-left-width) /2;
                         right = left + width;
                     }
                     if (Align == ContentAlignment.BottomRight || Align == ContentAlignment.MiddleRight || Align == ContentAlignment.TopRight)
                         left = right - width;
                 }
             }
 
             //When all 3 values are specified in either direction, we must use the alignment setting to determine which direction to snap to.
             if (!double.IsNaN(top) && !double.IsNaN(bottom) && !double.IsNaN(height)) {
                 if (height > bottom - top) height = bottom - top; //Use the smaller value in this case, no need to align.
                 else {
                     if (Align == ContentAlignment.TopLeft || Align == ContentAlignment.TopCenter || Align == ContentAlignment.TopRight)
                         bottom = top + height;
                     if (Align == ContentAlignment.MiddleLeft || Align == ContentAlignment.MiddleCenter || Align == ContentAlignment.MiddleRight) {
                         top += (bottom - top - height) / 2;
                         bottom = top + height;
                     }
                     if (Align == ContentAlignment.BottomLeft || Align == ContentAlignment.BottomCenter || Align == ContentAlignment.BottomRight)
                         top = bottom - height;
                 }
             }
 
 
             //Calculate values for top and left based off bottom and right
             if (double.IsNaN(left)) left = right - width;
             if (double.IsNaN(top)) top = bottom - height;
 
             //Calculate values for bottom and right based off top and left
             if (double.IsNaN(right)) right = left + width;
             if (double.IsNaN(bottom)) bottom = top + height;
 
 
             return new RectangleF((float)left, (float)top, (float)width, (float)height);
 
         }

Property Documentation

ContentAlignment ImageResizer.Plugins.Watermark.Layer.Align

getset

The alignment to use when (a) all 3 horizontal or vertical values are specified, and they need to be resolved, (b) when only width/height are specified, (c) when no positioning values are specified, or (d) when the content doesn't precisely fill they layer bounds.

Definition at line 146 of file Layer.cs.

DistanceUnit ImageResizer.Plugins.Watermark.Layer.Bottom

getset

The offset relative to the bottom of the container. Percentages are relative to the container height. Defines the bottom-most boundary for the layer. If null, Top will be used to calcuate the value based on the height. If Top is not specified, defaults to 0. Positive values are inside the container, negative values outside it.

Definition at line 97 of file Layer.cs.

LayerPlacement ImageResizer.Plugins.Watermark.Layer.DrawAs

getset

The z-order at which to draw the layer. Curret options are Overlay (over everything) and Background (over the background color).

Definition at line 170 of file Layer.cs.

bool ImageResizer.Plugins.Watermark.Layer.Fill

getset

(defaults false). When true, the image or text will attempt to fill 1 of the layer's bounds, even if upscaling is required. When Width is not specified, and both left and right are not specififed, this causes the image to fill the container width (if possible). When Height is not specified, and both top and bottom are not specififed, this causes the image to fill the container height (if possible). This causes &scale=both to be used on images unless another setting is specified in imageQuery.

Definition at line 159 of file Layer.cs.

DistanceUnit ImageResizer.Plugins.Watermark.Layer.Height

getset

The height of the layer. If used with both Top and Bottom, the smaller result wins. I.e, with a 100px container, height=50, top=30, top=30, the resulting height will be 40. If null, Top and Bottom will be used to calcuate the value. If both Top and Bottom are not specified, the natural height of the layer's contents will be used. Percentages are relative to the container height.

Definition at line 118 of file Layer.cs.

DistanceUnit ImageResizer.Plugins.Watermark.Layer.Left

getset

The offset from the left of the container. Percentages are relative to the container width. Defines the leftmost boundary for the layer. If null, Right will be used to calcuate the value based on the width. If Right is not specified, defaults to 0. Positive values are inside the container, negative values outside it.

Definition at line 75 of file Layer.cs.

string ImageResizer.Plugins.Watermark.Layer.RelativeTo

getset

Specifies the container that the position values (top,left,right,bottom,width,heght) are relative to. The default is 'image' (the innermost square, which contains the original photo). Additional valid values include 'imageArea' (includes whitespace added to preserve aspect ratio), 'padding', 'border', 'margin', and 'canvas'.

Definition at line 129 of file Layer.cs.

DistanceUnit ImageResizer.Plugins.Watermark.Layer.Right

getset

The offset relative to the right side of the container. Percentages are relative to the container width. Defines the rightmost boundary for the layer. If null, Top will be used to calcuate the value based on the height. If Top is not specified, defaults to 0. Positive values are inside the container, negative values outside it.

Definition at line 87 of file Layer.cs.

DistanceUnit ImageResizer.Plugins.Watermark.Layer.Top

getset

The offset from the top of the container. Percentages are relative to the container height. Defines the upper boundary for the layer. If null, Bottom will be used to calcuate the value based on the height. If Bottom is not specified, defaults to 0. Positive values are inside the container, negative values outside it.

Definition at line 64 of file Layer.cs.

DistanceUnit ImageResizer.Plugins.Watermark.Layer.Width

getset

The width of the layer. If used with both Left and Right, the smaller result wins. I.e, with a 100px container, width=50, left=30, right=30, the resulting width will be 40. If null, Left and Right will be used to calcuate the value. If both Left and Right are not specified, the natural width of the layer's contents will be used. Percentages are relative to the container width.

Definition at line 107 of file Layer.cs.

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

C:/Users/nathanael/Documents/resizer/Plugins/Watermark/Layer.cs

Public Types

Public Member Functions

Properties

Detailed Description

Member Function Documentation

Property Documentation