Muragami's Project Docs

User Tools

Site Tools

Trace:
maxrects-lua

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
Last revision Both sides next revision
maxrects-lua [2021/02/13 08:15]
muragami [MaxRects.new(width,height,canflip)] 		maxrects-lua [2021/02/13 10:21]
muragami [:insertCollection(collect,sort)]
Line 88: Line 88:
 MyOtherRect = MaxRects.copy(MyRect) -- shallow copy of just the 4 indexes and two fields MyOtherRect = MaxRects.copy(MyRect) -- shallow copy of just the 4 indexes and two fields
 </code> </code>
-===== Functions =====+ 
 +===== Functions (module) =====
  
 All the exposed functions of this module, with in-depth explanations. All the exposed functions of this module, with in-depth explanations.
Line 108: Line 109:
  
 Creates a shallow copy of a rectangle. Does not duplicate .data for instance, but copies the reference. Explicitly only copies: [1], [2], [3], [4], .data, and .flip. Creates a shallow copy of a rectangle. Does not duplicate .data for instance, but copies the reference. Explicitly only copies: [1], [2], [3], [4], .data, and .flip.
 +
 +===== Functions (instance) =====
 +
 ==== :reset(width,height,canflip) ==== ==== :reset(width,height,canflip) ====
  
Line 126: Line 130:
 Inserts a rectangle into the collection, using the algorithm to assign a location. If the rectangle can't fit, returns false. Inserts a rectangle into the collection, using the algorithm to assign a location. If the rectangle can't fit, returns false.
  
 +==== :insertRect(rect) ====
 +
 +  * **rect**: The rectangle to insert. X/Y([0]/[1]) are ignored, only Width([3]) and Height([4]) count.
 +
 +  * **return**: Boolean. True if the rectangle was inserted, False if it didn't fit.
 +
 +Inserts a rectangle into the collection, using the algorithm to assign a location. If the rectangle can't fit, returns false. Copies .data into the stored node in the collection.
 +
 +==== :insertCollection(collect,sort) ====
 +
 +  * **collect**: A table array of rectangles to insert into the collection (see [[#:insertRect(rect)]])
 +  * **//sort//**: //optional// A method to sort the rectangles before insert.
 +
 +  * **return**: Boolean, Number. True if all were inserted, False if only some fit. The number is the amount added.
 +
 +Inserts rectangles into the collection, from an array table. If you define sort to one of: 'SortArea', 'SortShortSide', or 'SortLongSide' it will sort them from biggest to smallest using that method before inserting. If you pass anything else as sort, it'll throw an error. Note: **table.sort() is applied to collect, so it's order might/will be changed by this function.**
 ==== :occupancy() ==== ==== :occupancy() ====
  
Line 147: Line 167:
 </code> </code>
  
 +==== :setAlgorithm(algo) ====
 +
 +  * **algo**: The algorithm to use for this instance. Defaults to 'BestShortSideFit'.
 +
 +Applies a given algorithm to the packer. The options are: 'BestShortSideFit', 'BestLongSideFit', 'BestAreaFit', and 'ContactPointRule'. Passing any other value will throw an error.
 +
 +==== :algorithmName() ====
 +
 +  * **return**: The algorithm in use for this instance. Defaults to 'BestShortSideFit'.
 +
 +Returns the algorithm in use by the packer. The options are: 'BestShortSideFit', 'BestLongSideFit', 'BestAreaFit', and 'ContactPointRule'.
 +
 +===== Simple LÖVE Texture Packer =====
  
 +TODO!
maxrects-lua.txt · Last modified: 2021/02/13 10:21 by muragami

Page Tools

Except where otherwise noted, content on this wiki is licensed under the following license: CC0 1.0 Universal
CC0 1.0 Universal Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki