Merge pull request #6 from cortex-command-community/development

Merge v1.3.0 into Master

Author: MaximDude

.gitignore

@@ -1,3 +1,8 @@
 /.bmx
 *.exe
-*.bak
+*.bak
+*.png
+*.bmp
+
+!test-image.bmp
+!input-template.bmp

README.md

@@ -17,27 +17,60 @@ Arne's original bend code was used as base and has been modified and improved to
 - GUI
 - Loading/saving files.
 - Adjusting joint position.
-- Zoom setting for easy joint adjustment.
+- Zoom setting on input image for easy joint adjustment.
 - Frames number output setting.
 - Background color setting.
 - Automatic setting of background color to magenta on save.
-- Saving as PNG or Indexed BMP (CC Palette)
+- Saving as PNG or Indexed BMP (CC Palette).
+- Saving as individual named frames.
 
 ## How To
 
 1. Create an input file using the provided template.
-2. Load your file in the app.
+	- **Warning:** The order of limb parts in the input file **is important!**  
+		- Order should be as specified, going left to right:  
+	Upper Arm FG, Lower Arm FG, Upper Arm BG, Lower Arm BG, Upper Leg FG, Lower Leg FG, Upper Leg BG, Lower Leg BG.
+    - **Double Warning:** 
+    	- Arm parts should be facing **right** for correct bending!  
+    	- Leg parts should be facing **left** for correct bending!  
+    	
+    - See included "test-image.bmp" to understand how your input file should look like.
+    
+2. Load your input file using the "**Load**" button.
+
 3. Bent limbs will auto generate with default settings.
+
 4. Adjust joint positions by clicking on the upper joint marker and dragging it around.
-	- Use **Zoom** setting to enlarge the input image for easier joint adjustment
+	- ~~Use **Zoom** setting to enlarge the input image for easier joint adjustment~~
+	- Input image will be automatically zoomed to x4 on first load.
 		- **Warning:** When zooming the joint markers will reset to original positions. First zoom, then adjust.
+
 5. Use **Frames** setting to set number of bend frames.
 	- Bend angle will adjust automatically. First/Last frames will always be fully bent/unbent.
+
 6. Decide whether you want to save as Indexed BMP or not - if yes, tick the "**Save as Indexed Bitmap**" checkbox.
-7. Hit save
-	- Background color will automatically be set to magenta (255,0,255) when save is clicked and will revert back to previous color when finished.
-8. Slice the saved image into frames and apply palette.
-	- Manually touch-up the exported frames if needed.
+
+7. Decide whether you want to save as individual named frames or not - if yes, tick the "**Save as Frames**" checkbox.
+	- Exported frame size is fixed to 24x24px.
+	- If enabled, a visual aid will be shown around each frame to help the user stay within bounds.
+		- Pixels outside bounds will be cropped.
+	- Exported leg frames will be automatically flipped horizontally to face right.  
+
+**Note:** "Save as Indexed Bitmap" and "Save as Frames" do not conflict and can be used together to export indexed individual frames.  
+
+8. Hit save  
+	- Background color will automatically be set to magenta (255,0,255) when save is clicked and will revert back to previous color when finished.  
+
+	- **Warning:**
+		- File extension will be added automatically depending on selected "**Save as Indexed Bitmap**" setting so there is no need to add it manually.  
+		Doing so will resolve in a double extension (for example: "MyFile.png.png").
+        
+	- **Quadruple Warning:**
+	
+    	- When saving with "**Save as Frames**" enabled, only input the name of the actor these limbs belong to (for example: "Robot").  
+    	Limb names and frame numbers will be added automatically.  
+    	**Adding the limb name and frame number manually will result in horrible exported file names.**
+    
 
 ## Current Issues
 

assets.bmx

@@ -8,6 +8,9 @@ Incbin "assets/palette"
 'Embed logo image for standalone exe
 Incbin "assets/logo-image"
 
+'Embed tile image for standalone exe
+Incbin "assets/tile"
+
 'Embed textbox contents to later load into strings
 Incbin "assets/about-textbox-content"
 Incbin "assets/help-textbox-content"

assets/help-textbox-content

@@ -63,4 +63,16 @@ When not ticked, output will be saved as a non-indexed PNG.
 THE INDEXING PROCESS IS SLOW!
 I've done my best to speed it up but it still isn't blazing fast like PNG saving.
 When saving indexed, the app may hang and appear unresponsive but in fact it's doing what it's supposed to.
-For best results, DO NOT TOUCH ANYTHING until the background color reverts from magenta to whatever it was before!
+For best results, DO NOT TOUCH ANYTHING until the background color reverts from magenta to whatever it was before!
+
+
+SAVE AS FRAMES:
+When ticked each frame of the output will be exported as an individual file.
+Exported frame size is fixed to 24x24px. A bounding box will be shown around each frame to help user stay within bounds.
+Anything outside bounds will be cropped.
+
+Does not conflict with "SAVE AS INDEXED BITMAP" and can be used together to export indexed individual frames.
+
+- Quadruple Warning :
+WHEN SAVING, DO NOT MANUALLY ADD LIMB NAME OR FRAME NUMBER TO FILE NAME. THIS IS DONE AUTOMATICALLY.
+DOING SO WILL RESULT IS HORRIBLE HORRIBLE EXPORTED FILE NAMES.

assets/tile

@@ -22,8 +22,10 @@ Include "types/file-io.bmx"
 Include "types/bitmap-index.bmx"
 
 'Version
-Global appVersion:String = "1.2.2"
-Global appVersionDate:String = "14 Feb 2020"
+Global appVersion:String = "1.3.0"
+Global appVersionDate:String = "16 Feb 2020"
+
+AppTitle = "CCCP Bender v"+appVersion
 
 Rem
 ------- BOOT ----------------------------------------------------------------------------------------------------------
@@ -40,7 +42,7 @@ Rem
 ------- EVENT HANDLING ------------------------------------------------------------------------------------------------
 EndRem
 
-While True	
+While True
 	TAppOutput.FOutputUpdate()
 
 	If ButtonState(TAppGUI.editSettingsIndexedCheckbox) = True Then
@@ -50,11 +52,19 @@ While True
 		fileFilters = "Image Files:png"
 		TAppFileIO.saveAsIndexed = False
 	EndIf
+	
+	If ButtonState(TAppGUI.editSettingsSaveAsFramesCheckbox) = True Then
+		TAppFileIO.saveAsFrames = True
+	Else
+		TAppFileIO.saveAsFrames = False
+	EndIf
 
-	WaitEvent
-	'Print CurrentEvent.ToString()
-	'Print GCMemAlloced()
+	'Debug stuff
+	'Print "current event: " + CurrentEvent.ToString()
+	'Print "allocated memory in bytes: " + GCMemAlloced() 'not sure how accurate this really is, numbers don't match with task manager
+	'Print "mouse position in canvas: x = " + MouseX() + " y = " + MouseY()
 
+	PollEvent
 	'Event Responses
 	Select EventID()
 		Case EVENT_APPRESUME
@@ -67,7 +77,6 @@ While True
 		Case EVENT_MENUACTION
 			Select EventData()
 				Case TAppGUI.ABOUT_MENU
-					AppTitle = "CCCP Bender v"+appversion
 					Notify(LoadText("Incbin::assets/about-textbox-content"),False)
 			EndSelect
 		Case EVENT_GADGETACTION
@@ -81,8 +90,12 @@ While True
 					TAppOutput.FOutputUpdate()
 				'Saving
 				Case TAppGUI.editSaveButton
-					TAppFileIO.prepForSave = True
-					TAppOutput.FOutputUpdate()
+					If TAppOutput.sourceImage <> Null Then
+						TAppFileIO.prepForSave = True
+						TAppOutput.FOutputUpdate()
+					Else
+						Notify("Nothing to save!",False)
+					EndIf
 				'Settings textbox inputs
 				'Scale
 				Case TAppGUI.editSettingsZoomTextbox

bender.bmx

@@ -163,20 +163,11 @@ Type TAppOutput
 				b = 7 SetRotation(angle[b,f]) DrawImageRect(boneImage[b],xBone[b,f],yBone[b,f],ImageWidth(boneImage[b])/INPUTZOOM,ImageHeight(boneImage[b])/INPUTZOOM)
 			Next
 			SetRotation(0)
+			FGrabOutputForSaving()
 		Else
 			SetColor(255,230,80)
-			DrawText("NO IMAGE LOADED!",(GraphicsWidth()/2)-(TextWidth("NO IMAGE LOADED!")/2),GraphicsHeight()/2)	
-		EndIf
-		'Output copy for saving
-		If TAppFileIO.saveAsIndexed = True Then
-			'If saving indexed grab a smaller pixmap to speed up indexing
-			TAppFileIO.tempOutputImage = GrabPixmap(55,120,34*FRAMES,210)
-		Else
-			TAppFileIO.tempOutputImage = GrabPixmap(0,96,768,384)
-		EndIf
-		Flip(1)
-		If TAppFileIO.prepForSave
-			TAppFileIO.FPrepForSave()
+			DrawText("NO IMAGE LOADED!",(GraphicsWidth()/2)-(TextWidth("NO IMAGE LOADED!")/2),GraphicsHeight()/2)
+			Flip(1)	
 		EndIf
 	EndFunction
 
@@ -206,4 +197,41 @@ Type TAppOutput
 		FLimbBend()
 		FOutputUpdate()
 	EndFunction
+	
+	'Output copy for saving
+	Function FGrabOutputForSaving()
+		If TAppFileIO.saveAsFrames = True Then
+			Local row:Int, frame:Int
+			Local tile:TImage = LoadImage("Incbin::assets/tile")
+			For row = 0 To 3
+				For frame = 0 To FRAMES-1
+					'Draw a tile outline around all frames to see we are within bounds.
+					DrawImage(tile,62+(frame*(TILESIZE/INPUTZOOM+8)),138+(row*48)) 'Doing this with an image because cba doing the math with DrawLine. Offsets are -1px because tile image is 26x26 for outline and tile is 24x24.
+					'Draw names of rows
+					SetColor(255,230,80)
+					DrawText("Arm FG",8,145)
+					DrawText("Arm BG",8,145+48)
+					DrawText("Leg FG",8,145+(48*2))
+					DrawText("Leg BG",8,145+(48*3))
+					'Grab pixmap inside tile bounds for saving
+					TAppFileIO.tempOutputFrame[row,frame] = GrabPixmap(63+(frame*(TILESIZE/INPUTZOOM+8)),139+(row*48),TILESIZE/INPUTZOOM,TILESIZE/INPUTZOOM)
+					'HFlip the legs so they're facing right
+					If row >= 2 Then
+						TAppFileIO.tempOutputFrame[row,frame] = XFlipPixmap(TAppFileIO.tempOutputFrame[row,frame])
+					EndIf
+				Next
+			Next
+		Else
+			If TAppFileIO.saveAsIndexed = True Then
+				'If saving indexed grab a smaller pixmap to speed up indexing
+				TAppFileIO.tempOutputImage = GrabPixmap(55,120,34*FRAMES,210)
+			Else
+				TAppFileIO.tempOutputImage = GrabPixmap(0,96,768,384)
+			EndIf
+		EndIf
+		Flip(1)
+		If TAppFileIO.prepForSave
+			TAppFileIO.FPrepForSave()
+		EndIf
+	EndFunction	
 EndType

assets/input-template.bmp renamed to input-template.bmp

@@ -15,12 +15,14 @@ Type TAppFileIO
 
 	'Save Bools
 	Global saveAsIndexed:Int = False
+	Global saveAsFrames:Int = False
 	Global prepForSave:Int = False
 	Global rdyForSave:Int = False
 	Global runOnce:Int = False
 
 	'Output copy for saving
 	Global tempOutputImage:TPixmap
+	Global tempOutputFrame:TPixmap[4,20] 'noice
 
 	'Load Source Image
 	Function FLoadFile()
@@ -48,7 +50,11 @@ Type TAppFileIO
 				runOnce = True
 				TAppOutput.FOutputUpdate()
 			Else
-				FSaveFile()
+				If Not saveAsFrames Then
+					FSaveFile()
+				Else
+					FSaveFileAsFrames()
+				EndIf
 			EndIf
 		EndIf
 	EndFunction
@@ -66,7 +72,7 @@ Type TAppFileIO
 		'Foolproofing
 		If exportedFile = importedFile Then
 			Notify("Cannot overwrite source image!",True)
-		ElseIf exportedFile <> importedFile Then
+		ElseIf exportedFile <> importedFile And exportedFile <> Null Then
 			'Writing new file
 			If saveAsIndexed = True
 				TBitmapIndex.FPixmapToIndexedBitmap(tempOutputImage,exportedFile)
@@ -79,4 +85,46 @@ Type TAppFileIO
 			FRevertPrep()
 		EndIf
 	EndFunction
+	
+	'Save Output Content As Frames
+	Function FSaveFileAsFrames()
+		exportedFile = RequestFile("Save graphic output","",True) 'No file extensions here, we add them later manually otherwise exported file name is messed up.
+		'Foolproofing
+		If exportedFile = importedFile Then
+			Notify("Cannot overwrite source image!",True)
+		ElseIf exportedFile <> importedFile And exportedFile <> Null Then
+			'Writing new file
+			Local row:Int, frame:Int
+			For row = 0 To 3
+				'Name the rows - by default: ArmFG, ArmBG, LegFG, LegBG in this order.
+				Local rowName:String
+				If row = 0 Then
+					rowName = "ArmFG"
+				ElseIf row = 1 Then
+					rowName = "ArmBG"
+				ElseIf row = 2 Then
+					rowName = "LegFG"
+				ElseIf row = 3 Then
+					rowName = "LegBG"
+				EndIf
+				For frame = 0 To TAppOutput.FRAMES-1
+					Local exportedFileTempName:String
+					If frame < 10 Then
+						exportedFileTempName = exportedFile+rowName+"00"+frame
+					Else
+						exportedFileTempName = exportedFile+rowName+"0"+frame
+					EndIf
+					If saveAsIndexed = True
+						TBitmapIndex.FPixmapToIndexedBitmap(tempOutputFrame[row,frame],exportedFileTempName+".bmp")
+					Else
+			      		SavePixmapPNG(tempOutputFrame[row,frame],exportedFileTempName+".png")
+					EndIf
+				Next
+			Next
+			FRevertPrep()
+		Else
+			'On Cancel
+			FRevertPrep()
+		EndIf	
+	EndFunction
 EndType

types/editor-output.bmx

@@ -36,6 +36,8 @@ Type TAppGUI
 	Global editSettingsColorBLabel:TGadget
 	Global editSettingsIndexedLabel:TGadget
 	Global editSettingsIndexedCheckbox:TGadget
+	Global editSettingsSaveAsFramesLabel:TGadget
+	Global editSettingsSaveAsFramesCheckbox:TGadget
 	'Editor Window Help
 	Global editHelpPanel:TGadget
 	Global editHelpTextbox:TGadget
@@ -64,7 +66,9 @@ Type TAppGUI
 		editSettingsColorGLabel = CreateLabel("G:",120,45,50,20,editSettingsPanel,LABEL_LEFT)
 		editSettingsColorBLabel = CreateLabel("B:",175,45,50,20,editSettingsPanel,LABEL_LEFT)
 		editSettingsIndexedLabel = CreateLabel("Save as Indexed Bitmap:",10,75,130,20,editSettingsPanel,LABEL_LEFT)
-		editSettingsIndexedCheckbox = CreateButton("",140,73,20,20,editSettingsPanel,BUTTON_CHECKBOX)
+		editSettingsIndexedCheckbox = CreateButton("",140,75,15,15,editSettingsPanel,BUTTON_CHECKBOX)
+		editSettingsSaveAsFramesLabel = CreateLabel("Save as Frames:",160,75,80,20,editSettingsPanel,LABEL_LEFT)
+		editSettingsSaveAsFramesCheckbox = CreateButton("",250,75,15,15,editSettingsPanel,BUTTON_CHECKBOX)
 		editHelpPanel = CreatePanel(10,203,280,250,editWindow,PANEL_GROUP,"  Help :  ")
 		editHelpTextbox = CreateTextArea(7,5,GadgetWidth(editHelpPanel)-21,GadgetHeight(editHelpPanel)-32,editHelpPanel,TEXTAREA_WORDWRAP|TEXTAREA_READONLY)
 		'Populate textboxes