GUIDOLib  1.7.7
Guido Engine Internal Documentation
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
GRPage Class Reference

Graphical representation of a score page.
Contains one or more instances of class GRSystem. More...

Inheritance diagram for GRPage:
GREvent GRARCompositeNotationElement GRARNotationElement GRNotationElement GObject GRVisitable

Public Member Functions

 GRPage (GRMusic *grmusic, GRStaffManager *grstafmgr, const TYPE_TIMEPOSITION &inDate, GuidoLayoutSettings &aSettings, GRPage *prevpage=0)
 
virtual ~GRPage ()
 
bool addSystem (GRSystem *inSystem, float *ioUsedSystemDistance)
 
void systemFinished (GRSystem *inSystem)
 
void finishPage (bool islastpage=false)
 
void setSpringParameter (float npar)
 
void setPageFormat (const ARPageFormat *inFormat)
 
void adjustPageSize ()
 
void checkCollisions (TCollisions &state, bool lyrics) const
 
float getNotesDensity () const
 
const ARMusicgetARMusic () const
 
virtual void trace (VGDevice &hdc) const
 
virtual void OnDraw (VGDevice &hdc) const
 
virtual void OnDraw (VGDevice &hdc, const GuidoOnDrawDesc &inDrawInfos) const
 
virtual void GetMap (GuidoElementSelector sel, MapCollector &f, MapInfos &infos) const
 
virtual void print (std::ostream &os) const
 
virtual void accept (GRVisitor &visitor)
 
void getMarginsCm (float *ml, float *mt, float *mr, float *mb)
 
void getPageFormat (GuidoPageFormat *outFormat) const
 
float getMarginLeft () const
 
float getMarginTop () const
 
float getMarginRight () const
 
float getMarginBottom () const
 
float getPageWidth () const
 
float getPageHeight () const
 
float getInnerWidth () const
 
float getInnerHeight () const
 
float getPageWidthCm () const
 
float getPageHeightCm () const
 
float getInnerWidthCm () const
 
float getInnerHeightCm () const
 
void getScaling (float &vsizex, float &vsizey) const
 
const SystemPointerList * getSystems () const
 
- Public Member Functions inherited from GREvent
 GREvent (GRStaff *inStaff, const ARMusicalEvent *ar, bool p_ownsAR=false)
 
 GREvent (GRStaff *inStaff, const ARMusicalEvent *ar, const TYPE_TIMEPOSITION &date, const TYPE_DURATION &dur)
 
virtual ~GREvent ()
 
virtual void addToOffset (const NVPoint &offs)
 
virtual float getSize () const
 
virtual const NVPointgetOffset () const
 
virtual const NVstringgetStyle () const
 
virtual const unsigned char * getColRef () const
 
virtual void setSize (float nsize)
 
virtual void addArticulation (const ARMusicalTag *inTag)
 
bool hasArticulation (int inArticulationFlag) const
 
virtual int adjustLength (const TYPE_DURATION &ndur)
 
virtual NVPoint getCrescEnd ()
 
virtual NVPoint getCrescStart ()
 
virtual void setHPosition (float inX)
 
virtual void setPosition (const NVPoint &inPos)
 
virtual GRGlobalStemgetGlobalStem () const
 
virtual void setGlobalStem (GRGlobalStem *inGlobalStem)
 
virtual void setGlobalLocation (GRGlobalLocation *pglog)
 
virtual void setBeamStem (GRBeam *inBeam, float pos)
 
virtual float setStemLength (float inLen, bool userLength=false)
 
virtual GDirection getStemDirection () const
 
virtual void setStemDirection (GDirection dir)
 
virtual void setFlagOnOff (bool i)
 
virtual bool getStemDirSet () const
 
virtual bool getStemLengthSet () const
 
virtual float getStemLength () const
 
virtual NVPoint getStemStartPos () const
 
virtual NVPoint getStemEndPos () const
 
virtual float changeStemLength (float inLen, bool force=false)
 
virtual int getNumFaehnchen () const
 
virtual int getBeamCount () const
 
virtual void incBeamCount ()
 
virtual void decBeamCount ()
 
virtual void setFillsBar (bool value, GRNotationElement *, GRNotationElement *, bool)
 
virtual bool getFillsBar () const
 
bool isSyncopated () const
 
virtual void createDots (const TYPE_DURATION &duration, float notewidth, const NVPoint &inPos)
 
virtual void setDotFormat (const ARDotFormat *inFormat)
 
virtual void setDotFormat (GRNoteDot *inDot, const ARDotFormat *inFormat)
 
virtual bool isGREventClass () const
 
const GRNEList & getArticulations () const
 
GRNEList & getArticulations ()
 
virtual bool stemHasBeenChanged () const
 
virtual void setStemChanged ()
 
virtual const GREventisGREvent () const
 
virtual GREventisGREvent ()
 
GRNoteDotgetDot () const
 
- Public Member Functions inherited from GRARCompositeNotationElement
 GRARCompositeNotationElement (const ARMusicalObject *ar, bool ownsAR=false)
 
virtual ~GRARCompositeNotationElement ()
 
virtual void setGRStaff (GRStaff *inStaff)
 
GuidoPos First () const
 
GuidoPos Last () const
 
GRNotationElementGetNext (GuidoPos &ioPos) const
 
GRNotationElementGetTail () const
 
GuidoPos AddTail (GRNotationElement *el)
 
void RemoveElement (GRNotationElement *el)
 
void DrawSubElements (VGDevice &hdc) const
 
void GetSubElementsMap (GuidoElementSelector sel, MapCollector &f, MapInfos &infos) const
 
void RemoveAllSubElements ()
 
GuidoPos SetTailPosition (GuidoPos pos)
 
NEPointerListGetCompositeElements ()
 
const NEPointerListGetCompositeElements () const
 
- Public Member Functions inherited from GRARNotationElement
 GRARNotationElement (const ARMusicalObject *abstractRepresentationOfNotationElement, bool p_ownsAR=false)
 
virtual ~GRARNotationElement ()
 
virtual const ARMusicalObjectgetAbstractRepresentation ()
 
virtual const ARMusicalObjectgetAbstractRepresentation () const
 
virtual void setOwnership (bool ownsAR)
 
virtual bool isChordComma () const
 
- Public Member Functions inherited from GRNotationElement
 GRNotationElement ()
 
virtual ~GRNotationElement ()
 
GRStaffgetGRStaff () const
 
GRSystemSlicegetGRSystemSlice () const
 
virtual int getStaffNumber () const
 
virtual void tellPosition (GObject *caller, const NVPoint &point)
 
virtual float getLeftSpace () const
 
virtual float getRightSpace () const
 
virtual void setLeftSpace (float lspace)
 
virtual void setRightSpace (float rspace)
 
virtual void setNeedsSpring (int inFlag)
 
virtual int getNeedsSpring () const
 
virtual int getSpringID () const
 
virtual void tellSpringID (int inSpringID)
 
NEPointerListgetAssociations ()
 
const NEPointerListgetAssociations () const
 
virtual void removeAssociation (const NEPointerList &nl)
 
virtual void removeAssociation (GRNotationElement *el)
 
void FreeAssociatedList ()
 
virtual NVPoint getTieEnd () const
 
virtual NVPoint getTieStart () const
 
virtual NVRect getAssociatedBoundingBox () const
 
void addToBoundingBox (GRNotationElement *in)
 
void OnDrawSymbol (VGDevice &hdc, unsigned int inSymbol, float inOffsetX=0, float inOffsetY=0, float inFontSize=0) const
 
void OnDrawText (VGDevice &hdc, NVPoint pos, const char *cp, int inCharCount=-1) const
 
void OnDrawText (VGDevice &hdc, const char *cp, int inCharCount=-1) const
 
void DrawSymbol (VGDevice &hdc, unsigned int inSymbol, float x=0, float y=0, float size=0) const
 
void DrawNumericSymbols (VGDevice &hdc, const char *symbols, float x, float y, float size, float spacing=DEFAULTNUMERICSPACE) const
 
void Show (bool status)
 
bool GetShow () const
 
virtual void SendMap (const NVRect &r, MapCollector &f, TYPE_TIMEPOSITION date, TYPE_DURATION dur, GuidoElementType type, MapInfos &infos) const
 
virtual void SendMap (MapCollector &f, TYPE_TIMEPOSITION date, TYPE_DURATION dur, GuidoElementType type, MapInfos &infos) const
 
virtual unsigned int getTextAlign () const
 
virtual const TYPE_DURATIONgetDuration () const
 
virtual void setDuration (const TYPE_TIMEPOSITION &dur)
 
virtual void setRelativeTimePosition (const TYPE_TIMEPOSITION &tp)
 
virtual void setRelativeEndTimePosition (const TYPE_TIMEPOSITION &tp)
 
virtual const TYPE_TIMEPOSITIONgetRelativeTimePosition () const
 
virtual void setDrawOnOff (bool onoff)
 
virtual bool getDrawOnOff ()
 
virtual TYPE_TIMEPOSITION getRelativeEndTimePosition () const
 
virtual void recalcVerticalPosition ()
 
virtual void addAssociation (GRNotationElement *grnot)
 
const NEPointerListassociated () const
 
virtual void setIsInHeader (bool state)
 
virtual bool isInHeader () const
 
virtual bool isEmpty () const
 
virtual bool isLyrics () const
 
virtual bool checkCollisionWith () const
 
virtual const GRTextisText () const
 
virtual const GRSingleNoteisSingleNote () const
 
virtual GRSingleNoteisSingleNote ()
 
virtual const GRNoteisGRNote () const
 
virtual const GRRestisRest () const
 
virtual const GRGlueisGRGlue () const
 
virtual const GRTempoisGRTempo () const
 
virtual const GRTrillisGRTrill () const
 
virtual const GRBarisGRBar () const
 
virtual const GRDynamicsisGRDynamic () const
 
virtual GRFingeringisGRFingering ()
 
virtual GRSlurisGRSlur ()
 
virtual const GRHarmonyisGRHarmony () const
 
- Public Member Functions inherited from GObject
virtual ~GObject ()
 
virtual const char * getFont () const
 
virtual const char * getFontAttrib () const
 
virtual int getFontSize () const
 
virtual const NVPointgetReferencePosition () const
 Retrieves the Symbol-reference-position with respect to the GUIDO-reference-position. More...
 
const NVPointgetPosition () const
 
const NVRectgetBoundingBox () const
 
void addToBoundingBox (const NVRect &in)
 
NVRectgetReferenceBoundingBox ()
 
virtual void DrawBoundingBox (VGDevice &hdc, const VGColor &inBrushColor) const
 
- Public Member Functions inherited from GRVisitable
virtual ~GRVisitable ()
 

Public Attributes

TYPE_TIMEPOSITION mDebugPageDate
 

Protected Member Functions

void setScaling (VGDevice &hdc, float vsizex, float vsizey) const
 
bool DPtoLPRect (VGDevice &hdc, float left, float top, float right, float bottom, NVRect *outRect) const
 
virtual void updateBoundingBox ()
 
void setHorizontalSpacing ()
 
- Protected Member Functions inherited from GRNotationElement
void DrawExtents (VGDevice &hdc, const VGColor &inColor) const
 
- Protected Member Functions inherited from GObject
 GObject ()
 
 GObject (const GObject &in)
 

Protected Attributes

GRStaffManagerm_staffmgr
 
GRMusicmCurMusic
 
float mLeftMargin
 
float mTopMargin
 
float mRightMargin
 
float mBottomMargin
 
float mWidth
 
float mHeight
 
float m_totalsystemheight
 
SystemPointerList mSystems
 
GuidoLayoutSettings settings
 
- Protected Attributes inherited from GREvent
int mArticulationFlags
 
NVstring mStyle
 
NVPoint mOffset
 
float mSize
 
unsigned char * mColRef
 
int mBeamCount
 
float mCurLSPACE
 
GRGlobalStemmGlobalStem
 
bool mFillsBar
 
bool stemChanged
 
- Protected Attributes inherited from GRARNotationElement
const ARMusicalObjectmAbstractRepresentation
 
bool mOwnsAR
 
- Protected Attributes inherited from GRNotationElement
unsigned int mSymbol
 
GRStaffmGrStaff
 
int mNeedsSpring
 
int mSpringID
 
float mLeftSpace
 
float mRightSpace
 
bool mDraw
 
bool mShow
 
bool mIsInHeader
 
TYPE_DURATION mDurationOfGR
 
NEPointerListmAssociated
 
- Protected Attributes inherited from GObject
NVPoint mPosition
 
NVRect mBoundingBox
 
NVRect mMapping
 

Additional Inherited Members

- Static Public Member Functions inherited from GREvent
static GREventcast (GObject *inObj)
 
- Static Public Member Functions inherited from GRNotationElement
static int ComparePos (const GRNotationElement *g1, const GRNotationElement *g2)
 
- Static Public Member Functions inherited from GObject
static bool positionIsOnStaffLine (float inPositionY, float inLSpace)
 
static float GetSymbolExtent (unsigned int inSymbol)
 
- Static Protected Attributes inherited from GObject
static std::map< ConstMusicalSymbolID, float > sSymbolExtentMap
 
static NVPoint sRefposNone
 

Detailed Description

Graphical representation of a score page.
Contains one or more instances of class GRSystem.

Constructor & Destructor Documentation

◆ GRPage()

GRPage::GRPage ( GRMusic grmusic,
GRStaffManager grstafmgr,
const TYPE_TIMEPOSITION inDate,
GuidoLayoutSettings aSettings,
GRPage prevpage = 0 
)

◆ ~GRPage()

virtual GRPage::~GRPage ( )
virtual

Member Function Documentation

◆ accept()

virtual void GRPage::accept ( GRVisitor visitor)
virtual

Reimplemented from GRNotationElement.

◆ addSystem()

bool GRPage::addSystem ( GRSystem inSystem,
float *  ioUsedSystemDistance 
)

◆ adjustPageSize()

void GRPage::adjustPageSize ( )

◆ checkCollisions()

void GRPage::checkCollisions ( TCollisions state,
bool  lyrics 
) const

◆ DPtoLPRect()

bool GRPage::DPtoLPRect ( VGDevice hdc,
float  left,
float  top,
float  right,
float  bottom,
NVRect outRect 
) const
protected

◆ finishPage()

void GRPage::finishPage ( bool  islastpage = false)

◆ getARMusic()

const ARMusic* GRPage::getARMusic ( ) const

◆ getInnerHeight()

float GRPage::getInnerHeight ( ) const

◆ getInnerHeightCm()

float GRPage::getInnerHeightCm ( ) const

◆ getInnerWidth()

float GRPage::getInnerWidth ( ) const

◆ getInnerWidthCm()

float GRPage::getInnerWidthCm ( ) const

◆ GetMap()

virtual void GRPage::GetMap ( GuidoElementSelector  sel,
MapCollector f,
MapInfos infos 
) const
virtual

Reimplemented from GObject.

◆ getMarginBottom()

float GRPage::getMarginBottom ( ) const
inline

◆ getMarginLeft()

float GRPage::getMarginLeft ( ) const
inline

◆ getMarginRight()

float GRPage::getMarginRight ( ) const
inline

◆ getMarginsCm()

void GRPage::getMarginsCm ( float *  ml,
float *  mt,
float *  mr,
float *  mb 
)

◆ getMarginTop()

float GRPage::getMarginTop ( ) const
inline

◆ getNotesDensity()

float GRPage::getNotesDensity ( ) const

◆ getPageFormat()

void GRPage::getPageFormat ( GuidoPageFormat outFormat) const

◆ getPageHeight()

float GRPage::getPageHeight ( ) const
inline

◆ getPageHeightCm()

float GRPage::getPageHeightCm ( ) const

◆ getPageWidth()

float GRPage::getPageWidth ( ) const
inline

◆ getPageWidthCm()

float GRPage::getPageWidthCm ( ) const

◆ getScaling()

void GRPage::getScaling ( float &  vsizex,
float &  vsizey 
) const

◆ getSystems()

const SystemPointerList* GRPage::getSystems ( ) const
inline

◆ OnDraw() [1/2]

virtual void GRPage::OnDraw ( VGDevice hdc) const
virtual

Reimplemented from GRNotationElement.

◆ OnDraw() [2/2]

virtual void GRPage::OnDraw ( VGDevice hdc,
const GuidoOnDrawDesc inDrawInfos 
) const
virtual

◆ print()

virtual void GRPage::print ( std::ostream &  os) const
virtual

Reimplemented from GRNotationElement.

◆ setHorizontalSpacing()

void GRPage::setHorizontalSpacing ( )
protected

◆ setPageFormat()

void GRPage::setPageFormat ( const ARPageFormat inFormat)

◆ setScaling()

void GRPage::setScaling ( VGDevice hdc,
float  vsizex,
float  vsizey 
) const
protected

◆ setSpringParameter()

void GRPage::setSpringParameter ( float  npar)

◆ systemFinished()

void GRPage::systemFinished ( GRSystem inSystem)

◆ trace()

virtual void GRPage::trace ( VGDevice hdc) const
virtual

◆ updateBoundingBox()

virtual void GRPage::updateBoundingBox ( )
protectedvirtual

Reimplemented from GREvent.

Member Data Documentation

◆ m_staffmgr

GRStaffManager* GRPage::m_staffmgr
protected

◆ m_totalsystemheight

float GRPage::m_totalsystemheight
protected

◆ mBottomMargin

float GRPage::mBottomMargin
protected

◆ mCurMusic

GRMusic* GRPage::mCurMusic
protected

◆ mDebugPageDate

TYPE_TIMEPOSITION GRPage::mDebugPageDate

◆ mHeight

float GRPage::mHeight
protected

◆ mLeftMargin

float GRPage::mLeftMargin
protected

◆ mRightMargin

float GRPage::mRightMargin
protected

◆ mSystems

SystemPointerList GRPage::mSystems
protected

◆ mTopMargin

float GRPage::mTopMargin
protected

◆ mWidth

float GRPage::mWidth
protected

◆ settings

GuidoLayoutSettings GRPage::settings
protected

Guido Project Copyright © 2019 Grame-CNCM