Pencil2D Animation
Download Community News Docs Contribute
  • Overview
  • Articles
  • Code
  •  
  • Class List
  • Class Index
  • Class Hierarchy
  • Class Members
  • File List
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Private Member Functions | List of all members
LayerBitmap Class Reference
+ Inheritance diagram for LayerBitmap:
Inheritance graph
[legend]
+ Collaboration diagram for LayerBitmap:
Collaboration graph
[legend]

Public Member Functions

 LayerBitmap (int id)
 
QDomElement createDomElement (QDomDocument &doc) const override
 
void loadDomElement (const QDomElement &element, QString dataDirPath, ProgressCallback progressStep) override
 
Status presave (const QString &sDataFolder) override
 
BitmapImage * getBitmapImageAtFrame (int frameNumber)
 
BitmapImage * getLastBitmapImageAtFrame (int frameNumber, int increment=0)
 
void replaceKeyFrame (const KeyFrame *) override
 
void repositionFrame (QPoint point, int frame)
 
QRect getFrameBounds (int frame)
 
- Public Member Functions inherited from Layer
 Layer (int id, LAYER_TYPE eType)
 
int id () const
 
void setId (int layerId)
 
LAYER_TYPE type () const
 
void setName (QString name)
 
QString name () const
 
void switchVisibility ()
 
bool visible () const
 
void setVisible (bool b)
 
QList< int > selectedKeyFramesPositions () const
 Get selected keyframe positions sorted by position.
 
QList< int > selectedKeyFramesByLast () const
 Get selected keyframe positions based on the order they were selected.
 
virtual Status saveKeyFrameFile (KeyFrame *, QString dataPath)=0
 
virtual void loadDomElement (const QDomElement &element, QString dataDirPath, ProgressCallback progressForward)=0
 
virtual QDomElement createDomElement (QDomDocument &doc) const =0
 
QDomElement createBaseDomElement (QDomDocument &doc) const
 
void loadBaseDomElement (const QDomElement &elem)
 
int getMaxKeyFramePosition () const
 
int firstKeyFramePosition () const
 
bool keyExists (int position) const
 
int getPreviousKeyFramePosition (int position) const
 
int getNextKeyFramePosition (int position) const
 
int getPreviousFrameNumber (int position, bool isAbsolute) const
 
int getNextFrameNumber (int position, bool isAbsolute) const
 
int keyFrameCount () const
 
int selectedKeyFrameCount () const
 
bool hasAnySelectedFrames () const
 
bool insertExposureAt (int position)
 Will insert an empty frame (exposure) after the given position.
 
bool addNewKeyFrameAt (int position)
 Creates a new keyframe at the given position, unless one already exists.
 
void addOrReplaceKeyFrame (int position, KeyFrame *pKeyFrame)
 
virtual bool addKeyFrame (int position, KeyFrame *pKeyFrame)
 Adds a keyframe at the given position, unless one already exists.
 
virtual bool removeKeyFrame (int position)
 
virtual void replaceKeyFrame (const KeyFrame *pKeyFrame)=0
 
bool swapKeyFrames (int position1, int position2)
 
bool moveKeyFrame (int position, int offset)
 
KeyFrame * getKeyFrameAt (int position) const
 
KeyFrame * getLastKeyFrameAtPosition (int position) const
 
bool keyExistsWhichCovers (int frameNumber)
 
KeyFrame * getKeyFrameWhichCovers (int frameNumber) const
 
void foreachKeyFrame (std::function< void(KeyFrame *)>) const
 
void setModified (int position, bool isModified) const
 
bool isFrameSelected (int position) const
 
void setFrameSelected (int position, bool isSelected)
 
void toggleFrameSelected (int position, bool allowMultiple=false)
 
void extendSelectionTo (int position)
 
void selectAllFramesAfter (int position)
 
bool newSelectionOfConnectedFrames (int position)
 Make a selection from specified position until a blank spot appears The search is only looking forward, e.g.
 
void setExposureForSelectedFrames (int offset)
 Add or subtract exposure from selected frames.
 
bool reverseOrderOfSelection ()
 Reverse order of selected frames.
 
void deselectAll ()
 
bool moveSelectedFrames (int offset)
 
QList< int > getSelectedFramesByPos () const
 
bool canMoveSelectedFramesToOffset (int offset) const
 Predetermines whether the frames can be moved to a new position depending on the offset.
 
Status save (const QString &sDataFolder, QStringList &attachedFiles, ProgressCallback progressStep)
 
virtual Status presave (const QString &sDataFolder)
 
bool isPaintable () const
 
QList< int > dirtyFrames () const
 Returns a list of dirty frame positions.
 
void markFrameAsDirty (const int frameNumber)
 Mark the frame position as dirty.
 
void clearDirtyFrames ()
 Clear the list of dirty keyframes.
 

Protected Member Functions

Status saveKeyFrameFile (KeyFrame *, QString strPath) override
 
KeyFrame * createKeyFrame (int position) override
 
- Protected Member Functions inherited from Layer
virtual KeyFrame * createKeyFrame (int position)=0
 
bool loadKey (KeyFrame *)
 

Private Member Functions

void loadImageAtFrame (QString strFilePath, QPoint topLeft, int frameNumber, qreal opacity)
 
QString filePath (KeyFrame *key, const QDir &dataFolder) const
 
QString fileName (KeyFrame *key) const
 
bool needSaveFrame (KeyFrame *key, const QString &strSavePath)
 

Additional Inherited Members

- Public Types inherited from Layer
enum  LAYER_TYPE {
  UNDEFINED = 0 , BITMAP = 1 , VECTOR = 2 , MOVIE = 3 ,
  SOUND = 4 , CAMERA = 5
}
 

Detailed Description

Definition at line 25 of file layerbitmap.h.

Constructor & Destructor Documentation

◆ LayerBitmap()

LayerBitmap::LayerBitmap ( int  id)
explicit

Definition at line 26 of file layerbitmap.cpp.

◆ ~LayerBitmap()

LayerBitmap::~LayerBitmap ( )
override

Definition at line 31 of file layerbitmap.cpp.

Member Function Documentation

◆ createDomElement()

QDomElement LayerBitmap::createDomElement ( QDomDocument &  doc) const
overridevirtual

Implements Layer.

Definition at line 180 of file layerbitmap.cpp.

◆ createKeyFrame()

KeyFrame * LayerBitmap::createKeyFrame ( int  position)
overrideprotectedvirtual

Implements Layer.

Definition at line 107 of file layerbitmap.cpp.

◆ fileName()

QString LayerBitmap::fileName ( KeyFrame *  key) const
private

Definition at line 164 of file layerbitmap.cpp.

◆ filePath()

QString LayerBitmap::filePath ( KeyFrame *  key,
const QDir &  dataFolder 
) const
private

Definition at line 159 of file layerbitmap.cpp.

◆ getBitmapImageAtFrame()

BitmapImage * LayerBitmap::getBitmapImageAtFrame ( int  frameNumber)

Definition at line 35 of file layerbitmap.cpp.

◆ getFrameBounds()

QRect LayerBitmap::getFrameBounds ( int  frame)

Definition at line 59 of file layerbitmap.cpp.

◆ getLastBitmapImageAtFrame()

BitmapImage * LayerBitmap::getLastBitmapImageAtFrame ( int  frameNumber,
int  increment = 0 
)

Definition at line 41 of file layerbitmap.cpp.

◆ loadDomElement()

void LayerBitmap::loadDomElement ( const QDomElement &  element,
QString  dataDirPath,
ProgressCallback  progressStep 
)
overridevirtual

Implements Layer.

Definition at line 204 of file layerbitmap.cpp.

◆ loadImageAtFrame()

void LayerBitmap::loadImageAtFrame ( QString  strFilePath,
QPoint  topLeft,
int  frameNumber,
qreal  opacity 
)
private

Definition at line 66 of file layerbitmap.cpp.

◆ needSaveFrame()

bool LayerBitmap::needSaveFrame ( KeyFrame *  key,
const QString &  strSavePath 
)
private

Definition at line 169 of file layerbitmap.cpp.

◆ presave()

Status LayerBitmap::presave ( const QString &  sDataFolder)
overridevirtual

Reimplemented from Layer.

Definition at line 115 of file layerbitmap.cpp.

◆ replaceKeyFrame()

void LayerBitmap::replaceKeyFrame ( const KeyFrame *  bitmapImage)
overridevirtual

Implements Layer.

Definition at line 47 of file layerbitmap.cpp.

◆ repositionFrame()

void LayerBitmap::repositionFrame ( QPoint  point,
int  frame 
)

Definition at line 52 of file layerbitmap.cpp.

◆ saveKeyFrameFile()

Status LayerBitmap::saveKeyFrameFile ( KeyFrame *  keyframe,
QString  strPath 
)
overrideprotectedvirtual

Implements Layer.

Definition at line 75 of file layerbitmap.cpp.


The documentation for this class was generated from the following files:
  • core_lib/src/structure/layerbitmap.h
  • core_lib/src/structure/layerbitmap.cpp
Generated on Thu Jun 5 2025 14:06:44 for Pencil2D by doxygen 1.9.6 based on revision 4c63407997b2c03e5048716586dec6fbbb755173