Verovio
Source code documentation
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
vrv::DeviceContext Class Referenceabstract

This class is an abstract device context. More...

#include <devicecontext.h>

Inheritance diagram for vrv::DeviceContext:
vrv::BBoxDeviceContext vrv::SvgDeviceContext

Public Member Functions

virtual void DrawPlaceholder (int x, int y)
 Special method for forcing bounding boxes to be updated Used for invisible elements (e.g., <space>) that needs to be take into account in spacing.
 
virtual void SetCustomGraphicColor (const std::string &color)
 Method for changing the color of a custom graphic.
 
virtual void SetCustomGraphicAttributes (const std::string &data, const std::string &value)
 Method for adding custom graphic data-* attributes.
 
virtual bool UseGlobalStyling ()
 Method indicating if default global styling is used. More...
 
Constructors, destructors, and other standard methods
 DeviceContext ()
 
 DeviceContext (ClassId classId)
 
virtual ~DeviceContext ()
 
ClassId GetClassId () const
 
bool Is (ClassId classId) const
 
Getter and setter for the resources

Resources must be set before drawing

const Resources * GetResources (bool showWarning=false) const
 
bool HasResources () const
 
void SetResources (const Resources *resources)
 
void ResetResources ()
 
Getters and setters for common attributes.

Non-virtual methods cannot be overridden and manage the width, height and user-scale

void SetWidth (int width)
 
void SetHeight (int height)
 
void SetContentHeight (int height)
 
void SetUserScale (double scaleX, double scaleY)
 
void SetBaseSize (int width, int height)
 
void SetViewBoxFactor (double ppuFactor)
 
int GetWidth () const
 
int GetHeight () const
 
int GetContentHeight () const
 
double GetUserScaleX ()
 
double GetUserScaleY ()
 
std::pair< int, int > GetBaseSize () const
 
double GetViewBoxFactor () const
 
Setters

Non-virtual methods cannot be overridden and manage the Pen, Brush and FontInfo stacks

void SetBrush (float opacity, int color=COLOR_NONE)
 
void SetPen (int width, PenStyle style, int dashLength=0, int gapLength=0, LineCapStyle lineCap=LINECAP_DEFAULT, LineJoinStyle lineJoin=LINEJOIN_DEFAULT, float opacity=1.0, int color=COLOR_NONE)
 
void SetFont (FontInfo *font)
 
void SetPushBack ()
 
void ResetBrush ()
 
void ResetPen ()
 
void ResetFont ()
 
void ResetPushBack ()
 
virtual void SetBackground (int color, int style=PEN_SOLID)=0
 
virtual void SetBackgroundImage (void *image, double opacity=1.0)=0
 
virtual void SetBackgroundMode (int mode)=0
 
virtual void SetTextForeground (int color)=0
 
virtual void SetTextBackground (int color)=0
 
virtual void SetLogicalOrigin (int x, int y)=0
 
Getters
FontInfo * GetFont ()
 
bool HasFont () const
 
virtual Point GetLogicalOrigin ()=0
 
Getters for text extend (non-virtual)
virtual void GetTextExtent (const std::string &string, TextExtend *extend, bool typeSize)
 
virtual void GetTextExtent (const std::u32string &string, TextExtend *extend, bool typeSize)
 
virtual void GetSmuflTextExtent (const std::u32string &string, TextExtend *extend)
 
Drawing methods
virtual void DrawQuadBezierPath (Point bezier[3])=0
 
virtual void DrawCubicBezierPath (Point bezier[4])=0
 
virtual void DrawCubicBezierPathFilled (Point bezier1[4], Point bezier2[4])=0
 
virtual void DrawBentParallelogramFilled (Point side[4], int height)=0
 
virtual void DrawCircle (int x, int y, int radius)=0
 
virtual void DrawEllipse (int x, int y, int width, int height)=0
 
virtual void DrawEllipticArc (int x, int y, int width, int height, double start, double end)=0
 
virtual void DrawLine (int x1, int y1, int x2, int y2)=0
 
virtual void DrawPolyline (int n, Point points[], bool close=false)=0
 
virtual void DrawPolygon (int n, Point points[])=0
 
virtual void DrawRectangle (int x, int y, int width, int height)=0
 
virtual void DrawRotatedText (const std::string &text, int x, int y, double angle)=0
 
virtual void DrawRoundedRectangle (int x, int y, int width, int height, int radius)=0
 
virtual void DrawText (const std::string &text, const std::u32string &wtext=U"", int x=VRV_UNSET, int y=VRV_UNSET, int width=VRV_UNSET, int height=VRV_UNSET)=0
 
virtual void DrawMusicText (const std::u32string &text, int x, int y, bool setSmuflGlyph=false)=0
 
virtual void DrawSpline (int n, Point points[])=0
 
virtual void DrawGraphicUri (int x, int y, int width, int height, const std::string &uri)=0
 
virtual void DrawSvgShape (int x, int y, int width, int height, double scale, pugi::xml_node svg)=0
 
virtual void DrawBackgroundImage (int x=0, int y=0)=0
 
Method for starting and ending a text

Once started, DrawText should be called for actually drawing the text.

Font can be changed between called for DrawText

virtual void StartText (int x, int y, data_HORIZONTALALIGNMENT alignment=HORIZONTALALIGNMENT_left)=0
 
virtual void EndText ()=0
 
Move a text to the specified position, for example when starting a new line.

These methods should be called only between a StartText and EndText call.

virtual void MoveTextTo (int x, int y, data_HORIZONTALALIGNMENT alignment)=0
 
virtual void MoveTextVerticallyTo (int y)=0
 
Temporarily deactivate a graphic

This can be used for example for not taking into account the bounding box of parts of the graphic.

One example is the connectors in lyrics. This is a non-virtual method and hence cannot be overridden. In only changes a flag. The effect of the flag has to be defined in the child class. It should not be called twice in a row. Is it also possible to deactivate only X or Y axis. Reactivate will reactivate both axis.

void DeactivateGraphic ()
 
void DeactivateGraphicX ()
 
void DeactivateGraphicY ()
 
void ReactivateGraphic ()
 
Method for starting and ending a graphic

For example, the method can be used for grouping shapes in <g></g> in SVG

virtual void StartGraphic (Object *object, const std::string &gClass, const std::string &gId, GraphicID graphicID=PRIMARY, bool preprend=false)=0
 
virtual void EndGraphic (Object *object, View *view)=0
 
Method for starting and ending a graphic custom graphic that do not correspond to an Object

For example, the method can be used for grouping shapes in <g></g> in SVG

virtual void StartCustomGraphic (const std::string &name, std::string gClass="", std::string gId="")
 
virtual void EndCustomGraphic ()
 
Methods for re-starting and ending a graphic for objects drawn in separate steps

The methods can be used to the output together, for example for a Beam

virtual void ResumeGraphic (Object *object, std::string gId)=0
 
virtual void EndResumedGraphic (Object *object, View *view)=0
 
Method for starting and ending a text graphic when it needs to be different from a normal graphic.

For example, in SVG, a text graphic is a <tspan> (and not a <g>)

virtual void StartTextGraphic (Object *object, const std::string &gClass, const std::string &gId)
 
virtual void EndTextGraphic (Object *object, View *view)
 
Method for rotating a graphic (clockwise).

This should be called only once per graphic and before drawing anything in it.

virtual void RotateGraphic (Point const &orig, double angle)=0
 
Method for starting and ending page
virtual void StartPage ()=0
 
virtual void EndPage ()=0
 
Method for adding description element
virtual void AddDescription (const std::string &text)
 

Static Public Member Functions

static int RGB2Int (char red, char green, char blue)
 Color conversion method.
 

Protected Attributes

std::stack< Pen > m_penStack
 
std::stack< Brush > m_brushStack
 
std::stack< FontInfo * > m_fontStack
 
bool m_isDeactivatedX
 flag for indicating if the graphic is deactivated
 
bool m_isDeactivatedY
 
bool m_pushBack
 push back mode
 
Zone * m_facsimile = NULL
 

Detailed Description

This class is an abstract device context.

It enables different types of concrete classes to be implemented. For example: MusWxDC - a wrapper to wxDCs with wxWidgets; SvgDeviceContext - a non-gui file DC; MusCairoDC - a wrapper to a Cairo surface; The class uses int-based color encoding (instead of wxColor in wxDC). It uses FontInfo (instead of wxFont in wxDC).

Member Function Documentation

◆ UseGlobalStyling()

virtual bool vrv::DeviceContext::UseGlobalStyling ( )
inlinevirtual

Method indicating if default global styling is used.

Typically this is the case with SVG and CSS. When global styling is used, some elements will not set corresponding styles. Global styling is false by default.

Reimplemented in vrv::SvgDeviceContext.

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