GuillotinePacker Class

Namespace: Stride.Core.Mathematics
Assembly: Stride.Core.Mathematics.dll

Implementation of a "Guillotine" packer. More information at http://clb.demon.fi/files/RectangleBinPack.pdf.

System.Object → GuillotinePacker

Derived from GuillotinePacker:

public class GuillotinePacker

Name		Description
Properties
	Height	Current height used by the packer.
	Width	Current width used by the packer.
Methods
	Clear()	Clears the whole region.
	Clear(Int32, Int32)	Clears the specified region.
	Free(ref Rectangle)	Frees the specified old rectangle.
	Insert(Int32, Int32, ref Rectangle)	Tries to fit a single rectangle with the specified width and height.
	TryInsert(Int32, Int32, Int32, GuillotinePacker.InsertRectangleCallback)	Tries to fit multiple rectangle with (width, height).

| Improve this Doc View Source

Current height used by the packer.

public int Height { get; }

Type	Description
System.Int32

Current width used by the packer.

public int Width { get; }

Type	Description
System.Int32

| Improve this Doc View Source

Clears the whole region.

public virtual void Clear()

Clears the specified region.

public void Clear(int width, int height)

Type	Name	Description
System.Int32	width	The width.
System.Int32	height	The height.

Frees the specified old rectangle.

public void Free(ref Rectangle oldRectangle)

Type	Name	Description
Rectangle	oldRectangle	The old rectangle.

Tries to fit a single rectangle with the specified width and height.

public bool Insert(int width, int height, ref Rectangle bestRectangle)

Type	Name	Description
System.Int32	width	Width requested.
System.Int32	height	Height requested
Rectangle	bestRectangle	Fill with the rectangle if it was successfully inserted.

Type	Description
System.Boolean	`true` if it was successfully inserted.

Tries to fit multiple rectangle with (width, height).

public bool TryInsert(int width, int height, int count, GuillotinePacker.InsertRectangleCallback inserted)

Type	Name	Description
System.Int32	width	Width requested.
System.Int32	height	Height requested
System.Int32	count	The number of rectangle to fit.
GuillotinePacker.InsertRectangleCallback	inserted	A callback called for each rectangle successfully fitted.

Type	Description
System.Boolean	`true` if all rectangles were successfully fitted.