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 | List of all members
LayerSound Class Reference
+ Inheritance diagram for LayerSound:
Inheritance graph
[legend]
+ Collaboration diagram for LayerSound:
Collaboration graph
[legend]

Public Member Functions

 LayerSound (int id)
 
QDomElement createDomElement (QDomDocument &doc) const override
 
void loadDomElement (const QDomElement &element, QString dataDirPath, ProgressCallback progressStep) override
 
void replaceKeyFrame (const KeyFrame *soundClip) override
 
Status loadSoundClipAtFrame (const QString &sSoundClipName, const QString &filePathString, int frame)
 
void updateFrameLengths (int fps)
 
SoundClip * getSoundClipWhichCovers (int frameNumber)
 
- 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 path) override
 
KeyFrame * createKeyFrame (int position) override
 
- Protected Member Functions inherited from Layer
virtual KeyFrame * createKeyFrame (int position)=0
 
bool loadKey (KeyFrame *)
 

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 layersound.h.

Constructor & Destructor Documentation

◆ LayerSound()

LayerSound::LayerSound ( int  id)
explicit

Definition at line 27 of file layersound.cpp.

◆ ~LayerSound()

LayerSound::~LayerSound ( )

Definition at line 32 of file layersound.cpp.

Member Function Documentation

◆ createDomElement()

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

Implements Layer.

Definition at line 68 of file layersound.cpp.

◆ createKeyFrame()

KeyFrame * LayerSound::createKeyFrame ( int  position)
overrideprotectedvirtual

Implements Layer.

Definition at line 160 of file layersound.cpp.

◆ getSoundClipWhichCovers()

SoundClip * LayerSound::getSoundClipWhichCovers ( int  frameNumber)

Definition at line 167 of file layersound.cpp.

◆ loadDomElement()

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

Implements Layer.

Definition at line 89 of file layersound.cpp.

◆ loadSoundClipAtFrame()

Status LayerSound::loadSoundClipAtFrame ( const QString &  sSoundClipName,
const QString &  filePathString,
int  frame 
)

Definition at line 36 of file layersound.cpp.

◆ replaceKeyFrame()

void LayerSound::replaceKeyFrame ( const KeyFrame *  soundClip)
overridevirtual

Implements Layer.

Definition at line 120 of file layersound.cpp.

◆ saveKeyFrameFile()

Status LayerSound::saveKeyFrameFile ( KeyFrame *  key,
QString  path 
)
overrideprotectedvirtual

Implements Layer.

Definition at line 125 of file layersound.cpp.

◆ updateFrameLengths()

void LayerSound::updateFrameLengths ( int  fps)

Definition at line 59 of file layersound.cpp.


The documentation for this class was generated from the following files:
  • core_lib/src/structure/layersound.h
  • core_lib/src/structure/layersound.cpp
Generated on Thu May 8 2025 04:47:54 for Pencil2D by doxygen 1.9.6 based on revision 4513250b1d5b1a3676ec0e67b06b7a885ceaae39