GSoC/2019/StatusReports/Albertoefg

Krita: Animated Vector Brush

Summary

• Project Name: Animated Vector Brush for Krita
• Proposal: Google Docs Proposal
• Related blog: albertoefg.info
• Abstract: This projects aims to implement an Animated Vector Brush for Krita, which uses SVG as a source file for the brush tips. The purpose of an animated brush is to change the brush tips automatically with every dab on the canvas. This allows for a quick way to paint different images, create random and fun designs, and explore new ways to paint that are not easy in physical world. In the other hand, using SVG as a source makes it easy to share the brush tips as they are saved as plain text, as opposed to raster image brushes.

Project Goals

• Write documentation for end users as per the Krita Contribution Guide.
• Define the structure of the SVG file containing the source tips for the Animated Vector Brush
• Load AVB
• Parse SVG
• Render brush tips as images
• Write a parasite class to hold the index
• Write a VectorAnimatedBrush class
• Write a VectorShapeObject class
• Write a helper class to populate the VectorAnimatedBrush class
• Change brush tip with every dab
• Save as AVB

Project related links

• Phabricator https://phabricator.kde.org/T10930
• Personal Blog https://albertoefg.info/blog/kde.html

Implementations Status

Write documentation

• Goal: The documentation should be written for end users as per the Krita Contribution Guide, it should also be sufficient for the users to understand and use the brush.
• Status: The documentation is mostly done, it is only necessary to add the proper screenshots and update in case of changes.
• TODO: Add screenshots.
• Related blog post: My first two weeks on Google Summer of Code

Commits and Differentials

• Phabricator T10930
  • e9dbd91f: Added Tutorial for Animated Vector Brushes.
  • 378b759a: Added small description for AVB
  • 1aa98e85: Created documentation for avb

Load AVB

• Goal: The Animated Vector Brush file should be loaded and call the proper class, in this case KisVectorAnimatedBrush.
• Status: The implementation is done, the loading of the AVB by the user is using the +import tab.
• Related blog post: My first two weeks on Google Summer of Code

Commits and Differentials

• Phabricator T10930
  • bd654077: Added vectorAnimatedBrush to brush server
  • ddee5b98: Load Vector Animated Brush
  • d1afdb40: Return false for empty SVG

Parse SVG

• Goal: The SVG should be parsed and transformed to KoShape as necessary, so Krita can use them to set brushTipImage, paint dabs or change the size of the brush tip.
• Status: Done.
• Related blog post: Basic functionality almost ready

Commits and Differentials

• Phabricator T10930
  • 7ed4b9c1: Use SvgParser to loadFromDevice
  • cffe647e: Set brushTipImage from the KoShapePainter

Render brush tips as images

• Goal: The KoShapes should be transformed to QImage as necessary, so Krita can use them to set brushTipImage, paint dabs or change the size of the brush tip.
• Status: Done.
• Related blog post: Basic functionality almost ready

Commits and Differentials

• Phabricator T10930
  • 7ed4b9c1: Use SvgParser to loadFromDevice
  • cffe647e: Set brushTipImage from the KoShapePainter
  • b024e4fb: Render QImages only once

Write a parasite class to hold the index

• Goal: Write a parasite class that will aid KisVectorAnimatedBrush class, holding the values of the Index and related data.
• Status: In Progress. Although the majority of the class works now, there is a need for comments and cleaning. It can also be extended to add more functionality like different types of sequences: tilt, velocity, etc.
• Related blog post: Implementing a derivated class of kis_brushes_pipe

Commits and Differentials

• Phabricator T10930
  • 065ac9ba: Added a parasite helper class
  • 4d3fbd9b: Fix the segmentation fault

Write a KisVectorAnimatedBrush class

• Goal: Write a the class KisVectorAnimatedBrush that will inherit from KisBrushesPipe to work as a brush pipe of VectorShapeObject brushes, it will also have a Private struct to hold a KisVectorHelperPipe object.
• Status: In Progress. The class is mostly done, however it can be extended to get more functionality.
• Related blog post: To be written

Commits and Differentials

• Phabricator T10930
  • ddee5b98: Load Vector Animated Brush
  • 058756d2: Intitalize Private struct to hold KisVectorHelperPipe object
  • 75365412: Use paintDevice to render brush
  • bbd5667e: Add destructor for Private object

Write a VectorShapeObject class

• Goal: Write a class that will work as a single brush that will hold a single KoShape and a single QImage. A series of objects of this class will populate the VectorAnimatedBrush class, using the KisVectorHelperPipe class.
• Status: Done.
• Related blog post: To be written

Commits and Differentials

• Phabricator T10930
  • eae68aa7: Add KisVectorHelperPipe Class Note: This class was added in the same commit as the helper pipe class.
  • 0b2ef645: Inherit from KisScalingsizebrush in KisVectorShapeObject
  • ebdd8f8c: Convert brushTip to MaskImage
  • 9e6ee547: Add appropriate brushType
  • 058756d2: Intitalize Private struct to hold KisVectorHelperPipe object

Write a Helper Pipe class to populate the KisVectorAnimatedBrush

• Goal: Write a helper class for KisVectorAnimatedBrush that will aid holding a parasite object of the class written earlier, and populate the pipe brush with VectorShapeObject brushes.
• Status: Done.
• Related blog post: To be written

Commits and Differentials

• Phabricator T10930
  • eae68aa7: Add KisVectorHelperPipe Class
  • 30c2f3c9: Populate brushesPipe with VectorShapeObjects

Change brush tip with every dab

• Goal: Change the brushTipimage with every dab
• Status: Done.
• Related blog post: To be written

Commits and Differentials

• Phabricator T10930
  • 2ed1c1d5: Fix iteration of shapesToimages
  • cda1fd56: Use chooseNextBrush to update the Index
  • e8248790 · Use KisVectorHelperPipe for the Index

Save as AVB

- TODO