 |
Verovio
Source code documentation
|
|
Verovio
Source code documentation
|
This class is a hold the data and corresponds to the model of a MVC design pattern. More...
#include <doc.h>
Public Member Functions | |
| bool | IsSupportedChild (ClassId classId) override |
| Add a page to the document. | |
| void | Reset () override |
| Clear the content of the document. | |
| void | ResetToLoading () |
| void | ClearSelectionPages () |
| Clear the selection pages. | |
| bool | GenerateDocumentScoreDef () |
| Generate a document scoreDef when none is provided. More... | |
| void | GenerateFooter () |
| Generate a document pgFoot if none is provided. | |
| void | GenerateHeader () |
| Generate a document pgHead from the MEI header if none is provided. | |
| bool | GenerateMeasureNumbers () |
| Generate measure numbers from measure attributes. | |
| void | GenerateMEIHeader () |
| Generate a minimal MEI header. | |
| void | ConvertHeaderToMEIBasic () |
| Convert the header to MEI basic by preserving only the fileDesc and its titleStmt. | |
| bool | HasPage (int pageIdx) const |
| Check if the document has a page with the specified value. | |
| int | GetPageCount () const |
| Get the total page count. | |
| bool | GetMidiExportDone () const |
| Return true if the MIDI generation is already done. | |
| Point | ConvertFontPoint (const Glyph *glyph, const Point &fontPoint, int staffSize, bool graceSize) const |
| double | GetMusicToLyricFontSizeRatio () const |
| Get the ratio between the lyric font size and the music font size. More... | |
| data_MEASUREMENTSIGNED | GetStaffDistance (const Object *object, int staffIndex, data_STAFFREL staffPosition) const |
| Get the default distance from the staff for the object The distance is given in x * MEI UNIT. | |
| void | CalculateTimemap () |
| Prepare the timemap for MIDI and timemap file export. More... | |
| bool | HasTimemap () const |
| Check to see if the timemap has already been calculated. More... | |
| void | ExportMIDI (smf::MidiFile *midiFile) |
| Export the document to a MIDI file. More... | |
| bool | ExportTimemap (std::string &output, bool includeRests, bool includeMeasures, bool useFractions) |
| Extract a timemap from the document to a JSON string. More... | |
| bool | ExportExpansionMap (std::string &output) |
| Extract expansionMap from the document to JSON string. | |
| bool | ExportFeatures (std::string &output, const std::string &options) |
| Extract music features to JSON string. | |
| void | ScoreDefSetCurrentDoc (bool force=false) |
| Set the initial scoreDef of each page. More... | |
| void | ScoreDefOptimizeDoc () |
| Optimize the scoreDef once the document is cast-off. | |
| void | ScoreDefSetGrpSymDoc () |
| Set the GrpSym start / end for each System once ScoreDef is set and (if necessary) optimized. | |
| void | PrepareData () |
| Prepare the document data. More... | |
| void | CastOffDoc () |
| Casts off the entire document. More... | |
| void | CastOffSmartDoc () |
| Casts off the entire document, only using the document's system breaks if they would be close to the end in the normal document. | |
| void | CastOffLineDoc () |
| Casts off the entire document, using the document's line breaks, but adding its own page breaks. | |
| void | CastOffDocBase (bool useSb, bool usePb, bool smart=false) |
| Casts off the entire document, with options for obeying breaks. More... | |
| void | UnCastOffDoc (bool resetCache=true) |
| Undo the cast off of the entire document. More... | |
| void | CastOffEncodingDoc () |
| Cast off of the entire document according to the encoded data (pb and sb). More... | |
| void | ConvertToPageBasedDoc () |
| Convert the doc from score-based to page-based MEI. More... | |
| void | ConvertToCastOffMensuralDoc (bool castOff) |
| Convert mensural MEI into cast-off (measure) segments looking at the barLine objects. More... | |
| void | ConvertToCmnDoc () |
| Convert mensural MEI into CMN measure-based MEI. | |
| void | ConvertMarkupDoc (bool permanent=true) |
| Convert analytical encoding (@fermata, @tie) to correpsonding elements By default, the element are used only for the rendering and not preserved in the MEI output Permanent conversion discard analytical markup and elements will be preserved in the MEI output. | |
| void | ScoringUpDoc () |
| Calls the scoringUpFunctor and applies it. | |
| void | ConvertToMensuralViewDoc () |
| void | ConvertMensuralToCmnDoc () |
| Convert the doc from mensural to CMN. | |
| void | SyncFromFacsimileDoc () |
| Sync the coordinate provided trought <facsimile> to m_drawingFacsX/Y. More... | |
| void | SyncToFacsimileDoc () |
| Sync the coordinate provided in rendering to a <facsimile>. More... | |
| void | TransposeDoc () |
| Transpose the content of the doc. | |
| void | ExpandExpansions () |
| Convert encoded <expansion> before rendering. | |
| Page * | SetDrawingPage (int pageIdx, bool withPageRange=false) |
| Set drawing values (page size, etc) when drawing a page. More... | |
| void | UpdatePageDrawingSizes () |
| Update the drawing page sizes when a page is set as drawing page. | |
| void | ResetDataPage () |
| Reset drawing page to NULL. More... | |
| bool | CheckPageSize (const Page *page) const |
| Check that the page is the drawing page or that they have no given dimensions. | |
| int | GetAdjustedDrawingPageWidth () const |
| Return the width adjusted to the content of the current drawing page. More... | |
| int | GetAdjustedDrawingPageHeight () const |
| Return the height adjusted to the content of the current drawing page. More... | |
| void | SetMarkup (int markup) |
| Setter for markup flag. More... | |
| bool | IsCastOff () const |
| Return true if the document has been cast off already. | |
| void | RefreshLayout () |
| Refresh the layout of all pages in the doc. | |
| void | SetFocus () |
| Reset the document focus. | |
Constructors, destructors, reset methods | |
Reset method resets all attribute classes | |
| Doc () | |
| virtual | ~Doc () |
| Options * | GetOptions () |
| Getter for the options. | |
| const Options * | GetOptions () const |
| void | SetOptions (Options *options) |
| const Resources & | GetResources () const |
| Getter for the resources. | |
| Resources & | GetResourcesForModification () |
| DocType | GetType () const |
| Getter and setter for the DocType. | |
| void | SetType (DocType type) |
| bool | IsFacs () const |
| bool | IsRaw () const |
| bool | IsRendering () const |
| bool | IsTranscription () const |
| Pages * | GetPages () |
| Get the Pages in the visible Mdiv. More... | |
| const Pages * | GetPages () const |
| ScoreDef * | GetFirstScoreDef () |
| Get the first scoreDef. | |
| const ScoreDef * | GetFirstScoreDef () const |
| std::list< Score * > | GetVisibleScores () |
| Get all visible scores / the first visible score Lazily updates the visible scores, hence not const. | |
| Score * | GetFirstVisibleScore () |
| Score * | GetCorrespondingScore (const Object *object) |
| Get the corresponding score for a node. | |
| const Score * | GetCorrespondingScore (const Object *object) const |
| Score * | GetCorrespondingScore (const Object *object, const std::list< Score * > &scores) |
| const Score * | GetCorrespondingScore (const Object *object, const std::list< Score * > &scores) const |
Get the height or width for a glyph taking into account the staff and grace sizes | |
(no const because the size of the member font is changed) | |
| int | GetGlyphHeight (char32_t code, int staffSize, bool graceSize) const |
| int | GetGlyphWidth (char32_t code, int staffSize, bool graceSize) const |
| int | GetGlyphLeft (char32_t code, int staffSize, bool graceSize) const |
| int | GetGlyphRight (char32_t code, int staffSize, bool graceSize) const |
| int | GetGlyphBottom (char32_t code, int staffSize, bool graceSize) const |
| int | GetGlyphTop (char32_t code, int staffSize, bool graceSize) const |
| int | GetGlyphAdvX (char32_t code, int staffSize, bool graceSize) const |
| int | GetDrawingUnit (int staffSize) const |
| int | GetDrawingDoubleUnit (int staffSize) const |
| int | GetDrawingStaffSize (int staffSize) const |
| int | GetDrawingOctaveSize (int staffSize) const |
| int | GetDrawingBrevisWidth (int staffSize) const |
| int | GetDrawingBarLineWidth (int staffSize) const |
| int | GetDrawingStaffLineWidth (int staffSize) const |
| int | GetDrawingStemWidth (int staffSize) const |
| int | GetDrawingDirHeight (int staffSize, bool withMargin) const |
| int | GetDrawingDynamHeight (int staffSize, bool withMargin) const |
| int | GetDrawingHairpinSize (int staffSize, bool withMargin) const |
| int | GetDrawingBeamWidth (int staffSize, bool graceSize) const |
| int | GetDrawingBeamWhiteWidth (int staffSize, bool graceSize) const |
| int | GetDrawingLedgerLineExtension (int staffSize, bool graceSize) const |
| int | GetDrawingMinimalLedgerLineExtension (int staffSize, bool graceSize) const |
| int | GetCueSize (int value) const |
| double | GetCueScaling () const |
| FontInfo * | GetDrawingSmuflFont (int staffSize, bool graceSize) |
| FontInfo * | GetDrawingLyricFont (int staffSize) |
| FontInfo * | GetFingeringFont (int staffSize) |
Get the height or width for a text glyph taking into account the grace size. | |
The staff size must already be taken into account in the FontInfo | |
| int | GetTextGlyphHeight (char32_t code, const FontInfo *font, bool graceSize) const |
| int | GetTextGlyphWidth (char32_t code, const FontInfo *font, bool graceSize) const |
| int | GetTextGlyphAdvX (char32_t code, const FontInfo *font, bool graceSize) const |
| int | GetTextGlyphDescender (char32_t code, const FontInfo *font, bool graceSize) const |
| int | GetTextLineHeight (const FontInfo *font, bool graceSize) const |
| int | GetTextXHeight (const FontInfo *font, bool graceSize) const |
Getters for the object margins (left and right). | |
The margins are given in x * MEI UNIT | |
| double | GetLeftMargin (const ClassId classId) const |
| double | GetLeftMargin (const Object *object) const |
| double | GetRightMargin (const ClassId classId) const |
| double | GetRightMargin (const Object *object) const |
| double | GetLeftPosition () const |
| double | GetBottomMargin (const ClassId classId) const |
| double | GetTopMargin (const ClassId classId) const |
| Page * | GetDrawingPage () |
| Getter to the drawPage. More... | |
| const Page * | GetDrawingPage () const |
Setter for and getter for mensural only flag | |
| void | SetMensuralMusicOnly (data_BOOLEAN isMensuralMusicOnly) |
| bool | IsMensuralMusicOnly () const |
Setter for and getter for neume-line flag | |
| void | SetNeumeLines (bool isNeumeLines) |
| bool | IsNeumeLines () const |
Setter and getter for facsimile | |
| void | SetFacsimile (Facsimile *facsimile) |
| Facsimile * | GetFacsimile () |
| const Facsimile * | GetFacsimile () const |
| bool | HasFacsimile () const |
Methods for managing a selection. | |
| void | InitSelectionDoc (DocSelection &selection, bool resetCache) |
| void | ResetSelectionDoc (bool resetCache) |
| bool | HasSelection () const |
| void | DeactiveateSelection () |
| Temporarily deactivate and reactivate selection. More... | |
| void | ReactivateSelection (bool resetAligners) |
| FunctorCode | Accept (Functor &functor) override |
| Interface for class functor visitation. | |
| FunctorCode | Accept (ConstFunctor &functor) const override |
| FunctorCode | AcceptEnd (Functor &functor) override |
| FunctorCode | AcceptEnd (ConstFunctor &functor) const override |
 Public Member Functions inherited from vrv::Object | |
| bool | IsFloatingObject () const |
| Wrapper for checking if an element is a floating object (system elements and control elements) | |
| const Resources * | GetDocResources () const |
| Resource access from the document. | |
| Object (const Object &object) | |
| Copy constructor that also copy the children. More... | |
| Object & | operator= (const Object &object) |
| Copy assignement - see copy constructor. | |
| void | MoveChildrenFrom (Object *sourceParent, int idx=-1, bool allowTypeChange=false) |
| Move all the children of the object passed as parameter to this one. More... | |
| void | ReplaceChild (Object *currentChild, Object *replacingChild) |
| Replace the currentChild with the replacingChild. More... | |
| void | SortChildren (binaryComp comp) |
| void | MoveItselfTo (Object *targetParent) |
| Move an object to another parent. More... | |
| virtual Object * | Clone () const |
| Method call for copying child classes. More... | |
| virtual bool | CopyChildren () const |
| Indicate whereas children have to be copied in copy / assignment constructors. More... | |
| virtual void | CloneReset () |
| Reset pointers after a copy and assignment constructor call. More... | |
| const std::string & | GetID () const |
| void | SetID (const std::string &id) |
| void | SwapID (Object *other) |
| void | ResetID () |
| std::string | GetComment () const |
| Methods for setting / getting comments. | |
| void | SetComment (std::string comment) |
| bool | HasComment () const |
| std::string | GetClosingComment () const |
| void | SetClosingComment (std::string endComment) |
| bool | HasClosingComment () const |
| ArrayOfObjects & | GetChildrenForModification () |
| Return a reference to the children that allows modification. More... | |
| void | CopyAttributesTo (Object *target) const |
| Copy all the attributes of an obejct to target. More... | |
| int | GetAttributes (ArrayOfStrAttr *attributes) const |
| Fill an array of pairs with all attributes and their values. More... | |
| bool | HasAttribute (std::string attribute, std::string value) const |
| Check if an Object has an attribute with the specified value. | |
| void | SetParent (Object *parent) |
| Set the parent of the Object. More... | |
| void | ResetParent () |
| Reset the parent of the Object. More... | |
| virtual void | AddChild (Object *object) |
| Base method for adding children. More... | |
| virtual bool | AddChildAdditionalCheck (Object *child) |
| Additional check when adding a child. | |
| virtual int | GetInsertOrderFor (ClassId classId) const |
| Return the child order for a the given ClassId. More... | |
| int | GetInsertOrderForIn (ClassId classId, const std::vector< ClassId > &order) const |
| Find the order from an overriden GetInsertOrderFor method. | |
| int | GetIdx () const |
| Return the index position of the object in its parent (-1 if not found) | |
| int | GetChildIndex (const Object *child) const |
| Look for the Object in the children and return its position (-1 if not found) | |
| int | GetDescendantIndex (const Object *child, const ClassId classId, int depth) |
| Look for all Objects of a class and return its position (-1 if not found) | |
| void | InsertChild (Object *element, int idx) |
| Insert an element at the idx position. | |
| void | RotateChildren (int first, int middle, int last) |
| Rotates the child elements of the object leftwards, using std::rotate() with the given indices. More... | |
| Object * | DetachChild (int idx) |
| Detach the child at the idx position (NULL if not found) The parent pointer is set to NULL. | |
| void | ReplaceWithCopyOf (Object *object) |
| Replace an object with a copy of the other. More... | |
| bool | HasDescendant (const Object *child, int deepness=UNLIMITED_DEPTH) const |
| Return true if the object has the child Object as descendant (reference of direct). More... | |
| Object * | Relinquish (int idx) |
| Give up ownership of the child at the idx position (NULL if not found) This is a method to be used only in the very particular case where the child object cannot be detached straight away. More... | |
| void | ClearRelinquishedChildren () |
| Removes all the children that were previously relinquished. More... | |
| void | ClearChildren () |
| Clear the children vector and delete all the objects. | |
| bool | DeleteChild (Object *child) |
| Remove and delete the child. More... | |
| int | DeleteChildrenByComparison (Comparison *comparison) |
| Delete the children that match the comparison. More... | |
| void | FillFlatList (ListOfConstObjects &list) const |
| Fill the list of all the children LayerElement. More... | |
| bool | IsModified () const |
| Check if the content was modified or not. | |
| void | Modify (bool modified=true) const |
| Mark the object and its parent (if any) as modified. | |
| bool | HasEditorialContent () |
| Return true if the object contains any editorial content. | |
| bool | HasNonEditorialContent () |
| Return true if the object contains anything that is not editorial content. | |
| void | SaveObject (Output *output, bool basic) |
| Saves the object (and its children) using the specified output stream. | |
| template<class Compare > | |
| void | StableSort (Compare comp) |
| Sort the child elements using std::stable_sort. | |
| void | ReorderByXPos () |
| Object * | FindNextChild (Comparison *comp, Object *start) |
| Object * | FindPreviousChild (Comparison *comp, Object *start) |
| Object () | |
| Object (ClassId classId) | |
| virtual | ~Object () |
| ClassId | GetClassId () const final |
| virtual std::string | GetClassName () const |
| void | SetAsReferenceObject () |
| Make an object a reference object that do not own children. More... | |
| bool | IsReferenceObject () const |
| bool | IsMilestoneElement () |
| Wrapper for checking if an element has a milestone start interface and also if is set as a milestone element. | |
| Object * | GetMilestoneEnd () |
| bool | IsControlElement () const |
| bool | IsEditorialElement () const |
| bool | IsLayerElement () const |
| bool | IsPageElement () const |
| bool | IsRunningElement () const |
| bool | IsScoreDefElement () const |
| bool | IsSystemElement () const |
| bool | IsTextElement () const |
| void | RegisterAttClass (AttClassId attClassId) |
| bool | HasAttClass (AttClassId attClassId) const |
| void | RegisterInterface (std::vector< AttClassId > *attClasses, InterfaceId interfaceId) |
| bool | HasInterface (InterfaceId interfaceId) const |
| virtual AltSymInterface * | GetAltSymInterface () |
| virtual const AltSymInterface * | GetAltSymInterface () const |
| virtual AreaPosInterface * | GetAreaPosInterface () |
| virtual const AreaPosInterface * | GetAreaPosInterface () const |
| virtual BeamDrawingInterface * | GetBeamDrawingInterface () |
| virtual const BeamDrawingInterface * | GetBeamDrawingInterface () const |
| virtual DurationInterface * | GetDurationInterface () |
| virtual const DurationInterface * | GetDurationInterface () const |
| virtual LinkingInterface * | GetLinkingInterface () |
| virtual const LinkingInterface * | GetLinkingInterface () const |
| virtual FacsimileInterface * | GetFacsimileInterface () |
| virtual const FacsimileInterface * | GetFacsimileInterface () const |
| virtual PitchInterface * | GetPitchInterface () |
| virtual const PitchInterface * | GetPitchInterface () const |
| virtual PlistInterface * | GetPlistInterface () |
| virtual const PlistInterface * | GetPlistInterface () const |
| virtual PositionInterface * | GetPositionInterface () |
| virtual const PositionInterface * | GetPositionInterface () const |
| virtual ScoreDefInterface * | GetScoreDefInterface () |
| virtual const ScoreDefInterface * | GetScoreDefInterface () const |
| virtual StemmedDrawingInterface * | GetStemmedDrawingInterface () |
| virtual const StemmedDrawingInterface * | GetStemmedDrawingInterface () const |
| virtual TextDirInterface * | GetTextDirInterface () |
| virtual const TextDirInterface * | GetTextDirInterface () const |
| virtual TimePointInterface * | GetTimePointInterface () |
| virtual const TimePointInterface * | GetTimePointInterface () const |
| virtual TimeSpanningInterface * | GetTimeSpanningInterface () |
| virtual const TimeSpanningInterface * | GetTimeSpanningInterface () const |
| void | InsertBefore (Object *child, Object *newChild) |
| void | InsertAfter (Object *child, Object *newChild) |
| int | GetChildCount () const |
| int | GetChildCount (const ClassId classId) const |
| int | GetChildCount (const ClassId classId, int depth) const |
| int | GetDescendantCount (const ClassId classId) const |
| Object * | GetChild (int idx) |
| Child access (generic) | |
| const Object * | GetChild (int idx) const |
| Object * | GetChild (int idx, const ClassId classId) |
| const Object * | GetChild (int idx, const ClassId classId) const |
| ArrayOfConstObjects | GetChildren () const |
| Return the children as const reference or copy. | |
| const ArrayOfObjects & | GetChildren () |
| Object * | GetFirst (const ClassId classId=UNSPECIFIED) |
| const Object * | GetFirst (const ClassId classId=UNSPECIFIED) const |
| Object * | GetNext () |
| const Object * | GetNext () const |
| Object * | GetNext (const Object *child, const ClassId classId=UNSPECIFIED) |
| const Object * | GetNext (const Object *child, const ClassId classId=UNSPECIFIED) const |
| Object * | GetPrevious (const Object *child, const ClassId classId=UNSPECIFIED) |
| const Object * | GetPrevious (const Object *child, const ClassId classId=UNSPECIFIED) const |
| Object * | GetLast (const ClassId classId=UNSPECIFIED) |
| Return the last child of the object (if any, NULL otherwise) | |
| const Object * | GetLast (const ClassId classId=UNSPECIFIED) const |
| Object * | GetParent () |
| Get the parent of the Object. | |
| const Object * | GetParent () const |
| int | GetDrawingX () const override |
| int | GetDrawingY () const override |
| void | ResetCachedDrawingX () const override |
| void | ResetCachedDrawingY () const override |
| Object * | FindDescendantByID (const std::string &id, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD) |
| Look for a descendant with the specified id (returns NULL if not found) This method is a wrapper for the Object::FindByID functor. | |
| const Object * | FindDescendantByID (const std::string &id, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD) const |
| Object * | FindDescendantByType (ClassId classId, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD) |
| Look for a descendant with the specified type (returns NULL if not found) This method is a wrapper for the Object::FindByType functor. | |
| const Object * | FindDescendantByType (ClassId classId, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD) const |
| Object * | FindDescendantByComparison (Comparison *comparison, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD) |
| Return the first element matching the Comparison functor Deepness allow to limit the depth search (EditorialElements are not count) | |
| const Object * | FindDescendantByComparison (Comparison *comparison, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD) const |
| Object * | FindDescendantExtremeByComparison (Comparison *comparison, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD) |
| Return the element matching the extreme value with an Comparison functor Deepness allow to limit the depth search (EditorialElements are not count) | |
| const Object * | FindDescendantExtremeByComparison (Comparison *comparison, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD) const |
| ListOfObjects | FindAllDescendantsByType (ClassId classId, bool continueDepthSearchForMatches=true, int deepness=UNLIMITED_DEPTH) |
| Return all the objects with specified type. | |
| ListOfConstObjects | FindAllDescendantsByType (ClassId classId, bool continueDepthSearchForMatches=true, int deepness=UNLIMITED_DEPTH) const |
| void | FindAllDescendantsByComparison (ListOfObjects *objects, Comparison *comparison, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD, bool clear=true) |
| Return all the objects matching the Comparison functor Deepness allow to limit the depth search (EditorialElements are not count) | |
| void | FindAllDescendantsByComparison (ListOfConstObjects *objects, Comparison *comparison, int deepness=UNLIMITED_DEPTH, bool direction=FORWARD, bool clear=true) const |
| void | FindAllDescendantsBetween (ListOfObjects *objects, Comparison *comparison, const Object *start, const Object *end, bool clear=true, int depth=UNLIMITED_DEPTH) |
| Return all the objects matching the Comparison functor and being between start and end in the tree. More... | |
| void | FindAllDescendantsBetween (ListOfConstObjects *objects, Comparison *comparison, const Object *start, const Object *end, bool clear=true, int depth=UNLIMITED_DEPTH) const |
| ListOfObjects | GetAncestors () |
| Returns all ancestors. | |
| ListOfConstObjects | GetAncestors () const |
| Object * | GetFirstAncestor (const ClassId classId, int maxSteps=-1) |
| Return the first ancestor of the specified type. More... | |
| const Object * | GetFirstAncestor (const ClassId classId, int maxSteps=-1) const |
| Object * | GetFirstAncestorInRange (const ClassId classIdMin, const ClassId classIdMax, int maxDepth=-1) |
| const Object * | GetFirstAncestorInRange (const ClassId classIdMin, const ClassId classIdMax, int maxDepth=-1) const |
| Object * | GetLastAncestorNot (const ClassId classId, int maxSteps=-1) |
| Return the last ancestor that is NOT of the specified type. More... | |
| const Object * | GetLastAncestorNot (const ClassId classId, int maxSteps=-1) const |
| Object * | GetFirstChildNot (const ClassId classId) |
| Return the first child that is NOT of the specified type. | |
| const Object * | GetFirstChildNot (const ClassId classId) const |
| bool | IsAttribute () const |
| void | IsAttribute (bool isAttribute) |
| bool | IsExpansion () const |
| void | IsExpansion (bool isExpansion) |
| void | Process (Functor &functor, int deepness=UNLIMITED_DEPTH, bool skipFirst=false) |
| Main method that processes functors. More... | |
| void | Process (ConstFunctor &functor, int deepness=UNLIMITED_DEPTH, bool skipFirst=false) const |
| void | LogDebugTree (int maxDepth=UNLIMITED_DEPTH, int level=0) |
| Output the class name of the object (or a custom msg) and of its children recursively. | |
| virtual std::string | LogDebugTreeMsg () |
| Public Member Functions inherited from vrv::BoundingBox | |
| virtual void | ResetBoundingBox () |
| Reset the bounding box values. | |
| bool | Encloses (const Point point) const |
| Return true if the bounding box encloses the point. | |
| int | Intersects (const FloatingCurvePositioner *curve, Accessor type, int margin=0) const |
| Return intersection between the bounding box and the curve represented by the FloatingPositioner. More... | |
| int | Intersects (const BeamDrawingInterface *beamInterface, Accessor type, int margin=0, bool fromBeamContentSide=false) const |
| Return intersection between the bounding box and the beam represented by the BeamDrawingInterface. More... | |
| BoundingBox () | |
| virtual | ~BoundingBox () |
| bool | Is (ClassId classId) const |
| bool | Is (const std::vector< ClassId > &classIds) const |
| virtual void | UpdateContentBBoxX (int x1, int x2) |
| virtual void | UpdateContentBBoxY (int y1, int y2) |
| virtual void | UpdateSelfBBoxX (int x1, int x2) |
| virtual void | UpdateSelfBBoxY (int y1, int y2) |
| void | SetEmptyBB () |
| bool | HasSelfBB () const |
| bool | HasSelfHorizontalBB () const |
| bool | HasSelfVerticalBB () const |
| bool | HasContentBB () const |
| bool | HasContentHorizontalBB () const |
| bool | HasContentVerticalBB () const |
| bool | HasEmptyBB () const |
| void | SetBoundingBoxGlyph (char32_t smuflGlyph, int fontSize) |
| Set and get the smuflGlyph / fontsize for a bounding box that is the one of a single SMuFL glyph. | |
| char32_t | GetBoundingBoxGlyph () const |
| int | GetBoundingBoxGlyphFontSize () const |
| int | GetSelfBottom () const |
| int | GetSelfTop () const |
| int | GetSelfLeft () const |
| int | GetSelfRight () const |
| int | GetContentBottom () const |
| int | GetContentTop () const |
| int | GetContentLeft () const |
| int | GetContentRight () const |
| int | GetSelfX1 () const |
| int | GetSelfX2 () const |
| int | GetSelfY1 () const |
| int | GetSelfY2 () const |
| int | GetContentX1 () const |
| int | GetContentX2 () const |
| int | GetContentY1 () const |
| int | GetContentY2 () const |
| int | GetBottomBy (Accessor type) const |
| int | GetTopBy (Accessor type) const |
| int | GetLeftBy (Accessor type) const |
| int | GetRightBy (Accessor type) const |
| int | GetX1By (Accessor type) const |
| int | GetX2By (Accessor type) const |
| int | GetY1By (Accessor type) const |
| int | GetY2By (Accessor type) const |
| bool | HorizontalContentOverlap (const BoundingBox *other, int margin=0) const |
| bool | VerticalContentOverlap (const BoundingBox *other, int margin=0) const |
| bool | HorizontalSelfOverlap (const BoundingBox *other, int margin=0) const |
| bool | VerticalSelfOverlap (const BoundingBox *other, int margin=0) const |
| int | HorizontalLeftOverlap (const BoundingBox *other, const Doc *doc, int margin=0, int vMargin=0) const |
| int | HorizontalRightOverlap (const BoundingBox *other, const Doc *doc, int margin=0, int vMargin=0) const |
| int | VerticalTopOverlap (const BoundingBox *other, const Doc *doc, int margin=0, int hMargin=0) const |
| int | VerticalBottomOverlap (const BoundingBox *other, const Doc *doc, int margin=0, int hMargin=0) const |
| int | GetCutOutTop (const Resources &resources) const |
| int | GetCutOutBottom (const Resources &resources) const |
| int | GetCutOutLeft (const Resources &resources) const |
| int | GetCutOutRight (const Resources &resources) const |
| int | GetCutOutLeft (const Resources &resources, bool fromTop) const |
| int | GetCutOutRight (const Resources &resources, bool fromTop) const |
Public Attributes | |
| Page * | m_selectionPreceding |
| Page * | m_selectionFollowing |
| std::string | m_selectionStart |
| std::string | m_selectionEnd |
| PageRange * | m_focusRange |
| A page range (owned object) with focus in the document. | |
| pugi::xml_document | m_header |
| A copy of the header tree stored as pugi::xml_document. | |
| pugi::xml_document | m_front |
| A copy of the front tree stored as pugi::xml_document. | |
| pugi::xml_document | m_back |
| A copy of the back tree stored as pugi::xml_document. | |
| std::string | m_musicDecls |
| The music@decls value. | |
| int | m_drawingPageHeight |
| The current page height. | |
| int | m_drawingPageWidth |
| The current page width. | |
| int | m_drawingPageContentHeight |
| The current page content height (without margings) | |
| int | m_drawingPageContentWidth |
| The current page content width (without margins) | |
| int | m_drawingPageMarginBottom |
| The current page bottom margin. | |
| int | m_drawingPageMarginLeft |
| The current page left margin. | |
| int | m_drawingPageMarginRight |
| The current page right margin. | |
| int | m_drawingPageMarginTop |
| The current page top margin. | |
| float | m_drawingBeamMaxSlope |
| the current beam maximal slope | |
| data_NOTATIONTYPE | m_notationType |
| Record notation type for document. More... | |
| ExpansionMap | m_expansionMap |
| An expansion map that contains | |
| Public Attributes inherited from vrv::Object | |
| ArrayOfStrAttr | m_unsupported |
| Keep an array of unsupported attributes as pairs. More... | |
Additional Inherited Members | |
| Public Types inherited from vrv::Object | |
| typedef bool(* | binaryComp) (Object *, Object *) |
| Sort children by a function that takes two arguments and returns true if the first argument is less than the second. More... | |
| Static Public Member Functions inherited from vrv::Object | |
| static void | SeedID (uint32_t seed=0) |
| static std::string | GenerateHashID () |
| static uint32_t | Hash (uint32_t number, bool reverse=false) |
| static bool | sortByUlx (Object *a, Object *b) |
| static bool | IsPreOrdered (const Object *left, const Object *right) |
| Return true if left appears before right in preorder traversal. | |
| static bool | IsControlElement (ClassId classId) |
| static bool | IsEditorialElement (ClassId classId) |
| static bool | IsLayerElement (ClassId classId) |
| static bool | IsPageElement (ClassId classId) |
| static bool | IsRunningElement (ClassId classId) |
| static bool | IsScoreDefElement (ClassId classId) |
| static bool | IsSystemElement (ClassId classId) |
| static bool | IsTextElement (ClassId classId) |
| Static Public Member Functions inherited from vrv::BoundingBox | |
| static std::pair< double, int > | ApproximateBezierExtrema (const Point bezier[4], bool isMaxExtrema, int approximationSteps=BEZIER_APPROXIMATION) |
| static double | CalcDistance (const Point &p1, const Point &p2) |
| Calculate the euclidean distance between two points. | |
| static bool | ArePointsClose (const Point &p1, const Point &p2, int margin) |
| static double | CalcSlope (const Point &p1, const Point &p2) |
| Calculate the slope represented by two points. | |
| static Point | CalcPositionAfterRotation (Point point, float alpha, Point center) |
| Calculate the position of a point after a rotation of alpha (in radian) around the center. | |
| static double | CalcBezierParamAtPosition (const Point bezier[4], int x) |
| Calculate the t parameter of a bezier at position x. | |
| static int | CalcBezierAtPosition (const Point bezier[4], int x) |
| Calculate the y position of a bezier at position x. | |
| static void | CalcLinearInterpolation (Point &dest, const Point &a, const Point &b, double t) |
| Calculate linear interpolation between two points at time t. | |
| static Point | CalcPointAtBezier (const Point bezier[4], double t) |
| Calculate point (X,Y) coordinaties on the bezier curve. | |
| static double | GetBezierThicknessCoefficient (const Point bezier[4], int currentThickness, int penWidth) |
| Calculate thickness coefficient to be applient for bezier curve to fit MEI units thickness. | |
| static Point | CalcDeCasteljau (const Point bezier[4], double t) |
| Calculate the point bezier point position for a t between 0.0 and 1.0. | |
| static void | CalcThickBezier (const Point bezier[4], int thickness, Point topBezier[4], Point bottomBezier[4]) |
| Calculate the position of the bezier above and below for a thick bezier. | |
| static void | ApproximateBezierBoundingBox (const Point bezier[4], Point &pos, int &width, int &height, int &minYPos, int &maxYPos) |
| Approximate the bounding box of a bezier taking into accound the height and the width. | |
| static std::set< double > | SolveCubicPolynomial (double a, double b, double c, double d) |
| Solve the cubic equation ax^3 + bx^2 + cx + d = 0 Returns up to three real roots. | |
| static int | RectLeftOverlap (const Point rect1[2], const Point rect2[2], int margin, int vMargin) |
| Calculate the left / right / top / bottom overlap of two rectangle taking into account the margin / v-h-Margins. | |
| static int | RectRightOverlap (const Point rect1[2], const Point rect2[2], int margin, int vMargin) |
| static int | RectTopOverlap (const Point rect1[2], const Point rect2[2], int margin, int hMargin) |
| static int | RectBottomOverlap (const Point rect1[2], const Point rect2[2], int margin, int hMargin) |
| Protected Attributes inherited from vrv::BoundingBox | |
| int | m_cachedDrawingX |
| The cached version of the drawingX and drawingY values. More... | |
| int | m_cachedDrawingY |
This class is a hold the data and corresponds to the model of a MVC design pattern.
| void vrv::Doc::CalculateTimemap | ( | ) |
Prepare the timemap for MIDI and timemap file export.
Run trough all the layers and fill the score-time and performance timing variables.
| void vrv::Doc::CastOffDoc | ( | ) |
Casts off the entire document.
Starting from a single system, create and fill pages and systems.
| void vrv::Doc::CastOffDocBase | ( | bool | useSb, |
| bool | usePb, | ||
| bool | smart = false |
||
| ) |
Casts off the entire document, with options for obeying breaks.
| useSb | - true to use the sb from the document. |
| usePb | - true to use the pb from the document. |
| smart | - true to sometimes use encoded sb and pb. |
| void vrv::Doc::CastOffEncodingDoc | ( | ) |
Cast off of the entire document according to the encoded data (pb and sb).
Does not perform any check on the presence and / or validity of such data.
| void vrv::Doc::ConvertToCastOffMensuralDoc | ( | bool | castOff | ) |
Convert mensural MEI into cast-off (measure) segments looking at the barLine objects.
Segment positions occur where a barLine is set on all staves. castOff parameters indicates if we perform cast off (true) or un-cast off
| void vrv::Doc::ConvertToPageBasedDoc | ( | ) |
Convert the doc from score-based to page-based MEI.
Containers will be converted to systemMilestone / systemMilestoneEnd. Does not perform any check if the data needs or can be converted.
| void vrv::Doc::DeactiveateSelection | ( | ) |
Temporarily deactivate and reactivate selection.
Used for example to get the complete MEI data. No check and cast-off performed.
| void vrv::Doc::ExportMIDI | ( | smf::MidiFile * | midiFile | ) |
Export the document to a MIDI file.
Run trough all the layers and fill the MIDI file content.
| bool vrv::Doc::ExportTimemap | ( | std::string & | output, |
| bool | includeRests, | ||
| bool | includeMeasures, | ||
| bool | useFractions | ||
| ) |
Extract a timemap from the document to a JSON string.
Run trough all the layers and fill the timemap file content.
| bool vrv::Doc::GenerateDocumentScoreDef | ( | ) |
Generate a document scoreDef when none is provided.
This only looks at the content first system of the document.
| int vrv::Doc::GetAdjustedDrawingPageHeight | ( | ) | const |
Return the height adjusted to the content of the current drawing page.
This includes the appropriate top and bottom margin (using top as bottom).
| int vrv::Doc::GetAdjustedDrawingPageWidth | ( | ) | const |
Return the width adjusted to the content of the current drawing page.
This includes the appropriate left and right margins.
|
inline |
Getter to the drawPage.
Normally, getting the page should be done with Doc::SetDrawingPage. This is only a method for asserting that we currently have the right page.
| double vrv::Doc::GetMusicToLyricFontSizeRatio | ( | ) | const |
Get the ratio between the lyric font size and the music font size.
This is used when the music font is used within text.
| Pages* vrv::Doc::GetPages | ( | ) |
| bool vrv::Doc::HasTimemap | ( | ) | const |
Check to see if the timemap has already been calculated.
This needs to return true before ExportMIDI() or ExportTimemap() can export anything (These two functions will automatically run CalculateTimemap() if HasTimemap() return false.
| void vrv::Doc::PrepareData | ( | ) |
Prepare the document data.
This sets pointers and value and needs to be done after loading and any editing. For example, it sets the approriate values for the lyrics connectors
|
inline |
Reset drawing page to NULL.
This might be necessary if we have replaced a page in the document. We need to call this because otherwise looking at the page idx will fail. See Doc::LayOut for an example.
| void vrv::Doc::ScoreDefSetCurrentDoc | ( | bool | force = false | ) |
Set the initial scoreDef of each page.
This is necessary for integrating changes that occur within a page. It uses the MusObject::SetPageScoreDef functor method for parsing the file. This will be done only if m_currentScoreDefDone is false or force is true.
| Page* vrv::Doc::SetDrawingPage | ( | int | pageIdx, |
| bool | withPageRange = false |
||
| ) |
Set drawing values (page size, etc) when drawing a page.
By default, the page size of the document is taken. If a page is given, the size of the page is taken. The withPageRange parameter trigger layout of pages in the appropriate range.
|
inline |
Setter for markup flag.
See corresponding enum in vrvdef.h Set when reading the file to indicate what markup conversion needs to be applied. See Doc::ConvertMarkupDoc
| void vrv::Doc::SyncFromFacsimileDoc | ( | ) |
Sync the coordinate provided trought <facsimile> to m_drawingFacsX/Y.
Call the SyncToFacsimile functor.
| void vrv::Doc::SyncToFacsimileDoc | ( | ) |
Sync the coordinate provided in rendering to a <facsimile>.
The document must have encoded layout and the option –break encoded must have enabled.
| void vrv::Doc::UnCastOffDoc | ( | bool | resetCache = true | ) |
Undo the cast off of the entire document.
The document will then contain one single page with one single system.
| data_NOTATIONTYPE vrv::Doc::m_notationType |
Record notation type for document.
(This should be improved by storing a vector of all notation types of the document for cases mixing notations)
1.8.17