Verovio
Source code documentation
Public Member Functions | Public Attributes | List of all members
vrv::BeamSegment Class Reference

Class for storing drawing parameters when calculating beams. More...

#include <beam.h>

Inheritance diagram for vrv::BeamSegment:
vrv::BeamSpanSegment

Public Member Functions

void RequestStaffSpace (const Doc *doc, const BeamDrawingInterface *beamInterface)
 Request staff space for mixed beams if minimal stem length is too short.
 
Constructors, destructors, and other standard methods
 BeamSegment ()
 
virtual ~BeamSegment ()
 
void Reset ()
 
void CalcBeam (const Layer *layer, Staff *staff, const Doc *doc, BeamDrawingInterface *beamInterface, data_BEAMPLACE place=BEAMPLACE_NONE, bool init=true)
 
const ArrayOfBeamElementCoords * GetElementCoordRefs ()
 
void InitCoordRefs (const ArrayOfBeamElementCoords *beamElementCoords)
 Initializes the m_beamElementCoords vector objects. More...
 
void ClearCoordRefs ()
 Clear the m_beamElementCoords vector and delete all the objects.
 
int GetAdjacentElementsDuration (int elementX) const
 Get longest duration of the elements that are adjacent to the X coordinate passed.
 
Getters for the X and Y starting value of the beam;
int GetStartingX () const
 
int GetStartingY () const
 
Getters for the stem same as role.
bool StemSameas () const
 
bool StemSameasIsUnset () const
 
bool StemSameasIsPrimary () const
 
bool StemSameasIsSecondary () const
 
Methods to intialize and update the role for stem.sameas context

Before the drawing beam place has been calculated, the role is marked as unset.

Then it is marked as primary or secondary depending on the beam place.

void InitSameasRoles (Beam *sameasBeam, data_BEAMPLACE &drawingPlace)
 
void UpdateSameasRoles (data_BEAMPLACE place)
 
void CalcNoteHeadShiftForStemSameas (Beam *sameasBeam, data_BEAMPLACE place)
 

Public Attributes

int m_nbNotesOrChords
 
double m_beamSlope
 
int m_verticalCenter
 
int m_ledgerLinesAbove
 
int m_ledgerLinesBelow
 
int m_uniformStemLength
 
data_BEAMPLACE m_weightedPlace
 
BeamElementCoord * m_firstNoteOrChord
 
BeamElementCoord * m_lastNoteOrChord
 
ArrayOfBeamElementCoords m_beamElementCoordRefs
 An array of coordinates for each element.
 
The role in a stem.sameas situation.

Set in BeamSegment::InitSameasRoles and then in UpdateSameasRoles Used to determine if the beam is the primary one (normal stems and beams) or the secondary one (linking both notes).

This depends on the drawing beam place, which can be encoded but otherwise calculated by CalcBeamPlace. The pointer to the other beam m_stemSameasReverseRole is set only for the first of the two beams and is not bi-directional. Is is set in InitSameasRoles.

StemSameasDrawingRole m_stemSameasRole
 
StemSameasDrawingRole * m_stemSameasReverseRole
 

Detailed Description

Class for storing drawing parameters when calculating beams.

See View::DrawBeam and View::CalcBeam

Member Function Documentation

◆ InitCoordRefs()

void vrv::BeamSegment::InitCoordRefs ( const ArrayOfBeamElementCoords *  beamElementCoords)

Initializes the m_beamElementCoords vector objects.

This is called by Beam::FilterList

The documentation for this class was generated from the following file: