Нет описания

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799
  1. /***************************************************************************
  2. ** **
  3. ** QCustomPlot, an easy to use, modern plotting widget for Qt **
  4. ** Copyright (C) 2011, 2012, 2013 Emanuel Eichhammer **
  5. ** **
  6. ** This program is free software: you can redistribute it and/or modify **
  7. ** it under the terms of the GNU General Public License as published by **
  8. ** the Free Software Foundation, either version 3 of the License, or **
  9. ** (at your option) any later version. **
  10. ** **
  11. ** This program is distributed in the hope that it will be useful, **
  12. ** but WITHOUT ANY WARRANTY; without even the implied warranty of **
  13. ** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the **
  14. ** GNU General Public License for more details. **
  15. ** **
  16. ** You should have received a copy of the GNU General Public License **
  17. ** along with this program. If not, see http://www.gnu.org/licenses/. **
  18. ** **
  19. ****************************************************************************
  20. ** Author: Emanuel Eichhammer **
  21. ** Website/Contact: http://www.qcustomplot.com/ **
  22. ** Date: 04.11.13 **
  23. ** Version: 1.1.0 **
  24. ****************************************************************************/
  25. #include "qcustomplot.h"
  26. ////////////////////////////////////////////////////////////////////////////////////////////////////
  27. //////////////////// QCPPainter
  28. ////////////////////////////////////////////////////////////////////////////////////////////////////
  29. /*! \class QCPPainter
  30. \brief QPainter subclass used internally
  31. This internal class is used to provide some extended functionality e.g. for tweaking position
  32. consistency between antialiased and non-antialiased painting. Further it provides workarounds
  33. for QPainter quirks.
  34. \warning This class intentionally hides non-virtual functions of QPainter, e.g. setPen, save and
  35. restore. So while it is possible to pass a QCPPainter instance to a function that expects a
  36. QPainter pointer, some of the workarounds and tweaks will be unavailable to the function (because
  37. it will call the base class implementations of the functions actually hidden by QCPPainter).
  38. */
  39. /*!
  40. Creates a new QCPPainter instance and sets default values
  41. */
  42. QCPPainter::QCPPainter() :
  43. QPainter(),
  44. mModes(pmDefault),
  45. mIsAntialiasing(false)
  46. {
  47. // don't setRenderHint(QPainter::NonCosmeticDefautPen) here, because painter isn't active yet and
  48. // a call to begin() will follow
  49. }
  50. /*!
  51. Creates a new QCPPainter instance on the specified paint \a device and sets default values. Just
  52. like the analogous QPainter constructor, begins painting on \a device immediately.
  53. Like \ref begin, this method sets QPainter::NonCosmeticDefaultPen in Qt versions before Qt5.
  54. */
  55. QCPPainter::QCPPainter(QPaintDevice *device) :
  56. QPainter(device),
  57. mModes(pmDefault),
  58. mIsAntialiasing(false)
  59. {
  60. #if QT_VERSION < QT_VERSION_CHECK(5, 0, 0) // before Qt5, default pens used to be cosmetic if NonCosmeticDefaultPen flag isn't set. So we set it to get consistency across Qt versions.
  61. if (isActive())
  62. setRenderHint(QPainter::NonCosmeticDefaultPen);
  63. #endif
  64. }
  65. QCPPainter::~QCPPainter()
  66. {
  67. }
  68. /*!
  69. Sets the pen of the painter and applies certain fixes to it, depending on the mode of this
  70. QCPPainter.
  71. \note this function hides the non-virtual base class implementation.
  72. */
  73. void QCPPainter::setPen(const QPen &pen)
  74. {
  75. QPainter::setPen(pen);
  76. if (mModes.testFlag(pmNonCosmetic))
  77. makeNonCosmetic();
  78. }
  79. /*! \overload
  80. Sets the pen (by color) of the painter and applies certain fixes to it, depending on the mode of
  81. this QCPPainter.
  82. \note this function hides the non-virtual base class implementation.
  83. */
  84. void QCPPainter::setPen(const QColor &color)
  85. {
  86. QPainter::setPen(color);
  87. if (mModes.testFlag(pmNonCosmetic))
  88. makeNonCosmetic();
  89. }
  90. /*! \overload
  91. Sets the pen (by style) of the painter and applies certain fixes to it, depending on the mode of
  92. this QCPPainter.
  93. \note this function hides the non-virtual base class implementation.
  94. */
  95. void QCPPainter::setPen(Qt::PenStyle penStyle)
  96. {
  97. QPainter::setPen(penStyle);
  98. if (mModes.testFlag(pmNonCosmetic))
  99. makeNonCosmetic();
  100. }
  101. /*! \overload
  102. Works around a Qt bug introduced with Qt 4.8 which makes drawing QLineF unpredictable when
  103. antialiasing is disabled. Thus when antialiasing is disabled, it rounds the \a line to
  104. integer coordinates and then passes it to the original drawLine.
  105. \note this function hides the non-virtual base class implementation.
  106. */
  107. void QCPPainter::drawLine(const QLineF &line)
  108. {
  109. if (mIsAntialiasing || mModes.testFlag(pmVectorized))
  110. QPainter::drawLine(line);
  111. else
  112. QPainter::drawLine(line.toLine());
  113. }
  114. /*!
  115. Sets whether painting uses antialiasing or not. Use this method instead of using setRenderHint
  116. with QPainter::Antialiasing directly, as it allows QCPPainter to regain pixel exactness between
  117. antialiased and non-antialiased painting (Since Qt < 5.0 uses slightly different coordinate systems for
  118. AA/Non-AA painting).
  119. */
  120. void QCPPainter::setAntialiasing(bool enabled)
  121. {
  122. setRenderHint(QPainter::Antialiasing, enabled);
  123. if (mIsAntialiasing != enabled)
  124. {
  125. mIsAntialiasing = enabled;
  126. if (!mModes.testFlag(pmVectorized)) // antialiasing half-pixel shift only needed for rasterized outputs
  127. {
  128. if (mIsAntialiasing)
  129. translate(0.5, 0.5);
  130. else
  131. translate(-0.5, -0.5);
  132. }
  133. }
  134. }
  135. /*!
  136. Sets the mode of the painter. This controls whether the painter shall adjust its
  137. fixes/workarounds optimized for certain output devices.
  138. */
  139. void QCPPainter::setModes(QCPPainter::PainterModes modes)
  140. {
  141. mModes = modes;
  142. }
  143. /*!
  144. Sets the QPainter::NonCosmeticDefaultPen in Qt versions before Qt5 after beginning painting on \a
  145. device. This is necessary to get cosmetic pen consistency across Qt versions, because since Qt5,
  146. all pens are non-cosmetic by default, and in Qt4 this render hint must be set to get that
  147. behaviour.
  148. The Constructor \ref QCPPainter(QPaintDevice *device) which directly starts painting also sets
  149. the render hint as appropriate.
  150. \note this function hides the non-virtual base class implementation.
  151. */
  152. bool QCPPainter::begin(QPaintDevice *device)
  153. {
  154. bool result = QPainter::begin(device);
  155. #if QT_VERSION < QT_VERSION_CHECK(5, 0, 0) // before Qt5, default pens used to be cosmetic if NonCosmeticDefaultPen flag isn't set. So we set it to get consistency across Qt versions.
  156. if (result)
  157. setRenderHint(QPainter::NonCosmeticDefaultPen);
  158. #endif
  159. return result;
  160. }
  161. /*! \overload
  162. Sets the mode of the painter. This controls whether the painter shall adjust its
  163. fixes/workarounds optimized for certain output devices.
  164. */
  165. void QCPPainter::setMode(QCPPainter::PainterMode mode, bool enabled)
  166. {
  167. if (!enabled && mModes.testFlag(mode))
  168. mModes &= ~mode;
  169. else if (enabled && !mModes.testFlag(mode))
  170. mModes |= mode;
  171. }
  172. /*!
  173. Saves the painter (see QPainter::save). Since QCPPainter adds some new internal state to
  174. QPainter, the save/restore functions are reimplemented to also save/restore those members.
  175. \note this function hides the non-virtual base class implementation.
  176. \see restore
  177. */
  178. void QCPPainter::save()
  179. {
  180. mAntialiasingStack.push(mIsAntialiasing);
  181. QPainter::save();
  182. }
  183. /*!
  184. Restores the painter (see QPainter::restore). Since QCPPainter adds some new internal state to
  185. QPainter, the save/restore functions are reimplemented to also save/restore those members.
  186. \note this function hides the non-virtual base class implementation.
  187. \see save
  188. */
  189. void QCPPainter::restore()
  190. {
  191. if (!mAntialiasingStack.isEmpty())
  192. mIsAntialiasing = mAntialiasingStack.pop();
  193. else
  194. qDebug() << Q_FUNC_INFO << "Unbalanced save/restore";
  195. QPainter::restore();
  196. }
  197. /*!
  198. Changes the pen width to 1 if it currently is 0. This function is called in the \ref setPen
  199. overrides when the \ref pmNonCosmetic mode is set.
  200. */
  201. void QCPPainter::makeNonCosmetic()
  202. {
  203. if (qFuzzyIsNull(pen().widthF()))
  204. {
  205. QPen p = pen();
  206. p.setWidth(1);
  207. QPainter::setPen(p);
  208. }
  209. }
  210. ////////////////////////////////////////////////////////////////////////////////////////////////////
  211. //////////////////// QCPScatterStyle
  212. ////////////////////////////////////////////////////////////////////////////////////////////////////
  213. /*! \class QCPScatterStyle
  214. \brief Represents the visual appearance of scatter points
  215. This class holds information about shape, color and size of scatter points. In plottables like
  216. QCPGraph it is used to store how scatter points shall be drawn. For example, \ref
  217. QCPGraph::setScatterStyle takes a QCPScatterStyle instance.
  218. A scatter style consists of a shape (\ref setShape), a line color (\ref setPen) and possibly a
  219. fill (\ref setBrush), if the shape provides a fillable area. Further, the size of the shape can
  220. be controlled with \ref setSize.
  221. \section QCPScatterStyle-defining Specifying a scatter style
  222. You can set all these configurations either by calling the respective functions on an instance:
  223. \code
  224. QCPScatterStyle myScatter;
  225. myScatter.setShape(QCPScatterStyle::ssCircle);
  226. myScatter.setPen(Qt::blue);
  227. myScatter.setBrush(Qt::white);
  228. myScatter.setSize(5);
  229. customPlot->graph(0)->setScatterStyle(myScatter);
  230. \endcode
  231. Or you can use one of the various constructors that take different parameter combinations, making
  232. it easy to specify a scatter style in a single call, like so:
  233. \code
  234. customPlot->graph(0)->setScatterStyle(QCPScatterStyle(QCPScatterStyle::ssCircle, Qt::blue, Qt::white, 5));
  235. \endcode
  236. \section QCPScatterStyle-undefinedpen Leaving the color/pen up to the plottable
  237. There are two constructors which leave the pen undefined: \ref QCPScatterStyle() and \ref
  238. QCPScatterStyle(ScatterShape shape, double size). If those constructors are used, a call to \ref
  239. isPenDefined will return false. It leads to scatter points that inherit the pen from the
  240. plottable that uses the scatter style. Thus, if such a scatter style is passed to QCPGraph, the line
  241. color of the graph (\ref QCPGraph::setPen) will be used by the scatter points. This makes
  242. it very convenient to set up typical scatter settings:
  243. \code
  244. customPlot->graph(0)->setScatterStyle(QCPScatterStyle::ssPlus);
  245. \endcode
  246. Notice that it wasn't even necessary to explicitly call a QCPScatterStyle constructor. This works
  247. because QCPScatterStyle provides a constructor that can transform a \ref ScatterShape directly
  248. into a QCPScatterStyle instance (that's the \ref QCPScatterStyle(ScatterShape shape, double size)
  249. constructor with a default for \a size). In those cases, C++ allows directly supplying a \ref
  250. ScatterShape, where actually a QCPScatterStyle is expected.
  251. \section QCPScatterStyle-custompath-and-pixmap Custom shapes and pixmaps
  252. QCPScatterStyle supports drawing custom shapes and arbitrary pixmaps as scatter points.
  253. For custom shapes, you can provide a QPainterPath with the desired shape to the \ref
  254. setCustomPath function or call the constructor that takes a painter path. The scatter shape will
  255. automatically be set to \ref ssCustom.
  256. For pixmaps, you call \ref setPixmap with the desired QPixmap. Alternatively you can use the
  257. constructor that takes a QPixmap. The scatter shape will automatically be set to \ref ssPixmap.
  258. Note that \ref setSize does not influence the appearance of the pixmap.
  259. */
  260. /* start documentation of inline functions */
  261. /*! \fn bool QCPScatterStyle::isNone() const
  262. Returns whether the scatter shape is \ref ssNone.
  263. \see setShape
  264. */
  265. /*! \fn bool QCPScatterStyle::isPenDefined() const
  266. Returns whether a pen has been defined for this scatter style.
  267. The pen is undefined if a constructor is called that does not carry \a pen as parameter. Those are
  268. \ref QCPScatterStyle() and \ref QCPScatterStyle(ScatterShape shape, double size). If the pen is
  269. left undefined, the scatter color will be inherited from the plottable that uses this scatter
  270. style.
  271. \see setPen
  272. */
  273. /* end documentation of inline functions */
  274. /*!
  275. Creates a new QCPScatterStyle instance with size set to 6. No shape, pen or brush is defined.
  276. Since the pen is undefined (\ref isPenDefined returns false), the scatter color will be inherited
  277. from the plottable that uses this scatter style.
  278. */
  279. QCPScatterStyle::QCPScatterStyle() :
  280. mSize(6),
  281. mShape(ssNone),
  282. mPen(Qt::NoPen),
  283. mBrush(Qt::NoBrush),
  284. mPenDefined(false)
  285. {
  286. }
  287. /*!
  288. Creates a new QCPScatterStyle instance with shape set to \a shape and size to \a size. No pen or
  289. brush is defined.
  290. Since the pen is undefined (\ref isPenDefined returns false), the scatter color will be inherited
  291. from the plottable that uses this scatter style.
  292. */
  293. QCPScatterStyle::QCPScatterStyle(ScatterShape shape, double size) :
  294. mSize(size),
  295. mShape(shape),
  296. mPen(Qt::NoPen),
  297. mBrush(Qt::NoBrush),
  298. mPenDefined(false)
  299. {
  300. }
  301. /*!
  302. Creates a new QCPScatterStyle instance with shape set to \a shape, the pen color set to \a color,
  303. and size to \a size. No brush is defined, i.e. the scatter point will not be filled.
  304. */
  305. QCPScatterStyle::QCPScatterStyle(ScatterShape shape, const QColor &color, double size) :
  306. mSize(size),
  307. mShape(shape),
  308. mPen(QPen(color)),
  309. mBrush(Qt::NoBrush),
  310. mPenDefined(true)
  311. {
  312. }
  313. /*!
  314. Creates a new QCPScatterStyle instance with shape set to \a shape, the pen color set to \a color,
  315. the brush color to \a fill (with a solid pattern), and size to \a size.
  316. */
  317. QCPScatterStyle::QCPScatterStyle(ScatterShape shape, const QColor &color, const QColor &fill, double size) :
  318. mSize(size),
  319. mShape(shape),
  320. mPen(QPen(color)),
  321. mBrush(QBrush(fill)),
  322. mPenDefined(true)
  323. {
  324. }
  325. /*!
  326. Creates a new QCPScatterStyle instance with shape set to \a shape, the pen set to \a pen, the
  327. brush to \a brush, and size to \a size.
  328. \warning In some cases it might be tempting to directly use a pen style like <tt>Qt::NoPen</tt> as \a pen
  329. and a color like <tt>Qt::blue</tt> as \a brush. Notice however, that the corresponding call\n
  330. <tt>QCPScatterStyle(QCPScatterShape::ssCircle, Qt::NoPen, Qt::blue, 5)</tt>\n
  331. doesn't necessarily lead C++ to use this constructor in some cases, but might mistake
  332. <tt>Qt::NoPen</tt> for a QColor and use the
  333. \ref QCPScatterStyle(ScatterShape shape, const QColor &color, const QColor &fill, double size)
  334. constructor instead (which will lead to an unexpected look of the scatter points). To prevent
  335. this, be more explicit with the parameter types. For example, use <tt>QBrush(Qt::blue)</tt>
  336. instead of just <tt>Qt::blue</tt>, to clearly point out to the compiler that this constructor is
  337. wanted.
  338. */
  339. QCPScatterStyle::QCPScatterStyle(ScatterShape shape, const QPen &pen, const QBrush &brush, double size) :
  340. mSize(size),
  341. mShape(shape),
  342. mPen(pen),
  343. mBrush(brush),
  344. mPenDefined(pen.style() != Qt::NoPen)
  345. {
  346. }
  347. /*!
  348. Creates a new QCPScatterStyle instance which will show the specified \a pixmap. The scatter shape
  349. is set to \ref ssPixmap.
  350. */
  351. QCPScatterStyle::QCPScatterStyle(const QPixmap &pixmap) :
  352. mSize(5),
  353. mShape(ssPixmap),
  354. mPen(Qt::NoPen),
  355. mBrush(Qt::NoBrush),
  356. mPixmap(pixmap),
  357. mPenDefined(false)
  358. {
  359. }
  360. /*!
  361. Creates a new QCPScatterStyle instance with a custom shape that is defined via \a customPath. The
  362. scatter shape is set to \ref ssCustom.
  363. The custom shape line will be drawn with \a pen and filled with \a brush. The size has a slightly
  364. different meaning than for built-in scatter points: The custom path will be drawn scaled by a
  365. factor of \a size/6.0. Since the default \a size is 6, the custom path will appear at a its
  366. natural size by default. To double the size of the path for example, set \a size to 12.
  367. */
  368. QCPScatterStyle::QCPScatterStyle(const QPainterPath &customPath, const QPen &pen, const QBrush &brush, double size) :
  369. mSize(size),
  370. mShape(ssCustom),
  371. mPen(pen),
  372. mBrush(brush),
  373. mCustomPath(customPath),
  374. mPenDefined(false)
  375. {
  376. }
  377. /*!
  378. Sets the size (pixel diameter) of the drawn scatter points to \a size.
  379. \see setShape
  380. */
  381. void QCPScatterStyle::setSize(double size)
  382. {
  383. mSize = size;
  384. }
  385. /*!
  386. Sets the shape to \a shape.
  387. Note that the calls \ref setPixmap and \ref setCustomPath automatically set the shape to \ref
  388. ssPixmap and \ref ssCustom, respectively.
  389. \see setSize
  390. */
  391. void QCPScatterStyle::setShape(QCPScatterStyle::ScatterShape shape)
  392. {
  393. mShape = shape;
  394. }
  395. /*!
  396. Sets the pen that will be used to draw scatter points to \a pen.
  397. If the pen was previously undefined (see \ref isPenDefined), the pen is considered defined after
  398. a call to this function, even if \a pen is <tt>Qt::NoPen</tt>.
  399. \see setBrush
  400. */
  401. void QCPScatterStyle::setPen(const QPen &pen)
  402. {
  403. mPenDefined = true;
  404. mPen = pen;
  405. }
  406. /*!
  407. Sets the brush that will be used to fill scatter points to \a brush. Note that not all scatter
  408. shapes have fillable areas. For example, \ref ssPlus does not while \ref ssCircle does.
  409. \see setPen
  410. */
  411. void QCPScatterStyle::setBrush(const QBrush &brush)
  412. {
  413. mBrush = brush;
  414. }
  415. /*!
  416. Sets the pixmap that will be drawn as scatter point to \a pixmap.
  417. Note that \ref setSize does not influence the appearance of the pixmap.
  418. The scatter shape is automatically set to \ref ssPixmap.
  419. */
  420. void QCPScatterStyle::setPixmap(const QPixmap &pixmap)
  421. {
  422. setShape(ssPixmap);
  423. mPixmap = pixmap;
  424. }
  425. /*!
  426. Sets the custom shape that will be drawn as scatter point to \a customPath.
  427. The scatter shape is automatically set to \ref ssCustom.
  428. */
  429. void QCPScatterStyle::setCustomPath(const QPainterPath &customPath)
  430. {
  431. setShape(ssCustom);
  432. mCustomPath = customPath;
  433. }
  434. /*!
  435. Applies the pen and the brush of this scatter style to \a painter. If this scatter style has an
  436. undefined pen (\ref isPenDefined), sets the pen of \a painter to \a defaultPen instead.
  437. This function is used by plottables (or any class that wants to draw scatters) just before a
  438. number of scatters with this style shall be drawn with the \a painter.
  439. \see drawShape
  440. */
  441. void QCPScatterStyle::applyTo(QCPPainter *painter, const QPen &defaultPen) const
  442. {
  443. painter->setPen(mPenDefined ? mPen : defaultPen);
  444. painter->setBrush(mBrush);
  445. }
  446. /*!
  447. Draws the scatter shape with \a painter at position \a pos.
  448. This function does not modify the pen or the brush on the painter, as \ref applyTo is meant to be
  449. called before scatter points are drawn with \ref drawShape.
  450. \see applyTo
  451. */
  452. void QCPScatterStyle::drawShape(QCPPainter *painter, QPointF pos) const
  453. {
  454. drawShape(painter, pos.x(), pos.y());
  455. }
  456. /*! \overload
  457. Draws the scatter shape with \a painter at position \a x and \a y.
  458. */
  459. void QCPScatterStyle::drawShape(QCPPainter *painter, double x, double y) const
  460. {
  461. double w = mSize/2.0;
  462. switch (mShape)
  463. {
  464. case ssNone: break;
  465. case ssDot:
  466. {
  467. painter->drawLine(QPointF(x, y), QPointF(x+0.0001, y));
  468. break;
  469. }
  470. case ssCross:
  471. {
  472. painter->drawLine(QLineF(x-w, y-w, x+w, y+w));
  473. painter->drawLine(QLineF(x-w, y+w, x+w, y-w));
  474. break;
  475. }
  476. case ssPlus:
  477. {
  478. painter->drawLine(QLineF(x-w, y, x+w, y));
  479. painter->drawLine(QLineF( x, y+w, x, y-w));
  480. break;
  481. }
  482. case ssCircle:
  483. {
  484. painter->drawEllipse(QPointF(x , y), w, w);
  485. break;
  486. }
  487. case ssDisc:
  488. {
  489. QBrush b = painter->brush();
  490. painter->setBrush(painter->pen().color());
  491. painter->drawEllipse(QPointF(x , y), w, w);
  492. painter->setBrush(b);
  493. break;
  494. }
  495. case ssSquare:
  496. {
  497. painter->drawRect(QRectF(x-w, y-w, mSize, mSize));
  498. break;
  499. }
  500. case ssDiamond:
  501. {
  502. painter->drawLine(QLineF(x-w, y, x, y-w));
  503. painter->drawLine(QLineF( x, y-w, x+w, y));
  504. painter->drawLine(QLineF(x+w, y, x, y+w));
  505. painter->drawLine(QLineF( x, y+w, x-w, y));
  506. break;
  507. }
  508. case ssStar:
  509. {
  510. painter->drawLine(QLineF(x-w, y, x+w, y));
  511. painter->drawLine(QLineF( x, y+w, x, y-w));
  512. painter->drawLine(QLineF(x-w*0.707, y-w*0.707, x+w*0.707, y+w*0.707));
  513. painter->drawLine(QLineF(x-w*0.707, y+w*0.707, x+w*0.707, y-w*0.707));
  514. break;
  515. }
  516. case ssTriangle:
  517. {
  518. painter->drawLine(QLineF(x-w, y+0.755*w, x+w, y+0.755*w));
  519. painter->drawLine(QLineF(x+w, y+0.755*w, x, y-0.977*w));
  520. painter->drawLine(QLineF( x, y-0.977*w, x-w, y+0.755*w));
  521. break;
  522. }
  523. case ssTriangleInverted:
  524. {
  525. painter->drawLine(QLineF(x-w, y-0.755*w, x+w, y-0.755*w));
  526. painter->drawLine(QLineF(x+w, y-0.755*w, x, y+0.977*w));
  527. painter->drawLine(QLineF( x, y+0.977*w, x-w, y-0.755*w));
  528. break;
  529. }
  530. case ssCrossSquare:
  531. {
  532. painter->drawLine(QLineF(x-w, y-w, x+w*0.95, y+w*0.95));
  533. painter->drawLine(QLineF(x-w, y+w*0.95, x+w*0.95, y-w));
  534. painter->drawRect(QRectF(x-w, y-w, mSize, mSize));
  535. break;
  536. }
  537. case ssPlusSquare:
  538. {
  539. painter->drawLine(QLineF(x-w, y, x+w*0.95, y));
  540. painter->drawLine(QLineF( x, y+w, x, y-w));
  541. painter->drawRect(QRectF(x-w, y-w, mSize, mSize));
  542. break;
  543. }
  544. case ssCrossCircle:
  545. {
  546. painter->drawLine(QLineF(x-w*0.707, y-w*0.707, x+w*0.670, y+w*0.670));
  547. painter->drawLine(QLineF(x-w*0.707, y+w*0.670, x+w*0.670, y-w*0.707));
  548. painter->drawEllipse(QPointF(x, y), w, w);
  549. break;
  550. }
  551. case ssPlusCircle:
  552. {
  553. painter->drawLine(QLineF(x-w, y, x+w, y));
  554. painter->drawLine(QLineF( x, y+w, x, y-w));
  555. painter->drawEllipse(QPointF(x, y), w, w);
  556. break;
  557. }
  558. case ssPeace:
  559. {
  560. painter->drawLine(QLineF(x, y-w, x, y+w));
  561. painter->drawLine(QLineF(x, y, x-w*0.707, y+w*0.707));
  562. painter->drawLine(QLineF(x, y, x+w*0.707, y+w*0.707));
  563. painter->drawEllipse(QPointF(x, y), w, w);
  564. break;
  565. }
  566. case ssPixmap:
  567. {
  568. painter->drawPixmap(x-mPixmap.width()*0.5, y-mPixmap.height()*0.5, mPixmap);
  569. break;
  570. }
  571. case ssCustom:
  572. {
  573. QTransform oldTransform = painter->transform();
  574. painter->translate(x, y);
  575. painter->scale(mSize/6.0, mSize/6.0);
  576. painter->drawPath(mCustomPath);
  577. painter->setTransform(oldTransform);
  578. break;
  579. }
  580. }
  581. }
  582. ////////////////////////////////////////////////////////////////////////////////////////////////////
  583. //////////////////// QCPLayer
  584. ////////////////////////////////////////////////////////////////////////////////////////////////////
  585. /*! \class QCPLayer
  586. \brief A layer that may contain objects, to control the rendering order
  587. The Layering system of QCustomPlot is the mechanism to control the rendering order of the
  588. elements inside the plot.
  589. It is based on the two classes QCPLayer and QCPLayerable. QCustomPlot holds an ordered list of
  590. one or more instances of QCPLayer (see QCustomPlot::addLayer, QCustomPlot::layer,
  591. QCustomPlot::moveLayer, etc.). When replotting, QCustomPlot goes through the list of layers
  592. bottom to top and successively draws the layerables of the layers.
  593. A QCPLayer contains an ordered list of QCPLayerable instances. QCPLayerable is an abstract base
  594. class from which almost all visible objects derive, like axes, grids, graphs, items, etc.
  595. Initially, QCustomPlot has five layers: "background", "grid", "main", "axes" and "legend" (in
  596. that order). The top two layers "axes" and "legend" contain the default axes and legend, so they
  597. will be drawn on top. In the middle, there is the "main" layer. It is initially empty and set as
  598. the current layer (see QCustomPlot::setCurrentLayer). This means, all new plottables, items etc.
  599. are created on this layer by default. Then comes the "grid" layer which contains the QCPGrid
  600. instances (which belong tightly to QCPAxis, see \ref QCPAxis::grid). The Axis rect background
  601. shall be drawn behind everything else, thus the default QCPAxisRect instance is placed on the
  602. "background" layer. Of course, the layer affiliation of the individual objects can be changed as
  603. required (\ref QCPLayerable::setLayer).
  604. Controlling the ordering of objects is easy: Create a new layer in the position you want it to
  605. be, e.g. above "main", with QCustomPlot::addLayer. Then set the current layer with
  606. QCustomPlot::setCurrentLayer to that new layer and finally create the objects normally. They will
  607. be placed on the new layer automatically, due to the current layer setting. Alternatively you
  608. could have also ignored the current layer setting and just moved the objects with
  609. QCPLayerable::setLayer to the desired layer after creating them.
  610. It is also possible to move whole layers. For example, If you want the grid to be shown in front
  611. of all plottables/items on the "main" layer, just move it above "main" with
  612. QCustomPlot::moveLayer.
  613. The rendering order within one layer is simply by order of creation or insertion. The item
  614. created last (or added last to the layer), is drawn on top of all other objects on that layer.
  615. When a layer is deleted, the objects on it are not deleted with it, but fall on the layer below
  616. the deleted layer, see QCustomPlot::removeLayer.
  617. */
  618. /* start documentation of inline functions */
  619. /*! \fn QList<QCPLayerable*> QCPLayer::children() const
  620. Returns a list of all layerables on this layer. The order corresponds to the rendering order:
  621. layerables with higher indices are drawn above layerables with lower indices.
  622. */
  623. /*! \fn int QCPLayer::index() const
  624. Returns the index this layer has in the QCustomPlot. The index is the integer number by which this layer can be
  625. accessed via \ref QCustomPlot::layer.
  626. Layers with higher indices will be drawn above layers with lower indices.
  627. */
  628. /* end documentation of inline functions */
  629. /*!
  630. Creates a new QCPLayer instance.
  631. Normally you shouldn't directly instantiate layers, use \ref QCustomPlot::addLayer instead.
  632. \warning It is not checked that \a layerName is actually a unique layer name in \a parentPlot.
  633. This check is only performed by \ref QCustomPlot::addLayer.
  634. */
  635. QCPLayer::QCPLayer(QCustomPlot *parentPlot, const QString &layerName) :
  636. QObject(parentPlot),
  637. mParentPlot(parentPlot),
  638. mName(layerName),
  639. mIndex(-1) // will be set to a proper value by the QCustomPlot layer creation function
  640. {
  641. // Note: no need to make sure layerName is unique, because layer
  642. // management is done with QCustomPlot functions.
  643. }
  644. QCPLayer::~QCPLayer()
  645. {
  646. // If child layerables are still on this layer, detach them, so they don't try to reach back to this
  647. // then invalid layer once they get deleted/moved themselves. This only happens when layers are deleted
  648. // directly, like in the QCustomPlot destructor. (The regular layer removal procedure for the user is to
  649. // call QCustomPlot::removeLayer, which moves all layerables off this layer before deleting it.)
  650. while (!mChildren.isEmpty())
  651. mChildren.last()->setLayer(0); // removes itself from mChildren via removeChild()
  652. if (mParentPlot->currentLayer() == this)
  653. qDebug() << Q_FUNC_INFO << "The parent plot's mCurrentLayer will be a dangling pointer. Should have been set to a valid layer or 0 beforehand.";
  654. }
  655. /*! \internal
  656. Adds the \a layerable to the list of this layer. If \a prepend is set to true, the layerable will
  657. be prepended to the list, i.e. be drawn beneath the other layerables already in the list.
  658. This function does not change the \a mLayer member of \a layerable to this layer. (Use
  659. QCPLayerable::setLayer to change the layer of an object, not this function.)
  660. \see removeChild
  661. */
  662. void QCPLayer::addChild(QCPLayerable *layerable, bool prepend)
  663. {
  664. if (!mChildren.contains(layerable))
  665. {
  666. if (prepend)
  667. mChildren.prepend(layerable);
  668. else
  669. mChildren.append(layerable);
  670. } else
  671. qDebug() << Q_FUNC_INFO << "layerable is already child of this layer" << reinterpret_cast<quintptr>(layerable);
  672. }
  673. /*! \internal
  674. Removes the \a layerable from the list of this layer.
  675. This function does not change the \a mLayer member of \a layerable. (Use QCPLayerable::setLayer
  676. to change the layer of an object, not this function.)
  677. \see addChild
  678. */
  679. void QCPLayer::removeChild(QCPLayerable *layerable)
  680. {
  681. if (!mChildren.removeOne(layerable))
  682. qDebug() << Q_FUNC_INFO << "layerable is not child of this layer" << reinterpret_cast<quintptr>(layerable);
  683. }
  684. ////////////////////////////////////////////////////////////////////////////////////////////////////
  685. //////////////////// QCPLayerable
  686. ////////////////////////////////////////////////////////////////////////////////////////////////////
  687. /*! \class QCPLayerable
  688. \brief Base class for all drawable objects
  689. This is the abstract base class most visible objects derive from, e.g. plottables, axes, grid
  690. etc.
  691. Every layerable is on a layer (QCPLayer) which allows controlling the rendering order by stacking
  692. the layers accordingly.
  693. For details about the layering mechanism, see the QCPLayer documentation.
  694. */
  695. /* start documentation of inline functions */
  696. /*! \fn QCPLayerable *QCPLayerable::parentLayerable() const
  697. Returns the parent layerable of this layerable. The parent layerable is used to provide
  698. visibility hierarchies in conjunction with the method \ref realVisibility. This way, layerables
  699. only get drawn if their parent layerables are visible, too.
  700. Note that a parent layerable is not necessarily also the QObject parent for memory management.
  701. Further, a layerable doesn't always have a parent layerable, so this function may return 0.
  702. A parent layerable is set implicitly with when placed inside layout elements and doesn't need to be
  703. set manually by the user.
  704. */
  705. /* end documentation of inline functions */
  706. /* start documentation of pure virtual functions */
  707. /*! \fn virtual void QCPLayerable::applyDefaultAntialiasingHint(QCPPainter *painter) const = 0
  708. \internal
  709. This function applies the default antialiasing setting to the specified \a painter, using the
  710. function \ref applyAntialiasingHint. It is the antialiasing state the painter is put in, when
  711. \ref draw is called on the layerable. If the layerable has multiple entities whose antialiasing
  712. setting may be specified individually, this function should set the antialiasing state of the
  713. most prominent entity. In this case however, the \ref draw function usually calls the specialized
  714. versions of this function before drawing each entity, effectively overriding the setting of the
  715. default antialiasing hint.
  716. <b>First example:</b> QCPGraph has multiple entities that have an antialiasing setting: The graph
  717. line, fills, scatters and error bars. Those can be configured via QCPGraph::setAntialiased,
  718. QCPGraph::setAntialiasedFill, QCPGraph::setAntialiasedScatters etc. Consequently, there isn't
  719. only the QCPGraph::applyDefaultAntialiasingHint function (which corresponds to the graph line's
  720. antialiasing), but specialized ones like QCPGraph::applyFillAntialiasingHint and
  721. QCPGraph::applyScattersAntialiasingHint. So before drawing one of those entities, QCPGraph::draw
  722. calls the respective specialized applyAntialiasingHint function.
  723. <b>Second example:</b> QCPItemLine consists only of a line so there is only one antialiasing
  724. setting which can be controlled with QCPItemLine::setAntialiased. (This function is inherited by
  725. all layerables. The specialized functions, as seen on QCPGraph, must be added explicitly to the
  726. respective layerable subclass.) Consequently it only has the normal
  727. QCPItemLine::applyDefaultAntialiasingHint. The \ref QCPItemLine::draw function doesn't need to
  728. care about setting any antialiasing states, because the default antialiasing hint is already set
  729. on the painter when the \ref draw function is called, and that's the state it wants to draw the
  730. line with.
  731. */
  732. /*! \fn virtual void QCPLayerable::draw(QCPPainter *painter) const = 0
  733. \internal
  734. This function draws the layerable with the specified \a painter. It is only called by
  735. QCustomPlot, if the layerable is visible (\ref setVisible).
  736. Before this function is called, the painter's antialiasing state is set via \ref
  737. applyDefaultAntialiasingHint, see the documentation there. Further, the clipping rectangle was
  738. set to \ref clipRect.
  739. */
  740. /* end documentation of pure virtual functions */
  741. /*!
  742. Creates a new QCPLayerable instance.
  743. Since QCPLayerable is an abstract base class, it can't be instantiated directly. Use one of the
  744. derived classes.
  745. If \a plot is provided, it automatically places itself on the layer named \a targetLayer. If \a
  746. targetLayer is an empty string, it places itself on the current layer of the plot (see \ref
  747. QCustomPlot::setCurrentLayer).
  748. It is possible to provide 0 as \a plot. In that case, you should assign a parent plot at a later
  749. time with \ref initializeParentPlot.
  750. The layerable's parent layerable is set to \a parentLayerable, if provided. Direct layerable parents
  751. are mainly used to control visibility in a hierarchy of layerables. This means a layerable is
  752. only drawn, if all its ancestor layerables are also visible. Note that \a parentLayerable does
  753. not become the QObject-parent (for memory management) of this layerable, \a plot does.
  754. */
  755. QCPLayerable::QCPLayerable(QCustomPlot *plot, QString targetLayer, QCPLayerable *parentLayerable) :
  756. QObject(plot),
  757. mVisible(true),
  758. mParentPlot(plot),
  759. mParentLayerable(parentLayerable),
  760. mLayer(0),
  761. mAntialiased(true)
  762. {
  763. if (mParentPlot)
  764. {
  765. if (targetLayer.isEmpty())
  766. setLayer(mParentPlot->currentLayer());
  767. else if (!setLayer(targetLayer))
  768. qDebug() << Q_FUNC_INFO << "setting QCPlayerable initial layer to" << targetLayer << "failed.";
  769. }
  770. }
  771. QCPLayerable::~QCPLayerable()
  772. {
  773. if (mLayer)
  774. {
  775. mLayer->removeChild(this);
  776. mLayer = 0;
  777. }
  778. }
  779. /*!
  780. Sets the visibility of this layerable object. If an object is not visible, it will not be drawn
  781. on the QCustomPlot surface, and user interaction with it (e.g. click and selection) is not
  782. possible.
  783. */
  784. void QCPLayerable::setVisible(bool on)
  785. {
  786. mVisible = on;
  787. }
  788. /*!
  789. Sets the \a layer of this layerable object. The object will be placed on top of the other objects
  790. already on \a layer.
  791. Returns true on success, i.e. if \a layer is a valid layer.
  792. */
  793. bool QCPLayerable::setLayer(QCPLayer *layer)
  794. {
  795. return moveToLayer(layer, false);
  796. }
  797. /*! \overload
  798. Sets the layer of this layerable object by name
  799. Returns true on success, i.e. if \a layerName is a valid layer name.
  800. */
  801. bool QCPLayerable::setLayer(const QString &layerName)
  802. {
  803. if (!mParentPlot)
  804. {
  805. qDebug() << Q_FUNC_INFO << "no parent QCustomPlot set";
  806. return false;
  807. }
  808. if (QCPLayer *layer = mParentPlot->layer(layerName))
  809. {
  810. return setLayer(layer);
  811. } else
  812. {
  813. qDebug() << Q_FUNC_INFO << "there is no layer with name" << layerName;
  814. return false;
  815. }
  816. }
  817. /*!
  818. Sets whether this object will be drawn antialiased or not.
  819. Note that antialiasing settings may be overridden by QCustomPlot::setAntialiasedElements and
  820. QCustomPlot::setNotAntialiasedElements.
  821. */
  822. void QCPLayerable::setAntialiased(bool enabled)
  823. {
  824. mAntialiased = enabled;
  825. }
  826. /*!
  827. Returns whether this layerable is visible, taking possible direct layerable parent visibility
  828. into account. This is the method that is consulted to decide whether a layerable shall be drawn
  829. or not.
  830. If this layerable has a direct layerable parent (usually set via hierarchies implemented in
  831. subclasses, like in the case of QCPLayoutElement), this function returns true only if this
  832. layerable has its visibility set to true and the parent layerable's \ref realVisibility returns
  833. true.
  834. If this layerable doesn't have a direct layerable parent, returns the state of this layerable's
  835. visibility.
  836. */
  837. bool QCPLayerable::realVisibility() const
  838. {
  839. return mVisible && (!mParentLayerable || mParentLayerable.data()->realVisibility());
  840. }
  841. /*!
  842. This function is used to decide whether a click hits a layerable object or not.
  843. \a pos is a point in pixel coordinates on the QCustomPlot surface. This function returns the
  844. shortest pixel distance of this point to the object. If the object is either invisible or the
  845. distance couldn't be determined, -1.0 is returned. Further, if \a onlySelectable is true and the
  846. object is not selectable, -1.0 is returned, too.
  847. If the item is represented not by single lines but by an area like QCPItemRect or QCPItemText, a
  848. click inside the area returns a constant value greater zero (typically the selectionTolerance of
  849. the parent QCustomPlot multiplied by 0.99). If the click lies outside the area, this function
  850. returns -1.0.
  851. Providing a constant value for area objects allows selecting line objects even when they are
  852. obscured by such area objects, by clicking close to the lines (i.e. closer than
  853. 0.99*selectionTolerance).
  854. The actual setting of the selection state is not done by this function. This is handled by the
  855. parent QCustomPlot when the mouseReleaseEvent occurs, and the finally selected object is notified
  856. via the selectEvent/deselectEvent methods.
  857. \a details is an optional output parameter. Every layerable subclass may place any information
  858. in \a details. This information will be passed to \ref selectEvent when the parent QCustomPlot
  859. decides on the basis of this selectTest call, that the object was successfully selected. The
  860. subsequent call to \ref selectEvent will carry the \a details. This is useful for multi-part
  861. objects (like QCPAxis). This way, a possibly complex calculation to decide which part was clicked
  862. is only done once in \ref selectTest. The result (i.e. the actually clicked part) can then be
  863. placed in \a details. So in the subsequent \ref selectEvent, the decision which part was
  864. selected doesn't have to be done a second time for a single selection operation.
  865. You may pass 0 as \a details to indicate that you are not interested in those selection details.
  866. \see selectEvent, deselectEvent, QCustomPlot::setInteractions
  867. */
  868. double QCPLayerable::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  869. {
  870. Q_UNUSED(pos)
  871. Q_UNUSED(onlySelectable)
  872. Q_UNUSED(details)
  873. return -1.0;
  874. }
  875. /*! \internal
  876. Sets the parent plot of this layerable. Use this function once to set the parent plot if you have
  877. passed 0 in the constructor. It can not be used to move a layerable from one QCustomPlot to
  878. another one.
  879. Note that, unlike when passing a non-null parent plot in the constructor, this function does not
  880. make \a parentPlot the QObject-parent of this layerable. If you want this, call
  881. QObject::setParent(\a parentPlot) in addition to this function.
  882. Further, you will probably want to set a layer (\ref setLayer) after calling this function, to
  883. make the layerable appear on the QCustomPlot.
  884. The parent plot change will be propagated to subclasses via a call to \ref parentPlotInitialized
  885. so they can react accordingly (e.g. also initialize the parent plot of child layerables, like
  886. QCPLayout does).
  887. */
  888. void QCPLayerable::initializeParentPlot(QCustomPlot *parentPlot)
  889. {
  890. if (mParentPlot)
  891. {
  892. qDebug() << Q_FUNC_INFO << "called with mParentPlot already initialized";
  893. return;
  894. }
  895. if (!parentPlot)
  896. qDebug() << Q_FUNC_INFO << "called with parentPlot zero";
  897. mParentPlot = parentPlot;
  898. parentPlotInitialized(mParentPlot);
  899. }
  900. /*! \internal
  901. Sets the parent layerable of this layerable to \a parentLayerable. Note that \a parentLayerable does not
  902. become the QObject-parent (for memory management) of this layerable.
  903. The parent layerable has influence on the return value of the \ref realVisibility method. Only
  904. layerables with a fully visible parent tree will return true for \ref realVisibility, and thus be
  905. drawn.
  906. \see realVisibility
  907. */
  908. void QCPLayerable::setParentLayerable(QCPLayerable *parentLayerable)
  909. {
  910. mParentLayerable = parentLayerable;
  911. }
  912. /*! \internal
  913. Moves this layerable object to \a layer. If \a prepend is true, this object will be prepended to
  914. the new layer's list, i.e. it will be drawn below the objects already on the layer. If it is
  915. false, the object will be appended.
  916. Returns true on success, i.e. if \a layer is a valid layer.
  917. */
  918. bool QCPLayerable::moveToLayer(QCPLayer *layer, bool prepend)
  919. {
  920. if (layer && !mParentPlot)
  921. {
  922. qDebug() << Q_FUNC_INFO << "no parent QCustomPlot set";
  923. return false;
  924. }
  925. if (layer && layer->parentPlot() != mParentPlot)
  926. {
  927. qDebug() << Q_FUNC_INFO << "layer" << layer->name() << "is not in same QCustomPlot as this layerable";
  928. return false;
  929. }
  930. if (mLayer)
  931. mLayer->removeChild(this);
  932. mLayer = layer;
  933. if (mLayer)
  934. mLayer->addChild(this, prepend);
  935. return true;
  936. }
  937. /*! \internal
  938. Sets the QCPainter::setAntialiasing state on the provided \a painter, depending on the \a
  939. localAntialiased value as well as the overrides \ref QCustomPlot::setAntialiasedElements and \ref
  940. QCustomPlot::setNotAntialiasedElements. Which override enum this function takes into account is
  941. controlled via \a overrideElement.
  942. */
  943. void QCPLayerable::applyAntialiasingHint(QCPPainter *painter, bool localAntialiased, QCP::AntialiasedElement overrideElement) const
  944. {
  945. if (mParentPlot && mParentPlot->notAntialiasedElements().testFlag(overrideElement))
  946. painter->setAntialiasing(false);
  947. else if (mParentPlot && mParentPlot->antialiasedElements().testFlag(overrideElement))
  948. painter->setAntialiasing(true);
  949. else
  950. painter->setAntialiasing(localAntialiased);
  951. }
  952. /*! \internal
  953. This function is called by \ref initializeParentPlot, to allow subclasses to react on the setting
  954. of a parent plot. This is the case when 0 was passed as parent plot in the constructor, and the
  955. parent plot is set at a later time.
  956. For example, QCPLayoutElement/QCPLayout hierarchies may be created independently of any
  957. QCustomPlot at first. When they are then added to a layout inside the QCustomPlot, the top level
  958. element of the hierarchy gets its parent plot initialized with \ref initializeParentPlot. To
  959. propagate the parent plot to all the children of the hierarchy, the top level element then uses
  960. this function to pass the parent plot on to its child elements.
  961. The default implementation does nothing.
  962. \see initializeParentPlot
  963. */
  964. void QCPLayerable::parentPlotInitialized(QCustomPlot *parentPlot)
  965. {
  966. Q_UNUSED(parentPlot)
  967. }
  968. /*! \internal
  969. Returns the selection category this layerable shall belong to. The selection category is used in
  970. conjunction with \ref QCustomPlot::setInteractions to control which objects are selectable and
  971. which aren't.
  972. Subclasses that don't fit any of the normal \ref QCP::Interaction values can use \ref
  973. QCP::iSelectOther. This is what the default implementation returns.
  974. \see QCustomPlot::setInteractions
  975. */
  976. QCP::Interaction QCPLayerable::selectionCategory() const
  977. {
  978. return QCP::iSelectOther;
  979. }
  980. /*! \internal
  981. Returns the clipping rectangle of this layerable object. By default, this is the viewport of the
  982. parent QCustomPlot. Specific subclasses may reimplement this function to provide different
  983. clipping rects.
  984. The returned clipping rect is set on the painter before the draw function of the respective
  985. object is called.
  986. */
  987. QRect QCPLayerable::clipRect() const
  988. {
  989. if (mParentPlot)
  990. return mParentPlot->viewport();
  991. else
  992. return QRect();
  993. }
  994. /*! \internal
  995. This event is called when the layerable shall be selected, as a consequence of a click by the
  996. user. Subclasses should react to it by setting their selection state appropriately. The default
  997. implementation does nothing.
  998. \a event is the mouse event that caused the selection. \a additive indicates, whether the user
  999. was holding the multi-select-modifier while performing the selection (see \ref
  1000. QCustomPlot::setMultiSelectModifier). if \a additive is true, the selection state must be toggled
  1001. (i.e. become selected when unselected and unselected when selected).
  1002. Every selectEvent is preceded by a call to \ref selectTest, which has returned positively (i.e.
  1003. returned a value greater than 0 and less than the selection tolerance of the parent QCustomPlot).
  1004. The \a details data you output from \ref selectTest is feeded back via \a details here. You may
  1005. use it to transport any kind of information from the selectTest to the possibly subsequent
  1006. selectEvent. Usually \a details is used to transfer which part was clicked, if it is a layerable
  1007. that has multiple individually selectable parts (like QCPAxis). This way selectEvent doesn't need
  1008. to do the calculation again to find out which part was actually clicked.
  1009. \a selectionStateChanged is an output parameter. If the pointer is non-null, this function must
  1010. set the value either to true or false, depending on whether the selection state of this layerable
  1011. was actually changed. For layerables that only are selectable as a whole and not in parts, this
  1012. is simple: if \a additive is true, \a selectionStateChanged must also be set to true, because the
  1013. selection toggles. If \a additive is false, \a selectionStateChanged is only set to true, if the
  1014. layerable was previously unselected and now is switched to the selected state.
  1015. \see selectTest, deselectEvent
  1016. */
  1017. void QCPLayerable::selectEvent(QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged)
  1018. {
  1019. Q_UNUSED(event)
  1020. Q_UNUSED(additive)
  1021. Q_UNUSED(details)
  1022. Q_UNUSED(selectionStateChanged)
  1023. }
  1024. /*! \internal
  1025. This event is called when the layerable shall be deselected, either as consequence of a user
  1026. interaction or a call to \ref QCustomPlot::deselectAll. Subclasses should react to it by
  1027. unsetting their selection appropriately.
  1028. just as in \ref selectEvent, the output parameter \a selectionStateChanged (if non-null), must
  1029. return true or false when the selection state of this layerable has changed or not changed,
  1030. respectively.
  1031. \see selectTest, selectEvent
  1032. */
  1033. void QCPLayerable::deselectEvent(bool *selectionStateChanged)
  1034. {
  1035. Q_UNUSED(selectionStateChanged)
  1036. }
  1037. ////////////////////////////////////////////////////////////////////////////////////////////////////
  1038. //////////////////// QCPRange
  1039. ////////////////////////////////////////////////////////////////////////////////////////////////////
  1040. /*! \class QCPRange
  1041. \brief Represents the range an axis is encompassing.
  1042. contains a \a lower and \a upper double value and provides convenience input, output and
  1043. modification functions.
  1044. \see QCPAxis::setRange
  1045. */
  1046. /*!
  1047. Minimum range size (\a upper - \a lower) the range changing functions will accept. Smaller
  1048. intervals would cause errors due to the 11-bit exponent of double precision numbers,
  1049. corresponding to a minimum magnitude of roughly 1e-308.
  1050. \see validRange, maxRange
  1051. */
  1052. const double QCPRange::minRange = 1e-280;
  1053. /*!
  1054. Maximum values (negative and positive) the range will accept in range-changing functions.
  1055. Larger absolute values would cause errors due to the 11-bit exponent of double precision numbers,
  1056. corresponding to a maximum magnitude of roughly 1e308.
  1057. Since the number of planck-volumes in the entire visible universe is only ~1e183, this should
  1058. be enough.
  1059. \see validRange, minRange
  1060. */
  1061. const double QCPRange::maxRange = 1e250;
  1062. /*!
  1063. Constructs a range with \a lower and \a upper set to zero.
  1064. */
  1065. QCPRange::QCPRange() :
  1066. lower(0),
  1067. upper(0)
  1068. {
  1069. }
  1070. /*! \overload
  1071. Constructs a range with the specified \a lower and \a upper values.
  1072. */
  1073. QCPRange::QCPRange(double lower, double upper) :
  1074. lower(lower),
  1075. upper(upper)
  1076. {
  1077. normalize();
  1078. }
  1079. /*!
  1080. Returns the size of the range, i.e. \a upper-\a lower
  1081. */
  1082. double QCPRange::size() const
  1083. {
  1084. return upper-lower;
  1085. }
  1086. /*!
  1087. Returns the center of the range, i.e. (\a upper+\a lower)*0.5
  1088. */
  1089. double QCPRange::center() const
  1090. {
  1091. return (upper+lower)*0.5;
  1092. }
  1093. /*!
  1094. Makes sure \a lower is numerically smaller than \a upper. If this is not the case, the values
  1095. are swapped.
  1096. */
  1097. void QCPRange::normalize()
  1098. {
  1099. if (lower > upper)
  1100. qSwap(lower, upper);
  1101. }
  1102. /*!
  1103. Expands this range such that \a otherRange is contained in the new range. It is assumed that both
  1104. this range and \a otherRange are normalized (see \ref normalize).
  1105. If \a otherRange is already inside the current range, this function does nothing.
  1106. \see expanded
  1107. */
  1108. void QCPRange::expand(const QCPRange &otherRange)
  1109. {
  1110. if (lower > otherRange.lower)
  1111. lower = otherRange.lower;
  1112. if (upper < otherRange.upper)
  1113. upper = otherRange.upper;
  1114. }
  1115. /*!
  1116. Returns an expanded range that contains this and \a otherRange. It is assumed that both this
  1117. range and \a otherRange are normalized (see \ref normalize).
  1118. \see expand
  1119. */
  1120. QCPRange QCPRange::expanded(const QCPRange &otherRange) const
  1121. {
  1122. QCPRange result = *this;
  1123. result.expand(otherRange);
  1124. return result;
  1125. }
  1126. /*!
  1127. Returns a sanitized version of the range. Sanitized means for logarithmic scales, that
  1128. the range won't span the positive and negative sign domain, i.e. contain zero. Further
  1129. \a lower will always be numerically smaller (or equal) to \a upper.
  1130. If the original range does span positive and negative sign domains or contains zero,
  1131. the returned range will try to approximate the original range as good as possible.
  1132. If the positive interval of the original range is wider than the negative interval, the
  1133. returned range will only contain the positive interval, with lower bound set to \a rangeFac or
  1134. \a rangeFac *\a upper, whichever is closer to zero. Same procedure is used if the negative interval
  1135. is wider than the positive interval, this time by changing the \a upper bound.
  1136. */
  1137. QCPRange QCPRange::sanitizedForLogScale() const
  1138. {
  1139. double rangeFac = 1e-3;
  1140. QCPRange sanitizedRange(lower, upper);
  1141. sanitizedRange.normalize();
  1142. // can't have range spanning negative and positive values in log plot, so change range to fix it
  1143. //if (qFuzzyCompare(sanitizedRange.lower+1, 1) && !qFuzzyCompare(sanitizedRange.upper+1, 1))
  1144. if (sanitizedRange.lower == 0.0 && sanitizedRange.upper != 0.0)
  1145. {
  1146. // case lower is 0
  1147. if (rangeFac < sanitizedRange.upper*rangeFac)
  1148. sanitizedRange.lower = rangeFac;
  1149. else
  1150. sanitizedRange.lower = sanitizedRange.upper*rangeFac;
  1151. } //else if (!qFuzzyCompare(lower+1, 1) && qFuzzyCompare(upper+1, 1))
  1152. else if (sanitizedRange.lower != 0.0 && sanitizedRange.upper == 0.0)
  1153. {
  1154. // case upper is 0
  1155. if (-rangeFac > sanitizedRange.lower*rangeFac)
  1156. sanitizedRange.upper = -rangeFac;
  1157. else
  1158. sanitizedRange.upper = sanitizedRange.lower*rangeFac;
  1159. } else if (sanitizedRange.lower < 0 && sanitizedRange.upper > 0)
  1160. {
  1161. // find out whether negative or positive interval is wider to decide which sign domain will be chosen
  1162. if (-sanitizedRange.lower > sanitizedRange.upper)
  1163. {
  1164. // negative is wider, do same as in case upper is 0
  1165. if (-rangeFac > sanitizedRange.lower*rangeFac)
  1166. sanitizedRange.upper = -rangeFac;
  1167. else
  1168. sanitizedRange.upper = sanitizedRange.lower*rangeFac;
  1169. } else
  1170. {
  1171. // positive is wider, do same as in case lower is 0
  1172. if (rangeFac < sanitizedRange.upper*rangeFac)
  1173. sanitizedRange.lower = rangeFac;
  1174. else
  1175. sanitizedRange.lower = sanitizedRange.upper*rangeFac;
  1176. }
  1177. }
  1178. // due to normalization, case lower>0 && upper<0 should never occur, because that implies upper<lower
  1179. return sanitizedRange;
  1180. }
  1181. /*!
  1182. Returns a sanitized version of the range. Sanitized means for linear scales, that
  1183. \a lower will always be numerically smaller (or equal) to \a upper.
  1184. */
  1185. QCPRange QCPRange::sanitizedForLinScale() const
  1186. {
  1187. QCPRange sanitizedRange(lower, upper);
  1188. sanitizedRange.normalize();
  1189. return sanitizedRange;
  1190. }
  1191. /*!
  1192. Returns true when \a value lies within or exactly on the borders of the range.
  1193. */
  1194. bool QCPRange::contains(double value) const
  1195. {
  1196. return value >= lower && value <= upper;
  1197. }
  1198. /*!
  1199. Checks, whether the specified range is within valid bounds, which are defined
  1200. as QCPRange::maxRange and QCPRange::minRange.
  1201. A valid range means:
  1202. \li range bounds within -maxRange and maxRange
  1203. \li range size above minRange
  1204. \li range size below maxRange
  1205. */
  1206. bool QCPRange::validRange(double lower, double upper)
  1207. {
  1208. /*
  1209. return (lower > -maxRange &&
  1210. upper < maxRange &&
  1211. qAbs(lower-upper) > minRange &&
  1212. (lower < -minRange || lower > minRange) &&
  1213. (upper < -minRange || upper > minRange));
  1214. */
  1215. return (lower > -maxRange &&
  1216. upper < maxRange &&
  1217. qAbs(lower-upper) > minRange &&
  1218. qAbs(lower-upper) < maxRange);
  1219. }
  1220. /*!
  1221. \overload
  1222. Checks, whether the specified range is within valid bounds, which are defined
  1223. as QCPRange::maxRange and QCPRange::minRange.
  1224. A valid range means:
  1225. \li range bounds within -maxRange and maxRange
  1226. \li range size above minRange
  1227. \li range size below maxRange
  1228. */
  1229. bool QCPRange::validRange(const QCPRange &range)
  1230. {
  1231. /*
  1232. return (range.lower > -maxRange &&
  1233. range.upper < maxRange &&
  1234. qAbs(range.lower-range.upper) > minRange &&
  1235. qAbs(range.lower-range.upper) < maxRange &&
  1236. (range.lower < -minRange || range.lower > minRange) &&
  1237. (range.upper < -minRange || range.upper > minRange));
  1238. */
  1239. return (range.lower > -maxRange &&
  1240. range.upper < maxRange &&
  1241. qAbs(range.lower-range.upper) > minRange &&
  1242. qAbs(range.lower-range.upper) < maxRange);
  1243. }
  1244. /*! \page thelayoutsystem The Layout System
  1245. The layout system is responsible for positioning and scaling layout elements such as axis rects,
  1246. legends and plot titles in a QCustomPlot.
  1247. \section layoutsystem-classesandmechanisms Classes and mechanisms
  1248. The layout system is based on the abstract base class \ref QCPLayoutElement. All objects that
  1249. take part in the layout system derive from this class, either directly or indirectly.
  1250. Since QCPLayoutElement itself derives from \ref QCPLayerable, a layout element may draw its own
  1251. content. However, it is perfectly possible for a layout element to only serve as a structuring
  1252. and/or positioning element, not drawing anything on its own.
  1253. \subsection layoutsystem-rects Rects of a layout element
  1254. A layout element is a rectangular object described by two rects: the inner rect (\ref
  1255. QCPLayoutElement::rect) and the outer rect (\ref QCPLayoutElement::setOuterRect). The inner rect
  1256. is calculated automatically by applying the margin (\ref QCPLayoutElement::setMargins) inward
  1257. from the outer rect. The inner rect is meant for main content while the margin area may either be
  1258. left blank or serve for displaying peripheral graphics. For example, \ref QCPAxisRect positions
  1259. the four main axes at the sides of the inner rect, so graphs end up inside it and the axis labels
  1260. and tick labels are in the margin area.
  1261. \subsection layoutsystem-margins Margins
  1262. Each layout element may provide a mechanism to automatically determine its margins. Internally,
  1263. this is realized with the \ref QCPLayoutElement::calculateAutoMargin function which takes a \ref
  1264. QCP::MarginSide and returns an integer value which represents the ideal margin for the specified
  1265. side. The automatic margin will be used on the sides specified in \ref
  1266. QCPLayoutElement::setAutoMargins. By default, it is set to \ref QCP::msAll meaning automatic
  1267. margin calculation is enabled for all four sides. In this case, a minimum margin may be set with
  1268. \ref QCPLayoutElement::setMinimumMargins, to prevent the automatic margin mechanism from setting
  1269. margins smaller than desired for a specific situation. If automatic margin calculation is unset
  1270. for a specific side, the margin of that side can be controlled directy via \ref
  1271. QCPLayoutElement::setMargins.
  1272. If multiple layout ements are arranged next to or beneath each other, it may be desirable to
  1273. align their inner rects on certain sides. Since they all might have different automatic margins,
  1274. this usually isn't the case. The class \ref QCPMarginGroup and \ref
  1275. QCPLayoutElement::setMarginGroup fix this by allowing to synchronize multiple margins. See the
  1276. documentation there for details.
  1277. \subsection layoutsystem-layout Layouts
  1278. As mentioned, a QCPLayoutElement may have an arbitrary number of child layout elements and in
  1279. princple can have the only purpose to manage/arrange those child elements. This is what the
  1280. subclass \ref QCPLayout specializes on. It is a QCPLayoutElement itself but has no visual
  1281. representation. It defines an interface to add, remove and manage child layout elements.
  1282. QCPLayout isn't a usable layout though, it's an abstract base class that concrete layouts derive
  1283. from, like \ref QCPLayoutGrid which arranges its child elements in a grid and \ref QCPLayoutInset
  1284. which allows placing child elements freely inside its rect.
  1285. Since a QCPLayout is a layout element itself, it may be placed inside other layouts. This way,
  1286. complex hierarchies may be created, offering very flexible arrangements.
  1287. <div style="text-align:center">
  1288. <div style="display:inline-block; margin-left:auto; margin-right:auto">\image html LayoutsystemSketch0.png ""</div>
  1289. <div style="display:inline-block; margin-left:auto; margin-right:auto">\image html LayoutsystemSketch1.png ""</div>
  1290. <div style="clear:both"></div>
  1291. <div style="display:inline-block; max-width:1000px; text-align:justify">
  1292. Sketch of the default QCPLayoutGrid accessible via \ref QCustomPlot::plotLayout. The left image
  1293. shows the outer and inner rect of the grid layout itself while the right image shows how two
  1294. child layout elements are placed inside the grid layout next to each other in cells (0, 0) and
  1295. (0, 1).
  1296. </div>
  1297. </div>
  1298. \subsection layoutsystem-plotlayout The top level plot layout
  1299. Every QCustomPlot has one top level layout of type \ref QCPLayoutGrid. It is accessible via \ref
  1300. QCustomPlot::plotLayout and contains (directly or indirectly via other sub-layouts) all layout
  1301. elements in the QCustomPlot. By default, this top level grid layout contains a single cell which
  1302. holds the main axis rect.
  1303. \subsection layoutsystem-examples Examples
  1304. <b>Adding a plot title</b> is a typical and simple case to demonstrate basic workings of the layout system.
  1305. \code
  1306. // first we create and prepare a plot title layout element:
  1307. QCPPlotTitle *title = new QCPPlotTitle(customPlot);
  1308. title->setText("Plot Title Example");
  1309. title->setFont(QFont("sans", 12, QFont::Bold));
  1310. // then we add it to the main plot layout:
  1311. customPlot->plotLayout()->insertRow(0); // insert an empty row above the axis rect
  1312. customPlot->plotLayout()->addElement(0, 0, title); // insert the title in the empty cell we just created
  1313. \endcode
  1314. \image html layoutsystem-addingplottitle.png
  1315. <b>Arranging multiple axis rects</b> actually is the central purpose of the layout system.
  1316. \code
  1317. customPlot->plotLayout()->clear(); // let's start from scratch and remove the default axis rect
  1318. // add the first axis rect in second row (row index 1):
  1319. customPlot->plotLayout()->addElement(1, 0, new QCPAxisRect(customPlot));
  1320. // create a sub layout that we'll place in first row:
  1321. QCPLayoutGrid *subLayout = new QCPLayoutGrid;
  1322. customPlot->plotLayout()->addElement(0, 0, subLayout);
  1323. // add two axis rects in the sub layout next to eachother:
  1324. subLayout->addElement(0, 0, new QCPAxisRect(customPlot));
  1325. subLayout->addElement(0, 1, new QCPAxisRect(customPlot));
  1326. subLayout->setColumnStretchFactor(0, 3); // left axis rect shall have 60% of width
  1327. subLayout->setColumnStretchFactor(1, 2); // right one only 40% (3:2 = 60:40)
  1328. \endcode
  1329. \image html layoutsystem-multipleaxisrects.png
  1330. */
  1331. ////////////////////////////////////////////////////////////////////////////////////////////////////
  1332. //////////////////// QCPMarginGroup
  1333. ////////////////////////////////////////////////////////////////////////////////////////////////////
  1334. /*! \class QCPMarginGroup
  1335. \brief A margin group allows synchronization of margin sides if working with multiple layout elements.
  1336. QCPMarginGroup allows you to tie a margin side of two or more layout elements together, such that
  1337. they will all have the same size, based on the largest required margin in the group.
  1338. \n
  1339. \image html QCPMarginGroup.png "Demonstration of QCPMarginGroup"
  1340. \n
  1341. In certain situations it is desirable that margins at specific sides are synchronized across
  1342. layout elements. For example, if one QCPAxisRect is below another one in a grid layout, it will
  1343. provide a cleaner look to the user if the left and right margins of the two axis rects are of the
  1344. same size. The left axis of the top axis rect will then be at the same horizontal position as the
  1345. left axis of the lower axis rect, making them appear aligned. The same applies for the right
  1346. axes. This is what QCPMarginGroup makes possible.
  1347. To add/remove a specific side of a layout element to/from a margin group, use the \ref
  1348. QCPLayoutElement::setMarginGroup method. To completely break apart the margin group, either call
  1349. \ref clear, or just delete the margin group.
  1350. \section QCPMarginGroup-example Example
  1351. First create a margin group:
  1352. \code
  1353. QCPMarginGroup *group = new QCPMarginGroup(customPlot);
  1354. \endcode
  1355. Then set this group on the layout element sides:
  1356. \code
  1357. customPlot->axisRect(0)->setMarginGroup(QCP::msLeft|QCP::msRight, group);
  1358. customPlot->axisRect(1)->setMarginGroup(QCP::msLeft|QCP::msRight, group);
  1359. \endcode
  1360. Here, we've used the first two axis rects of the plot and synchronized their left margins with
  1361. each other and their right margins with each other.
  1362. */
  1363. /* start documentation of inline functions */
  1364. /*! \fn QList<QCPLayoutElement*> QCPMarginGroup::elements(QCP::MarginSide side) const
  1365. Returns a list of all layout elements that have their margin \a side associated with this margin
  1366. group.
  1367. */
  1368. /* end documentation of inline functions */
  1369. /*!
  1370. Creates a new QCPMarginGroup instance in \a parentPlot.
  1371. */
  1372. QCPMarginGroup::QCPMarginGroup(QCustomPlot *parentPlot) :
  1373. QObject(parentPlot),
  1374. mParentPlot(parentPlot)
  1375. {
  1376. mChildren.insert(QCP::msLeft, QList<QCPLayoutElement*>());
  1377. mChildren.insert(QCP::msRight, QList<QCPLayoutElement*>());
  1378. mChildren.insert(QCP::msTop, QList<QCPLayoutElement*>());
  1379. mChildren.insert(QCP::msBottom, QList<QCPLayoutElement*>());
  1380. }
  1381. QCPMarginGroup::~QCPMarginGroup()
  1382. {
  1383. clear();
  1384. }
  1385. /*!
  1386. Returns whether this margin group is empty. If this function returns true, no layout elements use
  1387. this margin group to synchronize margin sides.
  1388. */
  1389. bool QCPMarginGroup::isEmpty() const
  1390. {
  1391. QHashIterator<QCP::MarginSide, QList<QCPLayoutElement*> > it(mChildren);
  1392. while (it.hasNext())
  1393. {
  1394. it.next();
  1395. if (!it.value().isEmpty())
  1396. return false;
  1397. }
  1398. return true;
  1399. }
  1400. /*!
  1401. Clears this margin group. The synchronization of the margin sides that use this margin group is
  1402. lifted and they will use their individual margin sizes again.
  1403. */
  1404. void QCPMarginGroup::clear()
  1405. {
  1406. // make all children remove themselves from this margin group:
  1407. QHashIterator<QCP::MarginSide, QList<QCPLayoutElement*> > it(mChildren);
  1408. while (it.hasNext())
  1409. {
  1410. it.next();
  1411. const QList<QCPLayoutElement*> elements = it.value();
  1412. for (int i=elements.size()-1; i>=0; --i)
  1413. elements.at(i)->setMarginGroup(it.key(), 0); // removes itself from mChildren via removeChild
  1414. }
  1415. }
  1416. /*! \internal
  1417. Returns the synchronized common margin for \a side. This is the margin value that will be used by
  1418. the layout element on the respective side, if it is part of this margin group.
  1419. The common margin is calculated by requesting the automatic margin (\ref
  1420. QCPLayoutElement::calculateAutoMargin) of each element associated with \a side in this margin
  1421. group, and choosing the largest returned value. (QCPLayoutElement::minimumMargins is taken into
  1422. account, too.)
  1423. */
  1424. int QCPMarginGroup::commonMargin(QCP::MarginSide side) const
  1425. {
  1426. // query all automatic margins of the layout elements in this margin group side and find maximum:
  1427. int result = 0;
  1428. const QList<QCPLayoutElement*> elements = mChildren.value(side);
  1429. for (int i=0; i<elements.size(); ++i)
  1430. {
  1431. if (!elements.at(i)->autoMargins().testFlag(side))
  1432. continue;
  1433. int m = qMax(elements.at(i)->calculateAutoMargin(side), QCP::getMarginValue(elements.at(i)->minimumMargins(), side));
  1434. if (m > result)
  1435. result = m;
  1436. }
  1437. return result;
  1438. }
  1439. /*! \internal
  1440. Adds \a element to the internal list of child elements, for the margin \a side.
  1441. This function does not modify the margin group property of \a element.
  1442. */
  1443. void QCPMarginGroup::addChild(QCP::MarginSide side, QCPLayoutElement *element)
  1444. {
  1445. if (!mChildren[side].contains(element))
  1446. mChildren[side].append(element);
  1447. else
  1448. qDebug() << Q_FUNC_INFO << "element is already child of this margin group side" << reinterpret_cast<quintptr>(element);
  1449. }
  1450. /*! \internal
  1451. Removes \a element from the internal list of child elements, for the margin \a side.
  1452. This function does not modify the margin group property of \a element.
  1453. */
  1454. void QCPMarginGroup::removeChild(QCP::MarginSide side, QCPLayoutElement *element)
  1455. {
  1456. if (!mChildren[side].removeOne(element))
  1457. qDebug() << Q_FUNC_INFO << "element is not child of this margin group side" << reinterpret_cast<quintptr>(element);
  1458. }
  1459. ////////////////////////////////////////////////////////////////////////////////////////////////////
  1460. //////////////////// QCPLayoutElement
  1461. ////////////////////////////////////////////////////////////////////////////////////////////////////
  1462. /*! \class QCPLayoutElement
  1463. \brief The abstract base class for all objects that form \ref thelayoutsystem "the layout system".
  1464. This is an abstract base class. As such, it can't be instantiated directly, rather use one of its subclasses.
  1465. A Layout element is a rectangular object which can be placed in layouts. It has an outer rect
  1466. (QCPLayoutElement::outerRect) and an inner rect (\ref QCPLayoutElement::rect). The difference
  1467. between outer and inner rect is called its margin. The margin can either be set to automatic or
  1468. manual (\ref setAutoMargins) on a per-side basis. If a side is set to manual, that margin can be
  1469. set explicitly with \ref setMargins and will stay fixed at that value. If it's set to automatic,
  1470. the layout element subclass will control the value itself (via \ref calculateAutoMargin).
  1471. Layout elements can be placed in layouts (base class QCPLayout) like QCPLayoutGrid. The top level
  1472. layout is reachable via \ref QCustomPlot::plotLayout, and is a \ref QCPLayoutGrid. Since \ref
  1473. QCPLayout itself derives from \ref QCPLayoutElement, layouts can be nested.
  1474. Thus in QCustomPlot one can divide layout elements into two categories: The ones that are
  1475. invisible by themselves, because they don't draw anything. Their only purpose is to manage the
  1476. position and size of other layout elements. This category of layout elements usually use
  1477. QCPLayout as base class. Then there is the category of layout elements which actually draw
  1478. something. For example, QCPAxisRect, QCPLegend and QCPPlotTitle are of this category. This does
  1479. not necessarily mean that the latter category can't have child layout elements. QCPLegend for
  1480. instance, actually derives from QCPLayoutGrid and the individual legend items are child layout
  1481. elements in the grid layout.
  1482. */
  1483. /* start documentation of inline functions */
  1484. /*! \fn QCPLayout *QCPLayoutElement::layout() const
  1485. Returns the parent layout of this layout element.
  1486. */
  1487. /*! \fn QRect QCPLayoutElement::rect() const
  1488. Returns the inner rect of this layout element. The inner rect is the outer rect (\ref
  1489. setOuterRect) shrinked by the margins (\ref setMargins, \ref setAutoMargins).
  1490. In some cases, the area between outer and inner rect is left blank. In other cases the margin
  1491. area is used to display peripheral graphics while the main content is in the inner rect. This is
  1492. where automatic margin calculation becomes interesting because it allows the layout element to
  1493. adapt the margins to the peripheral graphics it wants to draw. For example, \ref QCPAxisRect
  1494. draws the axis labels and tick labels in the margin area, thus needs to adjust the margins (if
  1495. \ref setAutoMargins is enabled) according to the space required by the labels of the axes.
  1496. */
  1497. /*! \fn virtual void QCPLayoutElement::mousePressEvent(QMouseEvent *event)
  1498. This event is called, if the mouse was pressed while being inside the outer rect of this layout
  1499. element.
  1500. */
  1501. /*! \fn virtual void QCPLayoutElement::mouseMoveEvent(QMouseEvent *event)
  1502. This event is called, if the mouse is moved inside the outer rect of this layout element.
  1503. */
  1504. /*! \fn virtual void QCPLayoutElement::mouseReleaseEvent(QMouseEvent *event)
  1505. This event is called, if the mouse was previously pressed inside the outer rect of this layout
  1506. element and is now released.
  1507. */
  1508. /*! \fn virtual void QCPLayoutElement::mouseDoubleClickEvent(QMouseEvent *event)
  1509. This event is called, if the mouse is double-clicked inside the outer rect of this layout
  1510. element.
  1511. */
  1512. /*! \fn virtual void QCPLayoutElement::wheelEvent(QWheelEvent *event)
  1513. This event is called, if the mouse wheel is scrolled while the cursor is inside the rect of this
  1514. layout element.
  1515. */
  1516. /* end documentation of inline functions */
  1517. /*!
  1518. Creates an instance of QCPLayoutElement and sets default values.
  1519. */
  1520. QCPLayoutElement::QCPLayoutElement(QCustomPlot *parentPlot) :
  1521. QCPLayerable(parentPlot), // parenthood is changed as soon as layout element gets inserted into a layout (except for top level layout)
  1522. mParentLayout(0),
  1523. mMinimumSize(),
  1524. mMaximumSize(QWIDGETSIZE_MAX, QWIDGETSIZE_MAX),
  1525. mRect(0, 0, 0, 0),
  1526. mOuterRect(0, 0, 0, 0),
  1527. mMargins(0, 0, 0, 0),
  1528. mMinimumMargins(0, 0, 0, 0),
  1529. mAutoMargins(QCP::msAll)
  1530. {
  1531. }
  1532. QCPLayoutElement::~QCPLayoutElement()
  1533. {
  1534. setMarginGroup(QCP::msAll, 0); // unregister at margin groups, if there are any
  1535. // unregister at layout:
  1536. if (qobject_cast<QCPLayout*>(mParentLayout)) // the qobject_cast is just a safeguard in case the layout forgets to call clear() in its dtor and this dtor is called by QObject dtor
  1537. mParentLayout->take(this);
  1538. }
  1539. /*!
  1540. Sets the outer rect of this layout element. If the layout element is inside a layout, the layout
  1541. sets the position and size of this layout element using this function.
  1542. Calling this function externally has no effect, since the layout will overwrite any changes to
  1543. the outer rect upon the next replot.
  1544. The layout element will adapt its inner \ref rect by applying the margins inward to the outer rect.
  1545. \see rect
  1546. */
  1547. void QCPLayoutElement::setOuterRect(const QRect &rect)
  1548. {
  1549. if (mOuterRect != rect)
  1550. {
  1551. mOuterRect = rect;
  1552. mRect = mOuterRect.adjusted(mMargins.left(), mMargins.top(), -mMargins.right(), -mMargins.bottom());
  1553. }
  1554. }
  1555. /*!
  1556. Sets the margins of this layout element. If \ref setAutoMargins is disabled for some or all
  1557. sides, this function is used to manually set the margin on those sides. Sides that are still set
  1558. to be handled automatically are ignored and may have any value in \a margins.
  1559. The margin is the distance between the outer rect (controlled by the parent layout via \ref
  1560. setOuterRect) and the inner \ref rect (which usually contains the main content of this layout
  1561. element).
  1562. \see setAutoMargins
  1563. */
  1564. void QCPLayoutElement::setMargins(const QMargins &margins)
  1565. {
  1566. if (mMargins != margins)
  1567. {
  1568. mMargins = margins;
  1569. mRect = mOuterRect.adjusted(mMargins.left(), mMargins.top(), -mMargins.right(), -mMargins.bottom());
  1570. }
  1571. }
  1572. /*!
  1573. If \ref setAutoMargins is enabled on some or all margins, this function is used to provide
  1574. minimum values for those margins.
  1575. The minimum values are not enforced on margin sides that were set to be under manual control via
  1576. \ref setAutoMargins.
  1577. \see setAutoMargins
  1578. */
  1579. void QCPLayoutElement::setMinimumMargins(const QMargins &margins)
  1580. {
  1581. if (mMinimumMargins != margins)
  1582. {
  1583. mMinimumMargins = margins;
  1584. }
  1585. }
  1586. /*!
  1587. Sets on which sides the margin shall be calculated automatically. If a side is calculated
  1588. automatically, a minimum margin value may be provided with \ref setMinimumMargins. If a side is
  1589. set to be controlled manually, the value may be specified with \ref setMargins.
  1590. Margin sides that are under automatic control may participate in a \ref QCPMarginGroup (see \ref
  1591. setMarginGroup), to synchronize (align) it with other layout elements in the plot.
  1592. \see setMinimumMargins, setMargins
  1593. */
  1594. void QCPLayoutElement::setAutoMargins(QCP::MarginSides sides)
  1595. {
  1596. mAutoMargins = sides;
  1597. }
  1598. /*!
  1599. Sets the minimum size for the inner \ref rect of this layout element. A parent layout tries to
  1600. respect the \a size here by changing row/column sizes in the layout accordingly.
  1601. If the parent layout size is not sufficient to satisfy all minimum size constraints of its child
  1602. layout elements, the layout may set a size that is actually smaller than \a size. QCustomPlot
  1603. propagates the layout's size constraints to the outside by setting its own minimum QWidget size
  1604. accordingly, so violations of \a size should be exceptions.
  1605. */
  1606. void QCPLayoutElement::setMinimumSize(const QSize &size)
  1607. {
  1608. if (mMinimumSize != size)
  1609. {
  1610. mMinimumSize = size;
  1611. if (mParentLayout)
  1612. mParentLayout->sizeConstraintsChanged();
  1613. }
  1614. }
  1615. /*! \overload
  1616. Sets the minimum size for the inner \ref rect of this layout element.
  1617. */
  1618. void QCPLayoutElement::setMinimumSize(int width, int height)
  1619. {
  1620. setMinimumSize(QSize(width, height));
  1621. }
  1622. /*!
  1623. Sets the maximum size for the inner \ref rect of this layout element. A parent layout tries to
  1624. respect the \a size here by changing row/column sizes in the layout accordingly.
  1625. */
  1626. void QCPLayoutElement::setMaximumSize(const QSize &size)
  1627. {
  1628. if (mMaximumSize != size)
  1629. {
  1630. mMaximumSize = size;
  1631. if (mParentLayout)
  1632. mParentLayout->sizeConstraintsChanged();
  1633. }
  1634. }
  1635. /*! \overload
  1636. Sets the maximum size for the inner \ref rect of this layout element.
  1637. */
  1638. void QCPLayoutElement::setMaximumSize(int width, int height)
  1639. {
  1640. setMaximumSize(QSize(width, height));
  1641. }
  1642. /*!
  1643. Sets the margin \a group of the specified margin \a sides.
  1644. Margin groups allow synchronizing specified margins across layout elements, see the documentation
  1645. of \ref QCPMarginGroup.
  1646. To unset the margin group of \a sides, set \a group to 0.
  1647. Note that margin groups only work for margin sides that are set to automatic (\ref
  1648. setAutoMargins).
  1649. */
  1650. void QCPLayoutElement::setMarginGroup(QCP::MarginSides sides, QCPMarginGroup *group)
  1651. {
  1652. QVector<QCP::MarginSide> sideVector;
  1653. if (sides.testFlag(QCP::msLeft)) sideVector.append(QCP::msLeft);
  1654. if (sides.testFlag(QCP::msRight)) sideVector.append(QCP::msRight);
  1655. if (sides.testFlag(QCP::msTop)) sideVector.append(QCP::msTop);
  1656. if (sides.testFlag(QCP::msBottom)) sideVector.append(QCP::msBottom);
  1657. for (int i=0; i<sideVector.size(); ++i)
  1658. {
  1659. QCP::MarginSide side = sideVector.at(i);
  1660. if (marginGroup(side) != group)
  1661. {
  1662. QCPMarginGroup *oldGroup = marginGroup(side);
  1663. if (oldGroup) // unregister at old group
  1664. oldGroup->removeChild(side, this);
  1665. if (!group) // if setting to 0, remove hash entry. Else set hash entry to new group and register there
  1666. {
  1667. mMarginGroups.remove(side);
  1668. } else // setting to a new group
  1669. {
  1670. mMarginGroups[side] = group;
  1671. group->addChild(side, this);
  1672. }
  1673. }
  1674. }
  1675. }
  1676. /*!
  1677. Updates the layout element and sub-elements. This function is automatically called upon replot by
  1678. the parent layout element.
  1679. Layout elements that have child elements should call the \ref update method of their child
  1680. elements.
  1681. The default implementation executes the automatic margin mechanism, so subclasses should make
  1682. sure to call the base class implementation.
  1683. */
  1684. void QCPLayoutElement::update()
  1685. {
  1686. if (mAutoMargins != QCP::msNone)
  1687. {
  1688. // set the margins of this layout element according to automatic margin calculation, either directly or via a margin group:
  1689. QMargins newMargins = mMargins;
  1690. QVector<QCP::MarginSide> marginSides = QVector<QCP::MarginSide>() << QCP::msLeft << QCP::msRight << QCP::msTop << QCP::msBottom;
  1691. for (int i=0; i<marginSides.size(); ++i)
  1692. {
  1693. QCP::MarginSide side = marginSides.at(i);
  1694. if (mAutoMargins.testFlag(side)) // this side's margin shall be calculated automatically
  1695. {
  1696. if (mMarginGroups.contains(side))
  1697. QCP::setMarginValue(newMargins, side, mMarginGroups[side]->commonMargin(side)); // this side is part of a margin group, so get the margin value from that group
  1698. else
  1699. QCP::setMarginValue(newMargins, side, calculateAutoMargin(side)); // this side is not part of a group, so calculate the value directly
  1700. // apply minimum margin restrictions:
  1701. if (QCP::getMarginValue(newMargins, side) < QCP::getMarginValue(mMinimumMargins, side))
  1702. QCP::setMarginValue(newMargins, side, QCP::getMarginValue(mMinimumMargins, side));
  1703. }
  1704. }
  1705. setMargins(newMargins);
  1706. }
  1707. }
  1708. /*!
  1709. Returns the minimum size this layout element (the inner \ref rect) may be compressed to.
  1710. if a minimum size (\ref setMinimumSize) was not set manually, parent layouts consult this
  1711. function to determine the minimum allowed size of this layout element. (A manual minimum size is
  1712. considered set if it is non-zero.)
  1713. */
  1714. QSize QCPLayoutElement::minimumSizeHint() const
  1715. {
  1716. return mMinimumSize;
  1717. }
  1718. /*!
  1719. Returns the maximum size this layout element (the inner \ref rect) may be expanded to.
  1720. if a maximum size (\ref setMaximumSize) was not set manually, parent layouts consult this
  1721. function to determine the maximum allowed size of this layout element. (A manual maximum size is
  1722. considered set if it is smaller than Qt's QWIDGETSIZE_MAX.)
  1723. */
  1724. QSize QCPLayoutElement::maximumSizeHint() const
  1725. {
  1726. return mMaximumSize;
  1727. }
  1728. /*!
  1729. Returns a list of all child elements in this layout element. If \a recursive is true, all
  1730. sub-child elements are included in the list, too.
  1731. Note that there may be entries with value 0 in the returned list. (For example, QCPLayoutGrid may have
  1732. empty cells which yield 0 at the respective index.)
  1733. */
  1734. QList<QCPLayoutElement*> QCPLayoutElement::elements(bool recursive) const
  1735. {
  1736. Q_UNUSED(recursive)
  1737. return QList<QCPLayoutElement*>();
  1738. }
  1739. /*!
  1740. Layout elements are sensitive to events inside their outer rect. If \a pos is within the outer
  1741. rect, this method returns a value corresponding to 0.99 times the parent plot's selection
  1742. tolerance. However, layout elements are not selectable by default. So if \a onlySelectable is
  1743. true, -1.0 is returned.
  1744. See \ref QCPLayerable::selectTest for a general explanation of this virtual method.
  1745. QCPLayoutElement subclasses may reimplement this method to provide more specific selection test
  1746. behaviour.
  1747. */
  1748. double QCPLayoutElement::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  1749. {
  1750. Q_UNUSED(details)
  1751. if (onlySelectable)
  1752. return -1;
  1753. if (QRectF(mOuterRect).contains(pos))
  1754. {
  1755. if (mParentPlot)
  1756. return mParentPlot->selectionTolerance()*0.99;
  1757. else
  1758. {
  1759. qDebug() << Q_FUNC_INFO << "parent plot not defined";
  1760. return -1;
  1761. }
  1762. } else
  1763. return -1;
  1764. }
  1765. /*! \internal
  1766. propagates the parent plot initialization to all child elements, by calling \ref
  1767. QCPLayerable::initializeParentPlot on them.
  1768. */
  1769. void QCPLayoutElement::parentPlotInitialized(QCustomPlot *parentPlot)
  1770. {
  1771. QList<QCPLayoutElement*> els = elements(false);
  1772. for (int i=0; i<els.size(); ++i)
  1773. {
  1774. if (!els.at(i)->parentPlot())
  1775. els.at(i)->initializeParentPlot(parentPlot);
  1776. }
  1777. }
  1778. /*! \internal
  1779. Returns the margin size for this \a side. It is used if automatic margins is enabled for this \a
  1780. side (see \ref setAutoMargins). If a minimum margin was set with \ref setMinimumMargins, the
  1781. returned value will not be smaller than the specified minimum margin.
  1782. The default implementation just returns the respective manual margin (\ref setMargins) or the
  1783. minimum margin, whichever is larger.
  1784. */
  1785. int QCPLayoutElement::calculateAutoMargin(QCP::MarginSide side)
  1786. {
  1787. return qMax(QCP::getMarginValue(mMargins, side), QCP::getMarginValue(mMinimumMargins, side));
  1788. }
  1789. ////////////////////////////////////////////////////////////////////////////////////////////////////
  1790. //////////////////// QCPLayout
  1791. ////////////////////////////////////////////////////////////////////////////////////////////////////
  1792. /*! \class QCPLayout
  1793. \brief The abstract base class for layouts
  1794. This is an abstract base class for layout elements whose main purpose is to define the position
  1795. and size of other child layout elements. In most cases, layouts don't draw anything themselves
  1796. (but there are exceptions to this, e.g. QCPLegend).
  1797. QCPLayout derives from QCPLayoutElement, and thus can itself be nested in other layouts.
  1798. QCPLayout introduces a common interface for accessing and manipulating the child elements. Those
  1799. functions are most notably \ref elementCount, \ref elementAt, \ref takeAt, \ref take, \ref
  1800. simplify, \ref removeAt, \ref remove and \ref clear. Individual subclasses may add more functions
  1801. to this interface which are more specialized to the form of the layout. For example, \ref
  1802. QCPLayoutGrid adds functions that take row and column indices to access cells of the layout grid
  1803. more conveniently.
  1804. Since this is an abstract base class, you can't instantiate it directly. Rather use one of its
  1805. subclasses like QCPLayoutGrid or QCPLayoutInset.
  1806. For a general introduction to the layout system, see the dedicated documentation page \ref
  1807. thelayoutsystem "The Layout System".
  1808. */
  1809. /* start documentation of pure virtual functions */
  1810. /*! \fn virtual int QCPLayout::elementCount() const = 0
  1811. Returns the number of elements/cells in the layout.
  1812. \see elements, elementAt
  1813. */
  1814. /*! \fn virtual QCPLayoutElement* QCPLayout::elementAt(int index) const = 0
  1815. Returns the element in the cell with the given \a index. If \a index is invalid, returns 0.
  1816. Note that even if \a index is valid, the respective cell may be empty in some layouts (e.g.
  1817. QCPLayoutGrid), so this function may return 0 in those cases. You may use this function to check
  1818. whether a cell is empty or not.
  1819. \see elements, elementCount, takeAt
  1820. */
  1821. /*! \fn virtual QCPLayoutElement* QCPLayout::takeAt(int index) = 0
  1822. Removes the element with the given \a index from the layout and returns it.
  1823. If the \a index is invalid or the cell with that index is empty, returns 0.
  1824. Note that some layouts don't remove the respective cell right away but leave an empty cell after
  1825. successful removal of the layout element. To collapse empty cells, use \ref simplify.
  1826. \see elementAt, take
  1827. */
  1828. /*! \fn virtual bool QCPLayout::take(QCPLayoutElement* element) = 0
  1829. Removes the specified \a element from the layout and returns true on success.
  1830. If the \a element isn't in this layout, returns false.
  1831. Note that some layouts don't remove the respective cell right away but leave an empty cell after
  1832. successful removal of the layout element. To collapse empty cells, use \ref simplify.
  1833. \see takeAt
  1834. */
  1835. /* end documentation of pure virtual functions */
  1836. /*!
  1837. Creates an instance of QCPLayoutElement and sets default values. Note that since QCPLayoutElement
  1838. is an abstract base class, it can't be instantiated directly.
  1839. */
  1840. QCPLayout::QCPLayout()
  1841. {
  1842. }
  1843. /*!
  1844. First calls the QCPLayoutElement::update base class implementation to update the margins on this
  1845. layout.
  1846. Then calls \ref updateLayout which subclasses reimplement to reposition and resize their cells.
  1847. Finally, \ref update is called on all child elements.
  1848. */
  1849. void QCPLayout::update()
  1850. {
  1851. QCPLayoutElement::update(); // recalculates (auto-)margins
  1852. // set child element rects according to layout:
  1853. updateLayout();
  1854. // propagate update call to child elements:
  1855. for (int i=0; i<elementCount(); ++i)
  1856. {
  1857. if (QCPLayoutElement *el = elementAt(i))
  1858. el->update();
  1859. }
  1860. }
  1861. /* inherits documentation from base class */
  1862. QList<QCPLayoutElement*> QCPLayout::elements(bool recursive) const
  1863. {
  1864. int c = elementCount();
  1865. QList<QCPLayoutElement*> result;
  1866. #if QT_VERSION >= QT_VERSION_CHECK(4, 7, 0)
  1867. result.reserve(c);
  1868. #endif
  1869. for (int i=0; i<c; ++i)
  1870. result.append(elementAt(i));
  1871. if (recursive)
  1872. {
  1873. for (int i=0; i<c; ++i)
  1874. {
  1875. if (result.at(i))
  1876. result << result.at(i)->elements(recursive);
  1877. }
  1878. }
  1879. return result;
  1880. }
  1881. /*!
  1882. Simplifies the layout by collapsing empty cells. The exact behavior depends on subclasses, the
  1883. default implementation does nothing.
  1884. Not all layouts need simplification. For example, QCPLayoutInset doesn't use explicit
  1885. simplification while QCPLayoutGrid does.
  1886. */
  1887. void QCPLayout::simplify()
  1888. {
  1889. }
  1890. /*!
  1891. Removes and deletes the element at the provided \a index. Returns true on success. If \a index is
  1892. invalid or points to an empty cell, returns false.
  1893. This function internally uses \ref takeAt to remove the element from the layout and then deletes
  1894. the returned element.
  1895. \see remove, takeAt
  1896. */
  1897. bool QCPLayout::removeAt(int index)
  1898. {
  1899. if (QCPLayoutElement *el = takeAt(index))
  1900. {
  1901. delete el;
  1902. return true;
  1903. } else
  1904. return false;
  1905. }
  1906. /*!
  1907. Removes and deletes the provided \a element. Returns true on success. If \a element is not in the
  1908. layout, returns false.
  1909. This function internally uses \ref takeAt to remove the element from the layout and then deletes
  1910. the element.
  1911. \see removeAt, take
  1912. */
  1913. bool QCPLayout::remove(QCPLayoutElement *element)
  1914. {
  1915. if (take(element))
  1916. {
  1917. delete element;
  1918. return true;
  1919. } else
  1920. return false;
  1921. }
  1922. /*!
  1923. Removes and deletes all layout elements in this layout.
  1924. \see remove, removeAt
  1925. */
  1926. void QCPLayout::clear()
  1927. {
  1928. for (int i=elementCount()-1; i>=0; --i)
  1929. {
  1930. if (elementAt(i))
  1931. removeAt(i);
  1932. }
  1933. simplify();
  1934. }
  1935. /*!
  1936. Subclasses call this method to report changed (minimum/maximum) size constraints.
  1937. If the parent of this layout is again a QCPLayout, forwards the call to the parent's \ref
  1938. sizeConstraintsChanged. If the parent is a QWidget (i.e. is the \ref QCustomPlot::plotLayout of
  1939. QCustomPlot), calls QWidget::updateGeometry, so if the QCustomPlot widget is inside a Qt QLayout,
  1940. it may update itself and resize cells accordingly.
  1941. */
  1942. void QCPLayout::sizeConstraintsChanged() const
  1943. {
  1944. if (QWidget *w = qobject_cast<QWidget*>(parent()))
  1945. w->updateGeometry();
  1946. else if (QCPLayout *l = qobject_cast<QCPLayout*>(parent()))
  1947. l->sizeConstraintsChanged();
  1948. }
  1949. /*! \internal
  1950. Subclasses reimplement this method to update the position and sizes of the child elements/cells
  1951. via calling their \ref QCPLayoutElement::setOuterRect. The default implementation does nothing.
  1952. The geometry used as a reference is the inner \ref rect of this layout. Child elements should stay
  1953. within that rect.
  1954. \ref getSectionSizes may help with the reimplementation of this function.
  1955. \see update
  1956. */
  1957. void QCPLayout::updateLayout()
  1958. {
  1959. }
  1960. /*! \internal
  1961. Associates \a el with this layout. This is done by setting the \ref QCPLayoutElement::layout, the
  1962. \ref QCPLayerable::parentLayerable and the QObject parent to this layout.
  1963. Further, if \a el didn't previously have a parent plot, calls \ref
  1964. QCPLayerable::initializeParentPlot on \a el to set the paret plot.
  1965. This method is used by subclass specific methods that add elements to the layout. Note that this
  1966. method only changes properties in \a el. The removal from the old layout and the insertion into
  1967. the new layout must be done additionally.
  1968. */
  1969. void QCPLayout::adoptElement(QCPLayoutElement *el)
  1970. {
  1971. if (el)
  1972. {
  1973. el->mParentLayout = this;
  1974. el->setParentLayerable(this);
  1975. el->setParent(this);
  1976. if (!el->parentPlot())
  1977. el->initializeParentPlot(mParentPlot);
  1978. } else
  1979. qDebug() << Q_FUNC_INFO << "Null element passed";
  1980. }
  1981. /*! \internal
  1982. Disassociates \a el from this layout. This is done by setting the \ref QCPLayoutElement::layout
  1983. and the \ref QCPLayerable::parentLayerable to zero. The QObject parent is set to the parent
  1984. QCustomPlot.
  1985. This method is used by subclass specific methods that remove elements from the layout (e.g. \ref
  1986. take or \ref takeAt). Note that this method only changes properties in \a el. The removal from
  1987. the old layout must be done additionally.
  1988. */
  1989. void QCPLayout::releaseElement(QCPLayoutElement *el)
  1990. {
  1991. if (el)
  1992. {
  1993. el->mParentLayout = 0;
  1994. el->setParentLayerable(0);
  1995. el->setParent(mParentPlot);
  1996. // Note: Don't initializeParentPlot(0) here, because layout element will stay in same parent plot
  1997. } else
  1998. qDebug() << Q_FUNC_INFO << "Null element passed";
  1999. }
  2000. /*! \internal
  2001. This is a helper function for the implementation of \ref updateLayout in subclasses.
  2002. It calculates the sizes of one-dimensional sections with provided constraints on maximum section
  2003. sizes, minimum section sizes, relative stretch factors and the final total size of all sections.
  2004. The QVector entries refer to the sections. Thus all QVectors must have the same size.
  2005. \a maxSizes gives the maximum allowed size of each section. If there shall be no maximum size
  2006. imposed, set all vector values to Qt's QWIDGETSIZE_MAX.
  2007. \a minSizes gives the minimum allowed size of each section. If there shall be no minimum size
  2008. imposed, set all vector values to zero. If the \a minSizes entries add up to a value greater than
  2009. \a totalSize, sections will be scaled smaller than the proposed minimum sizes. (In other words,
  2010. not exceeding the allowed total size is taken to be more important than not going below minimum
  2011. section sizes.)
  2012. \a stretchFactors give the relative proportions of the sections to each other. If all sections
  2013. shall be scaled equally, set all values equal. If the first section shall be double the size of
  2014. each individual other section, set the first number of \a stretchFactors to double the value of
  2015. the other individual values (e.g. {2, 1, 1, 1}).
  2016. \a totalSize is the value that the final section sizes will add up to. Due to rounding, the
  2017. actual sum may differ slightly. If you want the section sizes to sum up to exactly that value,
  2018. you could distribute the remaining difference on the sections.
  2019. The return value is a QVector containing the section sizes.
  2020. */
  2021. QVector<int> QCPLayout::getSectionSizes(QVector<int> maxSizes, QVector<int> minSizes, QVector<double> stretchFactors, int totalSize) const
  2022. {
  2023. if (maxSizes.size() != minSizes.size() || minSizes.size() != stretchFactors.size())
  2024. {
  2025. qDebug() << Q_FUNC_INFO << "Passed vector sizes aren't equal:" << maxSizes << minSizes << stretchFactors;
  2026. return QVector<int>();
  2027. }
  2028. if (stretchFactors.isEmpty())
  2029. return QVector<int>();
  2030. int sectionCount = stretchFactors.size();
  2031. QVector<double> sectionSizes(sectionCount);
  2032. // if provided total size is forced smaller than total minimum size, ignore minimum sizes (squeeze sections):
  2033. int minSizeSum = 0;
  2034. for (int i=0; i<sectionCount; ++i)
  2035. minSizeSum += minSizes.at(i);
  2036. if (totalSize < minSizeSum)
  2037. {
  2038. // new stretch factors are minimum sizes and minimum sizes are set to zero:
  2039. for (int i=0; i<sectionCount; ++i)
  2040. {
  2041. stretchFactors[i] = minSizes.at(i);
  2042. minSizes[i] = 0;
  2043. }
  2044. }
  2045. QList<int> minimumLockedSections;
  2046. QList<int> unfinishedSections;
  2047. for (int i=0; i<sectionCount; ++i)
  2048. unfinishedSections.append(i);
  2049. double freeSize = totalSize;
  2050. int outerIterations = 0;
  2051. while (!unfinishedSections.isEmpty() && outerIterations < sectionCount*2) // the iteration check ist just a failsafe in case something really strange happens
  2052. {
  2053. ++outerIterations;
  2054. int innerIterations = 0;
  2055. while (!unfinishedSections.isEmpty() && innerIterations < sectionCount*2) // the iteration check ist just a failsafe in case something really strange happens
  2056. {
  2057. ++innerIterations;
  2058. // find section that hits its maximum next:
  2059. int nextId = -1;
  2060. double nextMax = 1e12;
  2061. for (int i=0; i<unfinishedSections.size(); ++i)
  2062. {
  2063. int secId = unfinishedSections.at(i);
  2064. double hitsMaxAt = (maxSizes.at(secId)-sectionSizes.at(secId))/stretchFactors.at(secId);
  2065. if (hitsMaxAt < nextMax)
  2066. {
  2067. nextMax = hitsMaxAt;
  2068. nextId = secId;
  2069. }
  2070. }
  2071. // check if that maximum is actually within the bounds of the total size (i.e. can we stretch all remaining sections so far that the found section
  2072. // actually hits its maximum, without exceeding the total size when we add up all sections)
  2073. double stretchFactorSum = 0;
  2074. for (int i=0; i<unfinishedSections.size(); ++i)
  2075. stretchFactorSum += stretchFactors.at(unfinishedSections.at(i));
  2076. double nextMaxLimit = freeSize/stretchFactorSum;
  2077. if (nextMax < nextMaxLimit) // next maximum is actually hit, move forward to that point and fix the size of that section
  2078. {
  2079. for (int i=0; i<unfinishedSections.size(); ++i)
  2080. {
  2081. sectionSizes[unfinishedSections.at(i)] += nextMax*stretchFactors.at(unfinishedSections.at(i)); // increment all sections
  2082. freeSize -= nextMax*stretchFactors.at(unfinishedSections.at(i));
  2083. }
  2084. unfinishedSections.removeOne(nextId); // exclude the section that is now at maximum from further changes
  2085. } else // next maximum isn't hit, just distribute rest of free space on remaining sections
  2086. {
  2087. for (int i=0; i<unfinishedSections.size(); ++i)
  2088. sectionSizes[unfinishedSections.at(i)] += nextMaxLimit*stretchFactors.at(unfinishedSections.at(i)); // increment all sections
  2089. unfinishedSections.clear();
  2090. }
  2091. }
  2092. if (innerIterations == sectionCount*2)
  2093. qDebug() << Q_FUNC_INFO << "Exceeded maximum expected inner iteration count, layouting aborted. Input was:" << maxSizes << minSizes << stretchFactors << totalSize;
  2094. // now check whether the resulting section sizes violate minimum restrictions:
  2095. bool foundMinimumViolation = false;
  2096. for (int i=0; i<sectionSizes.size(); ++i)
  2097. {
  2098. if (minimumLockedSections.contains(i))
  2099. continue;
  2100. if (sectionSizes.at(i) < minSizes.at(i)) // section violates minimum
  2101. {
  2102. sectionSizes[i] = minSizes.at(i); // set it to minimum
  2103. foundMinimumViolation = true; // make sure we repeat the whole optimization process
  2104. minimumLockedSections.append(i);
  2105. }
  2106. }
  2107. if (foundMinimumViolation)
  2108. {
  2109. freeSize = totalSize;
  2110. for (int i=0; i<sectionCount; ++i)
  2111. {
  2112. if (!minimumLockedSections.contains(i)) // only put sections that haven't hit their minimum back into the pool
  2113. unfinishedSections.append(i);
  2114. else
  2115. freeSize -= sectionSizes.at(i); // remove size of minimum locked sections from available space in next round
  2116. }
  2117. // reset all section sizes to zero that are in unfinished sections (all others have been set to their minimum):
  2118. for (int i=0; i<unfinishedSections.size(); ++i)
  2119. sectionSizes[unfinishedSections.at(i)] = 0;
  2120. }
  2121. }
  2122. if (outerIterations == sectionCount*2)
  2123. qDebug() << Q_FUNC_INFO << "Exceeded maximum expected outer iteration count, layouting aborted. Input was:" << maxSizes << minSizes << stretchFactors << totalSize;
  2124. QVector<int> result(sectionCount);
  2125. for (int i=0; i<sectionCount; ++i)
  2126. result[i] = qRound(sectionSizes.at(i));
  2127. return result;
  2128. }
  2129. ////////////////////////////////////////////////////////////////////////////////////////////////////
  2130. //////////////////// QCPLayoutGrid
  2131. ////////////////////////////////////////////////////////////////////////////////////////////////////
  2132. /*! \class QCPLayoutGrid
  2133. \brief A layout that arranges child elements in a grid
  2134. Elements are laid out in a grid with configurable stretch factors (\ref setColumnStretchFactor,
  2135. \ref setRowStretchFactor) and spacing (\ref setColumnSpacing, \ref setRowSpacing).
  2136. Elements can be added to cells via \ref addElement. The grid is expanded if the specified row or
  2137. column doesn't exist yet. Whether a cell contains a valid layout element can be checked with \ref
  2138. hasElement, that element can be retrieved with \ref element. If rows and columns that only have
  2139. empty cells shall be removed, call \ref simplify. Removal of elements is either done by just
  2140. adding the element to a different layout or by using the QCPLayout interface \ref take or \ref
  2141. remove.
  2142. Row and column insertion can be performed with \ref insertRow and \ref insertColumn.
  2143. */
  2144. /*!
  2145. Creates an instance of QCPLayoutGrid and sets default values.
  2146. */
  2147. QCPLayoutGrid::QCPLayoutGrid() :
  2148. mColumnSpacing(5),
  2149. mRowSpacing(5)
  2150. {
  2151. }
  2152. QCPLayoutGrid::~QCPLayoutGrid()
  2153. {
  2154. // clear all child layout elements. This is important because only the specific layouts know how
  2155. // to handle removing elements (clear calls virtual removeAt method to do that).
  2156. clear();
  2157. }
  2158. /*!
  2159. Returns the element in the cell in \a row and \a column.
  2160. Returns 0 if either the row/column is invalid or if the cell is empty. In those cases, a qDebug
  2161. message is printed. To check whether a cell exists and isn't empty, use \ref hasElement.
  2162. \see addElement, hasElement
  2163. */
  2164. QCPLayoutElement *QCPLayoutGrid::element(int row, int column) const
  2165. {
  2166. if (row >= 0 && row < mElements.size())
  2167. {
  2168. if (column >= 0 && column < mElements.first().size())
  2169. {
  2170. if (QCPLayoutElement *result = mElements.at(row).at(column))
  2171. return result;
  2172. else
  2173. qDebug() << Q_FUNC_INFO << "Requested cell is empty. Row:" << row << "Column:" << column;
  2174. } else
  2175. qDebug() << Q_FUNC_INFO << "Invalid column. Row:" << row << "Column:" << column;
  2176. } else
  2177. qDebug() << Q_FUNC_INFO << "Invalid row. Row:" << row << "Column:" << column;
  2178. return 0;
  2179. }
  2180. /*!
  2181. Returns the number of rows in the layout.
  2182. \see columnCount
  2183. */
  2184. int QCPLayoutGrid::rowCount() const
  2185. {
  2186. return mElements.size();
  2187. }
  2188. /*!
  2189. Returns the number of columns in the layout.
  2190. \see rowCount
  2191. */
  2192. int QCPLayoutGrid::columnCount() const
  2193. {
  2194. if (mElements.size() > 0)
  2195. return mElements.first().size();
  2196. else
  2197. return 0;
  2198. }
  2199. /*!
  2200. Adds the \a element to cell with \a row and \a column. If \a element is already in a layout, it
  2201. is first removed from there. If \a row or \a column don't exist yet, the layout is expanded
  2202. accordingly.
  2203. Returns true if the element was added successfully, i.e. if the cell at \a row and \a column
  2204. didn't already have an element.
  2205. \see element, hasElement, take, remove
  2206. */
  2207. bool QCPLayoutGrid::addElement(int row, int column, QCPLayoutElement *element)
  2208. {
  2209. if (element)
  2210. {
  2211. if (!hasElement(row, column))
  2212. {
  2213. if (element->layout()) // remove from old layout first
  2214. element->layout()->take(element);
  2215. expandTo(row+1, column+1);
  2216. mElements[row][column] = element;
  2217. adoptElement(element);
  2218. return true;
  2219. } else
  2220. qDebug() << Q_FUNC_INFO << "There is already an element in the specified row/column:" << row << column;
  2221. } else
  2222. qDebug() << Q_FUNC_INFO << "Can't add null element to row/column:" << row << column;
  2223. return false;
  2224. }
  2225. /*!
  2226. Returns whether the cell at \a row and \a column exists and contains a valid element, i.e. isn't
  2227. empty.
  2228. \see element
  2229. */
  2230. bool QCPLayoutGrid::hasElement(int row, int column)
  2231. {
  2232. if (row >= 0 && row < rowCount() && column >= 0 && column < columnCount())
  2233. return mElements.at(row).at(column);
  2234. else
  2235. return false;
  2236. }
  2237. /*!
  2238. Sets the stretch \a factor of \a column.
  2239. Stretch factors control the relative sizes of rows and columns. Cells will not be resized beyond
  2240. their minimum and maximum widths/heights (\ref QCPLayoutElement::setMinimumSize, \ref
  2241. QCPLayoutElement::setMaximumSize), regardless of the stretch factor.
  2242. The default stretch factor of newly created rows/columns is 1.
  2243. \see setColumnStretchFactors, setRowStretchFactor
  2244. */
  2245. void QCPLayoutGrid::setColumnStretchFactor(int column, double factor)
  2246. {
  2247. if (column >= 0 && column < columnCount())
  2248. {
  2249. if (factor > 0)
  2250. mColumnStretchFactors[column] = factor;
  2251. else
  2252. qDebug() << Q_FUNC_INFO << "Invalid stretch factor, must be positive:" << factor;
  2253. } else
  2254. qDebug() << Q_FUNC_INFO << "Invalid column:" << column;
  2255. }
  2256. /*!
  2257. Sets the stretch \a factors of all columns. \a factors must have the size \ref columnCount.
  2258. Stretch factors control the relative sizes of rows and columns. Cells will not be resized beyond
  2259. their minimum and maximum widths/heights (\ref QCPLayoutElement::setMinimumSize, \ref
  2260. QCPLayoutElement::setMaximumSize), regardless of the stretch factor.
  2261. The default stretch factor of newly created rows/columns is 1.
  2262. \see setColumnStretchFactor, setRowStretchFactors
  2263. */
  2264. void QCPLayoutGrid::setColumnStretchFactors(const QList<double> &factors)
  2265. {
  2266. if (factors.size() == mColumnStretchFactors.size())
  2267. {
  2268. mColumnStretchFactors = factors;
  2269. for (int i=0; i<mColumnStretchFactors.size(); ++i)
  2270. {
  2271. if (mColumnStretchFactors.at(i) <= 0)
  2272. {
  2273. qDebug() << Q_FUNC_INFO << "Invalid stretch factor, must be positive:" << mColumnStretchFactors.at(i);
  2274. mColumnStretchFactors[i] = 1;
  2275. }
  2276. }
  2277. } else
  2278. qDebug() << Q_FUNC_INFO << "Column count not equal to passed stretch factor count:" << factors;
  2279. }
  2280. /*!
  2281. Sets the stretch \a factor of \a row.
  2282. Stretch factors control the relative sizes of rows and columns. Cells will not be resized beyond
  2283. their minimum and maximum widths/heights (\ref QCPLayoutElement::setMinimumSize, \ref
  2284. QCPLayoutElement::setMaximumSize), regardless of the stretch factor.
  2285. The default stretch factor of newly created rows/columns is 1.
  2286. \see setColumnStretchFactors, setRowStretchFactor
  2287. */
  2288. void QCPLayoutGrid::setRowStretchFactor(int row, double factor)
  2289. {
  2290. if (row >= 0 && row < rowCount())
  2291. {
  2292. if (factor > 0)
  2293. mRowStretchFactors[row] = factor;
  2294. else
  2295. qDebug() << Q_FUNC_INFO << "Invalid stretch factor, must be positive:" << factor;
  2296. } else
  2297. qDebug() << Q_FUNC_INFO << "Invalid row:" << row;
  2298. }
  2299. /*!
  2300. Sets the stretch \a factors of all rows. \a factors must have the size \ref rowCount.
  2301. Stretch factors control the relative sizes of rows and columns. Cells will not be resized beyond
  2302. their minimum and maximum widths/heights (\ref QCPLayoutElement::setMinimumSize, \ref
  2303. QCPLayoutElement::setMaximumSize), regardless of the stretch factor.
  2304. The default stretch factor of newly created rows/columns is 1.
  2305. \see setRowStretchFactor, setColumnStretchFactors
  2306. */
  2307. void QCPLayoutGrid::setRowStretchFactors(const QList<double> &factors)
  2308. {
  2309. if (factors.size() == mRowStretchFactors.size())
  2310. {
  2311. mRowStretchFactors = factors;
  2312. for (int i=0; i<mRowStretchFactors.size(); ++i)
  2313. {
  2314. if (mRowStretchFactors.at(i) <= 0)
  2315. {
  2316. qDebug() << Q_FUNC_INFO << "Invalid stretch factor, must be positive:" << mRowStretchFactors.at(i);
  2317. mRowStretchFactors[i] = 1;
  2318. }
  2319. }
  2320. } else
  2321. qDebug() << Q_FUNC_INFO << "Row count not equal to passed stretch factor count:" << factors;
  2322. }
  2323. /*!
  2324. Sets the gap that is left blank between columns to \a pixels.
  2325. \see setRowSpacing
  2326. */
  2327. void QCPLayoutGrid::setColumnSpacing(int pixels)
  2328. {
  2329. mColumnSpacing = pixels;
  2330. }
  2331. /*!
  2332. Sets the gap that is left blank between rows to \a pixels.
  2333. \see setColumnSpacing
  2334. */
  2335. void QCPLayoutGrid::setRowSpacing(int pixels)
  2336. {
  2337. mRowSpacing = pixels;
  2338. }
  2339. /*!
  2340. Expands the layout to have \a newRowCount rows and \a newColumnCount columns. So the last valid
  2341. row index will be \a newRowCount-1, the last valid column index will be \a newColumnCount-1.
  2342. If the current column/row count is already larger or equal to \a newColumnCount/\a newRowCount,
  2343. this function does nothing in that dimension.
  2344. Newly created cells are empty, new rows and columns have the stretch factor 1.
  2345. Note that upon a call to \ref addElement, the layout is expanded automatically to contain the
  2346. specified row and column, using this function.
  2347. \see simplify
  2348. */
  2349. void QCPLayoutGrid::expandTo(int newRowCount, int newColumnCount)
  2350. {
  2351. // add rows as necessary:
  2352. while (rowCount() < newRowCount)
  2353. {
  2354. mElements.append(QList<QCPLayoutElement*>());
  2355. mRowStretchFactors.append(1);
  2356. }
  2357. // go through rows and expand columns as necessary:
  2358. int newColCount = qMax(columnCount(), newColumnCount);
  2359. for (int i=0; i<rowCount(); ++i)
  2360. {
  2361. while (mElements.at(i).size() < newColCount)
  2362. mElements[i].append(0);
  2363. }
  2364. while (mColumnStretchFactors.size() < newColCount)
  2365. mColumnStretchFactors.append(1);
  2366. }
  2367. /*!
  2368. Inserts a new row with empty cells at the row index \a newIndex. Valid values for \a newIndex
  2369. range from 0 (inserts a row at the top) to \a rowCount (appends a row at the bottom).
  2370. \see insertColumn
  2371. */
  2372. void QCPLayoutGrid::insertRow(int newIndex)
  2373. {
  2374. if (mElements.isEmpty() || mElements.first().isEmpty()) // if grid is completely empty, add first cell
  2375. {
  2376. expandTo(1, 1);
  2377. return;
  2378. }
  2379. if (newIndex < 0)
  2380. newIndex = 0;
  2381. if (newIndex > rowCount())
  2382. newIndex = rowCount();
  2383. mRowStretchFactors.insert(newIndex, 1);
  2384. QList<QCPLayoutElement*> newRow;
  2385. for (int col=0; col<columnCount(); ++col)
  2386. newRow.append((QCPLayoutElement*)0);
  2387. mElements.insert(newIndex, newRow);
  2388. }
  2389. /*!
  2390. Inserts a new column with empty cells at the column index \a newIndex. Valid values for \a
  2391. newIndex range from 0 (inserts a row at the left) to \a rowCount (appends a row at the right).
  2392. \see insertRow
  2393. */
  2394. void QCPLayoutGrid::insertColumn(int newIndex)
  2395. {
  2396. if (mElements.isEmpty() || mElements.first().isEmpty()) // if grid is completely empty, add first cell
  2397. {
  2398. expandTo(1, 1);
  2399. return;
  2400. }
  2401. if (newIndex < 0)
  2402. newIndex = 0;
  2403. if (newIndex > columnCount())
  2404. newIndex = columnCount();
  2405. mColumnStretchFactors.insert(newIndex, 1);
  2406. for (int row=0; row<rowCount(); ++row)
  2407. mElements[row].insert(newIndex, (QCPLayoutElement*)0);
  2408. }
  2409. /* inherits documentation from base class */
  2410. void QCPLayoutGrid::updateLayout()
  2411. {
  2412. QVector<int> minColWidths, minRowHeights, maxColWidths, maxRowHeights;
  2413. getMinimumRowColSizes(&minColWidths, &minRowHeights);
  2414. getMaximumRowColSizes(&maxColWidths, &maxRowHeights);
  2415. int totalRowSpacing = (rowCount()-1) * mRowSpacing;
  2416. int totalColSpacing = (columnCount()-1) * mColumnSpacing;
  2417. QVector<int> colWidths = getSectionSizes(maxColWidths, minColWidths, mColumnStretchFactors.toVector(), mRect.width()-totalColSpacing);
  2418. QVector<int> rowHeights = getSectionSizes(maxRowHeights, minRowHeights, mRowStretchFactors.toVector(), mRect.height()-totalRowSpacing);
  2419. // go through cells and set rects accordingly:
  2420. int yOffset = mRect.top();
  2421. for (int row=0; row<rowCount(); ++row)
  2422. {
  2423. if (row > 0)
  2424. yOffset += rowHeights.at(row-1)+mRowSpacing;
  2425. int xOffset = mRect.left();
  2426. for (int col=0; col<columnCount(); ++col)
  2427. {
  2428. if (col > 0)
  2429. xOffset += colWidths.at(col-1)+mColumnSpacing;
  2430. if (mElements.at(row).at(col))
  2431. mElements.at(row).at(col)->setOuterRect(QRect(xOffset, yOffset, colWidths.at(col), rowHeights.at(row)));
  2432. }
  2433. }
  2434. }
  2435. /* inherits documentation from base class */
  2436. int QCPLayoutGrid::elementCount() const
  2437. {
  2438. return rowCount()*columnCount();
  2439. }
  2440. /* inherits documentation from base class */
  2441. QCPLayoutElement *QCPLayoutGrid::elementAt(int index) const
  2442. {
  2443. if (index >= 0 && index < elementCount())
  2444. return mElements.at(index / columnCount()).at(index % columnCount());
  2445. else
  2446. return 0;
  2447. }
  2448. /* inherits documentation from base class */
  2449. QCPLayoutElement *QCPLayoutGrid::takeAt(int index)
  2450. {
  2451. if (QCPLayoutElement *el = elementAt(index))
  2452. {
  2453. releaseElement(el);
  2454. mElements[index / columnCount()][index % columnCount()] = 0;
  2455. return el;
  2456. } else
  2457. {
  2458. qDebug() << Q_FUNC_INFO << "Attempt to take invalid index:" << index;
  2459. return 0;
  2460. }
  2461. }
  2462. /* inherits documentation from base class */
  2463. bool QCPLayoutGrid::take(QCPLayoutElement *element)
  2464. {
  2465. if (element)
  2466. {
  2467. for (int i=0; i<elementCount(); ++i)
  2468. {
  2469. if (elementAt(i) == element)
  2470. {
  2471. takeAt(i);
  2472. return true;
  2473. }
  2474. }
  2475. qDebug() << Q_FUNC_INFO << "Element not in this layout, couldn't take";
  2476. } else
  2477. qDebug() << Q_FUNC_INFO << "Can't take null element";
  2478. return false;
  2479. }
  2480. /* inherits documentation from base class */
  2481. QList<QCPLayoutElement*> QCPLayoutGrid::elements(bool recursive) const
  2482. {
  2483. QList<QCPLayoutElement*> result;
  2484. int colC = columnCount();
  2485. int rowC = rowCount();
  2486. #if QT_VERSION >= QT_VERSION_CHECK(4, 7, 0)
  2487. result.reserve(colC*rowC);
  2488. #endif
  2489. for (int row=0; row<rowC; ++row)
  2490. {
  2491. for (int col=0; col<colC; ++col)
  2492. {
  2493. result.append(mElements.at(row).at(col));
  2494. }
  2495. }
  2496. if (recursive)
  2497. {
  2498. int c = result.size();
  2499. for (int i=0; i<c; ++i)
  2500. {
  2501. if (result.at(i))
  2502. result << result.at(i)->elements(recursive);
  2503. }
  2504. }
  2505. return result;
  2506. }
  2507. /*!
  2508. Simplifies the layout by collapsing rows and columns which only contain empty cells.
  2509. */
  2510. void QCPLayoutGrid::simplify()
  2511. {
  2512. // remove rows with only empty cells:
  2513. for (int row=rowCount()-1; row>=0; --row)
  2514. {
  2515. bool hasElements = false;
  2516. for (int col=0; col<columnCount(); ++col)
  2517. {
  2518. if (mElements.at(row).at(col))
  2519. {
  2520. hasElements = true;
  2521. break;
  2522. }
  2523. }
  2524. if (!hasElements)
  2525. {
  2526. mRowStretchFactors.removeAt(row);
  2527. mElements.removeAt(row);
  2528. if (mElements.isEmpty()) // removed last element, also remove stretch factor (wouldn't happen below because also columnCount changed to 0 now)
  2529. mColumnStretchFactors.clear();
  2530. }
  2531. }
  2532. // remove columns with only empty cells:
  2533. for (int col=columnCount()-1; col>=0; --col)
  2534. {
  2535. bool hasElements = false;
  2536. for (int row=0; row<rowCount(); ++row)
  2537. {
  2538. if (mElements.at(row).at(col))
  2539. {
  2540. hasElements = true;
  2541. break;
  2542. }
  2543. }
  2544. if (!hasElements)
  2545. {
  2546. mColumnStretchFactors.removeAt(col);
  2547. for (int row=0; row<rowCount(); ++row)
  2548. mElements[row].removeAt(col);
  2549. }
  2550. }
  2551. }
  2552. /* inherits documentation from base class */
  2553. QSize QCPLayoutGrid::minimumSizeHint() const
  2554. {
  2555. QVector<int> minColWidths, minRowHeights;
  2556. getMinimumRowColSizes(&minColWidths, &minRowHeights);
  2557. QSize result(0, 0);
  2558. for (int i=0; i<minColWidths.size(); ++i)
  2559. result.rwidth() += minColWidths.at(i);
  2560. for (int i=0; i<minRowHeights.size(); ++i)
  2561. result.rheight() += minRowHeights.at(i);
  2562. result.rwidth() += qMax(0, columnCount()-1) * mColumnSpacing + mMargins.left() + mMargins.right();
  2563. result.rheight() += qMax(0, rowCount()-1) * mRowSpacing + mMargins.top() + mMargins.bottom();
  2564. return result;
  2565. }
  2566. /* inherits documentation from base class */
  2567. QSize QCPLayoutGrid::maximumSizeHint() const
  2568. {
  2569. QVector<int> maxColWidths, maxRowHeights;
  2570. getMaximumRowColSizes(&maxColWidths, &maxRowHeights);
  2571. QSize result(0, 0);
  2572. for (int i=0; i<maxColWidths.size(); ++i)
  2573. result.setWidth(qMin(result.width()+maxColWidths.at(i), QWIDGETSIZE_MAX));
  2574. for (int i=0; i<maxRowHeights.size(); ++i)
  2575. result.setHeight(qMin(result.height()+maxRowHeights.at(i), QWIDGETSIZE_MAX));
  2576. result.rwidth() += qMax(0, columnCount()-1) * mColumnSpacing + mMargins.left() + mMargins.right();
  2577. result.rheight() += qMax(0, rowCount()-1) * mRowSpacing + mMargins.top() + mMargins.bottom();
  2578. return result;
  2579. }
  2580. /*! \internal
  2581. Places the minimum column widths and row heights into \a minColWidths and \a minRowHeights
  2582. respectively.
  2583. The minimum height of a row is the largest minimum height of any element in that row. The minimum
  2584. width of a column is the largest minimum width of any element in that column.
  2585. This is a helper function for \ref updateLayout.
  2586. \see getMaximumRowColSizes
  2587. */
  2588. void QCPLayoutGrid::getMinimumRowColSizes(QVector<int> *minColWidths, QVector<int> *minRowHeights) const
  2589. {
  2590. *minColWidths = QVector<int>(columnCount(), 0);
  2591. *minRowHeights = QVector<int>(rowCount(), 0);
  2592. for (int row=0; row<rowCount(); ++row)
  2593. {
  2594. for (int col=0; col<columnCount(); ++col)
  2595. {
  2596. if (mElements.at(row).at(col))
  2597. {
  2598. QSize minHint = mElements.at(row).at(col)->minimumSizeHint();
  2599. QSize min = mElements.at(row).at(col)->minimumSize();
  2600. QSize final(min.width() > 0 ? min.width() : minHint.width(), min.height() > 0 ? min.height() : minHint.height());
  2601. if (minColWidths->at(col) < final.width())
  2602. (*minColWidths)[col] = final.width();
  2603. if (minRowHeights->at(row) < final.height())
  2604. (*minRowHeights)[row] = final.height();
  2605. }
  2606. }
  2607. }
  2608. }
  2609. /*! \internal
  2610. Places the maximum column widths and row heights into \a maxColWidths and \a maxRowHeights
  2611. respectively.
  2612. The maximum height of a row is the smallest maximum height of any element in that row. The
  2613. maximum width of a column is the smallest maximum width of any element in that column.
  2614. This is a helper function for \ref updateLayout.
  2615. \see getMinimumRowColSizes
  2616. */
  2617. void QCPLayoutGrid::getMaximumRowColSizes(QVector<int> *maxColWidths, QVector<int> *maxRowHeights) const
  2618. {
  2619. *maxColWidths = QVector<int>(columnCount(), QWIDGETSIZE_MAX);
  2620. *maxRowHeights = QVector<int>(rowCount(), QWIDGETSIZE_MAX);
  2621. for (int row=0; row<rowCount(); ++row)
  2622. {
  2623. for (int col=0; col<columnCount(); ++col)
  2624. {
  2625. if (mElements.at(row).at(col))
  2626. {
  2627. QSize maxHint = mElements.at(row).at(col)->maximumSizeHint();
  2628. QSize max = mElements.at(row).at(col)->maximumSize();
  2629. QSize final(max.width() < QWIDGETSIZE_MAX ? max.width() : maxHint.width(), max.height() < QWIDGETSIZE_MAX ? max.height() : maxHint.height());
  2630. if (maxColWidths->at(col) > final.width())
  2631. (*maxColWidths)[col] = final.width();
  2632. if (maxRowHeights->at(row) > final.height())
  2633. (*maxRowHeights)[row] = final.height();
  2634. }
  2635. }
  2636. }
  2637. }
  2638. ////////////////////////////////////////////////////////////////////////////////////////////////////
  2639. //////////////////// QCPLayoutInset
  2640. ////////////////////////////////////////////////////////////////////////////////////////////////////
  2641. /*! \class QCPLayoutInset
  2642. \brief A layout that places child elements aligned to the border or arbitrarily positioned
  2643. Elements are placed either aligned to the border or at arbitrary position in the area of the
  2644. layout. Which placement applies is controlled with the \ref InsetPlacement (\ref
  2645. setInsetPlacement).
  2646. Elements are added via \ref addElement(QCPLayoutElement *element, Qt::Alignment alignment) or
  2647. addElement(QCPLayoutElement *element, const QRectF &rect). If the first method is used, the inset
  2648. placement will default to \ref ipBorderAligned and the element will be aligned according to the
  2649. \a alignment parameter. The second method defaults to \ref ipFree and allows placing elements at
  2650. arbitrary position and size, defined by \a rect.
  2651. The alignment or rect can be set via \ref setInsetAlignment or \ref setInsetRect, respectively.
  2652. This is the layout that every QCPAxisRect has as \ref QCPAxisRect::insetLayout.
  2653. */
  2654. /* start documentation of inline functions */
  2655. /*! \fn virtual void QCPLayoutInset::simplify()
  2656. The QCPInsetLayout does not need simplification since it can never have empty cells due to its
  2657. linear index structure. This method does nothing.
  2658. */
  2659. /* end documentation of inline functions */
  2660. /*!
  2661. Creates an instance of QCPLayoutInset and sets default values.
  2662. */
  2663. QCPLayoutInset::QCPLayoutInset()
  2664. {
  2665. }
  2666. QCPLayoutInset::~QCPLayoutInset()
  2667. {
  2668. // clear all child layout elements. This is important because only the specific layouts know how
  2669. // to handle removing elements (clear calls virtual removeAt method to do that).
  2670. clear();
  2671. }
  2672. /*!
  2673. Returns the placement type of the element with the specified \a index.
  2674. */
  2675. QCPLayoutInset::InsetPlacement QCPLayoutInset::insetPlacement(int index) const
  2676. {
  2677. if (elementAt(index))
  2678. return mInsetPlacement.at(index);
  2679. else
  2680. {
  2681. qDebug() << Q_FUNC_INFO << "Invalid element index:" << index;
  2682. return ipFree;
  2683. }
  2684. }
  2685. /*!
  2686. Returns the alignment of the element with the specified \a index. The alignment only has a
  2687. meaning, if the inset placement (\ref setInsetPlacement) is \ref ipBorderAligned.
  2688. */
  2689. Qt::Alignment QCPLayoutInset::insetAlignment(int index) const
  2690. {
  2691. if (elementAt(index))
  2692. return mInsetAlignment.at(index);
  2693. else
  2694. {
  2695. qDebug() << Q_FUNC_INFO << "Invalid element index:" << index;
  2696. return 0;
  2697. }
  2698. }
  2699. /*!
  2700. Returns the rect of the element with the specified \a index. The rect only has a
  2701. meaning, if the inset placement (\ref setInsetPlacement) is \ref ipFree.
  2702. */
  2703. QRectF QCPLayoutInset::insetRect(int index) const
  2704. {
  2705. if (elementAt(index))
  2706. return mInsetRect.at(index);
  2707. else
  2708. {
  2709. qDebug() << Q_FUNC_INFO << "Invalid element index:" << index;
  2710. return QRectF();
  2711. }
  2712. }
  2713. /*!
  2714. Sets the inset placement type of the element with the specified \a index to \a placement.
  2715. \see InsetPlacement
  2716. */
  2717. void QCPLayoutInset::setInsetPlacement(int index, QCPLayoutInset::InsetPlacement placement)
  2718. {
  2719. if (elementAt(index))
  2720. mInsetPlacement[index] = placement;
  2721. else
  2722. qDebug() << Q_FUNC_INFO << "Invalid element index:" << index;
  2723. }
  2724. /*!
  2725. If the inset placement (\ref setInsetPlacement) is \ref ipBorderAligned, this function
  2726. is used to set the alignment of the element with the specified \a index to \a alignment.
  2727. \a alignment is an or combination of the following alignment flags: Qt::AlignLeft,
  2728. Qt::AlignHCenter, Qt::AlighRight, Qt::AlignTop, Qt::AlignVCenter, Qt::AlignBottom. Any other
  2729. alignment flags will be ignored.
  2730. */
  2731. void QCPLayoutInset::setInsetAlignment(int index, Qt::Alignment alignment)
  2732. {
  2733. if (elementAt(index))
  2734. mInsetAlignment[index] = alignment;
  2735. else
  2736. qDebug() << Q_FUNC_INFO << "Invalid element index:" << index;
  2737. }
  2738. /*!
  2739. If the inset placement (\ref setInsetPlacement) is \ref ipFree, this function is used to set the
  2740. position and size of the element with the specified \a index to \a rect.
  2741. \a rect is given in fractions of the whole inset layout rect. So an inset with rect (0, 0, 1, 1)
  2742. will span the entire layout. An inset with rect (0.6, 0.1, 0.35, 0.35) will be in the top right
  2743. corner of the layout, with 35% width and height of the parent layout.
  2744. Note that the minimum and maximum sizes of the embedded element (\ref
  2745. QCPLayoutElement::setMinimumSize, \ref QCPLayoutElement::setMaximumSize) are enforced.
  2746. */
  2747. void QCPLayoutInset::setInsetRect(int index, const QRectF &rect)
  2748. {
  2749. if (elementAt(index))
  2750. mInsetRect[index] = rect;
  2751. else
  2752. qDebug() << Q_FUNC_INFO << "Invalid element index:" << index;
  2753. }
  2754. /* inherits documentation from base class */
  2755. void QCPLayoutInset::updateLayout()
  2756. {
  2757. for (int i=0; i<mElements.size(); ++i)
  2758. {
  2759. QRect insetRect;
  2760. QSize finalMinSize, finalMaxSize;
  2761. QSize minSizeHint = mElements.at(i)->minimumSizeHint();
  2762. QSize maxSizeHint = mElements.at(i)->maximumSizeHint();
  2763. finalMinSize.setWidth(mElements.at(i)->minimumSize().width() > 0 ? mElements.at(i)->minimumSize().width() : minSizeHint.width());
  2764. finalMinSize.setHeight(mElements.at(i)->minimumSize().height() > 0 ? mElements.at(i)->minimumSize().height() : minSizeHint.height());
  2765. finalMaxSize.setWidth(mElements.at(i)->maximumSize().width() < QWIDGETSIZE_MAX ? mElements.at(i)->maximumSize().width() : maxSizeHint.width());
  2766. finalMaxSize.setHeight(mElements.at(i)->maximumSize().height() < QWIDGETSIZE_MAX ? mElements.at(i)->maximumSize().height() : maxSizeHint.height());
  2767. if (mInsetPlacement.at(i) == ipFree)
  2768. {
  2769. insetRect = QRect(rect().x()+rect().width()*mInsetRect.at(i).x(),
  2770. rect().y()+rect().height()*mInsetRect.at(i).y(),
  2771. rect().width()*mInsetRect.at(i).width(),
  2772. rect().height()*mInsetRect.at(i).height());
  2773. if (insetRect.size().width() < finalMinSize.width())
  2774. insetRect.setWidth(finalMinSize.width());
  2775. if (insetRect.size().height() < finalMinSize.height())
  2776. insetRect.setHeight(finalMinSize.height());
  2777. if (insetRect.size().width() > finalMaxSize.width())
  2778. insetRect.setWidth(finalMaxSize.width());
  2779. if (insetRect.size().height() > finalMaxSize.height())
  2780. insetRect.setHeight(finalMaxSize.height());
  2781. } else if (mInsetPlacement.at(i) == ipBorderAligned)
  2782. {
  2783. insetRect.setSize(finalMinSize);
  2784. Qt::Alignment al = mInsetAlignment.at(i);
  2785. if (al.testFlag(Qt::AlignLeft)) insetRect.moveLeft(rect().x());
  2786. else if (al.testFlag(Qt::AlignRight)) insetRect.moveRight(rect().x()+rect().width());
  2787. else insetRect.moveLeft(rect().x()+rect().width()*0.5-finalMinSize.width()*0.5); // default to Qt::AlignHCenter
  2788. if (al.testFlag(Qt::AlignTop)) insetRect.moveTop(rect().y());
  2789. else if (al.testFlag(Qt::AlignBottom)) insetRect.moveBottom(rect().y()+rect().height());
  2790. else insetRect.moveTop(rect().y()+rect().height()*0.5-finalMinSize.height()*0.5); // default to Qt::AlignVCenter
  2791. }
  2792. mElements.at(i)->setOuterRect(insetRect);
  2793. }
  2794. }
  2795. /* inherits documentation from base class */
  2796. int QCPLayoutInset::elementCount() const
  2797. {
  2798. return mElements.size();
  2799. }
  2800. /* inherits documentation from base class */
  2801. QCPLayoutElement *QCPLayoutInset::elementAt(int index) const
  2802. {
  2803. if (index >= 0 && index < mElements.size())
  2804. return mElements.at(index);
  2805. else
  2806. return 0;
  2807. }
  2808. /* inherits documentation from base class */
  2809. QCPLayoutElement *QCPLayoutInset::takeAt(int index)
  2810. {
  2811. if (QCPLayoutElement *el = elementAt(index))
  2812. {
  2813. releaseElement(el);
  2814. mElements.removeAt(index);
  2815. mInsetPlacement.removeAt(index);
  2816. mInsetAlignment.removeAt(index);
  2817. mInsetRect.removeAt(index);
  2818. return el;
  2819. } else
  2820. {
  2821. qDebug() << Q_FUNC_INFO << "Attempt to take invalid index:" << index;
  2822. return 0;
  2823. }
  2824. }
  2825. /* inherits documentation from base class */
  2826. bool QCPLayoutInset::take(QCPLayoutElement *element)
  2827. {
  2828. if (element)
  2829. {
  2830. for (int i=0; i<elementCount(); ++i)
  2831. {
  2832. if (elementAt(i) == element)
  2833. {
  2834. takeAt(i);
  2835. return true;
  2836. }
  2837. }
  2838. qDebug() << Q_FUNC_INFO << "Element not in this layout, couldn't take";
  2839. } else
  2840. qDebug() << Q_FUNC_INFO << "Can't take null element";
  2841. return false;
  2842. }
  2843. /*!
  2844. The inset layout is sensitive to events only at areas where its child elements are sensitive. If
  2845. the selectTest method of any of the child elements returns a positive number for \a pos, this
  2846. method returns a value corresponding to 0.99 times the parent plot's selection tolerance. The
  2847. inset layout is not selectable itself by default. So if \a onlySelectable is true, -1.0 is
  2848. returned.
  2849. See \ref QCPLayerable::selectTest for a general explanation of this virtual method.
  2850. */
  2851. double QCPLayoutInset::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  2852. {
  2853. Q_UNUSED(details)
  2854. if (onlySelectable)
  2855. return -1;
  2856. for (int i=0; i<mElements.size(); ++i)
  2857. {
  2858. // inset layout shall only return positive selectTest, if actually an inset object is at pos
  2859. // else it would block the entire underlying QCPAxisRect with its surface.
  2860. if (mElements.at(i)->selectTest(pos, onlySelectable) >= 0)
  2861. return mParentPlot->selectionTolerance()*0.99;
  2862. }
  2863. return -1;
  2864. }
  2865. /*!
  2866. Adds the specified \a element to the layout as an inset aligned at the border (\ref
  2867. setInsetAlignment is initialized with \ref ipBorderAligned). The alignment is set to \a
  2868. alignment.
  2869. \a alignment is an or combination of the following alignment flags: Qt::AlignLeft,
  2870. Qt::AlignHCenter, Qt::AlighRight, Qt::AlignTop, Qt::AlignVCenter, Qt::AlignBottom. Any other
  2871. alignment flags will be ignored.
  2872. \see addElement(QCPLayoutElement *element, const QRectF &rect)
  2873. */
  2874. void QCPLayoutInset::addElement(QCPLayoutElement *element, Qt::Alignment alignment)
  2875. {
  2876. if (element)
  2877. {
  2878. if (element->layout()) // remove from old layout first
  2879. element->layout()->take(element);
  2880. mElements.append(element);
  2881. mInsetPlacement.append(ipBorderAligned);
  2882. mInsetAlignment.append(alignment);
  2883. mInsetRect.append(QRectF(0.6, 0.6, 0.4, 0.4));
  2884. adoptElement(element);
  2885. } else
  2886. qDebug() << Q_FUNC_INFO << "Can't add null element";
  2887. }
  2888. /*!
  2889. Adds the specified \a element to the layout as an inset with free positioning/sizing (\ref
  2890. setInsetAlignment is initialized with \ref ipFree). The position and size is set to \a
  2891. rect.
  2892. \a rect is given in fractions of the whole inset layout rect. So an inset with rect (0, 0, 1, 1)
  2893. will span the entire layout. An inset with rect (0.6, 0.1, 0.35, 0.35) will be in the top right
  2894. corner of the layout, with 35% width and height of the parent layout.
  2895. \see addElement(QCPLayoutElement *element, Qt::Alignment alignment)
  2896. */
  2897. void QCPLayoutInset::addElement(QCPLayoutElement *element, const QRectF &rect)
  2898. {
  2899. if (element)
  2900. {
  2901. if (element->layout()) // remove from old layout first
  2902. element->layout()->take(element);
  2903. mElements.append(element);
  2904. mInsetPlacement.append(ipFree);
  2905. mInsetAlignment.append(Qt::AlignRight|Qt::AlignTop);
  2906. mInsetRect.append(rect);
  2907. adoptElement(element);
  2908. } else
  2909. qDebug() << Q_FUNC_INFO << "Can't add null element";
  2910. }
  2911. ////////////////////////////////////////////////////////////////////////////////////////////////////
  2912. //////////////////// QCPLineEnding
  2913. ////////////////////////////////////////////////////////////////////////////////////////////////////
  2914. /*! \class QCPLineEnding
  2915. \brief Handles the different ending decorations for line-like items
  2916. \image html QCPLineEnding.png "The various ending styles currently supported"
  2917. For every ending a line-like item has, an instance of this class exists. For example, QCPItemLine
  2918. has two endings which can be set with QCPItemLine::setHead and QCPItemLine::setTail.
  2919. The styles themselves are defined via the enum QCPLineEnding::EndingStyle. Most decorations can
  2920. be modified regarding width and length, see \ref setWidth and \ref setLength. The direction of
  2921. the ending decoration (e.g. direction an arrow is pointing) is controlled by the line-like item.
  2922. For example, when both endings of a QCPItemLine are set to be arrows, they will point to opposite
  2923. directions, e.g. "outward". This can be changed by \ref setInverted, which would make the
  2924. respective arrow point inward.
  2925. Note that due to the overloaded QCPLineEnding constructor, you may directly specify a
  2926. QCPLineEnding::EndingStyle where actually a QCPLineEnding is expected, e.g. \code
  2927. myItemLine->setHead(QCPLineEnding::esSpikeArrow) \endcode
  2928. */
  2929. /*!
  2930. Creates a QCPLineEnding instance with default values (style \ref esNone).
  2931. */
  2932. QCPLineEnding::QCPLineEnding() :
  2933. mStyle(esNone),
  2934. mWidth(8),
  2935. mLength(10),
  2936. mInverted(false)
  2937. {
  2938. }
  2939. /*!
  2940. Creates a QCPLineEnding instance with the specified values.
  2941. */
  2942. QCPLineEnding::QCPLineEnding(QCPLineEnding::EndingStyle style, double width, double length, bool inverted) :
  2943. mStyle(style),
  2944. mWidth(width),
  2945. mLength(length),
  2946. mInverted(inverted)
  2947. {
  2948. }
  2949. /*!
  2950. Sets the style of the ending decoration.
  2951. */
  2952. void QCPLineEnding::setStyle(QCPLineEnding::EndingStyle style)
  2953. {
  2954. mStyle = style;
  2955. }
  2956. /*!
  2957. Sets the width of the ending decoration, if the style supports it. On arrows, for example, the
  2958. width defines the size perpendicular to the arrow's pointing direction.
  2959. \see setLength
  2960. */
  2961. void QCPLineEnding::setWidth(double width)
  2962. {
  2963. mWidth = width;
  2964. }
  2965. /*!
  2966. Sets the length of the ending decoration, if the style supports it. On arrows, for example, the
  2967. length defines the size in pointing direction.
  2968. \see setWidth
  2969. */
  2970. void QCPLineEnding::setLength(double length)
  2971. {
  2972. mLength = length;
  2973. }
  2974. /*!
  2975. Sets whether the ending decoration shall be inverted. For example, an arrow decoration will point
  2976. inward when \a inverted is set to true.
  2977. Note that also the \a width direction is inverted. For symmetrical ending styles like arrows or
  2978. discs, this doesn't make a difference. However, asymmetric styles like \ref esHalfBar are
  2979. affected by it, which can be used to control to which side the half bar points to.
  2980. */
  2981. void QCPLineEnding::setInverted(bool inverted)
  2982. {
  2983. mInverted = inverted;
  2984. }
  2985. /*! \internal
  2986. Returns the maximum pixel radius the ending decoration might cover, starting from the position
  2987. the decoration is drawn at (typically a line ending/\ref QCPItemPosition of an item).
  2988. This is relevant for clipping. Only omit painting of the decoration when the position where the
  2989. decoration is supposed to be drawn is farther away from the clipping rect than the returned
  2990. distance.
  2991. */
  2992. double QCPLineEnding::boundingDistance() const
  2993. {
  2994. switch (mStyle)
  2995. {
  2996. case esNone:
  2997. return 0;
  2998. case esFlatArrow:
  2999. case esSpikeArrow:
  3000. case esLineArrow:
  3001. case esSkewedBar:
  3002. return qSqrt(mWidth*mWidth+mLength*mLength); // items that have width and length
  3003. case esDisc:
  3004. case esSquare:
  3005. case esDiamond:
  3006. case esBar:
  3007. case esHalfBar:
  3008. return mWidth*1.42; // items that only have a width -> width*sqrt(2)
  3009. }
  3010. return 0;
  3011. }
  3012. /*!
  3013. Starting from the origin of this line ending (which is style specific), returns the length
  3014. covered by the line ending symbol, in backward direction.
  3015. For example, the \ref esSpikeArrow has a shorter real length than a \ref esFlatArrow, even if
  3016. both have the same \ref setLength value, because the spike arrow has an inward curved back, which
  3017. reduces the length along its center axis (the drawing origin for arrows is at the tip).
  3018. This function is used for precise, style specific placement of line endings, for example in
  3019. QCPAxes.
  3020. */
  3021. double QCPLineEnding::realLength() const
  3022. {
  3023. switch (mStyle)
  3024. {
  3025. case esNone:
  3026. case esLineArrow:
  3027. case esSkewedBar:
  3028. case esBar:
  3029. case esHalfBar:
  3030. return 0;
  3031. case esFlatArrow:
  3032. return mLength;
  3033. case esDisc:
  3034. case esSquare:
  3035. case esDiamond:
  3036. return mWidth*0.5;
  3037. case esSpikeArrow:
  3038. return mLength*0.8;
  3039. }
  3040. return 0;
  3041. }
  3042. /*! \internal
  3043. Draws the line ending with the specified \a painter at the position \a pos. The direction of the
  3044. line ending is controlled with \a dir.
  3045. */
  3046. void QCPLineEnding::draw(QCPPainter *painter, const QVector2D &pos, const QVector2D &dir) const
  3047. {
  3048. if (mStyle == esNone)
  3049. return;
  3050. QVector2D lengthVec(dir.normalized());
  3051. if (lengthVec.isNull())
  3052. lengthVec = QVector2D(1, 0);
  3053. QVector2D widthVec(-lengthVec.y(), lengthVec.x());
  3054. lengthVec *= mLength*(mInverted ? -1 : 1);
  3055. widthVec *= mWidth*0.5*(mInverted ? -1 : 1);
  3056. QPen penBackup = painter->pen();
  3057. QBrush brushBackup = painter->brush();
  3058. QPen miterPen = penBackup;
  3059. miterPen.setJoinStyle(Qt::MiterJoin); // to make arrow heads spikey
  3060. QBrush brush(painter->pen().color(), Qt::SolidPattern);
  3061. switch (mStyle)
  3062. {
  3063. case esNone: break;
  3064. case esFlatArrow:
  3065. {
  3066. QPointF points[3] = {pos.toPointF(),
  3067. (pos-lengthVec+widthVec).toPointF(),
  3068. (pos-lengthVec-widthVec).toPointF()
  3069. };
  3070. painter->setPen(miterPen);
  3071. painter->setBrush(brush);
  3072. painter->drawConvexPolygon(points, 3);
  3073. painter->setBrush(brushBackup);
  3074. painter->setPen(penBackup);
  3075. break;
  3076. }
  3077. case esSpikeArrow:
  3078. {
  3079. QPointF points[4] = {pos.toPointF(),
  3080. (pos-lengthVec+widthVec).toPointF(),
  3081. (pos-lengthVec*0.8).toPointF(),
  3082. (pos-lengthVec-widthVec).toPointF()
  3083. };
  3084. painter->setPen(miterPen);
  3085. painter->setBrush(brush);
  3086. painter->drawConvexPolygon(points, 4);
  3087. painter->setBrush(brushBackup);
  3088. painter->setPen(penBackup);
  3089. break;
  3090. }
  3091. case esLineArrow:
  3092. {
  3093. QPointF points[3] = {(pos-lengthVec+widthVec).toPointF(),
  3094. pos.toPointF(),
  3095. (pos-lengthVec-widthVec).toPointF()
  3096. };
  3097. painter->setPen(miterPen);
  3098. painter->drawPolyline(points, 3);
  3099. painter->setPen(penBackup);
  3100. break;
  3101. }
  3102. case esDisc:
  3103. {
  3104. painter->setBrush(brush);
  3105. painter->drawEllipse(pos.toPointF(), mWidth*0.5, mWidth*0.5);
  3106. painter->setBrush(brushBackup);
  3107. break;
  3108. }
  3109. case esSquare:
  3110. {
  3111. QVector2D widthVecPerp(-widthVec.y(), widthVec.x());
  3112. QPointF points[4] = {(pos-widthVecPerp+widthVec).toPointF(),
  3113. (pos-widthVecPerp-widthVec).toPointF(),
  3114. (pos+widthVecPerp-widthVec).toPointF(),
  3115. (pos+widthVecPerp+widthVec).toPointF()
  3116. };
  3117. painter->setPen(miterPen);
  3118. painter->setBrush(brush);
  3119. painter->drawConvexPolygon(points, 4);
  3120. painter->setBrush(brushBackup);
  3121. painter->setPen(penBackup);
  3122. break;
  3123. }
  3124. case esDiamond:
  3125. {
  3126. QVector2D widthVecPerp(-widthVec.y(), widthVec.x());
  3127. QPointF points[4] = {(pos-widthVecPerp).toPointF(),
  3128. (pos-widthVec).toPointF(),
  3129. (pos+widthVecPerp).toPointF(),
  3130. (pos+widthVec).toPointF()
  3131. };
  3132. painter->setPen(miterPen);
  3133. painter->setBrush(brush);
  3134. painter->drawConvexPolygon(points, 4);
  3135. painter->setBrush(brushBackup);
  3136. painter->setPen(penBackup);
  3137. break;
  3138. }
  3139. case esBar:
  3140. {
  3141. painter->drawLine((pos+widthVec).toPointF(), (pos-widthVec).toPointF());
  3142. break;
  3143. }
  3144. case esHalfBar:
  3145. {
  3146. painter->drawLine((pos+widthVec).toPointF(), pos.toPointF());
  3147. break;
  3148. }
  3149. case esSkewedBar:
  3150. {
  3151. if (qFuzzyIsNull(painter->pen().widthF()) && !painter->modes().testFlag(QCPPainter::pmNonCosmetic))
  3152. {
  3153. // if drawing with cosmetic pen (perfectly thin stroke, happens only in vector exports), draw bar exactly on tip of line
  3154. painter->drawLine((pos+widthVec+lengthVec*0.2*(mInverted?-1:1)).toPointF(),
  3155. (pos-widthVec-lengthVec*0.2*(mInverted?-1:1)).toPointF());
  3156. } else
  3157. {
  3158. // if drawing with thick (non-cosmetic) pen, shift bar a little in line direction to prevent line from sticking through bar slightly
  3159. painter->drawLine((pos+widthVec+lengthVec*0.2*(mInverted?-1:1)+dir.normalized()*qMax(1.0, (double)painter->pen().widthF())*0.5).toPointF(),
  3160. (pos-widthVec-lengthVec*0.2*(mInverted?-1:1)+dir.normalized()*qMax(1.0, (double)painter->pen().widthF())*0.5).toPointF());
  3161. }
  3162. break;
  3163. }
  3164. }
  3165. }
  3166. /*! \internal
  3167. \overload
  3168. Draws the line ending. The direction is controlled with the \a angle parameter in radians.
  3169. */
  3170. void QCPLineEnding::draw(QCPPainter *painter, const QVector2D &pos, double angle) const
  3171. {
  3172. draw(painter, pos, QVector2D(qCos(angle), qSin(angle)));
  3173. }
  3174. ////////////////////////////////////////////////////////////////////////////////////////////////////
  3175. //////////////////// QCPGrid
  3176. ////////////////////////////////////////////////////////////////////////////////////////////////////
  3177. /*! \class QCPGrid
  3178. \brief Responsible for drawing the grid of a QCPAxis.
  3179. This class is tightly bound to QCPAxis. Every axis owns a grid instance and uses it to draw the
  3180. grid lines, sub grid lines and zero-line. You can interact with the grid of an axis via \ref
  3181. QCPAxis::grid. Normally, you don't need to create an instance of QCPGrid yourself.
  3182. The axis and grid drawing was split into two classes to allow them to be placed on different
  3183. layers (both QCPAxis and QCPGrid inherit from QCPLayerable). Thus it is possible to have the grid
  3184. in the background and the axes in the foreground, and any plottables/items in between. This
  3185. described situation is the default setup, see the QCPLayer documentation.
  3186. */
  3187. /*!
  3188. Creates a QCPGrid instance and sets default values.
  3189. You shouldn't instantiate grids on their own, since every QCPAxis brings its own QCPGrid.
  3190. */
  3191. QCPGrid::QCPGrid(QCPAxis *parentAxis) :
  3192. QCPLayerable(parentAxis->parentPlot(), "", parentAxis),
  3193. mParentAxis(parentAxis)
  3194. {
  3195. // warning: this is called in QCPAxis constructor, so parentAxis members should not be accessed/called
  3196. setParent(parentAxis);
  3197. setPen(QPen(QColor(200,200,200), 0, Qt::DotLine));
  3198. setSubGridPen(QPen(QColor(220,220,220), 0, Qt::DotLine));
  3199. setZeroLinePen(QPen(QColor(200,200,200), 0, Qt::SolidLine));
  3200. setSubGridVisible(false);
  3201. setAntialiased(false);
  3202. setAntialiasedSubGrid(false);
  3203. setAntialiasedZeroLine(false);
  3204. }
  3205. /*!
  3206. Sets whether grid lines at sub tick marks are drawn.
  3207. \see setSubGridPen
  3208. */
  3209. void QCPGrid::setSubGridVisible(bool visible)
  3210. {
  3211. mSubGridVisible = visible;
  3212. }
  3213. /*!
  3214. Sets whether sub grid lines are drawn antialiased.
  3215. */
  3216. void QCPGrid::setAntialiasedSubGrid(bool enabled)
  3217. {
  3218. mAntialiasedSubGrid = enabled;
  3219. }
  3220. /*!
  3221. Sets whether zero lines are drawn antialiased.
  3222. */
  3223. void QCPGrid::setAntialiasedZeroLine(bool enabled)
  3224. {
  3225. mAntialiasedZeroLine = enabled;
  3226. }
  3227. /*!
  3228. Sets the pen with which (major) grid lines are drawn.
  3229. */
  3230. void QCPGrid::setPen(const QPen &pen)
  3231. {
  3232. mPen = pen;
  3233. }
  3234. /*!
  3235. Sets the pen with which sub grid lines are drawn.
  3236. */
  3237. void QCPGrid::setSubGridPen(const QPen &pen)
  3238. {
  3239. mSubGridPen = pen;
  3240. }
  3241. /*!
  3242. Sets the pen with which zero lines are drawn.
  3243. Zero lines are lines at value coordinate 0 which may be drawn with a different pen than other grid
  3244. lines. To disable zero lines and just draw normal grid lines at zero, set \a pen to Qt::NoPen.
  3245. */
  3246. void QCPGrid::setZeroLinePen(const QPen &pen)
  3247. {
  3248. mZeroLinePen = pen;
  3249. }
  3250. /*! \internal
  3251. A convenience function to easily set the QPainter::Antialiased hint on the provided \a painter
  3252. before drawing the major grid lines.
  3253. This is the antialiasing state the painter passed to the \ref draw method is in by default.
  3254. This function takes into account the local setting of the antialiasing flag as well as the
  3255. overrides set with \ref QCustomPlot::setAntialiasedElements and \ref
  3256. QCustomPlot::setNotAntialiasedElements.
  3257. \see setAntialiased
  3258. */
  3259. void QCPGrid::applyDefaultAntialiasingHint(QCPPainter *painter) const
  3260. {
  3261. applyAntialiasingHint(painter, mAntialiased, QCP::aeGrid);
  3262. }
  3263. /*! \internal
  3264. Draws grid lines and sub grid lines at the positions of (sub) ticks of the parent axis, spanning
  3265. over the complete axis rect. Also draws the zero line, if appropriate (\ref setZeroLinePen).
  3266. */
  3267. void QCPGrid::draw(QCPPainter *painter)
  3268. {
  3269. if (!mParentAxis) { qDebug() << Q_FUNC_INFO << "invalid parent axis"; return; }
  3270. if (mSubGridVisible)
  3271. drawSubGridLines(painter);
  3272. drawGridLines(painter);
  3273. }
  3274. /*! \internal
  3275. Draws the main grid lines and possibly a zero line with the specified painter.
  3276. This is a helper function called by \ref draw.
  3277. */
  3278. void QCPGrid::drawGridLines(QCPPainter *painter) const
  3279. {
  3280. if (!mParentAxis) { qDebug() << Q_FUNC_INFO << "invalid parent axis"; return; }
  3281. int lowTick = mParentAxis->mLowestVisibleTick;
  3282. int highTick = mParentAxis->mHighestVisibleTick;
  3283. double t; // helper variable, result of coordinate-to-pixel transforms
  3284. if (mParentAxis->orientation() == Qt::Horizontal)
  3285. {
  3286. // draw zeroline:
  3287. int zeroLineIndex = -1;
  3288. if (mZeroLinePen.style() != Qt::NoPen && mParentAxis->mRange.lower < 0 && mParentAxis->mRange.upper > 0)
  3289. {
  3290. applyAntialiasingHint(painter, mAntialiasedZeroLine, QCP::aeZeroLine);
  3291. painter->setPen(mZeroLinePen);
  3292. double epsilon = mParentAxis->range().size()*1E-6; // for comparing double to zero
  3293. for (int i=lowTick; i <= highTick; ++i)
  3294. {
  3295. if (qAbs(mParentAxis->mTickVector.at(i)) < epsilon)
  3296. {
  3297. zeroLineIndex = i;
  3298. t = mParentAxis->coordToPixel(mParentAxis->mTickVector.at(i)); // x
  3299. painter->drawLine(QLineF(t, mParentAxis->mAxisRect->bottom(), t, mParentAxis->mAxisRect->top()));
  3300. break;
  3301. }
  3302. }
  3303. }
  3304. // draw grid lines:
  3305. applyDefaultAntialiasingHint(painter);
  3306. painter->setPen(mPen);
  3307. for (int i=lowTick; i <= highTick; ++i)
  3308. {
  3309. if (i == zeroLineIndex) continue; // don't draw a gridline on top of the zeroline
  3310. t = mParentAxis->coordToPixel(mParentAxis->mTickVector.at(i)); // x
  3311. painter->drawLine(QLineF(t, mParentAxis->mAxisRect->bottom(), t, mParentAxis->mAxisRect->top()));
  3312. }
  3313. } else
  3314. {
  3315. // draw zeroline:
  3316. int zeroLineIndex = -1;
  3317. if (mZeroLinePen.style() != Qt::NoPen && mParentAxis->mRange.lower < 0 && mParentAxis->mRange.upper > 0)
  3318. {
  3319. applyAntialiasingHint(painter, mAntialiasedZeroLine, QCP::aeZeroLine);
  3320. painter->setPen(mZeroLinePen);
  3321. double epsilon = mParentAxis->mRange.size()*1E-6; // for comparing double to zero
  3322. for (int i=lowTick; i <= highTick; ++i)
  3323. {
  3324. if (qAbs(mParentAxis->mTickVector.at(i)) < epsilon)
  3325. {
  3326. zeroLineIndex = i;
  3327. t = mParentAxis->coordToPixel(mParentAxis->mTickVector.at(i)); // y
  3328. painter->drawLine(QLineF(mParentAxis->mAxisRect->left(), t, mParentAxis->mAxisRect->right(), t));
  3329. break;
  3330. }
  3331. }
  3332. }
  3333. // draw grid lines:
  3334. applyDefaultAntialiasingHint(painter);
  3335. painter->setPen(mPen);
  3336. for (int i=lowTick; i <= highTick; ++i)
  3337. {
  3338. if (i == zeroLineIndex) continue; // don't draw a gridline on top of the zeroline
  3339. t = mParentAxis->coordToPixel(mParentAxis->mTickVector.at(i)); // y
  3340. painter->drawLine(QLineF(mParentAxis->mAxisRect->left(), t, mParentAxis->mAxisRect->right(), t));
  3341. }
  3342. }
  3343. }
  3344. /*! \internal
  3345. Draws the sub grid lines with the specified painter.
  3346. This is a helper function called by \ref draw.
  3347. */
  3348. void QCPGrid::drawSubGridLines(QCPPainter *painter) const
  3349. {
  3350. if (!mParentAxis) { qDebug() << Q_FUNC_INFO << "invalid parent axis"; return; }
  3351. applyAntialiasingHint(painter, mAntialiasedSubGrid, QCP::aeSubGrid);
  3352. double t; // helper variable, result of coordinate-to-pixel transforms
  3353. painter->setPen(mSubGridPen);
  3354. if (mParentAxis->orientation() == Qt::Horizontal)
  3355. {
  3356. for (int i=0; i<mParentAxis->mSubTickVector.size(); ++i)
  3357. {
  3358. t = mParentAxis->coordToPixel(mParentAxis->mSubTickVector.at(i)); // x
  3359. painter->drawLine(QLineF(t, mParentAxis->mAxisRect->bottom(), t, mParentAxis->mAxisRect->top()));
  3360. }
  3361. } else
  3362. {
  3363. for (int i=0; i<mParentAxis->mSubTickVector.size(); ++i)
  3364. {
  3365. t = mParentAxis->coordToPixel(mParentAxis->mSubTickVector.at(i)); // y
  3366. painter->drawLine(QLineF(mParentAxis->mAxisRect->left(), t, mParentAxis->mAxisRect->right(), t));
  3367. }
  3368. }
  3369. }
  3370. ////////////////////////////////////////////////////////////////////////////////////////////////////
  3371. //////////////////// QCPAxis
  3372. ////////////////////////////////////////////////////////////////////////////////////////////////////
  3373. /*! \class QCPAxis
  3374. \brief Manages a single axis inside a QCustomPlot.
  3375. Usually doesn't need to be instantiated externally. Access %QCustomPlot's default four axes via
  3376. QCustomPlot::xAxis (bottom), QCustomPlot::yAxis (left), QCustomPlot::xAxis2 (top) and
  3377. QCustomPlot::yAxis2 (right).
  3378. Axes are always part of an axis rect, see QCPAxisRect.
  3379. \image html AxisNamesOverview.png
  3380. <center>Naming convention of axis parts</center>
  3381. \n
  3382. \image html AxisRectSpacingOverview.png
  3383. <center>Overview of the spacings and paddings that define the geometry of an axis. The dashed gray line
  3384. on the left represents the QCustomPlot widget border.</center>
  3385. */
  3386. /* start of documentation of inline functions */
  3387. /*! \fn Qt::Orientation QCPAxis::orientation() const
  3388. Returns the orientation of the axis. The axis orientation (horizontal or vertical) is deduced
  3389. from the axis type (left, top, right or bottom).
  3390. */
  3391. /*! \fn QCPGrid *QCPAxis::grid() const
  3392. Returns the \ref QCPGrid instance belonging to this axis. Access it to set details about the way the
  3393. grid is displayed.
  3394. */
  3395. /* end of documentation of inline functions */
  3396. /* start of documentation of signals */
  3397. /*! \fn void QCPAxis::ticksRequest()
  3398. This signal is emitted when \ref setAutoTicks is false and the axis is about to generate tick
  3399. labels for a replot.
  3400. Modifying the tick positions can be done with \ref setTickVector. If you also want to control the
  3401. tick labels, set \ref setAutoTickLabels to false and also provide the labels with \ref
  3402. setTickVectorLabels.
  3403. If you only want static ticks you probably don't need this signal, since you can just set the
  3404. tick vector (and possibly tick label vector) once. However, if you want to provide ticks (and
  3405. maybe labels) dynamically, e.g. depending on the current axis range, connect a slot to this
  3406. signal and set the vector/vectors there.
  3407. */
  3408. /*! \fn void QCPAxis::rangeChanged(const QCPRange &newRange)
  3409. This signal is emitted when the range of this axis has changed. You can connect it to the \ref
  3410. setRange slot of another axis to communicate the new range to the other axis, in order for it to
  3411. be synchronized.
  3412. */
  3413. /*! \fn void QCPAxis::rangeChanged(const QCPRange &newRange, const QCPRange &oldRange)
  3414. \overload
  3415. Additionally to the new range, this signal also provides the previous range held by the axis as
  3416. \a oldRange.
  3417. */
  3418. /*! \fn void QCPAxis::selectionChanged(QCPAxis::SelectableParts selection)
  3419. This signal is emitted when the selection state of this axis has changed, either by user interaction
  3420. or by a direct call to \ref setSelectedParts.
  3421. */
  3422. /* end of documentation of signals */
  3423. /*!
  3424. Constructs an Axis instance of Type \a type for the axis rect \a parent.
  3425. You shouldn't instantiate axes directly, rather use \ref QCPAxisRect::addAxis.
  3426. */
  3427. QCPAxis::QCPAxis(QCPAxisRect *parent, AxisType type) :
  3428. QCPLayerable(parent->parentPlot(), "", parent),
  3429. // axis base:
  3430. mAxisType(type),
  3431. mAxisRect(parent),
  3432. mOffset(0),
  3433. mPadding(5),
  3434. mOrientation((type == atBottom || type == atTop) ? Qt::Horizontal : Qt::Vertical),
  3435. mSelectableParts(spAxis | spTickLabels | spAxisLabel),
  3436. mSelectedParts(spNone),
  3437. mBasePen(QPen(Qt::black, 0, Qt::SolidLine, Qt::SquareCap)),
  3438. mSelectedBasePen(QPen(Qt::blue, 2)),
  3439. mLowerEnding(QCPLineEnding::esNone),
  3440. mUpperEnding(QCPLineEnding::esNone),
  3441. // axis label:
  3442. mLabelPadding(0),
  3443. mLabel(""),
  3444. mLabelFont(mParentPlot->font()),
  3445. mSelectedLabelFont(QFont(mLabelFont.family(), mLabelFont.pointSize(), QFont::Bold)),
  3446. mLabelColor(Qt::black),
  3447. mSelectedLabelColor(Qt::blue),
  3448. // tick labels:
  3449. mTickLabelPadding(0),
  3450. mTickLabels(true),
  3451. mAutoTickLabels(true),
  3452. mTickLabelRotation(0),
  3453. mTickLabelType(ltNumber),
  3454. mTickLabelFont(mParentPlot->font()),
  3455. mSelectedTickLabelFont(QFont(mTickLabelFont.family(), mTickLabelFont.pointSize(), QFont::Bold)),
  3456. mTickLabelColor(Qt::black),
  3457. mSelectedTickLabelColor(Qt::blue),
  3458. mDateTimeFormat("hh:mm:ss\ndd.MM.yy"),
  3459. mDateTimeSpec(Qt::LocalTime),
  3460. mNumberPrecision(6),
  3461. mNumberFormatChar('g'),
  3462. mNumberBeautifulPowers(true),
  3463. mNumberMultiplyCross(false),
  3464. // ticks and subticks:
  3465. mTicks(true),
  3466. mTickStep(1),
  3467. mSubTickCount(4),
  3468. mAutoTickCount(6),
  3469. mAutoTicks(true),
  3470. mAutoTickStep(true),
  3471. mAutoSubTicks(true),
  3472. mTickLengthIn(5),
  3473. mTickLengthOut(0),
  3474. mSubTickLengthIn(2),
  3475. mSubTickLengthOut(0),
  3476. mTickPen(QPen(Qt::black, 0, Qt::SolidLine, Qt::SquareCap)),
  3477. mSelectedTickPen(QPen(Qt::blue, 2)),
  3478. mSubTickPen(QPen(Qt::black, 0, Qt::SolidLine, Qt::SquareCap)),
  3479. mSelectedSubTickPen(QPen(Qt::blue, 2)),
  3480. // scale and range:
  3481. mRange(0, 5),
  3482. mRangeReversed(false),
  3483. mScaleType(stLinear),
  3484. mScaleLogBase(10),
  3485. mScaleLogBaseLogInv(1.0/qLn(mScaleLogBase)),
  3486. // internal members:
  3487. mGrid(new QCPGrid(this)),
  3488. mLabelCache(16), // cache at most 16 (tick) labels
  3489. mLowestVisibleTick(0),
  3490. mHighestVisibleTick(-1),
  3491. mExponentialChar('e'), // will be updated with locale sensitive values in setupTickVector
  3492. mPositiveSignChar('+'), // will be updated with locale sensitive values in setupTickVector
  3493. mCachedMarginValid(false),
  3494. mCachedMargin(0)
  3495. {
  3496. mGrid->setVisible(false);
  3497. setAntialiased(false);
  3498. setLayer(mParentPlot->currentLayer()); // it's actually on that layer already, but we want it in front of the grid, so we place it on there again
  3499. if (type == atTop)
  3500. {
  3501. setTickLabelPadding(3);
  3502. setLabelPadding(6);
  3503. } else if (type == atRight)
  3504. {
  3505. setTickLabelPadding(7);
  3506. setLabelPadding(12);
  3507. } else if (type == atBottom)
  3508. {
  3509. setTickLabelPadding(3);
  3510. setLabelPadding(3);
  3511. } else if (type == atLeft)
  3512. {
  3513. setTickLabelPadding(5);
  3514. setLabelPadding(10);
  3515. }
  3516. }
  3517. /* No documentation as it is a property getter */
  3518. QString QCPAxis::numberFormat() const
  3519. {
  3520. QString result;
  3521. result.append(mNumberFormatChar);
  3522. if (mNumberBeautifulPowers)
  3523. {
  3524. result.append("b");
  3525. if (mNumberMultiplyCross)
  3526. result.append("c");
  3527. }
  3528. return result;
  3529. }
  3530. /*!
  3531. Sets whether the axis uses a linear scale or a logarithmic scale. If \a type is set to \ref
  3532. stLogarithmic, the logarithm base can be set with \ref setScaleLogBase. In logarithmic axis
  3533. scaling, major tick marks appear at all powers of the logarithm base. Properties like tick step
  3534. (\ref setTickStep) don't apply in logarithmic scaling. If you wish a decimal base but less major
  3535. ticks, consider choosing a logarithm base of 100, 1000 or even higher.
  3536. If \a type is \ref stLogarithmic and the number format (\ref setNumberFormat) uses the 'b' option
  3537. (beautifully typeset decimal powers), the display usually is "1 [multiplication sign] 10
  3538. [superscript] n", which looks unnatural for logarithmic scaling (the "1 [multiplication sign]"
  3539. part). To only display the decimal power, set the number precision to zero with
  3540. \ref setNumberPrecision.
  3541. */
  3542. void QCPAxis::setScaleType(ScaleType type)
  3543. {
  3544. if (mScaleType != type)
  3545. {
  3546. mScaleType = type;
  3547. if (mScaleType == stLogarithmic)
  3548. mRange = mRange.sanitizedForLogScale();
  3549. mCachedMarginValid = false;
  3550. }
  3551. }
  3552. /*!
  3553. If \ref setScaleType is set to \ref stLogarithmic, \a base will be the logarithm base of the
  3554. scaling. In logarithmic axis scaling, major tick marks appear at all powers of \a base.
  3555. Properties like tick step (\ref setTickStep) don't apply in logarithmic scaling. If you wish a decimal base but
  3556. less major ticks, consider choosing \a base 100, 1000 or even higher.
  3557. */
  3558. void QCPAxis::setScaleLogBase(double base)
  3559. {
  3560. if (base > 1)
  3561. {
  3562. mScaleLogBase = base;
  3563. mScaleLogBaseLogInv = 1.0/qLn(mScaleLogBase); // buffer for faster baseLog() calculation
  3564. mCachedMarginValid = false;
  3565. } else
  3566. qDebug() << Q_FUNC_INFO << "Invalid logarithmic scale base (must be greater 1):" << base;
  3567. }
  3568. /*!
  3569. Sets the range of the axis.
  3570. This slot may be connected with the \ref rangeChanged signal of another axis so this axis
  3571. is always synchronized with the other axis range, when it changes.
  3572. To invert the direction of an axis, use \ref setRangeReversed.
  3573. */
  3574. void QCPAxis::setRange(const QCPRange &range)
  3575. {
  3576. if (range.lower == mRange.lower && range.upper == mRange.upper)
  3577. return;
  3578. if (!QCPRange::validRange(range)) return;
  3579. QCPRange oldRange = mRange;
  3580. if (mScaleType == stLogarithmic)
  3581. {
  3582. mRange = range.sanitizedForLogScale();
  3583. } else
  3584. {
  3585. mRange = range.sanitizedForLinScale();
  3586. }
  3587. mCachedMarginValid = false;
  3588. emit rangeChanged(mRange);
  3589. emit rangeChanged(mRange, oldRange);
  3590. }
  3591. /*!
  3592. Sets whether the user can (de-)select the parts in \a selectable by clicking on the QCustomPlot surface.
  3593. (When \ref QCustomPlot::setInteractions contains iSelectAxes.)
  3594. However, even when \a selectable is set to a value not allowing the selection of a specific part,
  3595. it is still possible to set the selection of this part manually, by calling \ref setSelectedParts
  3596. directly.
  3597. \see SelectablePart, setSelectedParts
  3598. */
  3599. void QCPAxis::setSelectableParts(const SelectableParts &selectable)
  3600. {
  3601. mSelectableParts = selectable;
  3602. }
  3603. /*!
  3604. Sets the selected state of the respective axis parts described by \ref SelectablePart. When a part
  3605. is selected, it uses a different pen/font.
  3606. The entire selection mechanism for axes is handled automatically when \ref
  3607. QCustomPlot::setInteractions contains iSelectAxes. You only need to call this function when you
  3608. wish to change the selection state manually.
  3609. This function can change the selection state of a part, independent of the \ref setSelectableParts setting.
  3610. emits the \ref selectionChanged signal when \a selected is different from the previous selection state.
  3611. \see SelectablePart, setSelectableParts, selectTest, setSelectedBasePen, setSelectedTickPen, setSelectedSubTickPen,
  3612. setSelectedTickLabelFont, setSelectedLabelFont, setSelectedTickLabelColor, setSelectedLabelColor
  3613. */
  3614. void QCPAxis::setSelectedParts(const SelectableParts &selected)
  3615. {
  3616. if (mSelectedParts != selected)
  3617. {
  3618. if (mSelectedParts.testFlag(spTickLabels) != selected.testFlag(spTickLabels))
  3619. mLabelCache.clear();
  3620. mSelectedParts = selected;
  3621. emit selectionChanged(mSelectedParts);
  3622. }
  3623. }
  3624. /*!
  3625. \overload
  3626. Sets the lower and upper bound of the axis range.
  3627. To invert the direction of an axis, use \ref setRangeReversed.
  3628. There is also a slot to set a range, see \ref setRange(const QCPRange &range).
  3629. */
  3630. void QCPAxis::setRange(double lower, double upper)
  3631. {
  3632. if (lower == mRange.lower && upper == mRange.upper)
  3633. return;
  3634. if (!QCPRange::validRange(lower, upper)) return;
  3635. QCPRange oldRange = mRange;
  3636. mRange.lower = lower;
  3637. mRange.upper = upper;
  3638. if (mScaleType == stLogarithmic)
  3639. {
  3640. mRange = mRange.sanitizedForLogScale();
  3641. } else
  3642. {
  3643. mRange = mRange.sanitizedForLinScale();
  3644. }
  3645. mCachedMarginValid = false;
  3646. emit rangeChanged(mRange);
  3647. emit rangeChanged(mRange, oldRange);
  3648. }
  3649. /*!
  3650. \overload
  3651. Sets the range of the axis.
  3652. The \a position coordinate indicates together with the \a alignment parameter, where the new
  3653. range will be positioned. \a size defines the size of the new axis range. \a alignment may be
  3654. Qt::AlignLeft, Qt::AlignRight or Qt::AlignCenter. This will cause the left border, right border,
  3655. or center of the range to be aligned with \a position. Any other values of \a alignment will
  3656. default to Qt::AlignCenter.
  3657. */
  3658. void QCPAxis::setRange(double position, double size, Qt::AlignmentFlag alignment)
  3659. {
  3660. if (alignment == Qt::AlignLeft)
  3661. setRange(position, position+size);
  3662. else if (alignment == Qt::AlignRight)
  3663. setRange(position-size, position);
  3664. else // alignment == Qt::AlignCenter
  3665. setRange(position-size/2.0, position+size/2.0);
  3666. }
  3667. /*!
  3668. Sets the lower bound of the axis range. The upper bound is not changed.
  3669. \see setRange
  3670. */
  3671. void QCPAxis::setRangeLower(double lower)
  3672. {
  3673. if (mRange.lower == lower)
  3674. return;
  3675. QCPRange oldRange = mRange;
  3676. mRange.lower = lower;
  3677. if (mScaleType == stLogarithmic)
  3678. {
  3679. mRange = mRange.sanitizedForLogScale();
  3680. } else
  3681. {
  3682. mRange = mRange.sanitizedForLinScale();
  3683. }
  3684. mCachedMarginValid = false;
  3685. emit rangeChanged(mRange);
  3686. emit rangeChanged(mRange, oldRange);
  3687. }
  3688. /*!
  3689. Sets the upper bound of the axis range. The lower bound is not changed.
  3690. \see setRange
  3691. */
  3692. void QCPAxis::setRangeUpper(double upper)
  3693. {
  3694. if (mRange.upper == upper)
  3695. return;
  3696. QCPRange oldRange = mRange;
  3697. mRange.upper = upper;
  3698. if (mScaleType == stLogarithmic)
  3699. {
  3700. mRange = mRange.sanitizedForLogScale();
  3701. } else
  3702. {
  3703. mRange = mRange.sanitizedForLinScale();
  3704. }
  3705. mCachedMarginValid = false;
  3706. emit rangeChanged(mRange);
  3707. emit rangeChanged(mRange, oldRange);
  3708. }
  3709. /*!
  3710. Sets whether the axis range (direction) is displayed reversed. Normally, the values on horizontal
  3711. axes increase left to right, on vertical axes bottom to top. When \a reversed is set to true, the
  3712. direction of increasing values is inverted.
  3713. Note that the range and data interface stays the same for reversed axes, e.g. the \a lower part
  3714. of the \ref setRange interface will still reference the mathematically smaller number than the \a
  3715. upper part.
  3716. */
  3717. void QCPAxis::setRangeReversed(bool reversed)
  3718. {
  3719. if (mRangeReversed != reversed)
  3720. {
  3721. mRangeReversed = reversed;
  3722. mCachedMarginValid = false;
  3723. }
  3724. }
  3725. /*!
  3726. Sets whether the tick positions should be calculated automatically (either from an automatically
  3727. generated tick step or a tick step provided manually via \ref setTickStep, see \ref setAutoTickStep).
  3728. If \a on is set to false, you must provide the tick positions manually via \ref setTickVector.
  3729. For these manual ticks you may let QCPAxis generate the appropriate labels automatically by
  3730. leaving \ref setAutoTickLabels set to true. If you also wish to control the displayed labels
  3731. manually, set \ref setAutoTickLabels to false and provide the label strings with \ref
  3732. setTickVectorLabels.
  3733. If you need dynamically calculated tick vectors (and possibly tick label vectors), set the
  3734. vectors in a slot connected to the \ref ticksRequest signal.
  3735. */
  3736. void QCPAxis::setAutoTicks(bool on)
  3737. {
  3738. if (mAutoTicks != on)
  3739. {
  3740. mAutoTicks = on;
  3741. mCachedMarginValid = false;
  3742. }
  3743. }
  3744. /*!
  3745. When \ref setAutoTickStep is true, \a approximateCount determines how many ticks should be
  3746. generated in the visible range, approximately.
  3747. It's not guaranteed that this number of ticks is met exactly, but approximately within a
  3748. tolerance of about two.
  3749. Only values greater than zero are accepted as \a approximateCount.
  3750. */
  3751. void QCPAxis::setAutoTickCount(int approximateCount)
  3752. {
  3753. if (mAutoTickCount != approximateCount)
  3754. {
  3755. if (approximateCount > 0)
  3756. {
  3757. mAutoTickCount = approximateCount;
  3758. mCachedMarginValid = false;
  3759. } else
  3760. qDebug() << Q_FUNC_INFO << "approximateCount must be greater than zero:" << approximateCount;
  3761. }
  3762. }
  3763. /*!
  3764. Sets whether the tick labels are generated automatically. Depending on the tick label type (\ref
  3765. ltNumber or \ref ltDateTime), the labels will either show the coordinate as floating point
  3766. number (\ref setNumberFormat), or a date/time formatted according to \ref setDateTimeFormat.
  3767. If \a on is set to false, you should provide the tick labels via \ref setTickVectorLabels. This
  3768. is usually used in a combination with \ref setAutoTicks set to false for complete control over
  3769. tick positions and labels, e.g. when the ticks should be at multiples of pi and show "2pi", "3pi"
  3770. etc. as tick labels.
  3771. If you need dynamically calculated tick vectors (and possibly tick label vectors), set the
  3772. vectors in a slot connected to the \ref ticksRequest signal.
  3773. */
  3774. void QCPAxis::setAutoTickLabels(bool on)
  3775. {
  3776. if (mAutoTickLabels != on)
  3777. {
  3778. mAutoTickLabels = on;
  3779. mCachedMarginValid = false;
  3780. }
  3781. }
  3782. /*!
  3783. Sets whether the tick step, i.e. the interval between two (major) ticks, is calculated
  3784. automatically. If \a on is set to true, the axis finds a tick step that is reasonable for human
  3785. readable plots.
  3786. The number of ticks the algorithm aims for within the visible range can be set with \ref
  3787. setAutoTickCount.
  3788. If \a on is set to false, you may set the tick step manually with \ref setTickStep.
  3789. */
  3790. void QCPAxis::setAutoTickStep(bool on)
  3791. {
  3792. if (mAutoTickStep != on)
  3793. {
  3794. mAutoTickStep = on;
  3795. mCachedMarginValid = false;
  3796. }
  3797. }
  3798. /*!
  3799. Sets whether the number of sub ticks in one tick interval is determined automatically. This
  3800. works, as long as the tick step mantissa is a multiple of 0.5. When \ref setAutoTickStep is
  3801. enabled, this is always the case.
  3802. When \a on is set to false, you may set the sub tick count with \ref setSubTickCount manually.
  3803. */
  3804. void QCPAxis::setAutoSubTicks(bool on)
  3805. {
  3806. if (mAutoSubTicks != on)
  3807. {
  3808. mAutoSubTicks = on;
  3809. mCachedMarginValid = false;
  3810. }
  3811. }
  3812. /*!
  3813. Sets whether tick marks are displayed.
  3814. Note that setting \a show to false does not imply that tick labels are invisible, too. To achieve
  3815. that, see \ref setTickLabels.
  3816. */
  3817. void QCPAxis::setTicks(bool show)
  3818. {
  3819. if (mTicks != show)
  3820. {
  3821. mTicks = show;
  3822. mCachedMarginValid = false;
  3823. }
  3824. }
  3825. /*!
  3826. Sets whether tick labels are displayed. Tick labels are the numbers drawn next to tick marks.
  3827. */
  3828. void QCPAxis::setTickLabels(bool show)
  3829. {
  3830. if (mTickLabels != show)
  3831. {
  3832. mTickLabels = show;
  3833. mCachedMarginValid = false;
  3834. }
  3835. }
  3836. /*!
  3837. Sets the distance between the axis base line (including any outward ticks) and the tick labels.
  3838. \see setLabelPadding, setPadding
  3839. */
  3840. void QCPAxis::setTickLabelPadding(int padding)
  3841. {
  3842. if (mTickLabelPadding != padding)
  3843. {
  3844. mTickLabelPadding = padding;
  3845. mCachedMarginValid = false;
  3846. }
  3847. }
  3848. /*!
  3849. Sets whether the tick labels display numbers or dates/times.
  3850. If \a type is set to \ref ltNumber, the format specifications of \ref setNumberFormat apply.
  3851. If \a type is set to \ref ltDateTime, the format specifications of \ref setDateTimeFormat apply.
  3852. In QCustomPlot, date/time coordinates are <tt>double</tt> numbers representing the seconds since
  3853. 1970-01-01T00:00:00 UTC. This format can be retrieved from QDateTime objects with the
  3854. QDateTime::toTime_t() function. Since this only gives a resolution of one second, there is also
  3855. the QDateTime::toMSecsSinceEpoch() function which returns the timespan described above in
  3856. milliseconds. Divide its return value by 1000.0 to get a value with the format needed for
  3857. date/time plotting, with a resolution of one millisecond.
  3858. Using the toMSecsSinceEpoch function allows dates that go back to 2nd January 4713 B.C.
  3859. (represented by a negative number), unlike the toTime_t function, which works with unsigned
  3860. integers and thus only goes back to 1st January 1970. So both for range and accuracy, use of
  3861. toMSecsSinceEpoch()/1000.0 should be preferred as key coordinate for date/time axes.
  3862. \see setTickLabels
  3863. */
  3864. void QCPAxis::setTickLabelType(LabelType type)
  3865. {
  3866. if (mTickLabelType != type)
  3867. {
  3868. mTickLabelType = type;
  3869. mCachedMarginValid = false;
  3870. }
  3871. }
  3872. /*!
  3873. Sets the font of the tick labels.
  3874. \see setTickLabels, setTickLabelColor
  3875. */
  3876. void QCPAxis::setTickLabelFont(const QFont &font)
  3877. {
  3878. if (font != mTickLabelFont)
  3879. {
  3880. mTickLabelFont = font;
  3881. mCachedMarginValid = false;
  3882. mLabelCache.clear();
  3883. }
  3884. }
  3885. /*!
  3886. Sets the color of the tick labels.
  3887. \see setTickLabels, setTickLabelFont
  3888. */
  3889. void QCPAxis::setTickLabelColor(const QColor &color)
  3890. {
  3891. if (color != mTickLabelColor)
  3892. {
  3893. mTickLabelColor = color;
  3894. mCachedMarginValid = false;
  3895. mLabelCache.clear();
  3896. }
  3897. }
  3898. /*!
  3899. Sets the rotation of the tick labels. If \a degrees is zero, the labels are drawn normally. Else,
  3900. the tick labels are drawn rotated by \a degrees clockwise. The specified angle is bound to values
  3901. from -90 to 90 degrees.
  3902. If \a degrees is exactly -90, 0 or 90, the tick labels are centered on the tick coordinate. For
  3903. other angles, the label is drawn with an offset such that it seems to point toward or away from
  3904. the tick mark.
  3905. */
  3906. void QCPAxis::setTickLabelRotation(double degrees)
  3907. {
  3908. if (!qFuzzyIsNull(degrees-mTickLabelRotation))
  3909. {
  3910. mTickLabelRotation = qBound(-90.0, degrees, 90.0);
  3911. mCachedMarginValid = false;
  3912. mLabelCache.clear();
  3913. }
  3914. }
  3915. /*!
  3916. Sets the format in which dates and times are displayed as tick labels, if \ref setTickLabelType is \ref ltDateTime.
  3917. for details about the \a format string, see the documentation of QDateTime::toString().
  3918. Newlines can be inserted with "\n".
  3919. \see setDateTimeSpec
  3920. */
  3921. void QCPAxis::setDateTimeFormat(const QString &format)
  3922. {
  3923. if (mDateTimeFormat != format)
  3924. {
  3925. mDateTimeFormat = format;
  3926. mCachedMarginValid = false;
  3927. mLabelCache.clear();
  3928. }
  3929. }
  3930. /*!
  3931. Sets the time spec that is used for the date time values when \ref setTickLabelType is \ref
  3932. ltDateTime.
  3933. The default value of QDateTime objects (and also QCustomPlot) is <tt>Qt::LocalTime</tt>. However,
  3934. if the date time values passed to QCustomPlot are given in the UTC spec, set \a
  3935. timeSpec to <tt>Qt::UTC</tt> to get the correct axis labels.
  3936. \see setDateTimeFormat
  3937. */
  3938. void QCPAxis::setDateTimeSpec(const Qt::TimeSpec &timeSpec)
  3939. {
  3940. mDateTimeSpec = timeSpec;
  3941. }
  3942. /*!
  3943. Sets the number format for the numbers drawn as tick labels (if tick label type is \ref
  3944. ltNumber). This \a formatCode is an extended version of the format code used e.g. by
  3945. QString::number() and QLocale::toString(). For reference about that, see the "Argument Formats"
  3946. section in the detailed description of the QString class. \a formatCode is a string of one, two
  3947. or three characters. The first character is identical to the normal format code used by Qt. In
  3948. short, this means: 'e'/'E' scientific format, 'f' fixed format, 'g'/'G' scientific or fixed,
  3949. whichever is shorter.
  3950. The second and third characters are optional and specific to QCustomPlot:\n
  3951. If the first char was 'e' or 'g', numbers are/might be displayed in the scientific format, e.g.
  3952. "5.5e9", which is ugly in a plot. So when the second char of \a formatCode is set to 'b' (for
  3953. "beautiful"), those exponential numbers are formatted in a more natural way, i.e. "5.5
  3954. [multiplication sign] 10 [superscript] 9". By default, the multiplication sign is a centered dot.
  3955. If instead a cross should be shown (as is usual in the USA), the third char of \a formatCode can
  3956. be set to 'c'. The inserted multiplication signs are the UTF-8 characters 215 (0xD7) for the
  3957. cross and 183 (0xB7) for the dot.
  3958. If the scale type (\ref setScaleType) is \ref stLogarithmic and the \a formatCode uses the 'b'
  3959. option (beautifully typeset decimal powers), the display usually is "1 [multiplication sign] 10
  3960. [superscript] n", which looks unnatural for logarithmic scaling (the "1 [multiplication sign]"
  3961. part). To only display the decimal power, set the number precision to zero with \ref
  3962. setNumberPrecision.
  3963. Examples for \a formatCode:
  3964. \li \c g normal format code behaviour. If number is small, fixed format is used, if number is large,
  3965. normal scientific format is used
  3966. \li \c gb If number is small, fixed format is used, if number is large, scientific format is used with
  3967. beautifully typeset decimal powers and a dot as multiplication sign
  3968. \li \c ebc All numbers are in scientific format with beautifully typeset decimal power and a cross as
  3969. multiplication sign
  3970. \li \c fb illegal format code, since fixed format doesn't support (or need) beautifully typeset decimal
  3971. powers. Format code will be reduced to 'f'.
  3972. \li \c hello illegal format code, since first char is not 'e', 'E', 'f', 'g' or 'G'. Current format
  3973. code will not be changed.
  3974. */
  3975. void QCPAxis::setNumberFormat(const QString &formatCode)
  3976. {
  3977. if (formatCode.isEmpty())
  3978. {
  3979. qDebug() << Q_FUNC_INFO << "Passed formatCode is empty";
  3980. return;
  3981. }
  3982. mLabelCache.clear();
  3983. mCachedMarginValid = false;
  3984. // interpret first char as number format char:
  3985. QString allowedFormatChars = "eEfgG";
  3986. if (allowedFormatChars.contains(formatCode.at(0)))
  3987. {
  3988. mNumberFormatChar = formatCode.at(0).toLatin1();
  3989. } else
  3990. {
  3991. qDebug() << Q_FUNC_INFO << "Invalid number format code (first char not in 'eEfgG'):" << formatCode;
  3992. return;
  3993. }
  3994. if (formatCode.length() < 2)
  3995. {
  3996. mNumberBeautifulPowers = false;
  3997. mNumberMultiplyCross = false;
  3998. return;
  3999. }
  4000. // interpret second char as indicator for beautiful decimal powers:
  4001. if (formatCode.at(1) == 'b' && (mNumberFormatChar == 'e' || mNumberFormatChar == 'g'))
  4002. {
  4003. mNumberBeautifulPowers = true;
  4004. } else
  4005. {
  4006. qDebug() << Q_FUNC_INFO << "Invalid number format code (second char not 'b' or first char neither 'e' nor 'g'):" << formatCode;
  4007. return;
  4008. }
  4009. if (formatCode.length() < 3)
  4010. {
  4011. mNumberMultiplyCross = false;
  4012. return;
  4013. }
  4014. // interpret third char as indicator for dot or cross multiplication symbol:
  4015. if (formatCode.at(2) == 'c')
  4016. {
  4017. mNumberMultiplyCross = true;
  4018. } else if (formatCode.at(2) == 'd')
  4019. {
  4020. mNumberMultiplyCross = false;
  4021. } else
  4022. {
  4023. qDebug() << Q_FUNC_INFO << "Invalid number format code (third char neither 'c' nor 'd'):" << formatCode;
  4024. return;
  4025. }
  4026. }
  4027. /*!
  4028. Sets the precision of the tick label numbers. See QLocale::toString(double i, char f, int prec)
  4029. for details. The effect of precisions are most notably for number Formats starting with 'e', see
  4030. \ref setNumberFormat
  4031. If the scale type (\ref setScaleType) is \ref stLogarithmic and the number format (\ref
  4032. setNumberFormat) uses the 'b' format code (beautifully typeset decimal powers), the display
  4033. usually is "1 [multiplication sign] 10 [superscript] n", which looks unnatural for logarithmic
  4034. scaling (the redundant "1 [multiplication sign]" part). To only display the decimal power "10
  4035. [superscript] n", set \a precision to zero.
  4036. */
  4037. void QCPAxis::setNumberPrecision(int precision)
  4038. {
  4039. if (mNumberPrecision != precision)
  4040. {
  4041. mNumberPrecision = precision;
  4042. mCachedMarginValid = false;
  4043. }
  4044. }
  4045. /*!
  4046. If \ref setAutoTickStep is set to false, use this function to set the tick step manually.
  4047. The tick step is the interval between (major) ticks, in plot coordinates.
  4048. \see setSubTickCount
  4049. */
  4050. void QCPAxis::setTickStep(double step)
  4051. {
  4052. if (mTickStep != step)
  4053. {
  4054. mTickStep = step;
  4055. mCachedMarginValid = false;
  4056. }
  4057. }
  4058. /*!
  4059. If you want full control over what ticks (and possibly labels) the axes show, this function is
  4060. used to set the coordinates at which ticks will appear.\ref setAutoTicks must be disabled, else
  4061. the provided tick vector will be overwritten with automatically generated tick coordinates upon
  4062. replot. The labels of the ticks can be generated automatically when \ref setAutoTickLabels is
  4063. left enabled. If it is disabled, you can set the labels manually with \ref setTickVectorLabels.
  4064. \a vec is a vector containing the positions of the ticks, in plot coordinates.
  4065. \warning \a vec must be sorted in ascending order, no additional checks are made to ensure this.
  4066. \see setTickVectorLabels
  4067. */
  4068. void QCPAxis::setTickVector(const QVector<double> &vec)
  4069. {
  4070. // don't check whether mTickVector != vec here, because it takes longer than we would save
  4071. mTickVector = vec;
  4072. mCachedMarginValid = false;
  4073. }
  4074. /*!
  4075. If you want full control over what ticks and labels the axes show, this function is used to set a
  4076. number of QStrings that will be displayed at the tick positions which you need to provide with
  4077. \ref setTickVector. These two vectors should have the same size. (Note that you need to disable
  4078. \ref setAutoTicks and \ref setAutoTickLabels first.)
  4079. \a vec is a vector containing the labels of the ticks. The entries correspond to the respective
  4080. indices in the tick vector, passed via \ref setTickVector.
  4081. \see setTickVector
  4082. */
  4083. void QCPAxis::setTickVectorLabels(const QVector<QString> &vec)
  4084. {
  4085. // don't check whether mTickVectorLabels != vec here, because it takes longer than we would save
  4086. mTickVectorLabels = vec;
  4087. mCachedMarginValid = false;
  4088. }
  4089. /*!
  4090. Sets the length of the ticks in pixels. \a inside is the length the ticks will reach inside the
  4091. plot and \a outside is the length they will reach outside the plot. If \a outside is greater than
  4092. zero, the tick labels and axis label will increase their distance to the axis accordingly, so
  4093. they won't collide with the ticks.
  4094. \see setSubTickLength
  4095. */
  4096. void QCPAxis::setTickLength(int inside, int outside)
  4097. {
  4098. if (mTickLengthIn != inside)
  4099. {
  4100. mTickLengthIn = inside;
  4101. }
  4102. if (mTickLengthOut != outside)
  4103. {
  4104. mTickLengthOut = outside;
  4105. mCachedMarginValid = false; // only outside tick length can change margin
  4106. }
  4107. }
  4108. /*!
  4109. Sets the length of the inward ticks in pixels. \a inside is the length the ticks will reach
  4110. inside the plot.
  4111. \see setTickLengthOut, setSubTickLength
  4112. */
  4113. void QCPAxis::setTickLengthIn(int inside)
  4114. {
  4115. if (mTickLengthIn != inside)
  4116. {
  4117. mTickLengthIn = inside;
  4118. }
  4119. }
  4120. /*!
  4121. Sets the length of the outward ticks in pixels. \a outside is the length the ticks will reach
  4122. outside the plot. If \a outside is greater than zero, the tick labels and axis label will
  4123. increase their distance to the axis accordingly, so they won't collide with the ticks.
  4124. \see setTickLengthIn, setSubTickLength
  4125. */
  4126. void QCPAxis::setTickLengthOut(int outside)
  4127. {
  4128. if (mTickLengthOut != outside)
  4129. {
  4130. mTickLengthOut = outside;
  4131. mCachedMarginValid = false; // only outside tick length can change margin
  4132. }
  4133. }
  4134. /*!
  4135. Sets the number of sub ticks in one (major) tick step. A sub tick count of three for example,
  4136. divides the tick intervals in four sub intervals.
  4137. By default, the number of sub ticks is chosen automatically in a reasonable manner as long as the
  4138. mantissa of the tick step is a multiple of 0.5. When \ref setAutoTickStep is enabled, this is
  4139. always the case.
  4140. If you want to disable automatic sub tick count and use this function to set the count manually,
  4141. see \ref setAutoSubTicks.
  4142. */
  4143. void QCPAxis::setSubTickCount(int count)
  4144. {
  4145. mSubTickCount = count;
  4146. }
  4147. /*!
  4148. Sets the length of the subticks in pixels. \a inside is the length the subticks will reach inside
  4149. the plot and \a outside is the length they will reach outside the plot. If \a outside is greater
  4150. than zero, the tick labels and axis label will increase their distance to the axis accordingly,
  4151. so they won't collide with the ticks.
  4152. */
  4153. void QCPAxis::setSubTickLength(int inside, int outside)
  4154. {
  4155. if (mSubTickLengthIn != inside)
  4156. {
  4157. mSubTickLengthIn = inside;
  4158. }
  4159. if (mSubTickLengthOut != outside)
  4160. {
  4161. mSubTickLengthOut = outside;
  4162. mCachedMarginValid = false; // only outside tick length can change margin
  4163. }
  4164. }
  4165. /*!
  4166. Sets the length of the inward subticks in pixels. \a inside is the length the subticks will reach inside
  4167. the plot.
  4168. \see setSubTickLengthOut, setTickLength
  4169. */
  4170. void QCPAxis::setSubTickLengthIn(int inside)
  4171. {
  4172. if (mSubTickLengthIn != inside)
  4173. {
  4174. mSubTickLengthIn = inside;
  4175. }
  4176. }
  4177. /*!
  4178. Sets the length of the outward subticks in pixels. \a outside is the length the subticks will reach
  4179. outside the plot. If \a outside is greater than zero, the tick labels will increase their
  4180. distance to the axis accordingly, so they won't collide with the ticks.
  4181. \see setSubTickLengthIn, setTickLength
  4182. */
  4183. void QCPAxis::setSubTickLengthOut(int outside)
  4184. {
  4185. if (mSubTickLengthOut != outside)
  4186. {
  4187. mSubTickLengthOut = outside;
  4188. mCachedMarginValid = false; // only outside tick length can change margin
  4189. }
  4190. }
  4191. /*!
  4192. Sets the pen, the axis base line is drawn with.
  4193. \see setTickPen, setSubTickPen
  4194. */
  4195. void QCPAxis::setBasePen(const QPen &pen)
  4196. {
  4197. mBasePen = pen;
  4198. }
  4199. /*!
  4200. Sets the pen, tick marks will be drawn with.
  4201. \see setTickLength, setBasePen
  4202. */
  4203. void QCPAxis::setTickPen(const QPen &pen)
  4204. {
  4205. mTickPen = pen;
  4206. }
  4207. /*!
  4208. Sets the pen, subtick marks will be drawn with.
  4209. \see setSubTickCount, setSubTickLength, setBasePen
  4210. */
  4211. void QCPAxis::setSubTickPen(const QPen &pen)
  4212. {
  4213. mSubTickPen = pen;
  4214. }
  4215. /*!
  4216. Sets the font of the axis label.
  4217. \see setLabelColor
  4218. */
  4219. void QCPAxis::setLabelFont(const QFont &font)
  4220. {
  4221. if (mLabelFont != font)
  4222. {
  4223. mLabelFont = font;
  4224. mCachedMarginValid = false;
  4225. }
  4226. }
  4227. /*!
  4228. Sets the color of the axis label.
  4229. \see setLabelFont
  4230. */
  4231. void QCPAxis::setLabelColor(const QColor &color)
  4232. {
  4233. mLabelColor = color;
  4234. }
  4235. /*!
  4236. Sets the text of the axis label that will be shown below/above or next to the axis, depending on
  4237. its orientation. To disable axis labels, pass an empty string as \a str.
  4238. */
  4239. void QCPAxis::setLabel(const QString &str)
  4240. {
  4241. if (mLabel != str)
  4242. {
  4243. mLabel = str;
  4244. mCachedMarginValid = false;
  4245. }
  4246. }
  4247. /*!
  4248. Sets the distance between the tick labels and the axis label.
  4249. \see setTickLabelPadding, setPadding
  4250. */
  4251. void QCPAxis::setLabelPadding(int padding)
  4252. {
  4253. if (mLabelPadding != padding)
  4254. {
  4255. mLabelPadding = padding;
  4256. mCachedMarginValid = false;
  4257. }
  4258. }
  4259. /*!
  4260. Sets the padding of the axis.
  4261. When \ref QCPAxisRect::setAutoMargins is enabled, the padding is the additional outer most space,
  4262. that is left blank.
  4263. The axis padding has no meaning if \ref QCPAxisRect::setAutoMargins is disabled.
  4264. \see setLabelPadding, setTickLabelPadding
  4265. */
  4266. void QCPAxis::setPadding(int padding)
  4267. {
  4268. if (mPadding != padding)
  4269. {
  4270. mPadding = padding;
  4271. mCachedMarginValid = false;
  4272. }
  4273. }
  4274. /*!
  4275. Sets the offset the axis has to its axis rect side.
  4276. If an axis rect side has multiple axes, only the offset of the inner most axis has meaning. The offset of the other axes
  4277. is controlled automatically, to place the axes at appropriate positions to prevent them from overlapping.
  4278. */
  4279. void QCPAxis::setOffset(int offset)
  4280. {
  4281. mOffset = offset;
  4282. }
  4283. /*!
  4284. Sets the font that is used for tick labels when they are selected.
  4285. \see setTickLabelFont, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions
  4286. */
  4287. void QCPAxis::setSelectedTickLabelFont(const QFont &font)
  4288. {
  4289. if (font != mSelectedTickLabelFont)
  4290. {
  4291. mSelectedTickLabelFont = font;
  4292. mLabelCache.clear();
  4293. // don't set mCachedMarginValid to false here because margin calculation is always done with non-selected fonts
  4294. }
  4295. }
  4296. /*!
  4297. Sets the font that is used for the axis label when it is selected.
  4298. \see setLabelFont, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions
  4299. */
  4300. void QCPAxis::setSelectedLabelFont(const QFont &font)
  4301. {
  4302. mSelectedLabelFont = font;
  4303. // don't set mCachedMarginValid to false here because margin calculation is always done with non-selected fonts
  4304. }
  4305. /*!
  4306. Sets the color that is used for tick labels when they are selected.
  4307. \see setTickLabelColor, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions
  4308. */
  4309. void QCPAxis::setSelectedTickLabelColor(const QColor &color)
  4310. {
  4311. if (color != mSelectedTickLabelColor)
  4312. {
  4313. mSelectedTickLabelColor = color;
  4314. mLabelCache.clear();
  4315. }
  4316. }
  4317. /*!
  4318. Sets the color that is used for the axis label when it is selected.
  4319. \see setLabelColor, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions
  4320. */
  4321. void QCPAxis::setSelectedLabelColor(const QColor &color)
  4322. {
  4323. mSelectedLabelColor = color;
  4324. }
  4325. /*!
  4326. Sets the pen that is used to draw the axis base line when selected.
  4327. \see setBasePen, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions
  4328. */
  4329. void QCPAxis::setSelectedBasePen(const QPen &pen)
  4330. {
  4331. mSelectedBasePen = pen;
  4332. }
  4333. /*!
  4334. Sets the pen that is used to draw the (major) ticks when selected.
  4335. \see setTickPen, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions
  4336. */
  4337. void QCPAxis::setSelectedTickPen(const QPen &pen)
  4338. {
  4339. mSelectedTickPen = pen;
  4340. }
  4341. /*!
  4342. Sets the pen that is used to draw the subticks when selected.
  4343. \see setSubTickPen, setSelectableParts, setSelectedParts, QCustomPlot::setInteractions
  4344. */
  4345. void QCPAxis::setSelectedSubTickPen(const QPen &pen)
  4346. {
  4347. mSelectedSubTickPen = pen;
  4348. }
  4349. /*!
  4350. Sets the style for the lower axis ending. See the documentation of QCPLineEnding for available
  4351. styles.
  4352. For horizontal axes, this method refers to the left ending, for vertical axes the bottom ending.
  4353. Note that this meaning does not change when the axis range is reversed with \ref
  4354. setRangeReversed.
  4355. \see setUpperEnding
  4356. */
  4357. void QCPAxis::setLowerEnding(const QCPLineEnding &ending)
  4358. {
  4359. mLowerEnding = ending;
  4360. }
  4361. /*!
  4362. Sets the style for the upper axis ending. See the documentation of QCPLineEnding for available
  4363. styles.
  4364. For horizontal axes, this method refers to the right ending, for vertical axes the top ending.
  4365. Note that this meaning does not change when the axis range is reversed with \ref
  4366. setRangeReversed.
  4367. \see setLowerEnding
  4368. */
  4369. void QCPAxis::setUpperEnding(const QCPLineEnding &ending)
  4370. {
  4371. mUpperEnding = ending;
  4372. }
  4373. /*!
  4374. If the scale type (\ref setScaleType) is \ref stLinear, \a diff is added to the lower and upper
  4375. bounds of the range. The range is simply moved by \a diff.
  4376. If the scale type is \ref stLogarithmic, the range bounds are multiplied by \a diff. This
  4377. corresponds to an apparent "linear" move in logarithmic scaling by a distance of log(diff).
  4378. */
  4379. void QCPAxis::moveRange(double diff)
  4380. {
  4381. QCPRange oldRange = mRange;
  4382. if (mScaleType == stLinear)
  4383. {
  4384. mRange.lower += diff;
  4385. mRange.upper += diff;
  4386. } else // mScaleType == stLogarithmic
  4387. {
  4388. mRange.lower *= diff;
  4389. mRange.upper *= diff;
  4390. }
  4391. mCachedMarginValid = false;
  4392. emit rangeChanged(mRange);
  4393. emit rangeChanged(mRange, oldRange);
  4394. }
  4395. /*!
  4396. Scales the range of this axis by \a factor around the coordinate \a center. For example, if \a
  4397. factor is 2.0, \a center is 1.0, then the axis range will double its size, and the point at
  4398. coordinate 1.0 won't have changed its position in the QCustomPlot widget (i.e. coordinates
  4399. around 1.0 will have moved symmetrically closer to 1.0).
  4400. */
  4401. void QCPAxis::scaleRange(double factor, double center)
  4402. {
  4403. QCPRange oldRange = mRange;
  4404. if (mScaleType == stLinear)
  4405. {
  4406. QCPRange newRange;
  4407. newRange.lower = (mRange.lower-center)*factor + center;
  4408. newRange.upper = (mRange.upper-center)*factor + center;
  4409. if (QCPRange::validRange(newRange))
  4410. mRange = newRange.sanitizedForLinScale();
  4411. } else // mScaleType == stLogarithmic
  4412. {
  4413. if ((mRange.upper < 0 && center < 0) || (mRange.upper > 0 && center > 0)) // make sure center has same sign as range
  4414. {
  4415. QCPRange newRange;
  4416. newRange.lower = pow(mRange.lower/center, factor)*center;
  4417. newRange.upper = pow(mRange.upper/center, factor)*center;
  4418. if (QCPRange::validRange(newRange))
  4419. mRange = newRange.sanitizedForLogScale();
  4420. } else
  4421. qDebug() << Q_FUNC_INFO << "Center of scaling operation doesn't lie in same logarithmic sign domain as range:" << center;
  4422. }
  4423. mCachedMarginValid = false;
  4424. emit rangeChanged(mRange);
  4425. emit rangeChanged(mRange, oldRange);
  4426. }
  4427. /*!
  4428. Scales the range of this axis to have a certain scale \a ratio to \a otherAxis. The scaling will
  4429. be done around the center of the current axis range.
  4430. For example, if \a ratio is 1, this axis is the \a yAxis and \a otherAxis is \a xAxis, graphs
  4431. plotted with those axes will appear in a 1:1 aspect ratio, independent of the aspect ratio the
  4432. axis rect has.
  4433. This is an operation that changes the range of this axis once, it doesn't fix the scale ratio
  4434. indefinitely. Note that calling this function in the constructor of the QCustomPlot's parent
  4435. won't have the desired effect, since the widget dimensions aren't defined yet, and a resizeEvent
  4436. will follow.
  4437. */
  4438. void QCPAxis::setScaleRatio(const QCPAxis *otherAxis, double ratio)
  4439. {
  4440. int otherPixelSize, ownPixelSize;
  4441. if (otherAxis->orientation() == Qt::Horizontal)
  4442. otherPixelSize = otherAxis->axisRect()->width();
  4443. else
  4444. otherPixelSize = otherAxis->axisRect()->height();
  4445. if (orientation() == Qt::Horizontal)
  4446. ownPixelSize = axisRect()->width();
  4447. else
  4448. ownPixelSize = axisRect()->height();
  4449. double newRangeSize = ratio*otherAxis->range().size()*ownPixelSize/(double)otherPixelSize;
  4450. setRange(range().center(), newRangeSize, Qt::AlignCenter);
  4451. }
  4452. /*!
  4453. Changes the axis range such that all plottables associated with this axis are fully visible in
  4454. that dimension.
  4455. \see QCPAbstractPlottable::rescaleAxes, QCustomPlot::rescaleAxes
  4456. */
  4457. void QCPAxis::rescale(bool onlyVisiblePlottables)
  4458. {
  4459. QList<QCPAbstractPlottable*> p = plottables();
  4460. QCPRange newRange;
  4461. bool haveRange = false;
  4462. for (int i=0; i<p.size(); ++i)
  4463. {
  4464. if (!p.at(i)->realVisibility() && onlyVisiblePlottables)
  4465. continue;
  4466. QCPRange plottableRange;
  4467. bool validRange;
  4468. QCPAbstractPlottable::SignDomain signDomain = QCPAbstractPlottable::sdBoth;
  4469. if (mScaleType == stLogarithmic)
  4470. signDomain = (mRange.upper < 0 ? QCPAbstractPlottable::sdNegative : QCPAbstractPlottable::sdPositive);
  4471. if (p.at(i)->keyAxis() == this)
  4472. plottableRange = p.at(i)->getKeyRange(validRange, signDomain);
  4473. else
  4474. plottableRange = p.at(i)->getValueRange(validRange, signDomain);
  4475. if (validRange)
  4476. {
  4477. if (!haveRange)
  4478. newRange = plottableRange;
  4479. else
  4480. newRange.expand(plottableRange);
  4481. haveRange = true;
  4482. }
  4483. }
  4484. if (haveRange)
  4485. setRange(newRange);
  4486. }
  4487. /*!
  4488. Transforms \a value, in pixel coordinates of the QCustomPlot widget, to axis coordinates.
  4489. */
  4490. double QCPAxis::pixelToCoord(double value) const
  4491. {
  4492. if (orientation() == Qt::Horizontal)
  4493. {
  4494. if (mScaleType == stLinear)
  4495. {
  4496. if (!mRangeReversed)
  4497. return (value-mAxisRect->left())/(double)mAxisRect->width()*mRange.size()+mRange.lower;
  4498. else
  4499. return -(value-mAxisRect->left())/(double)mAxisRect->width()*mRange.size()+mRange.upper;
  4500. } else // mScaleType == stLogarithmic
  4501. {
  4502. if (!mRangeReversed)
  4503. return pow(mRange.upper/mRange.lower, (value-mAxisRect->left())/(double)mAxisRect->width())*mRange.lower;
  4504. else
  4505. return pow(mRange.upper/mRange.lower, (mAxisRect->left()-value)/(double)mAxisRect->width())*mRange.upper;
  4506. }
  4507. } else // orientation() == Qt::Vertical
  4508. {
  4509. if (mScaleType == stLinear)
  4510. {
  4511. if (!mRangeReversed)
  4512. return (mAxisRect->bottom()-value)/(double)mAxisRect->height()*mRange.size()+mRange.lower;
  4513. else
  4514. return -(mAxisRect->bottom()-value)/(double)mAxisRect->height()*mRange.size()+mRange.upper;
  4515. } else // mScaleType == stLogarithmic
  4516. {
  4517. if (!mRangeReversed)
  4518. return pow(mRange.upper/mRange.lower, (mAxisRect->bottom()-value)/(double)mAxisRect->height())*mRange.lower;
  4519. else
  4520. return pow(mRange.upper/mRange.lower, (value-mAxisRect->bottom())/(double)mAxisRect->height())*mRange.upper;
  4521. }
  4522. }
  4523. }
  4524. /*!
  4525. Transforms \a value, in coordinates of the axis, to pixel coordinates of the QCustomPlot widget.
  4526. */
  4527. double QCPAxis::coordToPixel(double value) const
  4528. {
  4529. if (orientation() == Qt::Horizontal)
  4530. {
  4531. if (mScaleType == stLinear)
  4532. {
  4533. if (!mRangeReversed)
  4534. return (value-mRange.lower)/mRange.size()*mAxisRect->width()+mAxisRect->left();
  4535. else
  4536. return (mRange.upper-value)/mRange.size()*mAxisRect->width()+mAxisRect->left();
  4537. } else // mScaleType == stLogarithmic
  4538. {
  4539. if (value >= 0 && mRange.upper < 0) // invalid value for logarithmic scale, just draw it outside visible range
  4540. return !mRangeReversed ? mAxisRect->right()+200 : mAxisRect->left()-200;
  4541. else if (value <= 0 && mRange.upper > 0) // invalid value for logarithmic scale, just draw it outside visible range
  4542. return !mRangeReversed ? mAxisRect->left()-200 : mAxisRect->right()+200;
  4543. else
  4544. {
  4545. if (!mRangeReversed)
  4546. return baseLog(value/mRange.lower)/baseLog(mRange.upper/mRange.lower)*mAxisRect->width()+mAxisRect->left();
  4547. else
  4548. return baseLog(mRange.upper/value)/baseLog(mRange.upper/mRange.lower)*mAxisRect->width()+mAxisRect->left();
  4549. }
  4550. }
  4551. } else // orientation() == Qt::Vertical
  4552. {
  4553. if (mScaleType == stLinear)
  4554. {
  4555. if (!mRangeReversed)
  4556. return mAxisRect->bottom()-(value-mRange.lower)/mRange.size()*mAxisRect->height();
  4557. else
  4558. return mAxisRect->bottom()-(mRange.upper-value)/mRange.size()*mAxisRect->height();
  4559. } else // mScaleType == stLogarithmic
  4560. {
  4561. if (value >= 0 && mRange.upper < 0) // invalid value for logarithmic scale, just draw it outside visible range
  4562. return !mRangeReversed ? mAxisRect->top()-200 : mAxisRect->bottom()+200;
  4563. else if (value <= 0 && mRange.upper > 0) // invalid value for logarithmic scale, just draw it outside visible range
  4564. return !mRangeReversed ? mAxisRect->bottom()+200 : mAxisRect->top()-200;
  4565. else
  4566. {
  4567. if (!mRangeReversed)
  4568. return mAxisRect->bottom()-baseLog(value/mRange.lower)/baseLog(mRange.upper/mRange.lower)*mAxisRect->height();
  4569. else
  4570. return mAxisRect->bottom()-baseLog(mRange.upper/value)/baseLog(mRange.upper/mRange.lower)*mAxisRect->height();
  4571. }
  4572. }
  4573. }
  4574. }
  4575. /*!
  4576. Returns the part of the axis that is hit by \a pos (in pixels). The return value of this function
  4577. is independent of the user-selectable parts defined with \ref setSelectableParts. Further, this
  4578. function does not change the current selection state of the axis.
  4579. If the axis is not visible (\ref setVisible), this function always returns \ref spNone.
  4580. \see setSelectedParts, setSelectableParts, QCustomPlot::setInteractions
  4581. */
  4582. QCPAxis::SelectablePart QCPAxis::getPartAt(const QPointF &pos) const
  4583. {
  4584. if (!mVisible)
  4585. return spNone;
  4586. if (mAxisSelectionBox.contains(pos.toPoint()))
  4587. return spAxis;
  4588. else if (mTickLabelsSelectionBox.contains(pos.toPoint()))
  4589. return spTickLabels;
  4590. else if (mLabelSelectionBox.contains(pos.toPoint()))
  4591. return spAxisLabel;
  4592. else
  4593. return spNone;
  4594. }
  4595. /* inherits documentation from base class */
  4596. double QCPAxis::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  4597. {
  4598. if (!mParentPlot) return -1;
  4599. SelectablePart part = getPartAt(pos);
  4600. if ((onlySelectable && !mSelectableParts.testFlag(part)) || part == spNone)
  4601. return -1;
  4602. if (details)
  4603. details->setValue(part);
  4604. return mParentPlot->selectionTolerance()*0.99;
  4605. }
  4606. /*!
  4607. Returns a list of all the plottables that have this axis as key or value axis.
  4608. If you are only interested in plottables of type QCPGraph, see \ref graphs.
  4609. \see graphs, items
  4610. */
  4611. QList<QCPAbstractPlottable*> QCPAxis::plottables() const
  4612. {
  4613. QList<QCPAbstractPlottable*> result;
  4614. if (!mParentPlot) return result;
  4615. for (int i=0; i<mParentPlot->mPlottables.size(); ++i)
  4616. {
  4617. if (mParentPlot->mPlottables.at(i)->keyAxis() == this ||mParentPlot->mPlottables.at(i)->valueAxis() == this)
  4618. result.append(mParentPlot->mPlottables.at(i));
  4619. }
  4620. return result;
  4621. }
  4622. /*!
  4623. Returns a list of all the graphs that have this axis as key or value axis.
  4624. \see plottables, items
  4625. */
  4626. QList<QCPGraph*> QCPAxis::graphs() const
  4627. {
  4628. QList<QCPGraph*> result;
  4629. if (!mParentPlot) return result;
  4630. for (int i=0; i<mParentPlot->mGraphs.size(); ++i)
  4631. {
  4632. if (mParentPlot->mGraphs.at(i)->keyAxis() == this || mParentPlot->mGraphs.at(i)->valueAxis() == this)
  4633. result.append(mParentPlot->mGraphs.at(i));
  4634. }
  4635. return result;
  4636. }
  4637. /*!
  4638. Returns a list of all the items that are associated with this axis. An item is considered
  4639. associated with an axis if at least one of its positions uses the axis as key or value axis.
  4640. \see plottables, graphs
  4641. */
  4642. QList<QCPAbstractItem*> QCPAxis::items() const
  4643. {
  4644. QList<QCPAbstractItem*> result;
  4645. if (!mParentPlot) return result;
  4646. for (int itemId=0; itemId<mParentPlot->mItems.size(); ++itemId)
  4647. {
  4648. QList<QCPItemPosition*> positions = mParentPlot->mItems.at(itemId)->positions();
  4649. for (int posId=0; posId<positions.size(); ++posId)
  4650. {
  4651. if (positions.at(posId)->keyAxis() == this || positions.at(posId)->valueAxis() == this)
  4652. {
  4653. result.append(mParentPlot->mItems.at(itemId));
  4654. break;
  4655. }
  4656. }
  4657. }
  4658. return result;
  4659. }
  4660. /*!
  4661. Transforms a margin side to the logically corresponding axis type. (QCP::msLeft to
  4662. QCPAxis::atLeft, QCP::msRight to QCPAxis::atRight, etc.)
  4663. */
  4664. QCPAxis::AxisType QCPAxis::marginSideToAxisType(QCP::MarginSide side)
  4665. {
  4666. switch (side)
  4667. {
  4668. case QCP::msLeft: return atLeft;
  4669. case QCP::msRight: return atRight;
  4670. case QCP::msTop: return atTop;
  4671. case QCP::msBottom: return atBottom;
  4672. default: break;
  4673. }
  4674. qDebug() << Q_FUNC_INFO << "Invalid margin side passed:" << (int)side;
  4675. return atLeft;
  4676. }
  4677. /*! \internal
  4678. This function is called to prepare the tick vector, sub tick vector and tick label vector. If
  4679. \ref setAutoTicks is set to true, appropriate tick values are determined automatically via \ref
  4680. generateAutoTicks. If it's set to false, the signal ticksRequest is emitted, which can be used to
  4681. provide external tick positions. Then the sub tick vectors and tick label vectors are created.
  4682. */
  4683. void QCPAxis::setupTickVectors()
  4684. {
  4685. if (!mParentPlot) return;
  4686. if ((!mTicks && !mTickLabels && !mGrid->visible()) || mRange.size() <= 0) return;
  4687. // fill tick vectors, either by auto generating or by notifying user to fill the vectors himself
  4688. if (mAutoTicks)
  4689. {
  4690. generateAutoTicks();
  4691. } else
  4692. {
  4693. emit ticksRequest();
  4694. }
  4695. visibleTickBounds(mLowestVisibleTick, mHighestVisibleTick);
  4696. if (mTickVector.isEmpty())
  4697. {
  4698. mSubTickVector.clear();
  4699. return;
  4700. }
  4701. // generate subticks between ticks:
  4702. mSubTickVector.resize((mTickVector.size()-1)*mSubTickCount);
  4703. if (mSubTickCount > 0)
  4704. {
  4705. double subTickStep = 0;
  4706. double subTickPosition = 0;
  4707. int subTickIndex = 0;
  4708. bool done = false;
  4709. int lowTick = mLowestVisibleTick > 0 ? mLowestVisibleTick-1 : mLowestVisibleTick;
  4710. int highTick = mHighestVisibleTick < mTickVector.size()-1 ? mHighestVisibleTick+1 : mHighestVisibleTick;
  4711. for (int i=lowTick+1; i<=highTick; ++i)
  4712. {
  4713. subTickStep = (mTickVector.at(i)-mTickVector.at(i-1))/(double)(mSubTickCount+1);
  4714. for (int k=1; k<=mSubTickCount; ++k)
  4715. {
  4716. subTickPosition = mTickVector.at(i-1) + k*subTickStep;
  4717. if (subTickPosition < mRange.lower)
  4718. continue;
  4719. if (subTickPosition > mRange.upper)
  4720. {
  4721. done = true;
  4722. break;
  4723. }
  4724. mSubTickVector[subTickIndex] = subTickPosition;
  4725. subTickIndex++;
  4726. }
  4727. if (done) break;
  4728. }
  4729. mSubTickVector.resize(subTickIndex);
  4730. }
  4731. // generate tick labels according to tick positions:
  4732. mExponentialChar = mParentPlot->locale().exponential(); // will be needed when drawing the numbers generated here, in getTickLabelData()
  4733. mPositiveSignChar = mParentPlot->locale().positiveSign(); // will be needed when drawing the numbers generated here, in getTickLabelData()
  4734. if (mAutoTickLabels)
  4735. {
  4736. int vecsize = mTickVector.size();
  4737. mTickVectorLabels.resize(vecsize);
  4738. if (mTickLabelType == ltNumber)
  4739. {
  4740. for (int i=mLowestVisibleTick; i<=mHighestVisibleTick; ++i)
  4741. mTickVectorLabels[i] = mParentPlot->locale().toString(mTickVector.at(i), mNumberFormatChar, mNumberPrecision);
  4742. } else if (mTickLabelType == ltDateTime)
  4743. {
  4744. for (int i=mLowestVisibleTick; i<=mHighestVisibleTick; ++i)
  4745. {
  4746. #if QT_VERSION < QT_VERSION_CHECK(4, 7, 0) // use fromMSecsSinceEpoch function if available, to gain sub-second accuracy on tick labels (e.g. for format "hh:mm:ss:zzz")
  4747. mTickVectorLabels[i] = mParentPlot->locale().toString(QDateTime::fromTime_t(mTickVector.at(i)).toTimeSpec(mDateTimeSpec), mDateTimeFormat);
  4748. #else
  4749. mTickVectorLabels[i] = mParentPlot->locale().toString(QDateTime::fromMSecsSinceEpoch(mTickVector.at(i)*1000).toTimeSpec(mDateTimeSpec), mDateTimeFormat);
  4750. #endif
  4751. }
  4752. }
  4753. } else // mAutoTickLabels == false
  4754. {
  4755. if (mAutoTicks) // ticks generated automatically, but not ticklabels, so emit ticksRequest here for labels
  4756. {
  4757. emit ticksRequest();
  4758. }
  4759. // make sure provided tick label vector has correct (minimal) length:
  4760. if (mTickVectorLabels.size() < mTickVector.size())
  4761. mTickVectorLabels.resize(mTickVector.size());
  4762. }
  4763. }
  4764. /*! \internal
  4765. If \ref setAutoTicks is set to true, this function is called by \ref setupTickVectors to
  4766. generate reasonable tick positions (and subtick count). The algorithm tries to create
  4767. approximately <tt>mAutoTickCount</tt> ticks (set via \ref setAutoTickCount).
  4768. If the scale is logarithmic, \ref setAutoTickCount is ignored, and one tick is generated at every
  4769. power of the current logarithm base, set via \ref setScaleLogBase.
  4770. */
  4771. void QCPAxis::generateAutoTicks()
  4772. {
  4773. if (mScaleType == stLinear)
  4774. {
  4775. if (mAutoTickStep)
  4776. {
  4777. // Generate tick positions according to linear scaling:
  4778. mTickStep = mRange.size()/(double)(mAutoTickCount+1e-10); // mAutoTickCount ticks on average, the small addition is to prevent jitter on exact integers
  4779. double magnitudeFactor = qPow(10.0, qFloor(qLn(mTickStep)/qLn(10.0))); // get magnitude factor e.g. 0.01, 1, 10, 1000 etc.
  4780. double tickStepMantissa = mTickStep/magnitudeFactor;
  4781. if (tickStepMantissa < 5)
  4782. {
  4783. // round digit after decimal point to 0.5
  4784. mTickStep = (int)(tickStepMantissa*2)/2.0*magnitudeFactor;
  4785. } else
  4786. {
  4787. // round to first digit in multiples of 2
  4788. mTickStep = (int)(tickStepMantissa/2.0)*2.0*magnitudeFactor;
  4789. }
  4790. }
  4791. if (mAutoSubTicks)
  4792. mSubTickCount = calculateAutoSubTickCount(mTickStep);
  4793. // Generate tick positions according to mTickStep:
  4794. qint64 firstStep = floor(mRange.lower/mTickStep);
  4795. qint64 lastStep = ceil(mRange.upper/mTickStep);
  4796. int tickcount = lastStep-firstStep+1;
  4797. if (tickcount < 0) tickcount = 0;
  4798. mTickVector.resize(tickcount);
  4799. for (int i=0; i<tickcount; ++i)
  4800. mTickVector[i] = (firstStep+i)*mTickStep;
  4801. } else // mScaleType == stLogarithmic
  4802. {
  4803. // Generate tick positions according to logbase scaling:
  4804. if (mRange.lower > 0 && mRange.upper > 0) // positive range
  4805. {
  4806. double lowerMag = basePow((int)floor(baseLog(mRange.lower)));
  4807. double currentMag = lowerMag;
  4808. mTickVector.clear();
  4809. mTickVector.append(currentMag);
  4810. while (currentMag < mRange.upper && currentMag > 0) // currentMag might be zero for ranges ~1e-300, just cancel in that case
  4811. {
  4812. currentMag *= mScaleLogBase;
  4813. mTickVector.append(currentMag);
  4814. }
  4815. } else if (mRange.lower < 0 && mRange.upper < 0) // negative range
  4816. {
  4817. double lowerMag = -basePow((int)ceil(baseLog(-mRange.lower)));
  4818. double currentMag = lowerMag;
  4819. mTickVector.clear();
  4820. mTickVector.append(currentMag);
  4821. while (currentMag < mRange.upper && currentMag < 0) // currentMag might be zero for ranges ~1e-300, just cancel in that case
  4822. {
  4823. currentMag /= mScaleLogBase;
  4824. mTickVector.append(currentMag);
  4825. }
  4826. } else // invalid range for logarithmic scale, because lower and upper have different sign
  4827. {
  4828. mTickVector.clear();
  4829. qDebug() << Q_FUNC_INFO << "Invalid range for logarithmic plot: " << mRange.lower << "-" << mRange.upper;
  4830. }
  4831. }
  4832. }
  4833. /*! \internal
  4834. Called by generateAutoTicks when \ref setAutoSubTicks is set to true. Depending on the \a
  4835. tickStep between two major ticks on the axis, a different number of sub ticks is appropriate. For
  4836. Example taking 4 sub ticks for a \a tickStep of 1 makes more sense than taking 5 sub ticks,
  4837. because this corresponds to a sub tick step of 0.2, instead of the less intuitive 0.16667. Note
  4838. that a subtick count of 4 means dividing the major tick step into 5 sections.
  4839. This is implemented by a hand made lookup for integer tick steps as well as fractional tick steps
  4840. with a fractional part of (approximately) 0.5. If a tick step is different (i.e. has no
  4841. fractional part close to 0.5), the currently set sub tick count (\ref setSubTickCount) is
  4842. returned.
  4843. */
  4844. int QCPAxis::calculateAutoSubTickCount(double tickStep) const
  4845. {
  4846. int result = mSubTickCount; // default to current setting, if no proper value can be found
  4847. // get mantissa of tickstep:
  4848. double magnitudeFactor = qPow(10.0, qFloor(qLn(tickStep)/qLn(10.0))); // get magnitude factor e.g. 0.01, 1, 10, 1000 etc.
  4849. double tickStepMantissa = tickStep/magnitudeFactor;
  4850. // separate integer and fractional part of mantissa:
  4851. double epsilon = 0.01;
  4852. double intPartf;
  4853. int intPart;
  4854. double fracPart = modf(tickStepMantissa, &intPartf);
  4855. intPart = intPartf;
  4856. // handle cases with (almost) integer mantissa:
  4857. if (fracPart < epsilon || 1.0-fracPart < epsilon)
  4858. {
  4859. if (1.0-fracPart < epsilon)
  4860. ++intPart;
  4861. switch (intPart)
  4862. {
  4863. case 1: result = 4; break; // 1.0 -> 0.2 substep
  4864. case 2: result = 3; break; // 2.0 -> 0.5 substep
  4865. case 3: result = 2; break; // 3.0 -> 1.0 substep
  4866. case 4: result = 3; break; // 4.0 -> 1.0 substep
  4867. case 5: result = 4; break; // 5.0 -> 1.0 substep
  4868. case 6: result = 2; break; // 6.0 -> 2.0 substep
  4869. case 7: result = 6; break; // 7.0 -> 1.0 substep
  4870. case 8: result = 3; break; // 8.0 -> 2.0 substep
  4871. case 9: result = 2; break; // 9.0 -> 3.0 substep
  4872. }
  4873. } else
  4874. {
  4875. // handle cases with significantly fractional mantissa:
  4876. if (qAbs(fracPart-0.5) < epsilon) // *.5 mantissa
  4877. {
  4878. switch (intPart)
  4879. {
  4880. case 1: result = 2; break; // 1.5 -> 0.5 substep
  4881. case 2: result = 4; break; // 2.5 -> 0.5 substep
  4882. case 3: result = 4; break; // 3.5 -> 0.7 substep
  4883. case 4: result = 2; break; // 4.5 -> 1.5 substep
  4884. case 5: result = 4; break; // 5.5 -> 1.1 substep (won't occur with autoTickStep from here on)
  4885. case 6: result = 4; break; // 6.5 -> 1.3 substep
  4886. case 7: result = 2; break; // 7.5 -> 2.5 substep
  4887. case 8: result = 4; break; // 8.5 -> 1.7 substep
  4888. case 9: result = 4; break; // 9.5 -> 1.9 substep
  4889. }
  4890. }
  4891. // if mantissa fraction isnt 0.0 or 0.5, don't bother finding good sub tick marks, leave default
  4892. }
  4893. return result;
  4894. }
  4895. /*! \internal
  4896. Draws the axis with the specified \a painter.
  4897. The selection boxes (mAxisSelectionBox, mTickLabelsSelectionBox, mLabelSelectionBox) are set
  4898. here, too.
  4899. */
  4900. void QCPAxis::draw(QCPPainter *painter)
  4901. {
  4902. if (!mParentPlot) return;
  4903. QPoint origin;
  4904. if (mAxisType == atLeft)
  4905. origin = mAxisRect->bottomLeft()+QPoint(-mOffset, 0);
  4906. else if (mAxisType == atRight)
  4907. origin = mAxisRect->bottomRight()+QPoint(+mOffset, 0);
  4908. else if (mAxisType == atTop)
  4909. origin = mAxisRect->topLeft()+QPoint(0, -mOffset);
  4910. else if (mAxisType == atBottom)
  4911. origin = mAxisRect->bottomLeft()+QPoint(0, +mOffset);
  4912. double xCor = 0, yCor = 0; // paint system correction, for pixel exact matches (affects baselines and ticks of top/right axes)
  4913. switch (mAxisType)
  4914. {
  4915. case atTop: yCor = -1; break;
  4916. case atRight: xCor = 1; break;
  4917. default: break;
  4918. }
  4919. int margin = 0;
  4920. int lowTick = mLowestVisibleTick;
  4921. int highTick = mHighestVisibleTick;
  4922. double t; // helper variable, result of coordinate-to-pixel transforms
  4923. // draw baseline:
  4924. QLineF baseLine;
  4925. painter->setPen(getBasePen());
  4926. if (orientation() == Qt::Horizontal)
  4927. baseLine.setPoints(origin+QPointF(xCor, yCor), origin+QPointF(mAxisRect->width()+xCor, yCor));
  4928. else
  4929. baseLine.setPoints(origin+QPointF(xCor, yCor), origin+QPointF(xCor, -mAxisRect->height()+yCor));
  4930. if (mRangeReversed)
  4931. baseLine = QLineF(baseLine.p2(), baseLine.p1()); // won't make a difference for line itself, but for line endings later
  4932. painter->drawLine(baseLine);
  4933. // draw ticks:
  4934. if (mTicks)
  4935. {
  4936. painter->setPen(getTickPen());
  4937. // direction of ticks ("inward" is right for left axis and left for right axis)
  4938. int tickDir = (mAxisType == atBottom || mAxisType == atRight) ? -1 : 1;
  4939. if (orientation() == Qt::Horizontal)
  4940. {
  4941. for (int i=lowTick; i <= highTick; ++i)
  4942. {
  4943. t = coordToPixel(mTickVector.at(i)); // x
  4944. painter->drawLine(QLineF(t+xCor, origin.y()-mTickLengthOut*tickDir+yCor, t+xCor, origin.y()+mTickLengthIn*tickDir+yCor));
  4945. }
  4946. } else
  4947. {
  4948. for (int i=lowTick; i <= highTick; ++i)
  4949. {
  4950. t = coordToPixel(mTickVector.at(i)); // y
  4951. painter->drawLine(QLineF(origin.x()-mTickLengthOut*tickDir+xCor, t+yCor, origin.x()+mTickLengthIn*tickDir+xCor, t+yCor));
  4952. }
  4953. }
  4954. }
  4955. // draw subticks:
  4956. if (mTicks && mSubTickCount > 0)
  4957. {
  4958. painter->setPen(getSubTickPen());
  4959. // direction of ticks ("inward" is right for left axis and left for right axis)
  4960. int tickDir = (mAxisType == atBottom || mAxisType == atRight) ? -1 : 1;
  4961. if (orientation() == Qt::Horizontal)
  4962. {
  4963. for (int i=0; i<mSubTickVector.size(); ++i) // no need to check bounds because subticks are always only created inside current mRange
  4964. {
  4965. t = coordToPixel(mSubTickVector.at(i));
  4966. painter->drawLine(QLineF(t+xCor, origin.y()-mSubTickLengthOut*tickDir+yCor, t+xCor, origin.y()+mSubTickLengthIn*tickDir+yCor));
  4967. }
  4968. } else
  4969. {
  4970. for (int i=0; i<mSubTickVector.size(); ++i)
  4971. {
  4972. t = coordToPixel(mSubTickVector.at(i));
  4973. painter->drawLine(QLineF(origin.x()-mSubTickLengthOut*tickDir+xCor, t+yCor, origin.x()+mSubTickLengthIn*tickDir+xCor, t+yCor));
  4974. }
  4975. }
  4976. }
  4977. margin += qMax(0, qMax(mTickLengthOut, mSubTickLengthOut));
  4978. // draw axis base endings:
  4979. bool antialiasingBackup = painter->antialiasing();
  4980. painter->setAntialiasing(true); // always want endings to be antialiased, even if base and ticks themselves aren't
  4981. painter->setBrush(QBrush(basePen().color()));
  4982. QVector2D baseLineVector(baseLine.dx(), baseLine.dy());
  4983. if (mLowerEnding.style() != QCPLineEnding::esNone)
  4984. mLowerEnding.draw(painter, QVector2D(baseLine.p1())-baseLineVector.normalized()*mLowerEnding.realLength()*(mLowerEnding.inverted()?-1:1), -baseLineVector);
  4985. if (mUpperEnding.style() != QCPLineEnding::esNone)
  4986. mUpperEnding.draw(painter, QVector2D(baseLine.p2())+baseLineVector.normalized()*mUpperEnding.realLength()*(mUpperEnding.inverted()?-1:1), baseLineVector);
  4987. painter->setAntialiasing(antialiasingBackup);
  4988. // tick labels:
  4989. QSize tickLabelsSize(0, 0); // size of largest tick label, for offset calculation of axis label
  4990. if (mTickLabels)
  4991. {
  4992. margin += mTickLabelPadding;
  4993. painter->setFont(getTickLabelFont());
  4994. painter->setPen(QPen(getTickLabelColor()));
  4995. for (int i=lowTick; i <= highTick; ++i)
  4996. {
  4997. t = coordToPixel(mTickVector.at(i));
  4998. placeTickLabel(painter, t, margin, mTickVectorLabels.at(i), &tickLabelsSize);
  4999. }
  5000. }
  5001. if (orientation() == Qt::Horizontal)
  5002. margin += tickLabelsSize.height();
  5003. else
  5004. margin += tickLabelsSize.width();
  5005. // axis label:
  5006. QRect labelBounds;
  5007. if (!mLabel.isEmpty())
  5008. {
  5009. margin += mLabelPadding;
  5010. painter->setFont(getLabelFont());
  5011. painter->setPen(QPen(getLabelColor()));
  5012. labelBounds = painter->fontMetrics().boundingRect(0, 0, 0, 0, Qt::TextDontClip, mLabel);
  5013. if (mAxisType == atLeft)
  5014. {
  5015. QTransform oldTransform = painter->transform();
  5016. painter->translate((origin.x()-margin-labelBounds.height()), origin.y());
  5017. painter->rotate(-90);
  5018. painter->drawText(0, 0, mAxisRect->height(), labelBounds.height(), Qt::TextDontClip | Qt::AlignCenter, mLabel);
  5019. painter->setTransform(oldTransform);
  5020. }
  5021. else if (mAxisType == atRight)
  5022. {
  5023. QTransform oldTransform = painter->transform();
  5024. painter->translate((origin.x()+margin+labelBounds.height()), origin.y()-mAxisRect->height());
  5025. painter->rotate(90);
  5026. painter->drawText(0, 0, mAxisRect->height(), labelBounds.height(), Qt::TextDontClip | Qt::AlignCenter, mLabel);
  5027. painter->setTransform(oldTransform);
  5028. }
  5029. else if (mAxisType == atTop)
  5030. painter->drawText(origin.x(), origin.y()-margin-labelBounds.height(), mAxisRect->width(), labelBounds.height(), Qt::TextDontClip | Qt::AlignCenter, mLabel);
  5031. else if (mAxisType == atBottom)
  5032. painter->drawText(origin.x(), origin.y()+margin, mAxisRect->width(), labelBounds.height(), Qt::TextDontClip | Qt::AlignCenter, mLabel);
  5033. }
  5034. // set selection boxes:
  5035. int selAxisOutSize = qMax(qMax(mTickLengthOut, mSubTickLengthOut), mParentPlot->selectionTolerance());
  5036. int selAxisInSize = mParentPlot->selectionTolerance();
  5037. int selTickLabelSize = (orientation()==Qt::Horizontal ? tickLabelsSize.height() : tickLabelsSize.width());
  5038. int selTickLabelOffset = qMax(mTickLengthOut, mSubTickLengthOut)+mTickLabelPadding;
  5039. int selLabelSize = labelBounds.height();
  5040. int selLabelOffset = selTickLabelOffset+selTickLabelSize+mLabelPadding;
  5041. if (mAxisType == atLeft)
  5042. {
  5043. mAxisSelectionBox.setCoords(origin.x()-selAxisOutSize, mAxisRect->top(), origin.x()+selAxisInSize, mAxisRect->bottom());
  5044. mTickLabelsSelectionBox.setCoords(origin.x()-selTickLabelOffset-selTickLabelSize, mAxisRect->top(), origin.x()-selTickLabelOffset, mAxisRect->bottom());
  5045. mLabelSelectionBox.setCoords(origin.x()-selLabelOffset-selLabelSize, mAxisRect->top(), origin.x()-selLabelOffset, mAxisRect->bottom());
  5046. } else if (mAxisType == atRight)
  5047. {
  5048. mAxisSelectionBox.setCoords(origin.x()-selAxisInSize, mAxisRect->top(), origin.x()+selAxisOutSize, mAxisRect->bottom());
  5049. mTickLabelsSelectionBox.setCoords(origin.x()+selTickLabelOffset+selTickLabelSize, mAxisRect->top(), origin.x()+selTickLabelOffset, mAxisRect->bottom());
  5050. mLabelSelectionBox.setCoords(origin.x()+selLabelOffset+selLabelSize, mAxisRect->top(), origin.x()+selLabelOffset, mAxisRect->bottom());
  5051. } else if (mAxisType == atTop)
  5052. {
  5053. mAxisSelectionBox.setCoords(mAxisRect->left(), origin.y()-selAxisOutSize, mAxisRect->right(), origin.y()+selAxisInSize);
  5054. mTickLabelsSelectionBox.setCoords(mAxisRect->left(), origin.y()-selTickLabelOffset-selTickLabelSize, mAxisRect->right(), origin.y()-selTickLabelOffset);
  5055. mLabelSelectionBox.setCoords(mAxisRect->left(), origin.y()-selLabelOffset-selLabelSize, mAxisRect->right(), origin.y()-selLabelOffset);
  5056. } else if (mAxisType == atBottom)
  5057. {
  5058. mAxisSelectionBox.setCoords(mAxisRect->left(), origin.y()-selAxisInSize, mAxisRect->right(), origin.y()+selAxisOutSize);
  5059. mTickLabelsSelectionBox.setCoords(mAxisRect->left(), origin.y()+selTickLabelOffset+selTickLabelSize, mAxisRect->right(), origin.y()+selTickLabelOffset);
  5060. mLabelSelectionBox.setCoords(mAxisRect->left(), origin.y()+selLabelOffset+selLabelSize, mAxisRect->right(), origin.y()+selLabelOffset);
  5061. }
  5062. // draw hitboxes for debug purposes:
  5063. //painter->setBrush(Qt::NoBrush);
  5064. //painter->drawRects(QVector<QRect>() << mAxisSelectionBox << mTickLabelsSelectionBox << mLabelSelectionBox);
  5065. }
  5066. /*! \internal
  5067. Draws a single tick label with the provided \a painter, utilizing the internal label cache to
  5068. significantly speed up drawing of labels that were drawn in previous calls. The tick label is
  5069. always bound to an axis, the distance to the axis is controllable via \a distanceToAxis in
  5070. pixels. The pixel position in the axis direction is passed in the \a position parameter. Hence
  5071. for the bottom axis, \a position would indicate the horizontal pixel position (not coordinate),
  5072. at which the label should be drawn.
  5073. In order to later draw the axis label in a place that doesn't overlap with the tick labels, the
  5074. largest tick label size is needed. This is acquired by passing a \a tickLabelsSize to the \ref
  5075. drawTickLabel calls during the process of drawing all tick labels of one axis. In every call, \a
  5076. tickLabelsSize is expanded, if the drawn label exceeds the value \a tickLabelsSize currently
  5077. holds.
  5078. The label is drawn with the font and pen that are currently set on the \a painter. To draw
  5079. superscripted powers, the font is temporarily made smaller by a fixed factor (see \ref
  5080. getTickLabelData).
  5081. */
  5082. void QCPAxis::placeTickLabel(QCPPainter *painter, double position, int distanceToAxis, const QString &text, QSize *tickLabelsSize)
  5083. {
  5084. // warning: if you change anything here, also adapt getMaxTickLabelSize() accordingly!
  5085. if (!mParentPlot) return;
  5086. if (text.isEmpty()) return;
  5087. QSize finalSize;
  5088. QPointF labelAnchor;
  5089. switch (mAxisType)
  5090. {
  5091. case atLeft: labelAnchor = QPointF(mAxisRect->left()-distanceToAxis-mOffset, position); break;
  5092. case atRight: labelAnchor = QPointF(mAxisRect->right()+distanceToAxis+mOffset, position); break;
  5093. case atTop: labelAnchor = QPointF(position, mAxisRect->top()-distanceToAxis-mOffset); break;
  5094. case atBottom: labelAnchor = QPointF(position, mAxisRect->bottom()+distanceToAxis+mOffset); break;
  5095. }
  5096. if (parentPlot()->plottingHints().testFlag(QCP::phCacheLabels) && !painter->modes().testFlag(QCPPainter::pmNoCaching)) // label caching enabled
  5097. {
  5098. if (!mLabelCache.contains(text)) // no cached label exists, create it
  5099. {
  5100. CachedLabel *newCachedLabel = new CachedLabel;
  5101. TickLabelData labelData = getTickLabelData(painter->font(), text);
  5102. QPointF drawOffset = getTickLabelDrawOffset(labelData);
  5103. newCachedLabel->offset = drawOffset+labelData.rotatedTotalBounds.topLeft();
  5104. newCachedLabel->pixmap = QPixmap(labelData.rotatedTotalBounds.size());
  5105. newCachedLabel->pixmap.fill(Qt::transparent);
  5106. QCPPainter cachePainter(&newCachedLabel->pixmap);
  5107. cachePainter.setPen(painter->pen());
  5108. drawTickLabel(&cachePainter, -labelData.rotatedTotalBounds.topLeft().x(), -labelData.rotatedTotalBounds.topLeft().y(), labelData);
  5109. mLabelCache.insert(text, newCachedLabel, 1);
  5110. }
  5111. // draw cached label:
  5112. const CachedLabel *cachedLabel = mLabelCache.object(text);
  5113. // if label would be partly clipped by widget border on sides, don't draw it:
  5114. if (orientation() == Qt::Horizontal)
  5115. {
  5116. if (labelAnchor.x()+cachedLabel->offset.x()+cachedLabel->pixmap.width() > mParentPlot->viewport().right() ||
  5117. labelAnchor.x()+cachedLabel->offset.x() < mParentPlot->viewport().left())
  5118. return;
  5119. } else
  5120. {
  5121. if (labelAnchor.y()+cachedLabel->offset.y()+cachedLabel->pixmap.height() > mParentPlot->viewport().bottom() ||
  5122. labelAnchor.y()+cachedLabel->offset.y() < mParentPlot->viewport().top())
  5123. return;
  5124. }
  5125. painter->drawPixmap(labelAnchor+cachedLabel->offset, cachedLabel->pixmap);
  5126. finalSize = cachedLabel->pixmap.size();
  5127. } else // label caching disabled, draw text directly on surface:
  5128. {
  5129. TickLabelData labelData = getTickLabelData(painter->font(), text);
  5130. QPointF finalPosition = labelAnchor + getTickLabelDrawOffset(labelData);
  5131. // if label would be partly clipped by widget border on sides, don't draw it:
  5132. if (orientation() == Qt::Horizontal)
  5133. {
  5134. if (finalPosition.x()+(labelData.rotatedTotalBounds.width()+labelData.rotatedTotalBounds.left()) > mParentPlot->viewport().right() ||
  5135. finalPosition.x()+labelData.rotatedTotalBounds.left() < mParentPlot->viewport().left())
  5136. return;
  5137. } else
  5138. {
  5139. if (finalPosition.y()+(labelData.rotatedTotalBounds.height()+labelData.rotatedTotalBounds.top()) > mParentPlot->viewport().bottom() ||
  5140. finalPosition.y()+labelData.rotatedTotalBounds.top() < mParentPlot->viewport().top())
  5141. return;
  5142. }
  5143. drawTickLabel(painter, finalPosition.x(), finalPosition.y(), labelData);
  5144. finalSize = labelData.rotatedTotalBounds.size();
  5145. }
  5146. // expand passed tickLabelsSize if current tick label is larger:
  5147. if (finalSize.width() > tickLabelsSize->width())
  5148. tickLabelsSize->setWidth(finalSize.width());
  5149. if (finalSize.height() > tickLabelsSize->height())
  5150. tickLabelsSize->setHeight(finalSize.height());
  5151. }
  5152. /*! \internal
  5153. This is a \ref placeTickLabel helper function.
  5154. Draws the tick label specified in \a labelData with \a painter at the pixel positions \a x and \a
  5155. y. This function is used by \ref placeTickLabel to create new tick labels for the cache, or to
  5156. directly draw the labels on the QCustomPlot surface when label caching is disabled, i.e. when
  5157. QCP::phCacheLabels plotting hint is not set.
  5158. */
  5159. void QCPAxis::drawTickLabel(QCPPainter *painter, double x, double y, const QCPAxis::TickLabelData &labelData) const
  5160. {
  5161. // backup painter settings that we're about to change:
  5162. QTransform oldTransform = painter->transform();
  5163. QFont oldFont = painter->font();
  5164. // transform painter to position/rotation:
  5165. painter->translate(x, y);
  5166. if (!qFuzzyIsNull(mTickLabelRotation))
  5167. painter->rotate(mTickLabelRotation);
  5168. // draw text:
  5169. if (!labelData.expPart.isEmpty()) // indicator that beautiful powers must be used
  5170. {
  5171. painter->setFont(labelData.baseFont);
  5172. painter->drawText(0, 0, 0, 0, Qt::TextDontClip, labelData.basePart);
  5173. painter->setFont(labelData.expFont);
  5174. painter->drawText(labelData.baseBounds.width()+1, 0, labelData.expBounds.width(), labelData.expBounds.height(), Qt::TextDontClip, labelData.expPart);
  5175. } else
  5176. {
  5177. painter->setFont(labelData.baseFont);
  5178. painter->drawText(0, 0, labelData.totalBounds.width(), labelData.totalBounds.height(), Qt::TextDontClip | Qt::AlignHCenter, labelData.basePart);
  5179. }
  5180. // reset painter settings to what it was before:
  5181. painter->setTransform(oldTransform);
  5182. painter->setFont(oldFont);
  5183. }
  5184. /*! \internal
  5185. This is a \ref placeTickLabel helper function.
  5186. Transforms the passed \a text and \a font to a tickLabelData structure that can then be further
  5187. processed by \ref getTickLabelDrawOffset and \ref drawTickLabel. It splits the text into base and
  5188. exponent if necessary (see \ref setNumberFormat) and calculates appropriate bounding boxes.
  5189. */
  5190. QCPAxis::TickLabelData QCPAxis::getTickLabelData(const QFont &font, const QString &text) const
  5191. {
  5192. TickLabelData result;
  5193. // determine whether beautiful decimal powers should be used
  5194. bool useBeautifulPowers = false;
  5195. int ePos = -1;
  5196. if (mAutoTickLabels && mNumberBeautifulPowers && mTickLabelType == ltNumber)
  5197. {
  5198. ePos = text.indexOf('e');
  5199. if (ePos > -1)
  5200. useBeautifulPowers = true;
  5201. }
  5202. // calculate text bounding rects and do string preparation for beautiful decimal powers:
  5203. result.baseFont = font;
  5204. result.baseFont.setPointSizeF(result.baseFont.pointSizeF()+0.05); // QFontMetrics.boundingRect has a bug for exact point sizes that make the results oscillate due to internal rounding
  5205. if (useBeautifulPowers)
  5206. {
  5207. // split text into parts of number/symbol that will be drawn normally and part that will be drawn as exponent:
  5208. result.basePart = text.left(ePos);
  5209. // in log scaling, we want to turn "1*10^n" into "10^n", else add multiplication sign and decimal base:
  5210. if (mScaleType == stLogarithmic && result.basePart == "1")
  5211. result.basePart = "10";
  5212. else
  5213. result.basePart += (mNumberMultiplyCross ? QString(QChar(215)) : QString(QChar(183))) + "10";
  5214. result.expPart = text.mid(ePos+1);
  5215. // clip "+" and leading zeros off expPart:
  5216. while (result.expPart.at(1) == '0' && result.expPart.length() > 2) // length > 2 so we leave one zero when numberFormatChar is 'e'
  5217. result.expPart.remove(1, 1);
  5218. if (result.expPart.at(0) == mPositiveSignChar)
  5219. result.expPart.remove(0, 1);
  5220. // prepare smaller font for exponent:
  5221. result.expFont = font;
  5222. result.expFont.setPointSize(result.expFont.pointSize()*0.75);
  5223. // calculate bounding rects of base part, exponent part and total one:
  5224. result.baseBounds = QFontMetrics(result.baseFont).boundingRect(0, 0, 0, 0, Qt::TextDontClip, result.basePart);
  5225. result.expBounds = QFontMetrics(result.expFont).boundingRect(0, 0, 0, 0, Qt::TextDontClip, result.expPart);
  5226. result.totalBounds = result.baseBounds.adjusted(0, 0, result.expBounds.width()+2, 0); // +2 consists of the 1 pixel spacing between base and exponent (see drawTickLabel) and an extra pixel to include AA
  5227. } else // useBeautifulPowers == false
  5228. {
  5229. result.basePart = text;
  5230. result.totalBounds = QFontMetrics(result.baseFont).boundingRect(0, 0, 0, 0, Qt::TextDontClip | Qt::AlignHCenter, result.basePart);
  5231. }
  5232. result.totalBounds.moveTopLeft(QPoint(0, 0)); // want bounding box aligned top left at origin, independent of how it was created, to make further processing simpler
  5233. // calculate possibly different bounding rect after rotation:
  5234. result.rotatedTotalBounds = result.totalBounds;
  5235. if (!qFuzzyIsNull(mTickLabelRotation))
  5236. {
  5237. QTransform transform;
  5238. transform.rotate(mTickLabelRotation);
  5239. result.rotatedTotalBounds = transform.mapRect(result.rotatedTotalBounds);
  5240. }
  5241. return result;
  5242. }
  5243. /*! \internal
  5244. This is a \ref placeTickLabel helper function.
  5245. Calculates the offset at which the top left corner of the specified tick label shall be drawn.
  5246. The offset is relative to a point right next to the tick the label belongs to.
  5247. This function is thus responsible for e.g. centering tick labels under ticks and positioning them
  5248. appropriately when they are rotated.
  5249. */
  5250. QPointF QCPAxis::getTickLabelDrawOffset(const QCPAxis::TickLabelData &labelData) const
  5251. {
  5252. /*
  5253. calculate label offset from base point at tick (non-trivial, for best visual appearance): short
  5254. explanation for bottom axis: The anchor, i.e. the point in the label that is placed
  5255. horizontally under the corresponding tick is always on the label side that is closer to the
  5256. axis (e.g. the left side of the text when we're rotating clockwise). On that side, the height
  5257. is halved and the resulting point is defined the anchor. This way, a 90 degree rotated text
  5258. will be centered under the tick (i.e. displaced horizontally by half its height). At the same
  5259. time, a 45 degree rotated text will "point toward" its tick, as is typical for rotated tick
  5260. labels.
  5261. */
  5262. bool doRotation = !qFuzzyIsNull(mTickLabelRotation);
  5263. bool flip = qFuzzyCompare(qAbs(mTickLabelRotation), 90.0); // perfect +/-90 degree flip. Indicates vertical label centering on vertical axes.
  5264. double radians = mTickLabelRotation/180.0*M_PI;
  5265. int x=0, y=0;
  5266. if (mAxisType == atLeft)
  5267. {
  5268. if (doRotation)
  5269. {
  5270. if (mTickLabelRotation > 0)
  5271. {
  5272. x = -qCos(radians)*labelData.totalBounds.width();
  5273. y = flip ? -labelData.totalBounds.width()/2.0 : -qSin(radians)*labelData.totalBounds.width()-qCos(radians)*labelData.totalBounds.height()/2.0;
  5274. } else
  5275. {
  5276. x = -qCos(-radians)*labelData.totalBounds.width()-qSin(-radians)*labelData.totalBounds.height();
  5277. y = flip ? +labelData.totalBounds.width()/2.0 : +qSin(-radians)*labelData.totalBounds.width()-qCos(-radians)*labelData.totalBounds.height()/2.0;
  5278. }
  5279. } else
  5280. {
  5281. x = -labelData.totalBounds.width();
  5282. y = -labelData.totalBounds.height()/2.0;
  5283. }
  5284. } else if (mAxisType == atRight)
  5285. {
  5286. if (doRotation)
  5287. {
  5288. if (mTickLabelRotation > 0)
  5289. {
  5290. x = +qSin(radians)*labelData.totalBounds.height();
  5291. y = flip ? -labelData.totalBounds.width()/2.0 : -qCos(radians)*labelData.totalBounds.height()/2.0;
  5292. } else
  5293. {
  5294. x = 0;
  5295. y = flip ? +labelData.totalBounds.width()/2.0 : -qCos(-radians)*labelData.totalBounds.height()/2.0;
  5296. }
  5297. } else
  5298. {
  5299. x = 0;
  5300. y = -labelData.totalBounds.height()/2.0;
  5301. }
  5302. } else if (mAxisType == atTop)
  5303. {
  5304. if (doRotation)
  5305. {
  5306. if (mTickLabelRotation > 0)
  5307. {
  5308. x = -qCos(radians)*labelData.totalBounds.width()+qSin(radians)*labelData.totalBounds.height()/2.0;
  5309. y = -qSin(radians)*labelData.totalBounds.width()-qCos(radians)*labelData.totalBounds.height();
  5310. } else
  5311. {
  5312. x = -qSin(-radians)*labelData.totalBounds.height()/2.0;
  5313. y = -qCos(-radians)*labelData.totalBounds.height();
  5314. }
  5315. } else
  5316. {
  5317. x = -labelData.totalBounds.width()/2.0;
  5318. y = -labelData.totalBounds.height();
  5319. }
  5320. } else if (mAxisType == atBottom)
  5321. {
  5322. if (doRotation)
  5323. {
  5324. if (mTickLabelRotation > 0)
  5325. {
  5326. x = +qSin(radians)*labelData.totalBounds.height()/2.0;
  5327. y = 0;
  5328. } else
  5329. {
  5330. x = -qCos(-radians)*labelData.totalBounds.width()-qSin(-radians)*labelData.totalBounds.height()/2.0;
  5331. y = +qSin(-radians)*labelData.totalBounds.width();
  5332. }
  5333. } else
  5334. {
  5335. x = -labelData.totalBounds.width()/2.0;
  5336. y = 0;
  5337. }
  5338. }
  5339. return QPointF(x, y);
  5340. }
  5341. /*! \internal
  5342. Simulates the steps done by \ref placeTickLabel by calculating bounding boxes of the text label
  5343. to be drawn, depending on number format etc. Since only the largest tick label is wanted for the
  5344. margin calculation, the passed \a tickLabelsSize is only expanded, if it's currently set to a
  5345. smaller width/height.
  5346. */
  5347. void QCPAxis::getMaxTickLabelSize(const QFont &font, const QString &text, QSize *tickLabelsSize) const
  5348. {
  5349. // note: this function must return the same tick label sizes as the placeTickLabel function.
  5350. QSize finalSize;
  5351. if (parentPlot()->plottingHints().testFlag(QCP::phCacheLabels) && mLabelCache.contains(text)) // label caching enabled and have cached label
  5352. {
  5353. const CachedLabel *cachedLabel = mLabelCache.object(text);
  5354. finalSize = cachedLabel->pixmap.size();
  5355. } else // label caching disabled or no label with this text cached:
  5356. {
  5357. TickLabelData labelData = getTickLabelData(font, text);
  5358. finalSize = labelData.rotatedTotalBounds.size();
  5359. }
  5360. // expand passed tickLabelsSize if current tick label is larger:
  5361. if (finalSize.width() > tickLabelsSize->width())
  5362. tickLabelsSize->setWidth(finalSize.width());
  5363. if (finalSize.height() > tickLabelsSize->height())
  5364. tickLabelsSize->setHeight(finalSize.height());
  5365. }
  5366. /* inherits documentation from base class */
  5367. void QCPAxis::selectEvent(QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged)
  5368. {
  5369. Q_UNUSED(event)
  5370. SelectablePart part = details.value<SelectablePart>();
  5371. if (mSelectableParts.testFlag(part))
  5372. {
  5373. SelectableParts selBefore = mSelectedParts;
  5374. setSelectedParts(additive ? mSelectedParts^part : part);
  5375. if (selectionStateChanged)
  5376. *selectionStateChanged = mSelectedParts != selBefore;
  5377. }
  5378. }
  5379. /* inherits documentation from base class */
  5380. void QCPAxis::deselectEvent(bool *selectionStateChanged)
  5381. {
  5382. SelectableParts selBefore = mSelectedParts;
  5383. setSelectedParts(mSelectedParts & ~mSelectableParts);
  5384. if (selectionStateChanged)
  5385. *selectionStateChanged = mSelectedParts != selBefore;
  5386. }
  5387. /*! \internal
  5388. A convenience function to easily set the QPainter::Antialiased hint on the provided \a painter
  5389. before drawing axis lines.
  5390. This is the antialiasing state the painter passed to the \ref draw method is in by default.
  5391. This function takes into account the local setting of the antialiasing flag as well as the
  5392. overrides set with \ref QCustomPlot::setAntialiasedElements and \ref
  5393. QCustomPlot::setNotAntialiasedElements.
  5394. \see setAntialiased
  5395. */
  5396. void QCPAxis::applyDefaultAntialiasingHint(QCPPainter *painter) const
  5397. {
  5398. applyAntialiasingHint(painter, mAntialiased, QCP::aeAxes);
  5399. }
  5400. /*! \internal
  5401. Returns via \a lowIndex and \a highIndex, which ticks in the current tick vector are visible in
  5402. the current range. The return values are indices of the tick vector, not the positions of the
  5403. ticks themselves.
  5404. The actual use of this function is when an external tick vector is provided, since it might
  5405. exceed far beyond the currently displayed range, and would cause unnecessary calculations e.g. of
  5406. subticks.
  5407. If all ticks are outside the axis range, an inverted range is returned, i.e. highIndex will be
  5408. smaller than lowIndex. There is one case, where this function returns indices that are not really
  5409. visible in the current axis range: When the tick spacing is larger than the axis range size and
  5410. one tick is below the axis range and the next tick is already above the axis range. Because in
  5411. such cases it is usually desirable to know the tick pair, to draw proper subticks.
  5412. */
  5413. void QCPAxis::visibleTickBounds(int &lowIndex, int &highIndex) const
  5414. {
  5415. bool lowFound = false;
  5416. bool highFound = false;
  5417. lowIndex = 0;
  5418. highIndex = -1;
  5419. for (int i=0; i < mTickVector.size(); ++i)
  5420. {
  5421. if (mTickVector.at(i) >= mRange.lower)
  5422. {
  5423. lowFound = true;
  5424. lowIndex = i;
  5425. break;
  5426. }
  5427. }
  5428. for (int i=mTickVector.size()-1; i >= 0; --i)
  5429. {
  5430. if (mTickVector.at(i) <= mRange.upper)
  5431. {
  5432. highFound = true;
  5433. highIndex = i;
  5434. break;
  5435. }
  5436. }
  5437. if (!lowFound && highFound)
  5438. lowIndex = highIndex+1;
  5439. else if (lowFound && !highFound)
  5440. highIndex = lowIndex-1;
  5441. }
  5442. /*! \internal
  5443. A log function with the base mScaleLogBase, used mostly for coordinate transforms in logarithmic
  5444. scales with arbitrary log base. Uses the buffered mScaleLogBaseLogInv for faster calculation.
  5445. This is set to <tt>1.0/qLn(mScaleLogBase)</tt> in \ref setScaleLogBase.
  5446. \see basePow, setScaleLogBase, setScaleType
  5447. */
  5448. double QCPAxis::baseLog(double value) const
  5449. {
  5450. return qLn(value)*mScaleLogBaseLogInv;
  5451. }
  5452. /*! \internal
  5453. A power function with the base mScaleLogBase, used mostly for coordinate transforms in
  5454. logarithmic scales with arbitrary log base.
  5455. \see baseLog, setScaleLogBase, setScaleType
  5456. */
  5457. double QCPAxis::basePow(double value) const
  5458. {
  5459. return qPow(mScaleLogBase, value);
  5460. }
  5461. /*! \internal
  5462. Returns the pen that is used to draw the axis base line. Depending on the selection state, this
  5463. is either mSelectedBasePen or mBasePen.
  5464. */
  5465. QPen QCPAxis::getBasePen() const
  5466. {
  5467. return mSelectedParts.testFlag(spAxis) ? mSelectedBasePen : mBasePen;
  5468. }
  5469. /*! \internal
  5470. Returns the pen that is used to draw the (major) ticks. Depending on the selection state, this
  5471. is either mSelectedTickPen or mTickPen.
  5472. */
  5473. QPen QCPAxis::getTickPen() const
  5474. {
  5475. return mSelectedParts.testFlag(spAxis) ? mSelectedTickPen : mTickPen;
  5476. }
  5477. /*! \internal
  5478. Returns the pen that is used to draw the subticks. Depending on the selection state, this
  5479. is either mSelectedSubTickPen or mSubTickPen.
  5480. */
  5481. QPen QCPAxis::getSubTickPen() const
  5482. {
  5483. return mSelectedParts.testFlag(spAxis) ? mSelectedSubTickPen : mSubTickPen;
  5484. }
  5485. /*! \internal
  5486. Returns the font that is used to draw the tick labels. Depending on the selection state, this
  5487. is either mSelectedTickLabelFont or mTickLabelFont.
  5488. */
  5489. QFont QCPAxis::getTickLabelFont() const
  5490. {
  5491. return mSelectedParts.testFlag(spTickLabels) ? mSelectedTickLabelFont : mTickLabelFont;
  5492. }
  5493. /*! \internal
  5494. Returns the font that is used to draw the axis label. Depending on the selection state, this
  5495. is either mSelectedLabelFont or mLabelFont.
  5496. */
  5497. QFont QCPAxis::getLabelFont() const
  5498. {
  5499. return mSelectedParts.testFlag(spAxisLabel) ? mSelectedLabelFont : mLabelFont;
  5500. }
  5501. /*! \internal
  5502. Returns the color that is used to draw the tick labels. Depending on the selection state, this
  5503. is either mSelectedTickLabelColor or mTickLabelColor.
  5504. */
  5505. QColor QCPAxis::getTickLabelColor() const
  5506. {
  5507. return mSelectedParts.testFlag(spTickLabels) ? mSelectedTickLabelColor : mTickLabelColor;
  5508. }
  5509. /*! \internal
  5510. Returns the color that is used to draw the axis label. Depending on the selection state, this
  5511. is either mSelectedLabelColor or mLabelColor.
  5512. */
  5513. QColor QCPAxis::getLabelColor() const
  5514. {
  5515. return mSelectedParts.testFlag(spAxisLabel) ? mSelectedLabelColor : mLabelColor;
  5516. }
  5517. /*! \internal
  5518. Returns the appropriate outward margin for this axis. It is needed if \ref
  5519. QCPAxisRect::setAutoMargins is set to true on the parent axis rect. An axis with axis type \ref
  5520. atLeft will return an appropriate left margin, \ref atBottom will return an appropriate bottom
  5521. margin and so forth. For the calculation, this function goes through similar steps as \ref draw,
  5522. so changing one function likely requires the modification of the other one as well.
  5523. The margin consists of the outward tick length, tick label padding, tick label size, label
  5524. padding, label size, and padding.
  5525. The margin is cached internally, so repeated calls while leaving the axis range, fonts, etc.
  5526. unchanged are very fast.
  5527. */
  5528. int QCPAxis::calculateMargin()
  5529. {
  5530. if (mCachedMarginValid)
  5531. return mCachedMargin;
  5532. // run through similar steps as QCPAxis::draw, and caluclate margin needed to fit axis and its labels
  5533. int margin = 0;
  5534. if (mVisible)
  5535. {
  5536. int lowTick, highTick;
  5537. visibleTickBounds(lowTick, highTick);
  5538. // get length of tick marks pointing outwards:
  5539. if (mTicks)
  5540. margin += qMax(0, qMax(mTickLengthOut, mSubTickLengthOut));
  5541. // calculate size of tick labels:
  5542. QSize tickLabelsSize(0, 0);
  5543. if (mTickLabels)
  5544. {
  5545. for (int i=lowTick; i<=highTick; ++i)
  5546. getMaxTickLabelSize(mTickLabelFont, mTickVectorLabels.at(i), &tickLabelsSize); // don't use getTickLabelFont() because we don't want margin to possibly change on selection
  5547. margin += orientation() == Qt::Horizontal ? tickLabelsSize.height() : tickLabelsSize.width();
  5548. margin += mTickLabelPadding;
  5549. }
  5550. // calculate size of axis label (only height needed, because left/right labels are rotated by 90 degrees):
  5551. if (!mLabel.isEmpty())
  5552. {
  5553. QFontMetrics fontMetrics(mLabelFont); // don't use getLabelFont() because we don't want margin to possibly change on selection
  5554. QRect bounds;
  5555. bounds = fontMetrics.boundingRect(0, 0, 0, 0, Qt::TextDontClip | Qt::AlignHCenter | Qt::AlignVCenter, mLabel);
  5556. margin += bounds.height() + mLabelPadding;
  5557. }
  5558. }
  5559. margin += mPadding;
  5560. mCachedMargin = margin;
  5561. mCachedMarginValid = true;
  5562. return margin;
  5563. }
  5564. /* inherits documentation from base class */
  5565. QCP::Interaction QCPAxis::selectionCategory() const
  5566. {
  5567. return QCP::iSelectAxes;
  5568. }
  5569. ////////////////////////////////////////////////////////////////////////////////////////////////////
  5570. //////////////////// QCPAbstractPlottable
  5571. ////////////////////////////////////////////////////////////////////////////////////////////////////
  5572. /*! \class QCPAbstractPlottable
  5573. \brief The abstract base class for all data representing objects in a plot.
  5574. It defines a very basic interface like name, pen, brush, visibility etc. Since this class is
  5575. abstract, it can't be instantiated. Use one of the subclasses or create a subclass yourself to
  5576. create new ways of displaying data (see "Creating own plottables" below).
  5577. All further specifics are in the subclasses, for example:
  5578. \li A normal graph with possibly a line, scatter points and error bars is displayed by \ref QCPGraph
  5579. (typically created with \ref QCustomPlot::addGraph).
  5580. \li A parametric curve can be displayed with \ref QCPCurve.
  5581. \li A stackable bar chart can be achieved with \ref QCPBars.
  5582. \li A box of a statistical box plot is created with \ref QCPStatisticalBox.
  5583. \section plottables-subclassing Creating own plottables
  5584. To create an own plottable, you implement a subclass of QCPAbstractPlottable. These are the pure
  5585. virtual functions, you must implement:
  5586. \li \ref clearData
  5587. \li \ref selectTest
  5588. \li \ref draw
  5589. \li \ref drawLegendIcon
  5590. \li \ref getKeyRange
  5591. \li \ref getValueRange
  5592. See the documentation of those functions for what they need to do.
  5593. For drawing your plot, you can use the \ref coordsToPixels functions to translate a point in plot
  5594. coordinates to pixel coordinates. This function is quite convenient, because it takes the
  5595. orientation of the key and value axes into account for you (x and y are swapped when the key axis
  5596. is vertical and the value axis horizontal). If you are worried about performance (i.e. you need
  5597. to translate many points in a loop like QCPGraph), you can directly use \ref
  5598. QCPAxis::coordToPixel. However, you must then take care about the orientation of the axis
  5599. yourself.
  5600. Here are some important members you inherit from QCPAbstractPlottable:
  5601. <table>
  5602. <tr>
  5603. <td>QCustomPlot *\b mParentPlot</td>
  5604. <td>A pointer to the parent QCustomPlot instance. The parent plot is inferred from the axes that are passed in the constructor.</td>
  5605. </tr><tr>
  5606. <td>QString \b mName</td>
  5607. <td>The name of the plottable.</td>
  5608. </tr><tr>
  5609. <td>QPen \b mPen</td>
  5610. <td>The generic pen of the plottable. You should use this pen for the most prominent data representing lines in the plottable (e.g QCPGraph uses this pen for its graph lines and scatters)</td>
  5611. </tr><tr>
  5612. <td>QPen \b mSelectedPen</td>
  5613. <td>The generic pen that should be used when the plottable is selected (hint: \ref mainPen gives you the right pen, depending on selection state).</td>
  5614. </tr><tr>
  5615. <td>QBrush \b mBrush</td>
  5616. <td>The generic brush of the plottable. You should use this brush for the most prominent fillable structures in the plottable (e.g. QCPGraph uses this brush to control filling under the graph)</td>
  5617. </tr><tr>
  5618. <td>QBrush \b mSelectedBrush</td>
  5619. <td>The generic brush that should be used when the plottable is selected (hint: \ref mainBrush gives you the right brush, depending on selection state).</td>
  5620. </tr><tr>
  5621. <td>QPointer<QCPAxis>\b mKeyAxis, \b mValueAxis</td>
  5622. <td>The key and value axes this plottable is attached to. Call their QCPAxis::coordToPixel functions to translate coordinates to pixels in either the key or value dimension.
  5623. Make sure to check whether the weak pointer is null before using it. If one of the axes is null, don't draw the plottable.</td>
  5624. </tr><tr>
  5625. <td>bool \b mSelected</td>
  5626. <td>indicates whether the plottable is selected or not.</td>
  5627. </tr>
  5628. </table>
  5629. */
  5630. /* start of documentation of pure virtual functions */
  5631. /*! \fn void QCPAbstractPlottable::clearData() = 0
  5632. Clears all data in the plottable.
  5633. */
  5634. /*! \fn void QCPAbstractPlottable::drawLegendIcon(QCPPainter *painter, const QRect &rect) const = 0
  5635. \internal
  5636. called by QCPLegend::draw (via QCPPlottableLegendItem::draw) to create a graphical representation
  5637. of this plottable inside \a rect, next to the plottable name.
  5638. */
  5639. /*! \fn QCPRange QCPAbstractPlottable::getKeyRange(bool &validRange, SignDomain inSignDomain) const = 0
  5640. \internal
  5641. called by rescaleAxes functions to get the full data key bounds. For logarithmic plots, one can
  5642. set \a inSignDomain to either \ref sdNegative or \ref sdPositive in order to restrict the
  5643. returned range to that sign domain. E.g. when only negative range is wanted, set \a inSignDomain
  5644. to \ref sdNegative and all positive points will be ignored for range calculation. For no
  5645. restriction, just set \a inSignDomain to \ref sdBoth (default). \a validRange is an output
  5646. parameter that indicates whether a proper range could be found or not. If this is false, you
  5647. shouldn't use the returned range (e.g. no points in data).
  5648. \see rescaleAxes, getValueRange
  5649. */
  5650. /*! \fn QCPRange QCPAbstractPlottable::getValueRange(bool &validRange, SignDomain inSignDomain) const = 0
  5651. \internal
  5652. called by rescaleAxes functions to get the full data value bounds. For logarithmic plots, one can
  5653. set \a inSignDomain to either \ref sdNegative or \ref sdPositive in order to restrict the
  5654. returned range to that sign domain. E.g. when only negative range is wanted, set \a inSignDomain
  5655. to \ref sdNegative and all positive points will be ignored for range calculation. For no
  5656. restriction, just set \a inSignDomain to \ref sdBoth (default). \a validRange is an output
  5657. parameter that indicates whether a proper range could be found or not. If this is false, you
  5658. shouldn't use the returned range (e.g. no points in data).
  5659. \see rescaleAxes, getKeyRange
  5660. */
  5661. /* end of documentation of pure virtual functions */
  5662. /* start of documentation of signals */
  5663. /*! \fn void QCPAbstractPlottable::selectionChanged(bool selected)
  5664. This signal is emitted when the selection state of this plottable has changed to \a selected,
  5665. either by user interaction or by a direct call to \ref setSelected.
  5666. */
  5667. /* end of documentation of signals */
  5668. /*!
  5669. Constructs an abstract plottable which uses \a keyAxis as its key axis ("x") and \a valueAxis as
  5670. its value axis ("y"). \a keyAxis and \a valueAxis must reside in the same QCustomPlot instance
  5671. and have perpendicular orientations. If either of these restrictions is violated, a corresponding
  5672. message is printed to the debug output (qDebug), the construction is not aborted, though.
  5673. Since QCPAbstractPlottable is an abstract class that defines the basic interface to plottables,
  5674. it can't be directly instantiated.
  5675. You probably want one of the subclasses like \ref QCPGraph or \ref QCPCurve instead.
  5676. */
  5677. QCPAbstractPlottable::QCPAbstractPlottable(QCPAxis *keyAxis, QCPAxis *valueAxis) :
  5678. QCPLayerable(keyAxis->parentPlot(), "", keyAxis->axisRect()),
  5679. mName(""),
  5680. mAntialiasedFill(true),
  5681. mAntialiasedScatters(true),
  5682. mAntialiasedErrorBars(false),
  5683. mPen(Qt::black),
  5684. mSelectedPen(Qt::black),
  5685. mBrush(Qt::NoBrush),
  5686. mSelectedBrush(Qt::NoBrush),
  5687. mKeyAxis(keyAxis),
  5688. mValueAxis(valueAxis),
  5689. mSelectable(true),
  5690. mSelected(false)
  5691. {
  5692. if (keyAxis->parentPlot() != valueAxis->parentPlot())
  5693. qDebug() << Q_FUNC_INFO << "Parent plot of keyAxis is not the same as that of valueAxis.";
  5694. if (keyAxis->orientation() == valueAxis->orientation())
  5695. qDebug() << Q_FUNC_INFO << "keyAxis and valueAxis must be orthogonal to each other.";
  5696. }
  5697. /*!
  5698. The name is the textual representation of this plottable as it is displayed in the legend
  5699. (\ref QCPLegend). It may contain any UTF-8 characters, including newlines.
  5700. */
  5701. void QCPAbstractPlottable::setName(const QString &name)
  5702. {
  5703. mName = name;
  5704. }
  5705. /*!
  5706. Sets whether fills of this plottable is drawn antialiased or not.
  5707. Note that this setting may be overridden by \ref QCustomPlot::setAntialiasedElements and \ref
  5708. QCustomPlot::setNotAntialiasedElements.
  5709. */
  5710. void QCPAbstractPlottable::setAntialiasedFill(bool enabled)
  5711. {
  5712. mAntialiasedFill = enabled;
  5713. }
  5714. /*!
  5715. Sets whether the scatter symbols of this plottable are drawn antialiased or not.
  5716. Note that this setting may be overridden by \ref QCustomPlot::setAntialiasedElements and \ref
  5717. QCustomPlot::setNotAntialiasedElements.
  5718. */
  5719. void QCPAbstractPlottable::setAntialiasedScatters(bool enabled)
  5720. {
  5721. mAntialiasedScatters = enabled;
  5722. }
  5723. /*!
  5724. Sets whether the error bars of this plottable are drawn antialiased or not.
  5725. Note that this setting may be overridden by \ref QCustomPlot::setAntialiasedElements and \ref
  5726. QCustomPlot::setNotAntialiasedElements.
  5727. */
  5728. void QCPAbstractPlottable::setAntialiasedErrorBars(bool enabled)
  5729. {
  5730. mAntialiasedErrorBars = enabled;
  5731. }
  5732. /*!
  5733. The pen is used to draw basic lines that make up the plottable representation in the
  5734. plot.
  5735. For example, the \ref QCPGraph subclass draws its graph lines and scatter points
  5736. with this pen.
  5737. \see setBrush
  5738. */
  5739. void QCPAbstractPlottable::setPen(const QPen &pen)
  5740. {
  5741. mPen = pen;
  5742. }
  5743. /*!
  5744. When the plottable is selected, this pen is used to draw basic lines instead of the normal
  5745. pen set via \ref setPen.
  5746. \see setSelected, setSelectable, setSelectedBrush, selectTest
  5747. */
  5748. void QCPAbstractPlottable::setSelectedPen(const QPen &pen)
  5749. {
  5750. mSelectedPen = pen;
  5751. }
  5752. /*!
  5753. The brush is used to draw basic fills of the plottable representation in the
  5754. plot. The Fill can be a color, gradient or texture, see the usage of QBrush.
  5755. For example, the \ref QCPGraph subclass draws the fill under the graph with this brush, when
  5756. it's not set to Qt::NoBrush.
  5757. \see setPen
  5758. */
  5759. void QCPAbstractPlottable::setBrush(const QBrush &brush)
  5760. {
  5761. mBrush = brush;
  5762. }
  5763. /*!
  5764. When the plottable is selected, this brush is used to draw fills instead of the normal
  5765. brush set via \ref setBrush.
  5766. \see setSelected, setSelectable, setSelectedPen, selectTest
  5767. */
  5768. void QCPAbstractPlottable::setSelectedBrush(const QBrush &brush)
  5769. {
  5770. mSelectedBrush = brush;
  5771. }
  5772. /*!
  5773. The key axis of a plottable can be set to any axis of a QCustomPlot, as long as it is orthogonal
  5774. to the plottable's value axis. This function performs no checks to make sure this is the case.
  5775. The typical mathematical choice is to use the x-axis (QCustomPlot::xAxis) as key axis and the
  5776. y-axis (QCustomPlot::yAxis) as value axis.
  5777. Normally, the key and value axes are set in the constructor of the plottable (or \ref
  5778. QCustomPlot::addGraph when working with QCPGraphs through the dedicated graph interface).
  5779. \see setValueAxis
  5780. */
  5781. void QCPAbstractPlottable::setKeyAxis(QCPAxis *axis)
  5782. {
  5783. mKeyAxis = axis;
  5784. }
  5785. /*!
  5786. The value axis of a plottable can be set to any axis of a QCustomPlot, as long as it is
  5787. orthogonal to the plottable's key axis. This function performs no checks to make sure this is the
  5788. case. The typical mathematical choice is to use the x-axis (QCustomPlot::xAxis) as key axis and
  5789. the y-axis (QCustomPlot::yAxis) as value axis.
  5790. Normally, the key and value axes are set in the constructor of the plottable (or \ref
  5791. QCustomPlot::addGraph when working with QCPGraphs through the dedicated graph interface).
  5792. \see setKeyAxis
  5793. */
  5794. void QCPAbstractPlottable::setValueAxis(QCPAxis *axis)
  5795. {
  5796. mValueAxis = axis;
  5797. }
  5798. /*!
  5799. Sets whether the user can (de-)select this plottable by clicking on the QCustomPlot surface.
  5800. (When \ref QCustomPlot::setInteractions contains iSelectPlottables.)
  5801. However, even when \a selectable was set to false, it is possible to set the selection manually,
  5802. by calling \ref setSelected directly.
  5803. \see setSelected
  5804. */
  5805. void QCPAbstractPlottable::setSelectable(bool selectable)
  5806. {
  5807. mSelectable = selectable;
  5808. }
  5809. /*!
  5810. Sets whether this plottable is selected or not. When selected, it uses a different pen and brush
  5811. to draw its lines and fills, see \ref setSelectedPen and \ref setSelectedBrush.
  5812. The entire selection mechanism for plottables is handled automatically when \ref
  5813. QCustomPlot::setInteractions contains iSelectPlottables. You only need to call this function when
  5814. you wish to change the selection state manually.
  5815. This function can change the selection state even when \ref setSelectable was set to false.
  5816. emits the \ref selectionChanged signal when \a selected is different from the previous selection state.
  5817. \see setSelectable, selectTest
  5818. */
  5819. void QCPAbstractPlottable::setSelected(bool selected)
  5820. {
  5821. if (mSelected != selected)
  5822. {
  5823. mSelected = selected;
  5824. emit selectionChanged(mSelected);
  5825. }
  5826. }
  5827. /*!
  5828. Rescales the key and value axes associated with this plottable to contain all displayed data, so
  5829. the whole plottable is visible. If the scaling of an axis is logarithmic, rescaleAxes will make
  5830. sure not to rescale to an illegal range i.e. a range containing different signs and/or zero.
  5831. Instead it will stay in the current sign domain and ignore all parts of the plottable that lie
  5832. outside of that domain.
  5833. \a onlyEnlarge makes sure the ranges are only expanded, never reduced. So it's possible to show
  5834. multiple plottables in their entirety by multiple calls to rescaleAxes where the first call has
  5835. \a onlyEnlarge set to false (the default), and all subsequent set to true.
  5836. \see rescaleKeyAxis, rescaleValueAxis, QCustomPlot::rescaleAxes, QCPAxis::rescale
  5837. */
  5838. void QCPAbstractPlottable::rescaleAxes(bool onlyEnlarge) const
  5839. {
  5840. rescaleKeyAxis(onlyEnlarge);
  5841. rescaleValueAxis(onlyEnlarge);
  5842. }
  5843. /*!
  5844. Rescales the key axis of the plottable so the whole plottable is visible.
  5845. See \ref rescaleAxes for detailed behaviour.
  5846. */
  5847. void QCPAbstractPlottable::rescaleKeyAxis(bool onlyEnlarge) const
  5848. {
  5849. QCPAxis *keyAxis = mKeyAxis.data();
  5850. if (!keyAxis) { qDebug() << Q_FUNC_INFO << "invalid key axis"; return; }
  5851. SignDomain signDomain = sdBoth;
  5852. if (keyAxis->scaleType() == QCPAxis::stLogarithmic)
  5853. signDomain = (keyAxis->range().upper < 0 ? sdNegative : sdPositive);
  5854. bool rangeValid;
  5855. QCPRange newRange = getKeyRange(rangeValid, signDomain);
  5856. if (rangeValid)
  5857. {
  5858. if (onlyEnlarge)
  5859. newRange.expand(keyAxis->range());
  5860. keyAxis->setRange(newRange);
  5861. }
  5862. }
  5863. /*!
  5864. Rescales the value axis of the plottable so the whole plottable is visible.
  5865. Returns true if the axis was actually scaled. This might not be the case if this plottable has an
  5866. invalid range, e.g. because it has no data points.
  5867. See \ref rescaleAxes for detailed behaviour.
  5868. */
  5869. void QCPAbstractPlottable::rescaleValueAxis(bool onlyEnlarge) const
  5870. {
  5871. QCPAxis *valueAxis = mValueAxis.data();
  5872. if (!valueAxis) { qDebug() << Q_FUNC_INFO << "invalid value axis"; return; }
  5873. SignDomain signDomain = sdBoth;
  5874. if (valueAxis->scaleType() == QCPAxis::stLogarithmic)
  5875. signDomain = (valueAxis->range().upper < 0 ? sdNegative : sdPositive);
  5876. bool rangeValid;
  5877. QCPRange newRange = getValueRange(rangeValid, signDomain);
  5878. if (rangeValid)
  5879. {
  5880. if (onlyEnlarge)
  5881. newRange.expand(valueAxis->range());
  5882. valueAxis->setRange(newRange);
  5883. }
  5884. }
  5885. /*!
  5886. Adds this plottable to the legend of the parent QCustomPlot (QCustomPlot::legend).
  5887. Normally, a QCPPlottableLegendItem is created and inserted into the legend. If the plottable
  5888. needs a more specialized representation in the legend, this function will take this into account
  5889. and instead create the specialized subclass of QCPAbstractLegendItem.
  5890. Returns true on success, i.e. when the legend exists and a legend item associated with this plottable isn't already in
  5891. the legend.
  5892. \see removeFromLegend, QCPLegend::addItem
  5893. */
  5894. bool QCPAbstractPlottable::addToLegend()
  5895. {
  5896. if (!mParentPlot || !mParentPlot->legend)
  5897. return false;
  5898. if (!mParentPlot->legend->hasItemWithPlottable(this))
  5899. {
  5900. mParentPlot->legend->addItem(new QCPPlottableLegendItem(mParentPlot->legend, this));
  5901. return true;
  5902. } else
  5903. return false;
  5904. }
  5905. /*!
  5906. Removes the plottable from the legend of the parent QCustomPlot. This means the
  5907. QCPAbstractLegendItem (usually a QCPPlottableLegendItem) that is associated with this plottable
  5908. is removed.
  5909. Returns true on success, i.e. if the legend exists and a legend item associated with this
  5910. plottable was found and removed.
  5911. \see addToLegend, QCPLegend::removeItem
  5912. */
  5913. bool QCPAbstractPlottable::removeFromLegend() const
  5914. {
  5915. if (!mParentPlot->legend)
  5916. return false;
  5917. if (QCPPlottableLegendItem *lip = mParentPlot->legend->itemWithPlottable(this))
  5918. return mParentPlot->legend->removeItem(lip);
  5919. else
  5920. return false;
  5921. }
  5922. /* inherits documentation from base class */
  5923. QRect QCPAbstractPlottable::clipRect() const
  5924. {
  5925. if (mKeyAxis && mValueAxis)
  5926. return mKeyAxis.data()->axisRect()->rect() & mValueAxis.data()->axisRect()->rect();
  5927. else
  5928. return QRect();
  5929. }
  5930. /* inherits documentation from base class */
  5931. QCP::Interaction QCPAbstractPlottable::selectionCategory() const
  5932. {
  5933. return QCP::iSelectPlottables;
  5934. }
  5935. /*! \internal
  5936. Convenience function for transforming a key/value pair to pixels on the QCustomPlot surface,
  5937. taking the orientations of the axes associated with this plottable into account (e.g. whether key
  5938. represents x or y).
  5939. \a key and \a value are transformed to the coodinates in pixels and are written to \a x and \a y.
  5940. \see pixelsToCoords, QCPAxis::coordToPixel
  5941. */
  5942. void QCPAbstractPlottable::coordsToPixels(double key, double value, double &x, double &y) const
  5943. {
  5944. QCPAxis *keyAxis = mKeyAxis.data();
  5945. QCPAxis *valueAxis = mValueAxis.data();
  5946. if (!keyAxis || !valueAxis) { qDebug() << Q_FUNC_INFO << "invalid key or value axis"; return; }
  5947. if (keyAxis->orientation() == Qt::Horizontal)
  5948. {
  5949. x = keyAxis->coordToPixel(key);
  5950. y = valueAxis->coordToPixel(value);
  5951. } else
  5952. {
  5953. y = keyAxis->coordToPixel(key);
  5954. x = valueAxis->coordToPixel(value);
  5955. }
  5956. }
  5957. /*! \internal
  5958. \overload
  5959. Returns the input as pixel coordinates in a QPointF.
  5960. */
  5961. const QPointF QCPAbstractPlottable::coordsToPixels(double key, double value) const
  5962. {
  5963. QCPAxis *keyAxis = mKeyAxis.data();
  5964. QCPAxis *valueAxis = mValueAxis.data();
  5965. if (!keyAxis || !valueAxis) { qDebug() << Q_FUNC_INFO << "invalid key or value axis"; return QPointF(); }
  5966. if (keyAxis->orientation() == Qt::Horizontal)
  5967. return QPointF(keyAxis->coordToPixel(key), valueAxis->coordToPixel(value));
  5968. else
  5969. return QPointF(valueAxis->coordToPixel(value), keyAxis->coordToPixel(key));
  5970. }
  5971. /*! \internal
  5972. Convenience function for transforming a x/y pixel pair on the QCustomPlot surface to plot coordinates,
  5973. taking the orientations of the axes associated with this plottable into account (e.g. whether key
  5974. represents x or y).
  5975. \a x and \a y are transformed to the plot coodinates and are written to \a key and \a value.
  5976. \see coordsToPixels, QCPAxis::coordToPixel
  5977. */
  5978. void QCPAbstractPlottable::pixelsToCoords(double x, double y, double &key, double &value) const
  5979. {
  5980. QCPAxis *keyAxis = mKeyAxis.data();
  5981. QCPAxis *valueAxis = mValueAxis.data();
  5982. if (!keyAxis || !valueAxis) { qDebug() << Q_FUNC_INFO << "invalid key or value axis"; return; }
  5983. if (keyAxis->orientation() == Qt::Horizontal)
  5984. {
  5985. key = keyAxis->pixelToCoord(x);
  5986. value = valueAxis->pixelToCoord(y);
  5987. } else
  5988. {
  5989. key = keyAxis->pixelToCoord(y);
  5990. value = valueAxis->pixelToCoord(x);
  5991. }
  5992. }
  5993. /*! \internal
  5994. \overload
  5995. Returns the pixel input \a pixelPos as plot coordinates \a key and \a value.
  5996. */
  5997. void QCPAbstractPlottable::pixelsToCoords(const QPointF &pixelPos, double &key, double &value) const
  5998. {
  5999. pixelsToCoords(pixelPos.x(), pixelPos.y(), key, value);
  6000. }
  6001. /*! \internal
  6002. Returns the pen that should be used for drawing lines of the plottable. Returns mPen when the
  6003. graph is not selected and mSelectedPen when it is.
  6004. */
  6005. QPen QCPAbstractPlottable::mainPen() const
  6006. {
  6007. return mSelected ? mSelectedPen : mPen;
  6008. }
  6009. /*! \internal
  6010. Returns the brush that should be used for drawing fills of the plottable. Returns mBrush when the
  6011. graph is not selected and mSelectedBrush when it is.
  6012. */
  6013. QBrush QCPAbstractPlottable::mainBrush() const
  6014. {
  6015. return mSelected ? mSelectedBrush : mBrush;
  6016. }
  6017. /*! \internal
  6018. A convenience function to easily set the QPainter::Antialiased hint on the provided \a painter
  6019. before drawing plottable lines.
  6020. This is the antialiasing state the painter passed to the \ref draw method is in by default.
  6021. This function takes into account the local setting of the antialiasing flag as well as the
  6022. overrides set with \ref QCustomPlot::setAntialiasedElements and \ref
  6023. QCustomPlot::setNotAntialiasedElements.
  6024. \see setAntialiased, applyFillAntialiasingHint, applyScattersAntialiasingHint, applyErrorBarsAntialiasingHint
  6025. */
  6026. void QCPAbstractPlottable::applyDefaultAntialiasingHint(QCPPainter *painter) const
  6027. {
  6028. applyAntialiasingHint(painter, mAntialiased, QCP::aePlottables);
  6029. }
  6030. /*! \internal
  6031. A convenience function to easily set the QPainter::Antialiased hint on the provided \a painter
  6032. before drawing plottable fills.
  6033. This function takes into account the local setting of the antialiasing flag as well as the
  6034. overrides set with \ref QCustomPlot::setAntialiasedElements and \ref
  6035. QCustomPlot::setNotAntialiasedElements.
  6036. \see setAntialiased, applyDefaultAntialiasingHint, applyScattersAntialiasingHint, applyErrorBarsAntialiasingHint
  6037. */
  6038. void QCPAbstractPlottable::applyFillAntialiasingHint(QCPPainter *painter) const
  6039. {
  6040. applyAntialiasingHint(painter, mAntialiasedFill, QCP::aeFills);
  6041. }
  6042. /*! \internal
  6043. A convenience function to easily set the QPainter::Antialiased hint on the provided \a painter
  6044. before drawing plottable scatter points.
  6045. This function takes into account the local setting of the antialiasing flag as well as the
  6046. overrides set with \ref QCustomPlot::setAntialiasedElements and \ref
  6047. QCustomPlot::setNotAntialiasedElements.
  6048. \see setAntialiased, applyFillAntialiasingHint, applyDefaultAntialiasingHint, applyErrorBarsAntialiasingHint
  6049. */
  6050. void QCPAbstractPlottable::applyScattersAntialiasingHint(QCPPainter *painter) const
  6051. {
  6052. applyAntialiasingHint(painter, mAntialiasedScatters, QCP::aeScatters);
  6053. }
  6054. /*! \internal
  6055. A convenience function to easily set the QPainter::Antialiased hint on the provided \a painter
  6056. before drawing plottable error bars.
  6057. This function takes into account the local setting of the antialiasing flag as well as the
  6058. overrides set with \ref QCustomPlot::setAntialiasedElements and \ref
  6059. QCustomPlot::setNotAntialiasedElements.
  6060. \see setAntialiased, applyFillAntialiasingHint, applyScattersAntialiasingHint, applyDefaultAntialiasingHint
  6061. */
  6062. void QCPAbstractPlottable::applyErrorBarsAntialiasingHint(QCPPainter *painter) const
  6063. {
  6064. applyAntialiasingHint(painter, mAntialiasedErrorBars, QCP::aeErrorBars);
  6065. }
  6066. /*! \internal
  6067. Finds the shortest squared distance of \a point to the line segment defined by \a start and \a
  6068. end.
  6069. This function may be used to help with the implementation of the \ref selectTest function for
  6070. specific plottables.
  6071. \note This function is identical to QCPAbstractItem::distSqrToLine
  6072. */
  6073. double QCPAbstractPlottable::distSqrToLine(const QPointF &start, const QPointF &end, const QPointF &point) const
  6074. {
  6075. QVector2D a(start);
  6076. QVector2D b(end);
  6077. QVector2D p(point);
  6078. QVector2D v(b-a);
  6079. double vLengthSqr = v.lengthSquared();
  6080. if (!qFuzzyIsNull(vLengthSqr))
  6081. {
  6082. double mu = QVector2D::dotProduct(p-a, v)/vLengthSqr;
  6083. if (mu < 0)
  6084. return (a-p).lengthSquared();
  6085. else if (mu > 1)
  6086. return (b-p).lengthSquared();
  6087. else
  6088. return ((a + mu*v)-p).lengthSquared();
  6089. } else
  6090. return (a-p).lengthSquared();
  6091. }
  6092. /* inherits documentation from base class */
  6093. void QCPAbstractPlottable::selectEvent(QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged)
  6094. {
  6095. Q_UNUSED(event)
  6096. Q_UNUSED(details)
  6097. if (mSelectable)
  6098. {
  6099. bool selBefore = mSelected;
  6100. setSelected(additive ? !mSelected : true);
  6101. if (selectionStateChanged)
  6102. *selectionStateChanged = mSelected != selBefore;
  6103. }
  6104. }
  6105. /* inherits documentation from base class */
  6106. void QCPAbstractPlottable::deselectEvent(bool *selectionStateChanged)
  6107. {
  6108. if (mSelectable)
  6109. {
  6110. bool selBefore = mSelected;
  6111. setSelected(false);
  6112. if (selectionStateChanged)
  6113. *selectionStateChanged = mSelected != selBefore;
  6114. }
  6115. }
  6116. ////////////////////////////////////////////////////////////////////////////////////////////////////
  6117. //////////////////// QCPItemAnchor
  6118. ////////////////////////////////////////////////////////////////////////////////////////////////////
  6119. /*! \class QCPItemAnchor
  6120. \brief An anchor of an item to which positions can be attached to.
  6121. An item (QCPAbstractItem) may have one or more anchors. Unlike QCPItemPosition, an anchor doesn't
  6122. control anything on its item, but provides a way to tie other items via their positions to the
  6123. anchor.
  6124. For example, a QCPItemRect is defined by its positions \a topLeft and \a bottomRight.
  6125. Additionally it has various anchors like \a top, \a topRight or \a bottomLeft etc. So you can
  6126. attach the \a start (which is a QCPItemPosition) of a QCPItemLine to one of the anchors by
  6127. calling QCPItemPosition::setParentAnchor on \a start, passing the wanted anchor of the
  6128. QCPItemRect. This way the start of the line will now always follow the respective anchor location
  6129. on the rect item.
  6130. Note that QCPItemPosition derives from QCPItemAnchor, so every position can also serve as an
  6131. anchor to other positions.
  6132. To learn how to provide anchors in your own item subclasses, see the subclassing section of the
  6133. QCPAbstractItem documentation.
  6134. */
  6135. /* start documentation of inline functions */
  6136. /*! \fn virtual QCPItemPosition *QCPItemAnchor::toQCPItemPosition()
  6137. Returns 0 if this instance is merely a QCPItemAnchor, and a valid pointer of type QCPItemPosition* if
  6138. it actually is a QCPItemPosition (which is a subclass of QCPItemAnchor).
  6139. This safe downcast functionality could also be achieved with a dynamic_cast. However, QCustomPlot avoids
  6140. dynamic_cast to work with projects that don't have RTTI support enabled (e.g. -fno-rtti flag with
  6141. gcc compiler).
  6142. */
  6143. /* end documentation of inline functions */
  6144. /*!
  6145. Creates a new QCPItemAnchor. You shouldn't create QCPItemAnchor instances directly, even if
  6146. you want to make a new item subclass. Use \ref QCPAbstractItem::createAnchor instead, as
  6147. explained in the subclassing section of the QCPAbstractItem documentation.
  6148. */
  6149. QCPItemAnchor::QCPItemAnchor(QCustomPlot *parentPlot, QCPAbstractItem *parentItem, const QString name, int anchorId) :
  6150. mName(name),
  6151. mParentPlot(parentPlot),
  6152. mParentItem(parentItem),
  6153. mAnchorId(anchorId)
  6154. {
  6155. }
  6156. QCPItemAnchor::~QCPItemAnchor()
  6157. {
  6158. // unregister as parent at children:
  6159. QList<QCPItemPosition*> currentChildren(mChildren.toList());
  6160. for (int i=0; i<currentChildren.size(); ++i)
  6161. currentChildren.at(i)->setParentAnchor(0); // this acts back on this anchor and child removes itself from mChildren
  6162. }
  6163. /*!
  6164. Returns the final absolute pixel position of the QCPItemAnchor on the QCustomPlot surface.
  6165. The pixel information is internally retrieved via QCPAbstractItem::anchorPixelPosition of the
  6166. parent item, QCPItemAnchor is just an intermediary.
  6167. */
  6168. QPointF QCPItemAnchor::pixelPoint() const
  6169. {
  6170. if (mParentItem)
  6171. {
  6172. if (mAnchorId > -1)
  6173. {
  6174. return mParentItem->anchorPixelPoint(mAnchorId);
  6175. } else
  6176. {
  6177. qDebug() << Q_FUNC_INFO << "no valid anchor id set:" << mAnchorId;
  6178. return QPointF();
  6179. }
  6180. } else
  6181. {
  6182. qDebug() << Q_FUNC_INFO << "no parent item set";
  6183. return QPointF();
  6184. }
  6185. }
  6186. /*! \internal
  6187. Adds \a pos to the child list of this anchor. This is necessary to notify the children prior to
  6188. destruction of the anchor.
  6189. Note that this function does not change the parent setting in \a pos.
  6190. */
  6191. void QCPItemAnchor::addChild(QCPItemPosition *pos)
  6192. {
  6193. if (!mChildren.contains(pos))
  6194. mChildren.insert(pos);
  6195. else
  6196. qDebug() << Q_FUNC_INFO << "provided pos is child already" << reinterpret_cast<quintptr>(pos);
  6197. }
  6198. /*! \internal
  6199. Removes \a pos from the child list of this anchor.
  6200. Note that this function does not change the parent setting in \a pos.
  6201. */
  6202. void QCPItemAnchor::removeChild(QCPItemPosition *pos)
  6203. {
  6204. if (!mChildren.remove(pos))
  6205. qDebug() << Q_FUNC_INFO << "provided pos isn't child" << reinterpret_cast<quintptr>(pos);
  6206. }
  6207. ////////////////////////////////////////////////////////////////////////////////////////////////////
  6208. //////////////////// QCPItemPosition
  6209. ////////////////////////////////////////////////////////////////////////////////////////////////////
  6210. /*! \class QCPItemPosition
  6211. \brief Manages the position of an item.
  6212. Every item has at least one public QCPItemPosition member pointer which provides ways to position the
  6213. item on the QCustomPlot surface. Some items have multiple positions, for example QCPItemRect has two:
  6214. \a topLeft and \a bottomRight.
  6215. QCPItemPosition has a type (\ref PositionType) that can be set with \ref setType. This type defines
  6216. how coordinates passed to \ref setCoords are to be interpreted, e.g. as absolute pixel coordinates, as
  6217. plot coordinates of certain axes, etc.
  6218. Further, QCPItemPosition may have a parent QCPItemAnchor, see \ref setParentAnchor. (Note that every
  6219. QCPItemPosition inherits from QCPItemAnchor and thus can itself be used as parent anchor for other
  6220. positions.) This way you can tie multiple items together. If the QCPItemPosition has a parent, the
  6221. coordinates set with \ref setCoords are considered to be absolute values in the reference frame of the
  6222. parent anchor, where (0, 0) means directly ontop of the parent anchor. For example, You could attach
  6223. the \a start position of a QCPItemLine to the \a bottom anchor of a QCPItemText to make the starting
  6224. point of the line always be centered under the text label, no matter where the text is moved to, or is
  6225. itself tied to.
  6226. To set the apparent pixel position on the QCustomPlot surface directly, use \ref setPixelPoint. This
  6227. works no matter what type this QCPItemPosition is or what parent-child situation it is in, as \ref
  6228. setPixelPoint transforms the coordinates appropriately, to make the position appear at the specified
  6229. pixel values.
  6230. */
  6231. /*!
  6232. Creates a new QCPItemPosition. You shouldn't create QCPItemPosition instances directly, even if
  6233. you want to make a new item subclass. Use \ref QCPAbstractItem::createPosition instead, as
  6234. explained in the subclassing section of the QCPAbstractItem documentation.
  6235. */
  6236. QCPItemPosition::QCPItemPosition(QCustomPlot *parentPlot, QCPAbstractItem *parentItem, const QString name) :
  6237. QCPItemAnchor(parentPlot, parentItem, name),
  6238. mPositionType(ptAbsolute),
  6239. mKey(0),
  6240. mValue(0),
  6241. mParentAnchor(0)
  6242. {
  6243. }
  6244. QCPItemPosition::~QCPItemPosition()
  6245. {
  6246. // unregister as parent at children:
  6247. // Note: this is done in ~QCPItemAnchor again, but it's important QCPItemPosition does it itself, because only then
  6248. // the setParentAnchor(0) call the correct QCPItemPosition::pixelPoint function instead of QCPItemAnchor::pixelPoint
  6249. QList<QCPItemPosition*> currentChildren(mChildren.toList());
  6250. for (int i=0; i<currentChildren.size(); ++i)
  6251. currentChildren.at(i)->setParentAnchor(0); // this acts back on this anchor and child removes itself from mChildren
  6252. // unregister as child in parent:
  6253. if (mParentAnchor)
  6254. mParentAnchor->removeChild(this);
  6255. }
  6256. /* can't make this a header inline function, because QPointer breaks with forward declared types, see QTBUG-29588 */
  6257. QCPAxisRect *QCPItemPosition::axisRect() const
  6258. {
  6259. return mAxisRect.data();
  6260. }
  6261. /*!
  6262. Sets the type of the position. The type defines how the coordinates passed to \ref setCoords
  6263. should be handled and how the QCPItemPosition should behave in the plot.
  6264. The possible values for \a type can be separated in two main categories:
  6265. \li The position is regarded as a point in plot coordinates. This corresponds to \ref ptPlotCoords
  6266. and requires two axes that define the plot coordinate system. They can be specified with \ref setAxes.
  6267. By default, the QCustomPlot's x- and yAxis are used.
  6268. \li The position is fixed on the QCustomPlot surface, i.e. independent of axis ranges. This
  6269. corresponds to all other types, i.e. \ref ptAbsolute, \ref ptViewportRatio and \ref
  6270. ptAxisRectRatio. They differ only in the way the absolute position is described, see the
  6271. documentation of PositionType for details. For \ref ptAxisRectRatio, note that you can specify
  6272. the axis rect with \ref setAxisRect. By default this is set to the main axis rect.
  6273. Note that the position type \ref ptPlotCoords is only available (and sensible) when the position
  6274. has no parent anchor (\ref setParentAnchor).
  6275. If the type is changed, the apparent pixel position on the plot is preserved. This means
  6276. the coordinates as retrieved with coords() and set with \ref setCoords may change in the process.
  6277. */
  6278. void QCPItemPosition::setType(QCPItemPosition::PositionType type)
  6279. {
  6280. if (mPositionType != type)
  6281. {
  6282. // if switching from or to coordinate type that isn't valid (e.g. because axes or axis rect
  6283. // were deleted), don't try to recover the pixelPoint() because it would output a qDebug warning.
  6284. bool recoverPixelPosition = true;
  6285. if ((mPositionType == ptPlotCoords || type == ptPlotCoords) && (!mKeyAxis || !mValueAxis))
  6286. recoverPixelPosition = false;
  6287. if ((mPositionType == ptAxisRectRatio || type == ptAxisRectRatio) && (!mAxisRect))
  6288. recoverPixelPosition = false;
  6289. QPointF pixelP;
  6290. if (recoverPixelPosition)
  6291. pixelP = pixelPoint();
  6292. mPositionType = type;
  6293. if (recoverPixelPosition)
  6294. setPixelPoint(pixelP);
  6295. }
  6296. }
  6297. /*!
  6298. Sets the parent of this QCPItemPosition to \a parentAnchor. This means the position will now
  6299. follow any position changes of the anchor. The local coordinate system of positions with a parent
  6300. anchor always is absolute with (0, 0) being exactly on top of the parent anchor. (Hence the type
  6301. shouldn't be \ref ptPlotCoords for positions with parent anchors.)
  6302. if \a keepPixelPosition is true, the current pixel position of the QCPItemPosition is preserved
  6303. during reparenting. If it's set to false, the coordinates are set to (0, 0), i.e. the position
  6304. will be exactly on top of the parent anchor.
  6305. To remove this QCPItemPosition from any parent anchor, set \a parentAnchor to 0.
  6306. If the QCPItemPosition previously had no parent and the type is \ref ptPlotCoords, the type is
  6307. set to \ref ptAbsolute, to keep the position in a valid state.
  6308. */
  6309. bool QCPItemPosition::setParentAnchor(QCPItemAnchor *parentAnchor, bool keepPixelPosition)
  6310. {
  6311. // make sure self is not assigned as parent:
  6312. if (parentAnchor == this)
  6313. {
  6314. qDebug() << Q_FUNC_INFO << "can't set self as parent anchor" << reinterpret_cast<quintptr>(parentAnchor);
  6315. return false;
  6316. }
  6317. // make sure no recursive parent-child-relationships are created:
  6318. QCPItemAnchor *currentParent = parentAnchor;
  6319. while (currentParent)
  6320. {
  6321. if (QCPItemPosition *currentParentPos = currentParent->toQCPItemPosition())
  6322. {
  6323. // is a QCPItemPosition, might have further parent, so keep iterating
  6324. if (currentParentPos == this)
  6325. {
  6326. qDebug() << Q_FUNC_INFO << "can't create recursive parent-child-relationship" << reinterpret_cast<quintptr>(parentAnchor);
  6327. return false;
  6328. }
  6329. currentParent = currentParentPos->mParentAnchor;
  6330. } else
  6331. {
  6332. // is a QCPItemAnchor, can't have further parent. Now make sure the parent items aren't the
  6333. // same, to prevent a position being child of an anchor which itself depends on the position,
  6334. // because they're both on the same item:
  6335. if (currentParent->mParentItem == mParentItem)
  6336. {
  6337. qDebug() << Q_FUNC_INFO << "can't set parent to be an anchor which itself depends on this position" << reinterpret_cast<quintptr>(parentAnchor);
  6338. return false;
  6339. }
  6340. break;
  6341. }
  6342. }
  6343. // if previously no parent set and PosType is still ptPlotCoords, set to ptAbsolute:
  6344. if (!mParentAnchor && mPositionType == ptPlotCoords)
  6345. setType(ptAbsolute);
  6346. // save pixel position:
  6347. QPointF pixelP;
  6348. if (keepPixelPosition)
  6349. pixelP = pixelPoint();
  6350. // unregister at current parent anchor:
  6351. if (mParentAnchor)
  6352. mParentAnchor->removeChild(this);
  6353. // register at new parent anchor:
  6354. if (parentAnchor)
  6355. parentAnchor->addChild(this);
  6356. mParentAnchor = parentAnchor;
  6357. // restore pixel position under new parent:
  6358. if (keepPixelPosition)
  6359. setPixelPoint(pixelP);
  6360. else
  6361. setCoords(0, 0);
  6362. return true;
  6363. }
  6364. /*!
  6365. Sets the coordinates of this QCPItemPosition. What the coordinates mean, is defined by the type
  6366. (\ref setType).
  6367. For example, if the type is \ref ptAbsolute, \a key and \a value mean the x and y pixel position
  6368. on the QCustomPlot surface. In that case the origin (0, 0) is in the top left corner of the
  6369. QCustomPlot viewport. If the type is \ref ptPlotCoords, \a key and \a value mean a point in the
  6370. plot coordinate system defined by the axes set by \ref setAxes. By default those are the
  6371. QCustomPlot's xAxis and yAxis. See the documentation of \ref setType for other available
  6372. coordinate types and their meaning.
  6373. \see setPixelPoint
  6374. */
  6375. void QCPItemPosition::setCoords(double key, double value)
  6376. {
  6377. mKey = key;
  6378. mValue = value;
  6379. }
  6380. /*! \overload
  6381. Sets the coordinates as a QPointF \a pos where pos.x has the meaning of \a key and pos.y the
  6382. meaning of \a value of the \ref setCoords(double key, double value) method.
  6383. */
  6384. void QCPItemPosition::setCoords(const QPointF &pos)
  6385. {
  6386. setCoords(pos.x(), pos.y());
  6387. }
  6388. /*!
  6389. Returns the final absolute pixel position of the QCPItemPosition on the QCustomPlot surface. It
  6390. includes all effects of type (\ref setType) and possible parent anchors (\ref setParentAnchor).
  6391. \see setPixelPoint
  6392. */
  6393. QPointF QCPItemPosition::pixelPoint() const
  6394. {
  6395. switch (mPositionType)
  6396. {
  6397. case ptAbsolute:
  6398. {
  6399. if (mParentAnchor)
  6400. return QPointF(mKey, mValue) + mParentAnchor->pixelPoint();
  6401. else
  6402. return QPointF(mKey, mValue);
  6403. }
  6404. case ptViewportRatio:
  6405. {
  6406. if (mParentAnchor)
  6407. {
  6408. return QPointF(mKey*mParentPlot->viewport().width(),
  6409. mValue*mParentPlot->viewport().height()) + mParentAnchor->pixelPoint();
  6410. } else
  6411. {
  6412. return QPointF(mKey*mParentPlot->viewport().width(),
  6413. mValue*mParentPlot->viewport().height()) + mParentPlot->viewport().topLeft();
  6414. }
  6415. }
  6416. case ptAxisRectRatio:
  6417. {
  6418. if (mAxisRect)
  6419. {
  6420. if (mParentAnchor)
  6421. {
  6422. return QPointF(mKey*mAxisRect.data()->width(),
  6423. mValue*mAxisRect.data()->height()) + mParentAnchor->pixelPoint();
  6424. } else
  6425. {
  6426. return QPointF(mKey*mAxisRect.data()->width(),
  6427. mValue*mAxisRect.data()->height()) + mAxisRect.data()->topLeft();
  6428. }
  6429. } else
  6430. {
  6431. qDebug() << Q_FUNC_INFO << "No axis rect defined";
  6432. return QPointF(mKey, mValue);
  6433. }
  6434. }
  6435. case ptPlotCoords:
  6436. {
  6437. double x, y;
  6438. if (mKeyAxis && mValueAxis)
  6439. {
  6440. // both key and value axis are given, translate key/value to x/y coordinates:
  6441. if (mKeyAxis.data()->orientation() == Qt::Horizontal)
  6442. {
  6443. x = mKeyAxis.data()->coordToPixel(mKey);
  6444. y = mValueAxis.data()->coordToPixel(mValue);
  6445. } else
  6446. {
  6447. y = mKeyAxis.data()->coordToPixel(mKey);
  6448. x = mValueAxis.data()->coordToPixel(mValue);
  6449. }
  6450. } else if (mKeyAxis)
  6451. {
  6452. // only key axis is given, depending on orientation only transform x or y to key coordinate, other stays pixel:
  6453. if (mKeyAxis.data()->orientation() == Qt::Horizontal)
  6454. {
  6455. x = mKeyAxis.data()->coordToPixel(mKey);
  6456. y = mValue;
  6457. } else
  6458. {
  6459. y = mKeyAxis.data()->coordToPixel(mKey);
  6460. x = mValue;
  6461. }
  6462. } else if (mValueAxis)
  6463. {
  6464. // only value axis is given, depending on orientation only transform x or y to value coordinate, other stays pixel:
  6465. if (mValueAxis.data()->orientation() == Qt::Horizontal)
  6466. {
  6467. x = mValueAxis.data()->coordToPixel(mValue);
  6468. y = mKey;
  6469. } else
  6470. {
  6471. y = mValueAxis.data()->coordToPixel(mValue);
  6472. x = mKey;
  6473. }
  6474. } else
  6475. {
  6476. // no axis given, basically the same as if mPositionType were ptAbsolute
  6477. qDebug() << Q_FUNC_INFO << "No axes defined";
  6478. x = mKey;
  6479. y = mValue;
  6480. }
  6481. return QPointF(x, y);
  6482. }
  6483. }
  6484. return QPointF();
  6485. }
  6486. /*!
  6487. When \ref setType is \ref ptPlotCoords, this function may be used to specify the axes the
  6488. coordinates set with \ref setCoords relate to. By default they are set to the initial xAxis and
  6489. yAxis of the QCustomPlot.
  6490. */
  6491. void QCPItemPosition::setAxes(QCPAxis *keyAxis, QCPAxis *valueAxis)
  6492. {
  6493. mKeyAxis = keyAxis;
  6494. mValueAxis = valueAxis;
  6495. }
  6496. /*!
  6497. When \ref setType is \ref ptAxisRectRatio, this function may be used to specify the axis rect the
  6498. coordinates set with \ref setCoords relate to. By default this is set to the main axis rect of
  6499. the QCustomPlot.
  6500. */
  6501. void QCPItemPosition::setAxisRect(QCPAxisRect *axisRect)
  6502. {
  6503. mAxisRect = axisRect;
  6504. }
  6505. /*!
  6506. Sets the apparent pixel position. This works no matter what type (\ref setType) this
  6507. QCPItemPosition is or what parent-child situation it is in, as coordinates are transformed
  6508. appropriately, to make the position finally appear at the specified pixel values.
  6509. Only if the type is \ref ptAbsolute and no parent anchor is set, this function's effect is
  6510. identical to that of \ref setCoords.
  6511. \see pixelPoint, setCoords
  6512. */
  6513. void QCPItemPosition::setPixelPoint(const QPointF &pixelPoint)
  6514. {
  6515. switch (mPositionType)
  6516. {
  6517. case ptAbsolute:
  6518. {
  6519. if (mParentAnchor)
  6520. setCoords(pixelPoint-mParentAnchor->pixelPoint());
  6521. else
  6522. setCoords(pixelPoint);
  6523. break;
  6524. }
  6525. case ptViewportRatio:
  6526. {
  6527. if (mParentAnchor)
  6528. {
  6529. QPointF p(pixelPoint-mParentAnchor->pixelPoint());
  6530. p.rx() /= (double)mParentPlot->viewport().width();
  6531. p.ry() /= (double)mParentPlot->viewport().height();
  6532. setCoords(p);
  6533. } else
  6534. {
  6535. QPointF p(pixelPoint-mParentPlot->viewport().topLeft());
  6536. p.rx() /= (double)mParentPlot->viewport().width();
  6537. p.ry() /= (double)mParentPlot->viewport().height();
  6538. setCoords(p);
  6539. }
  6540. break;
  6541. }
  6542. case ptAxisRectRatio:
  6543. {
  6544. if (mAxisRect)
  6545. {
  6546. if (mParentAnchor)
  6547. {
  6548. QPointF p(pixelPoint-mParentAnchor->pixelPoint());
  6549. p.rx() /= (double)mAxisRect.data()->width();
  6550. p.ry() /= (double)mAxisRect.data()->height();
  6551. setCoords(p);
  6552. } else
  6553. {
  6554. QPointF p(pixelPoint-mAxisRect.data()->topLeft());
  6555. p.rx() /= (double)mAxisRect.data()->width();
  6556. p.ry() /= (double)mAxisRect.data()->height();
  6557. setCoords(p);
  6558. }
  6559. } else
  6560. {
  6561. qDebug() << Q_FUNC_INFO << "No axis rect defined";
  6562. setCoords(pixelPoint);
  6563. }
  6564. break;
  6565. }
  6566. case ptPlotCoords:
  6567. {
  6568. double newKey, newValue;
  6569. if (mKeyAxis && mValueAxis)
  6570. {
  6571. // both key and value axis are given, translate point to key/value coordinates:
  6572. if (mKeyAxis.data()->orientation() == Qt::Horizontal)
  6573. {
  6574. newKey = mKeyAxis.data()->pixelToCoord(pixelPoint.x());
  6575. newValue = mValueAxis.data()->pixelToCoord(pixelPoint.y());
  6576. } else
  6577. {
  6578. newKey = mKeyAxis.data()->pixelToCoord(pixelPoint.y());
  6579. newValue = mValueAxis.data()->pixelToCoord(pixelPoint.x());
  6580. }
  6581. } else if (mKeyAxis)
  6582. {
  6583. // only key axis is given, depending on orientation only transform x or y to key coordinate, other stays pixel:
  6584. if (mKeyAxis.data()->orientation() == Qt::Horizontal)
  6585. {
  6586. newKey = mKeyAxis.data()->pixelToCoord(pixelPoint.x());
  6587. newValue = pixelPoint.y();
  6588. } else
  6589. {
  6590. newKey = mKeyAxis.data()->pixelToCoord(pixelPoint.y());
  6591. newValue = pixelPoint.x();
  6592. }
  6593. } else if (mValueAxis)
  6594. {
  6595. // only value axis is given, depending on orientation only transform x or y to value coordinate, other stays pixel:
  6596. if (mValueAxis.data()->orientation() == Qt::Horizontal)
  6597. {
  6598. newKey = pixelPoint.y();
  6599. newValue = mValueAxis.data()->pixelToCoord(pixelPoint.x());
  6600. } else
  6601. {
  6602. newKey = pixelPoint.x();
  6603. newValue = mValueAxis.data()->pixelToCoord(pixelPoint.y());
  6604. }
  6605. } else
  6606. {
  6607. // no axis given, basically the same as if mPositionType were ptAbsolute
  6608. qDebug() << Q_FUNC_INFO << "No axes defined";
  6609. newKey = pixelPoint.x();
  6610. newValue = pixelPoint.y();
  6611. }
  6612. setCoords(newKey, newValue);
  6613. break;
  6614. }
  6615. }
  6616. }
  6617. ////////////////////////////////////////////////////////////////////////////////////////////////////
  6618. //////////////////// QCPAbstractItem
  6619. ////////////////////////////////////////////////////////////////////////////////////////////////////
  6620. /*! \class QCPAbstractItem
  6621. \brief The abstract base class for all items in a plot.
  6622. In QCustomPlot, items are supplemental graphical elements that are neither plottables
  6623. (QCPAbstractPlottable) nor axes (QCPAxis). While plottables are always tied to two axes and thus
  6624. plot coordinates, items can also be placed in absolute coordinates independent of any axes. Each
  6625. specific item has at least one QCPItemPosition member which controls the positioning. Some items
  6626. are defined by more than one coordinate and thus have two or more QCPItemPosition members (For
  6627. example, QCPItemRect has \a topLeft and \a bottomRight).
  6628. This abstract base class defines a very basic interface like visibility and clipping. Since this
  6629. class is abstract, it can't be instantiated. Use one of the subclasses or create a subclass
  6630. yourself to create new items.
  6631. The built-in items are:
  6632. <table>
  6633. <tr><td>QCPItemLine</td><td>A line defined by a start and an end point. May have different ending styles on each side (e.g. arrows).</td></tr>
  6634. <tr><td>QCPItemStraightLine</td><td>A straight line defined by a start and a direction point. Unlike QCPItemLine, the straight line is infinitely long and has no endings.</td></tr>
  6635. <tr><td>QCPItemCurve</td><td>A curve defined by start, end and two intermediate control points. May have different ending styles on each side (e.g. arrows).</td></tr>
  6636. <tr><td>QCPItemRect</td><td>A rectangle</td></tr>
  6637. <tr><td>QCPItemEllipse</td><td>An ellipse</td></tr>
  6638. <tr><td>QCPItemPixmap</td><td>An arbitrary pixmap</td></tr>
  6639. <tr><td>QCPItemText</td><td>A text label</td></tr>
  6640. <tr><td>QCPItemBracket</td><td>A bracket which may be used to reference/highlight certain parts in the plot.</td></tr>
  6641. <tr><td>QCPItemTracer</td><td>An item that can be attached to a QCPGraph and sticks to its data points, given a key coordinate.</td></tr>
  6642. </table>
  6643. Items are by default clipped to the main axis rect. To make an item visible outside that axis
  6644. rect, disable clipping via \ref setClipToAxisRect.
  6645. \section items-using Using items
  6646. First you instantiate the item you want to use and add it to the plot:
  6647. \code
  6648. QCPItemLine *line = new QCPItemLine(customPlot);
  6649. customPlot->addItem(line);
  6650. \endcode
  6651. by default, the positions of the item are bound to the x- and y-Axis of the plot. So we can just
  6652. set the plot coordinates where the line should start/end:
  6653. \code
  6654. line->start->setCoords(-0.1, 0.8);
  6655. line->end->setCoords(1.1, 0.2);
  6656. \endcode
  6657. If we don't want the line to be positioned in plot coordinates but a different coordinate system,
  6658. e.g. absolute pixel positions on the QCustomPlot surface, we need to change the position type like this:
  6659. \code
  6660. line->start->setType(QCPItemPosition::ptAbsolute);
  6661. line->end->setType(QCPItemPosition::ptAbsolute);
  6662. \endcode
  6663. Then we can set the coordinates, this time in pixels:
  6664. \code
  6665. line->start->setCoords(100, 200);
  6666. line->end->setCoords(450, 320);
  6667. \endcode
  6668. \section items-subclassing Creating own items
  6669. To create an own item, you implement a subclass of QCPAbstractItem. These are the pure
  6670. virtual functions, you must implement:
  6671. \li \ref selectTest
  6672. \li \ref draw
  6673. See the documentation of those functions for what they need to do.
  6674. \subsection items-positioning Allowing the item to be positioned
  6675. As mentioned, item positions are represented by QCPItemPosition members. Let's assume the new item shall
  6676. have only one point as its position (as opposed to two like a rect or multiple like a polygon). You then add
  6677. a public member of type QCPItemPosition like so:
  6678. \code QCPItemPosition * const myPosition;\endcode
  6679. the const makes sure the pointer itself can't be modified from the user of your new item (the QCPItemPosition
  6680. instance it points to, can be modified, of course).
  6681. The initialization of this pointer is made easy with the \ref createPosition function. Just assign
  6682. the return value of this function to each QCPItemPosition in the constructor of your item. \ref createPosition
  6683. takes a string which is the name of the position, typically this is identical to the variable name.
  6684. For example, the constructor of QCPItemExample could look like this:
  6685. \code
  6686. QCPItemExample::QCPItemExample(QCustomPlot *parentPlot) :
  6687. QCPAbstractItem(parentPlot),
  6688. myPosition(createPosition("myPosition"))
  6689. {
  6690. // other constructor code
  6691. }
  6692. \endcode
  6693. \subsection items-drawing The draw function
  6694. To give your item a visual representation, reimplement the \ref draw function and use the passed
  6695. QCPPainter to draw the item. You can retrieve the item position in pixel coordinates from the
  6696. position member(s) via \ref QCPItemPosition::pixelPoint.
  6697. To optimize performance you should calculate a bounding rect first (don't forget to take the pen
  6698. width into account), check whether it intersects the \ref clipRect, and only draw the item at all
  6699. if this is the case.
  6700. \subsection items-selection The selectTest function
  6701. Your implementation of the \ref selectTest function may use the helpers \ref distSqrToLine and
  6702. \ref rectSelectTest. With these, the implementation of the selection test becomes significantly
  6703. simpler for most items. See the documentation of \ref selectTest for what the function parameters
  6704. mean and what the function should return.
  6705. \subsection anchors Providing anchors
  6706. Providing anchors (QCPItemAnchor) starts off like adding a position. First you create a public
  6707. member, e.g.
  6708. \code QCPItemAnchor * const bottom;\endcode
  6709. and create it in the constructor with the \ref createAnchor function, assigning it a name and an
  6710. anchor id (an integer enumerating all anchors on the item, you may create an own enum for this).
  6711. Since anchors can be placed anywhere, relative to the item's position(s), your item needs to
  6712. provide the position of every anchor with the reimplementation of the \ref anchorPixelPoint(int
  6713. anchorId) function.
  6714. In essence the QCPItemAnchor is merely an intermediary that itself asks your item for the pixel
  6715. position when anything attached to the anchor needs to know the coordinates.
  6716. */
  6717. /* start of documentation of inline functions */
  6718. /*! \fn QList<QCPItemPosition*> QCPAbstractItem::positions() const
  6719. Returns all positions of the item in a list.
  6720. \see anchors, position
  6721. */
  6722. /*! \fn QList<QCPItemAnchor*> QCPAbstractItem::anchors() const
  6723. Returns all anchors of the item in a list. Note that since a position (QCPItemPosition) is always
  6724. also an anchor, the list will also contain the positions of this item.
  6725. \see positions, anchor
  6726. */
  6727. /* end of documentation of inline functions */
  6728. /* start documentation of pure virtual functions */
  6729. /*! \fn void QCPAbstractItem::draw(QCPPainter *painter) = 0
  6730. \internal
  6731. Draws this item with the provided \a painter.
  6732. The cliprect of the provided painter is set to the rect returned by \ref clipRect before this
  6733. function is called. The clipRect depends on the clipping settings defined by \ref
  6734. setClipToAxisRect and \ref setClipAxisRect.
  6735. */
  6736. /* end documentation of pure virtual functions */
  6737. /* start documentation of signals */
  6738. /*! \fn void QCPAbstractItem::selectionChanged(bool selected)
  6739. This signal is emitted when the selection state of this item has changed, either by user interaction
  6740. or by a direct call to \ref setSelected.
  6741. */
  6742. /* end documentation of signals */
  6743. /*!
  6744. Base class constructor which initializes base class members.
  6745. */
  6746. QCPAbstractItem::QCPAbstractItem(QCustomPlot *parentPlot) :
  6747. QCPLayerable(parentPlot),
  6748. mClipToAxisRect(false),
  6749. mSelectable(true),
  6750. mSelected(false)
  6751. {
  6752. QList<QCPAxisRect*> rects = parentPlot->axisRects();
  6753. if (rects.size() > 0)
  6754. {
  6755. setClipToAxisRect(true);
  6756. setClipAxisRect(rects.first());
  6757. }
  6758. }
  6759. QCPAbstractItem::~QCPAbstractItem()
  6760. {
  6761. // don't delete mPositions because every position is also an anchor and thus in mAnchors
  6762. qDeleteAll(mAnchors);
  6763. }
  6764. /* can't make this a header inline function, because QPointer breaks with forward declared types, see QTBUG-29588 */
  6765. QCPAxisRect *QCPAbstractItem::clipAxisRect() const
  6766. {
  6767. return mClipAxisRect.data();
  6768. }
  6769. /*!
  6770. Sets whether the item shall be clipped to an axis rect or whether it shall be visible on the
  6771. entire QCustomPlot. The axis rect can be set with \ref setClipAxisRect.
  6772. \see setClipAxisRect
  6773. */
  6774. void QCPAbstractItem::setClipToAxisRect(bool clip)
  6775. {
  6776. mClipToAxisRect = clip;
  6777. if (mClipToAxisRect)
  6778. setParentLayerable(mClipAxisRect.data());
  6779. }
  6780. /*!
  6781. Sets the clip axis rect. It defines the rect that will be used to clip the item when \ref
  6782. setClipToAxisRect is set to true.
  6783. \see setClipToAxisRect
  6784. */
  6785. void QCPAbstractItem::setClipAxisRect(QCPAxisRect *rect)
  6786. {
  6787. mClipAxisRect = rect;
  6788. if (mClipToAxisRect)
  6789. setParentLayerable(mClipAxisRect.data());
  6790. }
  6791. /*!
  6792. Sets whether the user can (de-)select this item by clicking on the QCustomPlot surface.
  6793. (When \ref QCustomPlot::setInteractions contains QCustomPlot::iSelectItems.)
  6794. However, even when \a selectable was set to false, it is possible to set the selection manually,
  6795. by calling \ref setSelected.
  6796. \see QCustomPlot::setInteractions, setSelected
  6797. */
  6798. void QCPAbstractItem::setSelectable(bool selectable)
  6799. {
  6800. mSelectable = selectable;
  6801. }
  6802. /*!
  6803. Sets whether this item is selected or not. When selected, it might use a different visual
  6804. appearance (e.g. pen and brush), this depends on the specific item though.
  6805. The entire selection mechanism for items is handled automatically when \ref
  6806. QCustomPlot::setInteractions contains QCustomPlot::iSelectItems. You only need to call this
  6807. function when you wish to change the selection state manually.
  6808. This function can change the selection state even when \ref setSelectable was set to false.
  6809. emits the \ref selectionChanged signal when \a selected is different from the previous selection state.
  6810. \see setSelectable, selectTest
  6811. */
  6812. void QCPAbstractItem::setSelected(bool selected)
  6813. {
  6814. if (mSelected != selected)
  6815. {
  6816. mSelected = selected;
  6817. emit selectionChanged(mSelected);
  6818. }
  6819. }
  6820. /*!
  6821. Returns the QCPItemPosition with the specified \a name. If this item doesn't have a position by
  6822. that name, returns 0.
  6823. This function provides an alternative way to access item positions. Normally, you access
  6824. positions direcly by their member pointers (which typically have the same variable name as \a
  6825. name).
  6826. \see positions, anchor
  6827. */
  6828. QCPItemPosition *QCPAbstractItem::position(const QString &name) const
  6829. {
  6830. for (int i=0; i<mPositions.size(); ++i)
  6831. {
  6832. if (mPositions.at(i)->name() == name)
  6833. return mPositions.at(i);
  6834. }
  6835. qDebug() << Q_FUNC_INFO << "position with name not found:" << name;
  6836. return 0;
  6837. }
  6838. /*!
  6839. Returns the QCPItemAnchor with the specified \a name. If this item doesn't have an anchor by
  6840. that name, returns 0.
  6841. This function provides an alternative way to access item anchors. Normally, you access
  6842. anchors direcly by their member pointers (which typically have the same variable name as \a
  6843. name).
  6844. \see anchors, position
  6845. */
  6846. QCPItemAnchor *QCPAbstractItem::anchor(const QString &name) const
  6847. {
  6848. for (int i=0; i<mAnchors.size(); ++i)
  6849. {
  6850. if (mAnchors.at(i)->name() == name)
  6851. return mAnchors.at(i);
  6852. }
  6853. qDebug() << Q_FUNC_INFO << "anchor with name not found:" << name;
  6854. return 0;
  6855. }
  6856. /*!
  6857. Returns whether this item has an anchor with the specified \a name.
  6858. Note that you can check for positions with this function, too. This is because every position is
  6859. also an anchor (QCPItemPosition inherits from QCPItemAnchor).
  6860. \see anchor, position
  6861. */
  6862. bool QCPAbstractItem::hasAnchor(const QString &name) const
  6863. {
  6864. for (int i=0; i<mAnchors.size(); ++i)
  6865. {
  6866. if (mAnchors.at(i)->name() == name)
  6867. return true;
  6868. }
  6869. return false;
  6870. }
  6871. /*! \internal
  6872. Returns the rect the visual representation of this item is clipped to. This depends on the
  6873. current setting of \ref setClipToAxisRect as well as the axis rect set with \ref setClipAxisRect.
  6874. If the item is not clipped to an axis rect, the \ref QCustomPlot::viewport rect is returned.
  6875. \see draw
  6876. */
  6877. QRect QCPAbstractItem::clipRect() const
  6878. {
  6879. if (mClipToAxisRect && mClipAxisRect)
  6880. return mClipAxisRect.data()->rect();
  6881. else
  6882. return mParentPlot->viewport();
  6883. }
  6884. /*! \internal
  6885. A convenience function to easily set the QPainter::Antialiased hint on the provided \a painter
  6886. before drawing item lines.
  6887. This is the antialiasing state the painter passed to the \ref draw method is in by default.
  6888. This function takes into account the local setting of the antialiasing flag as well as the
  6889. overrides set with \ref QCustomPlot::setAntialiasedElements and \ref
  6890. QCustomPlot::setNotAntialiasedElements.
  6891. \see setAntialiased
  6892. */
  6893. void QCPAbstractItem::applyDefaultAntialiasingHint(QCPPainter *painter) const
  6894. {
  6895. applyAntialiasingHint(painter, mAntialiased, QCP::aeItems);
  6896. }
  6897. /*! \internal
  6898. Finds the shortest squared distance of \a point to the line segment defined by \a start and \a
  6899. end.
  6900. This function may be used to help with the implementation of the \ref selectTest function for
  6901. specific items.
  6902. \note This function is identical to QCPAbstractPlottable::distSqrToLine
  6903. \see rectSelectTest
  6904. */
  6905. double QCPAbstractItem::distSqrToLine(const QPointF &start, const QPointF &end, const QPointF &point) const
  6906. {
  6907. QVector2D a(start);
  6908. QVector2D b(end);
  6909. QVector2D p(point);
  6910. QVector2D v(b-a);
  6911. double vLengthSqr = v.lengthSquared();
  6912. if (!qFuzzyIsNull(vLengthSqr))
  6913. {
  6914. double mu = QVector2D::dotProduct(p-a, v)/vLengthSqr;
  6915. if (mu < 0)
  6916. return (a-p).lengthSquared();
  6917. else if (mu > 1)
  6918. return (b-p).lengthSquared();
  6919. else
  6920. return ((a + mu*v)-p).lengthSquared();
  6921. } else
  6922. return (a-p).lengthSquared();
  6923. }
  6924. /*! \internal
  6925. A convenience function which returns the selectTest value for a specified \a rect and a specified
  6926. click position \a pos. \a filledRect defines whether a click inside the rect should also be
  6927. considered a hit or whether only the rect border is sensitive to hits.
  6928. This function may be used to help with the implementation of the \ref selectTest function for
  6929. specific items.
  6930. For example, if your item consists of four rects, call this function four times, once for each
  6931. rect, in your \ref selectTest reimplementation. Finally, return the minimum of all four returned
  6932. values which were greater or equal to zero. (Because this function may return -1.0 when \a pos
  6933. doesn't hit \a rect at all). If all calls returned -1.0, return -1.0, too, because your item
  6934. wasn't hit.
  6935. \see distSqrToLine
  6936. */
  6937. double QCPAbstractItem::rectSelectTest(const QRectF &rect, const QPointF &pos, bool filledRect) const
  6938. {
  6939. double result = -1;
  6940. // distance to border:
  6941. QList<QLineF> lines;
  6942. lines << QLineF(rect.topLeft(), rect.topRight()) << QLineF(rect.bottomLeft(), rect.bottomRight())
  6943. << QLineF(rect.topLeft(), rect.bottomLeft()) << QLineF(rect.topRight(), rect.bottomRight());
  6944. double minDistSqr = std::numeric_limits<double>::max();
  6945. for (int i=0; i<lines.size(); ++i)
  6946. {
  6947. double distSqr = distSqrToLine(lines.at(i).p1(), lines.at(i).p2(), pos);
  6948. if (distSqr < minDistSqr)
  6949. minDistSqr = distSqr;
  6950. }
  6951. result = qSqrt(minDistSqr);
  6952. // filled rect, allow click inside to count as hit:
  6953. if (filledRect && result > mParentPlot->selectionTolerance()*0.99)
  6954. {
  6955. if (rect.contains(pos))
  6956. result = mParentPlot->selectionTolerance()*0.99;
  6957. }
  6958. return result;
  6959. }
  6960. /*! \internal
  6961. Returns the pixel position of the anchor with Id \a anchorId. This function must be reimplemented in
  6962. item subclasses if they want to provide anchors (QCPItemAnchor).
  6963. For example, if the item has two anchors with id 0 and 1, this function takes one of these anchor
  6964. ids and returns the respective pixel points of the specified anchor.
  6965. \see createAnchor
  6966. */
  6967. QPointF QCPAbstractItem::anchorPixelPoint(int anchorId) const
  6968. {
  6969. qDebug() << Q_FUNC_INFO << "called on item which shouldn't have any anchors (this method not reimplemented). anchorId" << anchorId;
  6970. return QPointF();
  6971. }
  6972. /*! \internal
  6973. Creates a QCPItemPosition, registers it with this item and returns a pointer to it. The specified
  6974. \a name must be a unique string that is usually identical to the variable name of the position
  6975. member (This is needed to provide the name-based \ref position access to positions).
  6976. Don't delete positions created by this function manually, as the item will take care of it.
  6977. Use this function in the constructor (initialization list) of the specific item subclass to
  6978. create each position member. Don't create QCPItemPositions with \b new yourself, because they
  6979. won't be registered with the item properly.
  6980. \see createAnchor
  6981. */
  6982. QCPItemPosition *QCPAbstractItem::createPosition(const QString &name)
  6983. {
  6984. if (hasAnchor(name))
  6985. qDebug() << Q_FUNC_INFO << "anchor/position with name exists already:" << name;
  6986. QCPItemPosition *newPosition = new QCPItemPosition(mParentPlot, this, name);
  6987. mPositions.append(newPosition);
  6988. mAnchors.append(newPosition); // every position is also an anchor
  6989. newPosition->setAxes(mParentPlot->xAxis, mParentPlot->yAxis);
  6990. newPosition->setType(QCPItemPosition::ptPlotCoords);
  6991. if (mParentPlot->axisRect())
  6992. newPosition->setAxisRect(mParentPlot->axisRect());
  6993. newPosition->setCoords(0, 0);
  6994. return newPosition;
  6995. }
  6996. /*! \internal
  6997. Creates a QCPItemAnchor, registers it with this item and returns a pointer to it. The specified
  6998. \a name must be a unique string that is usually identical to the variable name of the anchor
  6999. member (This is needed to provide the name based \ref anchor access to anchors).
  7000. The \a anchorId must be a number identifying the created anchor. It is recommended to create an
  7001. enum (e.g. "AnchorIndex") for this on each item that uses anchors. This id is used by the anchor
  7002. to identify itself when it calls QCPAbstractItem::anchorPixelPoint. That function then returns
  7003. the correct pixel coordinates for the passed anchor id.
  7004. Don't delete anchors created by this function manually, as the item will take care of it.
  7005. Use this function in the constructor (initialization list) of the specific item subclass to
  7006. create each anchor member. Don't create QCPItemAnchors with \b new yourself, because then they
  7007. won't be registered with the item properly.
  7008. \see createPosition
  7009. */
  7010. QCPItemAnchor *QCPAbstractItem::createAnchor(const QString &name, int anchorId)
  7011. {
  7012. if (hasAnchor(name))
  7013. qDebug() << Q_FUNC_INFO << "anchor/position with name exists already:" << name;
  7014. QCPItemAnchor *newAnchor = new QCPItemAnchor(mParentPlot, this, name, anchorId);
  7015. mAnchors.append(newAnchor);
  7016. return newAnchor;
  7017. }
  7018. /* inherits documentation from base class */
  7019. void QCPAbstractItem::selectEvent(QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged)
  7020. {
  7021. Q_UNUSED(event)
  7022. Q_UNUSED(details)
  7023. if (mSelectable)
  7024. {
  7025. bool selBefore = mSelected;
  7026. setSelected(additive ? !mSelected : true);
  7027. if (selectionStateChanged)
  7028. *selectionStateChanged = mSelected != selBefore;
  7029. }
  7030. }
  7031. /* inherits documentation from base class */
  7032. void QCPAbstractItem::deselectEvent(bool *selectionStateChanged)
  7033. {
  7034. if (mSelectable)
  7035. {
  7036. bool selBefore = mSelected;
  7037. setSelected(false);
  7038. if (selectionStateChanged)
  7039. *selectionStateChanged = mSelected != selBefore;
  7040. }
  7041. }
  7042. /* inherits documentation from base class */
  7043. QCP::Interaction QCPAbstractItem::selectionCategory() const
  7044. {
  7045. return QCP::iSelectItems;
  7046. }
  7047. /*! \file */
  7048. /*! \mainpage %QCustomPlot 1.1.0 Documentation
  7049. \image html qcp-doc-logo.png
  7050. Below is a brief overview of and guide to the classes and their relations. If you are new to
  7051. QCustomPlot and just want to start using it, it's recommended to look at the tutorials and
  7052. examples at
  7053. http://www.qcustomplot.com/
  7054. This documentation is especially helpful as a reference, when you're familiar with the basic
  7055. concept of how to use %QCustomPlot and you wish to learn more about specific functionality.
  7056. See the \ref classoverview "class overview" for diagrams explaining the relationships between
  7057. the most important classes of the QCustomPlot library.
  7058. The central widget which displays the plottables and axes on its surface is QCustomPlot. Every
  7059. QCustomPlot contains four axes by default. They can be accessed via the members xAxis, yAxis,
  7060. xAxis2 and yAxis2, and are of type QCPAxis. QCustomPlot supports an arbitrary number of axes and
  7061. axis rects, see the documentation of QCPAxisRect for details.
  7062. \section mainpage-plottables Plottables
  7063. \a Plottables are classes that display any kind of data inside the QCustomPlot. They all derive
  7064. from QCPAbstractPlottable. For example, the QCPGraph class is a plottable that displays a graph
  7065. inside the plot with different line styles, scatter styles, filling etc.
  7066. Since plotting graphs is such a dominant use case, QCustomPlot has a special interface for working
  7067. with QCPGraph plottables, that makes it very easy to handle them:\n
  7068. You create a new graph with QCustomPlot::addGraph and access them with QCustomPlot::graph.
  7069. For all other plottables, you need to use the normal plottable interface:\n
  7070. First, you create an instance of the plottable you want, e.g.
  7071. \code
  7072. QCPCurve *newCurve = new QCPCurve(customPlot->xAxis, customPlot->yAxis);\endcode
  7073. add it to the customPlot:
  7074. \code
  7075. customPlot->addPlottable(newCurve);\endcode
  7076. and then modify the properties of the newly created plottable via the <tt>newCurve</tt> pointer.
  7077. Plottables (including graphs) can be retrieved via QCustomPlot::plottable. Since the return type
  7078. of that function is the abstract base class of all plottables, QCPAbstractPlottable, you will
  7079. probably want to qobject_cast the returned pointer to the respective plottable subclass. (As
  7080. usual, if the cast returns zero, the plottable wasn't of that specific subclass.)
  7081. All further interfacing with plottables (e.g how to set data) is specific to the plottable type.
  7082. See the documentations of the subclasses: QCPGraph, QCPCurve, QCPBars, QCPStatisticalBox.
  7083. \section mainpage-axes Controlling the Axes
  7084. As mentioned, QCustomPlot has four axes by default: \a xAxis (bottom), \a yAxis (left), \a xAxis2
  7085. (top), \a yAxis2 (right).
  7086. Their range is handled by the simple QCPRange class. You can set the range with the
  7087. QCPAxis::setRange function. By default, the axes represent a linear scale. To set a logarithmic
  7088. scale, set \ref QCPAxis::setScaleType to \ref QCPAxis::stLogarithmic. The logarithm base can be set freely
  7089. with \ref QCPAxis::setScaleLogBase.
  7090. By default, an axis automatically creates and labels ticks in a sensible manner. See the
  7091. following functions for tick manipulation:\n QCPAxis::setTicks, QCPAxis::setAutoTicks,
  7092. QCPAxis::setAutoTickCount, QCPAxis::setAutoTickStep, QCPAxis::setTickLabels,
  7093. QCPAxis::setTickLabelType, QCPAxis::setTickLabelRotation, QCPAxis::setTickStep,
  7094. QCPAxis::setTickLength,...
  7095. Each axis can be given an axis label (e.g. "Voltage (mV)") with QCPAxis::setLabel.
  7096. The distance of an axis backbone to the respective viewport border is called its margin.
  7097. Normally, the margins are calculated automatically. To change this, set
  7098. \ref QCPAxisRect::setAutoMargins to exclude the respective margin sides, set the margins manually with
  7099. \ref QCPAxisRect::setMargins. The main axis rect can be reached with \ref QCustomPlot::axisRect().
  7100. \section mainpage-legend Plot Legend
  7101. Every QCustomPlot owns one QCPLegend (as \a legend) by default. A legend is a small layout
  7102. element inside the plot which lists the plottables with an icon of the plottable line/symbol and
  7103. a description. The Description is retrieved from the plottable name
  7104. (QCPAbstractPlottable::setName). Plottables can be added and removed from the legend via \ref
  7105. QCPAbstractPlottable::addToLegend and \ref QCPAbstractPlottable::removeFromLegend. By default,
  7106. adding a plottable to QCustomPlot automatically adds it to the legend, too. This behaviour can be
  7107. modified with the QCustomPlot::setAutoAddPlottableToLegend property.
  7108. The QCPLegend provides an interface to access, add and remove legend items directly, too. See
  7109. QCPLegend::item, QCPLegend::itemWithPlottable, QCPLegend::addItem, QCPLegend::removeItem for
  7110. example.
  7111. Multiple legends are supported via the layout system (as a QCPLegend simply is a normal layout
  7112. element).
  7113. \section mainpage-userinteraction User Interactions
  7114. QCustomPlot supports dragging axis ranges with the mouse (\ref
  7115. QCPAxisRect::setRangeDrag), zooming axis ranges with the mouse wheel (\ref
  7116. QCPAxisRect::setRangeZoom) and a complete selection mechanism.
  7117. The availability of these interactions is controlled with \ref QCustomPlot::setInteractions. For
  7118. details about the interaction system, see the documentation there.
  7119. Further, QCustomPlot always emits corresponding signals, when objects are clicked or
  7120. doubleClicked. See \ref QCustomPlot::plottableClick, \ref QCustomPlot::plottableDoubleClick
  7121. and \ref QCustomPlot::axisClick for example.
  7122. \section mainpage-items Items
  7123. Apart from plottables there is another category of plot objects that are important: Items. The
  7124. base class of all items is QCPAbstractItem. An item sets itself apart from plottables in that
  7125. it's not necessarily bound to any axes. This means it may also be positioned in absolute pixel
  7126. coordinates or placed at a relative position on an axis rect. Further, it usually doesn't
  7127. represent data directly, but acts as decoration, emphasis, description etc.
  7128. Multiple items can be arranged in a parent-child-hierarchy allowing for dynamical behaviour. For
  7129. example, you could place the head of an arrow at a fixed plot coordinate, so it always points to
  7130. some important area in the plot. The tail of the arrow can be anchored to a text item which
  7131. always resides in the top center of the axis rect, independent of where the user drags the axis
  7132. ranges. This way the arrow stretches and turns so it always points from the label to the
  7133. specified plot coordinate, without any further code necessary.
  7134. For a more detailed introduction, see the QCPAbstractItem documentation, and from there the
  7135. documentations of the individual built-in items, to find out how to use them.
  7136. \section mainpage-layoutelements Layout elements and layouts
  7137. QCustomPlot uses an internal layout system to provide dynamic sizing and positioning of objects like
  7138. the axis rect(s), legends and the plot title. They are all based on \ref QCPLayoutElement and are arranged by
  7139. placing them inside a \ref QCPLayout.
  7140. Details on this topic are given on the dedicated page about \ref thelayoutsystem "the layout system".
  7141. \section mainpage-performancetweaks Performance Tweaks
  7142. Although QCustomPlot is quite fast, some features like translucent fills, antialiasing and thick
  7143. lines can cause a significant slow down. If you notice this in your application, here are some
  7144. thoughts on how to increase performance. By far the most time is spent in the drawing functions,
  7145. specifically the drawing of graphs. For maximum performance, consider the following (most
  7146. recommended/effective measures first):
  7147. \li use Qt 4.8.0 and up. Performance has doubled or tripled with respect to Qt 4.7.4. However
  7148. QPainter was broken and drawing pixel precise things, e.g. scatters, isn't possible with Qt >=
  7149. 4.8.0. So it's a performance vs. plot quality tradeoff when switching to Qt 4.8.
  7150. \li To increase responsiveness during dragging, consider setting \ref QCustomPlot::setNoAntialiasingOnDrag to true.
  7151. \li On X11 (GNU/Linux), avoid the slow native drawing system, use raster by supplying
  7152. "-graphicssystem raster" as command line argument or calling QApplication::setGraphicsSystem("raster")
  7153. before creating the QApplication object. (Only available for Qt versions before 5.0)
  7154. \li On all operating systems, use OpenGL hardware acceleration by supplying "-graphicssystem
  7155. opengl" as command line argument or calling QApplication::setGraphicsSystem("opengl") (Only
  7156. available for Qt versions before 5.0). If OpenGL is available, this will slightly decrease the
  7157. quality of antialiasing, but extremely increase performance especially with alpha
  7158. (semi-transparent) fills, much antialiasing and a large QCustomPlot drawing surface. Note
  7159. however, that the maximum frame rate might be constrained by the vertical sync frequency of your
  7160. monitor (VSync can be disabled in the graphics card driver configuration). So for simple plots
  7161. (where the potential framerate is far above 60 frames per second), OpenGL acceleration might
  7162. achieve numerically lower frame rates than the other graphics systems, because they are not
  7163. capped at the VSync frequency.
  7164. \li Avoid any kind of alpha (transparency), especially in fills
  7165. \li Avoid lines with a pen width greater than one
  7166. \li Avoid any kind of antialiasing, especially in graph lines (see \ref QCustomPlot::setNotAntialiasedElements)
  7167. \li Avoid repeatedly setting the complete data set with \ref QCPGraph::setData. Use \ref QCPGraph::addData instead, if most
  7168. data points stay unchanged, e.g. in a running measurement.
  7169. \li Set the \a copy parameter of the setData functions to false, so only pointers get
  7170. transferred. (Relevant only if preparing data maps with a large number of points, i.e. over 10000)
  7171. \section mainpage-flags Preprocessor Define Flags
  7172. QCustomPlot understands some preprocessor defines that are useful for debugging and compilation:
  7173. <dl>
  7174. <dt>\c QCUSTOMPLOT_COMPILE_LIBRARY
  7175. <dd>Define this flag when you compile QCustomPlot as a shared library (.so/.dll)
  7176. <dt>\c QCUSTOMPLOT_USE_LIBRARY
  7177. <dd>Define this flag before including the header, when using QCustomPlot as a shared library
  7178. <dt>\c QCUSTOMPLOT_CHECK_DATA
  7179. <dd>If this flag is defined, the QCustomPlot plottables will perform data validity checks on every redraw.
  7180. This means they will give qDebug output when you plot \e inf or \e nan values, they will not
  7181. fix your data.
  7182. </dl>
  7183. */
  7184. /*! \page classoverview Class Overview
  7185. The following diagrams may help to gain a deeper understanding of the relationships between classes that make up
  7186. the QCustomPlot library. The diagrams are not exhaustive, so only the classes deemed most relevant are shown.
  7187. \section classoverview-relations Class Relationship Diagram
  7188. \image html RelationOverview.png "Overview of most important classes and their relations"
  7189. \section classoverview-inheritance Class Inheritance Tree
  7190. \image html InheritanceOverview.png "Inheritance tree of most important classes"
  7191. */
  7192. ////////////////////////////////////////////////////////////////////////////////////////////////////
  7193. //////////////////// QCustomPlot
  7194. ////////////////////////////////////////////////////////////////////////////////////////////////////
  7195. /*! \class QCustomPlot
  7196. \brief The central class of the library. This is the QWidget which displays the plot and
  7197. interacts with the user.
  7198. For tutorials on how to use QCustomPlot, see the website\n
  7199. http://www.qcustomplot.com/
  7200. */
  7201. /* start of documentation of inline functions */
  7202. /*! \fn QRect QCustomPlot::viewport() const
  7203. Returns the viewport rect of this QCustomPlot instance. The viewport is the area the plot is
  7204. drawn in, all mechanisms, e.g. margin caluclation take the viewport to be the outer border of the
  7205. plot. The viewport normally is the rect() of the QCustomPlot widget, i.e. a rect with top left
  7206. (0, 0) and size of the QCustomPlot widget.
  7207. Don't confuse the viewport with the axis rect (QCustomPlot::axisRect). An axis rect is typically
  7208. an area enclosed by four axes, where the graphs/plottables are drawn in. The viewport is larger
  7209. and contains also the axes themselves, their tick numbers, their labels, the plot title etc.
  7210. Only when saving to a file (see \ref savePng, savePdf etc.) the viewport is temporarily modified
  7211. to allow saving plots with sizes independent of the current widget size.
  7212. */
  7213. /*! \fn QCPLayoutGrid *QCustomPlot::plotLayout() const
  7214. Returns the top level layout of this QCustomPlot instance. It is a \ref QCPLayoutGrid, initially containing just
  7215. one cell with the main QCPAxisRect inside.
  7216. */
  7217. /* end of documentation of inline functions */
  7218. /* start of documentation of signals */
  7219. /*! \fn void QCustomPlot::mouseDoubleClick(QMouseEvent *event)
  7220. This signal is emitted when the QCustomPlot receives a mouse double click event.
  7221. */
  7222. /*! \fn void QCustomPlot::mousePress(QMouseEvent *event)
  7223. This signal is emitted when the QCustomPlot receives a mouse press event.
  7224. It is emitted before QCustomPlot handles any other mechanism like range dragging. So a slot
  7225. connected to this signal can still influence the behaviour e.g. with \ref QCPAxisRect::setRangeDrag or \ref
  7226. QCPAxisRect::setRangeDragAxes.
  7227. */
  7228. /*! \fn void QCustomPlot::mouseMove(QMouseEvent *event)
  7229. This signal is emitted when the QCustomPlot receives a mouse move event.
  7230. It is emitted before QCustomPlot handles any other mechanism like range dragging. So a slot
  7231. connected to this signal can still influence the behaviour e.g. with \ref QCPAxisRect::setRangeDrag or \ref
  7232. QCPAxisRect::setRangeDragAxes.
  7233. \warning It is discouraged to change the drag-axes with \ref QCPAxisRect::setRangeDragAxes here,
  7234. because the dragging starting point was saved the moment the mouse was pressed. Thus it only has
  7235. a meaning for the range drag axes that were set at that moment. If you want to change the drag
  7236. axes, consider doing this in the \ref mousePress signal instead.
  7237. */
  7238. /*! \fn void QCustomPlot::mouseRelease(QMouseEvent *event)
  7239. This signal is emitted when the QCustomPlot receives a mouse release event.
  7240. It is emitted before QCustomPlot handles any other mechanisms like object selection. So a
  7241. slot connected to this signal can still influence the behaviour e.g. with \ref setInteractions or
  7242. \ref QCPAbstractPlottable::setSelectable.
  7243. */
  7244. /*! \fn void QCustomPlot::mouseWheel(QMouseEvent *event)
  7245. This signal is emitted when the QCustomPlot receives a mouse wheel event.
  7246. It is emitted before QCustomPlot handles any other mechanisms like range zooming. So a slot
  7247. connected to this signal can still influence the behaviour e.g. with \ref QCPAxisRect::setRangeZoom, \ref
  7248. QCPAxisRect::setRangeZoomAxes or \ref QCPAxisRect::setRangeZoomFactor.
  7249. */
  7250. /*! \fn void QCustomPlot::plottableClick(QCPAbstractPlottable *plottable, QMouseEvent *event)
  7251. This signal is emitted when a plottable is clicked.
  7252. \a event is the mouse event that caused the click and \a plottable is the plottable that received
  7253. the click.
  7254. \see plottableDoubleClick
  7255. */
  7256. /*! \fn void QCustomPlot::plottableDoubleClick(QCPAbstractPlottable *plottable, QMouseEvent *event)
  7257. This signal is emitted when a plottable is double clicked.
  7258. \a event is the mouse event that caused the click and \a plottable is the plottable that received
  7259. the click.
  7260. \see plottableClick
  7261. */
  7262. /*! \fn void QCustomPlot::itemClick(QCPAbstractItem *item, QMouseEvent *event)
  7263. This signal is emitted when an item is clicked.
  7264. \a event is the mouse event that caused the click and \a item is the item that received the
  7265. click.
  7266. \see itemDoubleClick
  7267. */
  7268. /*! \fn void QCustomPlot::itemDoubleClick(QCPAbstractItem *item, QMouseEvent *event)
  7269. This signal is emitted when an item is double clicked.
  7270. \a event is the mouse event that caused the click and \a item is the item that received the
  7271. click.
  7272. \see itemClick
  7273. */
  7274. /*! \fn void QCustomPlot::axisClick(QCPAxis *axis, QCPAxis::SelectablePart part, QMouseEvent *event)
  7275. This signal is emitted when an axis is clicked.
  7276. \a event is the mouse event that caused the click, \a axis is the axis that received the click and
  7277. \a part indicates the part of the axis that was clicked.
  7278. \see axisDoubleClick
  7279. */
  7280. /*! \fn void QCustomPlot::axisDoubleClick(QCPAxis *axis, QCPAxis::SelectablePart part, QMouseEvent *event)
  7281. This signal is emitted when an axis is double clicked.
  7282. \a event is the mouse event that caused the click, \a axis is the axis that received the click and
  7283. \a part indicates the part of the axis that was clicked.
  7284. \see axisClick
  7285. */
  7286. /*! \fn void QCustomPlot::legendClick(QCPLegend *legend, QCPAbstractLegendItem *item, QMouseEvent *event)
  7287. This signal is emitted when a legend (item) is clicked.
  7288. \a event is the mouse event that caused the click, \a legend is the legend that received the
  7289. click and \a item is the legend item that received the click. If only the legend and no item is
  7290. clicked, \a item is 0. This happens for a click inside the legend padding or the space between
  7291. two items.
  7292. \see legendDoubleClick
  7293. */
  7294. /*! \fn void QCustomPlot::legendDoubleClick(QCPLegend *legend, QCPAbstractLegendItem *item, QMouseEvent *event)
  7295. This signal is emitted when a legend (item) is double clicked.
  7296. \a event is the mouse event that caused the click, \a legend is the legend that received the
  7297. click and \a item is the legend item that received the click. If only the legend and no item is
  7298. clicked, \a item is 0. This happens for a click inside the legend padding or the space between
  7299. two items.
  7300. \see legendClick
  7301. */
  7302. /*! \fn void QCustomPlot:: titleClick(QMouseEvent *event, QCPPlotTitle *title)
  7303. This signal is emitted when a plot title is clicked.
  7304. \a event is the mouse event that caused the click and \a title is the plot title that received
  7305. the click.
  7306. \see titleDoubleClick
  7307. */
  7308. /*! \fn void QCustomPlot::titleDoubleClick(QMouseEvent *event, QCPPlotTitle *title)
  7309. This signal is emitted when a plot title is double clicked.
  7310. \a event is the mouse event that caused the click and \a title is the plot title that received
  7311. the click.
  7312. \see titleClick
  7313. */
  7314. /*! \fn void QCustomPlot::selectionChangedByUser()
  7315. This signal is emitted after the user has changed the selection in the QCustomPlot, e.g. by
  7316. clicking. It is not emitted when the selection state of an object has changed programmatically by
  7317. a direct call to setSelected() on an object or by calling \ref deselectAll.
  7318. In addition to this signal, selectable objects also provide individual signals, for example
  7319. QCPAxis::selectionChanged or QCPAbstractPlottable::selectionChanged. Note that those signals are
  7320. emitted even if the selection state is changed programmatically.
  7321. See the documentation of \ref setInteractions for details about the selection mechanism.
  7322. \see selectedPlottables, selectedGraphs, selectedItems, selectedAxes, selectedLegends
  7323. */
  7324. /*! \fn void QCustomPlot::beforeReplot()
  7325. This signal is emitted immediately before a replot takes place (caused by a call to the slot \ref
  7326. replot).
  7327. It is safe to mutually connect the replot slot with this signal on two QCustomPlots to make them
  7328. replot synchronously, it won't cause an infinite recursion.
  7329. \see replot, afterReplot
  7330. */
  7331. /*! \fn void QCustomPlot::afterReplot()
  7332. This signal is emitted immediately after a replot has taken place (caused by a call to the slot \ref
  7333. replot).
  7334. It is safe to mutually connect the replot slot with this signal on two QCustomPlots to make them
  7335. replot synchronously, it won't cause an infinite recursion.
  7336. \see replot, beforeReplot
  7337. */
  7338. /* end of documentation of signals */
  7339. /*!
  7340. Constructs a QCustomPlot and sets reasonable default values.
  7341. */
  7342. QCustomPlot::QCustomPlot(QWidget *parent) :
  7343. QWidget(parent),
  7344. xAxis(0),
  7345. yAxis(0),
  7346. xAxis2(0),
  7347. yAxis2(0),
  7348. legend(0),
  7349. mPlotLayout(0),
  7350. mAutoAddPlottableToLegend(true),
  7351. mAntialiasedElements(QCP::aeNone),
  7352. mNotAntialiasedElements(QCP::aeNone),
  7353. mInteractions(0),
  7354. mSelectionTolerance(8),
  7355. mNoAntialiasingOnDrag(false),
  7356. mBackgroundBrush(Qt::white, Qt::SolidPattern),
  7357. mBackgroundScaled(true),
  7358. mBackgroundScaledMode(Qt::KeepAspectRatioByExpanding),
  7359. mCurrentLayer(0),
  7360. mPlottingHints(QCP::phCacheLabels),
  7361. mMultiSelectModifier(Qt::ControlModifier),
  7362. mPaintBuffer(size()),
  7363. mMouseEventElement(0),
  7364. mReplotting(false)
  7365. {
  7366. setAttribute(Qt::WA_NoMousePropagation);
  7367. setAttribute(Qt::WA_OpaquePaintEvent);
  7368. setMouseTracking(true);
  7369. QLocale currentLocale = locale();
  7370. currentLocale.setNumberOptions(QLocale::OmitGroupSeparator);
  7371. setLocale(currentLocale);
  7372. // create initial layers:
  7373. mLayers.append(new QCPLayer(this, "background"));
  7374. mLayers.append(new QCPLayer(this, "grid"));
  7375. mLayers.append(new QCPLayer(this, "main"));
  7376. mLayers.append(new QCPLayer(this, "axes"));
  7377. mLayers.append(new QCPLayer(this, "legend"));
  7378. updateLayerIndices();
  7379. setCurrentLayer("main");
  7380. // create initial layout, axis rect and legend:
  7381. mPlotLayout = new QCPLayoutGrid;
  7382. mPlotLayout->initializeParentPlot(this);
  7383. mPlotLayout->setParent(this); // important because if parent is QWidget, QCPLayout::sizeConstraintsChanged will call QWidget::updateGeometry
  7384. QCPAxisRect *defaultAxisRect = new QCPAxisRect(this, true);
  7385. mPlotLayout->addElement(0, 0, defaultAxisRect);
  7386. xAxis = defaultAxisRect->axis(QCPAxis::atBottom);
  7387. yAxis = defaultAxisRect->axis(QCPAxis::atLeft);
  7388. xAxis2 = defaultAxisRect->axis(QCPAxis::atTop);
  7389. yAxis2 = defaultAxisRect->axis(QCPAxis::atRight);
  7390. legend = new QCPLegend;
  7391. legend->setVisible(false);
  7392. defaultAxisRect->insetLayout()->addElement(legend, Qt::AlignRight|Qt::AlignTop);
  7393. defaultAxisRect->insetLayout()->setMargins(QMargins(12, 12, 12, 12));
  7394. defaultAxisRect->setLayer("background");
  7395. xAxis->setLayer("axes");
  7396. yAxis->setLayer("axes");
  7397. xAxis2->setLayer("axes");
  7398. yAxis2->setLayer("axes");
  7399. xAxis->grid()->setLayer("grid");
  7400. yAxis->grid()->setLayer("grid");
  7401. xAxis2->grid()->setLayer("grid");
  7402. yAxis2->grid()->setLayer("grid");
  7403. legend->setLayer("legend");
  7404. setViewport(rect()); // needs to be called after mPlotLayout has been created
  7405. #ifdef Q_OS_WIN
  7406. setPlottingHint(QCP::phForceRepaint);
  7407. #endif
  7408. replot();
  7409. }
  7410. QCustomPlot::~QCustomPlot()
  7411. {
  7412. clearPlottables();
  7413. clearItems();
  7414. if (mPlotLayout)
  7415. {
  7416. delete mPlotLayout;
  7417. mPlotLayout = 0;
  7418. }
  7419. mCurrentLayer = 0;
  7420. qDeleteAll(mLayers); // don't use removeLayer, because it would prevent the last layer to be removed
  7421. mLayers.clear();
  7422. }
  7423. /*!
  7424. Sets which elements are forcibly drawn antialiased as an \a or combination of QCP::AntialiasedElement.
  7425. This overrides the antialiasing settings for whole element groups, normally controlled with the
  7426. \a setAntialiasing function on the individual elements. If an element is neither specified in
  7427. \ref setAntialiasedElements nor in \ref setNotAntialiasedElements, the antialiasing setting on
  7428. each individual element instance is used.
  7429. For example, if \a antialiasedElements contains \ref QCP::aePlottables, all plottables will be
  7430. drawn antialiased, no matter what the specific QCPAbstractPlottable::setAntialiased value was set
  7431. to.
  7432. if an element in \a antialiasedElements is already set in \ref setNotAntialiasedElements, it is
  7433. removed from there.
  7434. \see setNotAntialiasedElements
  7435. */
  7436. void QCustomPlot::setAntialiasedElements(const QCP::AntialiasedElements &antialiasedElements)
  7437. {
  7438. mAntialiasedElements = antialiasedElements;
  7439. // make sure elements aren't in mNotAntialiasedElements and mAntialiasedElements simultaneously:
  7440. if ((mNotAntialiasedElements & mAntialiasedElements) != 0)
  7441. mNotAntialiasedElements |= ~mAntialiasedElements;
  7442. }
  7443. /*!
  7444. Sets whether the specified \a antialiasedElement is forcibly drawn antialiased.
  7445. See \ref setAntialiasedElements for details.
  7446. \see setNotAntialiasedElement
  7447. */
  7448. void QCustomPlot::setAntialiasedElement(QCP::AntialiasedElement antialiasedElement, bool enabled)
  7449. {
  7450. if (!enabled && mAntialiasedElements.testFlag(antialiasedElement))
  7451. mAntialiasedElements &= ~antialiasedElement;
  7452. else if (enabled && !mAntialiasedElements.testFlag(antialiasedElement))
  7453. mAntialiasedElements |= antialiasedElement;
  7454. // make sure elements aren't in mNotAntialiasedElements and mAntialiasedElements simultaneously:
  7455. if ((mNotAntialiasedElements & mAntialiasedElements) != 0)
  7456. mNotAntialiasedElements |= ~mAntialiasedElements;
  7457. }
  7458. /*!
  7459. Sets which elements are forcibly drawn not antialiased as an \a or combination of
  7460. QCP::AntialiasedElement.
  7461. This overrides the antialiasing settings for whole element groups, normally controlled with the
  7462. \a setAntialiasing function on the individual elements. If an element is neither specified in
  7463. \ref setAntialiasedElements nor in \ref setNotAntialiasedElements, the antialiasing setting on
  7464. each individual element instance is used.
  7465. For example, if \a notAntialiasedElements contains \ref QCP::aePlottables, no plottables will be
  7466. drawn antialiased, no matter what the specific QCPAbstractPlottable::setAntialiased value was set
  7467. to.
  7468. if an element in \a notAntialiasedElements is already set in \ref setAntialiasedElements, it is
  7469. removed from there.
  7470. \see setAntialiasedElements
  7471. */
  7472. void QCustomPlot::setNotAntialiasedElements(const QCP::AntialiasedElements &notAntialiasedElements)
  7473. {
  7474. mNotAntialiasedElements = notAntialiasedElements;
  7475. // make sure elements aren't in mNotAntialiasedElements and mAntialiasedElements simultaneously:
  7476. if ((mNotAntialiasedElements & mAntialiasedElements) != 0)
  7477. mAntialiasedElements |= ~mNotAntialiasedElements;
  7478. }
  7479. /*!
  7480. Sets whether the specified \a notAntialiasedElement is forcibly drawn not antialiased.
  7481. See \ref setNotAntialiasedElements for details.
  7482. \see setAntialiasedElement
  7483. */
  7484. void QCustomPlot::setNotAntialiasedElement(QCP::AntialiasedElement notAntialiasedElement, bool enabled)
  7485. {
  7486. if (!enabled && mNotAntialiasedElements.testFlag(notAntialiasedElement))
  7487. mNotAntialiasedElements &= ~notAntialiasedElement;
  7488. else if (enabled && !mNotAntialiasedElements.testFlag(notAntialiasedElement))
  7489. mNotAntialiasedElements |= notAntialiasedElement;
  7490. // make sure elements aren't in mNotAntialiasedElements and mAntialiasedElements simultaneously:
  7491. if ((mNotAntialiasedElements & mAntialiasedElements) != 0)
  7492. mAntialiasedElements |= ~mNotAntialiasedElements;
  7493. }
  7494. /*!
  7495. If set to true, adding a plottable (e.g. a graph) to the QCustomPlot automatically also adds the
  7496. plottable to the legend (QCustomPlot::legend).
  7497. \see addPlottable, addGraph, QCPLegend::addItem
  7498. */
  7499. void QCustomPlot::setAutoAddPlottableToLegend(bool on)
  7500. {
  7501. mAutoAddPlottableToLegend = on;
  7502. }
  7503. /*!
  7504. Sets the possible interactions of this QCustomPlot as an or-combination of \ref QCP::Interaction
  7505. enums. There are the following types of interactions:
  7506. <b>Axis range manipulation</b> is controlled via \ref QCP::iRangeDrag and \ref QCP::iRangeZoom. When the
  7507. respective interaction is enabled, the user may drag axes ranges and zoom with the mouse wheel.
  7508. For details how to control which axes the user may drag/zoom and in what orientations, see \ref
  7509. QCPAxisRect::setRangeDrag, \ref QCPAxisRect::setRangeZoom, \ref QCPAxisRect::setRangeDragAxes,
  7510. \ref QCPAxisRect::setRangeZoomAxes.
  7511. <b>Plottable selection</b> is controlled by \ref QCP::iSelectPlottables. If \ref QCP::iSelectPlottables is
  7512. set, the user may select plottables (graphs, curves, bars,...) by clicking on them or in their
  7513. vicinity (\ref setSelectionTolerance). Whether the user can actually select a plottable can
  7514. further be restricted with the \ref QCPAbstractPlottable::setSelectable function on the specific
  7515. plottable. To find out whether a specific plottable is selected, call
  7516. QCPAbstractPlottable::selected(). To retrieve a list of all currently selected plottables, call
  7517. \ref selectedPlottables. If you're only interested in QCPGraphs, you may use the convenience
  7518. function \ref selectedGraphs.
  7519. <b>Item selection</b> is controlled by \ref QCP::iSelectItems. If \ref QCP::iSelectItems is set, the user
  7520. may select items (QCPItemLine, QCPItemText,...) by clicking on them or in their vicinity. To find
  7521. out whether a specific item is selected, call QCPAbstractItem::selected(). To retrieve a list of
  7522. all currently selected items, call \ref selectedItems.
  7523. <b>Axis selection</b> is controlled with \ref QCP::iSelectAxes. If \ref QCP::iSelectAxes is set, the user
  7524. may select parts of the axes by clicking on them. What parts exactly (e.g. Axis base line, tick
  7525. labels, axis label) are selectable can be controlled via \ref QCPAxis::setSelectableParts for
  7526. each axis. To retrieve a list of all axes that currently contain selected parts, call \ref
  7527. selectedAxes. Which parts of an axis are selected, can be retrieved with QCPAxis::selectedParts().
  7528. <b>Legend selection</b> is controlled with \ref QCP::iSelectLegend. If this is set, the user may
  7529. select the legend itself or individual items by clicking on them. What parts exactly are
  7530. selectable can be controlled via \ref QCPLegend::setSelectableParts. To find out whether the
  7531. legend or any of its child items are selected, check the value of QCPLegend::selectedParts. To
  7532. find out which child items are selected, call \ref QCPLegend::selectedItems.
  7533. <b>All other selectable elements</b> The selection of all other selectable objects (e.g.
  7534. QCPPlotTitle, or your own layerable subclasses) is controlled with \ref QCP::iSelectOther. If set, the
  7535. user may select those objects by clicking on them. To find out which are currently selected, you
  7536. need to check their selected state explicitly.
  7537. If the selection state has changed by user interaction, the \ref selectionChangedByUser signal is
  7538. emitted. Each selectable object additionally emits an individual selectionChanged signal whenever
  7539. their selection state has changed, i.e. not only by user interaction.
  7540. To allow multiple objects to be selected by holding the selection modifier (\ref
  7541. setMultiSelectModifier), set the flag \ref QCP::iMultiSelect.
  7542. \note In addition to the selection mechanism presented here, QCustomPlot always emits
  7543. corresponding signals, when an object is clicked or double clicked. see \ref plottableClick and
  7544. \ref plottableDoubleClick for example.
  7545. \see setInteraction, setSelectionTolerance
  7546. */
  7547. void QCustomPlot::setInteractions(const QCP::Interactions &interactions)
  7548. {
  7549. mInteractions = interactions;
  7550. }
  7551. /*!
  7552. Sets the single \a interaction of this QCustomPlot to \a enabled.
  7553. For details about the interaction system, see \ref setInteractions.
  7554. \see setInteractions
  7555. */
  7556. void QCustomPlot::setInteraction(const QCP::Interaction &interaction, bool enabled)
  7557. {
  7558. if (!enabled && mInteractions.testFlag(interaction))
  7559. mInteractions &= ~interaction;
  7560. else if (enabled && !mInteractions.testFlag(interaction))
  7561. mInteractions |= interaction;
  7562. }
  7563. /*!
  7564. Sets the tolerance that is used to decide whether a click selects an object (e.g. a plottable) or
  7565. not.
  7566. If the user clicks in the vicinity of the line of e.g. a QCPGraph, it's only regarded as a
  7567. potential selection when the minimum distance between the click position and the graph line is
  7568. smaller than \a pixels. Objects that are defined by an area (e.g. QCPBars) only react to clicks
  7569. directly inside the area and ignore this selection tolerance. In other words, it only has meaning
  7570. for parts of objects that are too thin to exactly hit with a click and thus need such a
  7571. tolerance.
  7572. \see setInteractions, QCPLayerable::selectTest
  7573. */
  7574. void QCustomPlot::setSelectionTolerance(int pixels)
  7575. {
  7576. mSelectionTolerance = pixels;
  7577. }
  7578. /*!
  7579. Sets whether antialiasing is disabled for this QCustomPlot while the user is dragging axes
  7580. ranges. If many objects, especially plottables, are drawn antialiased, this greatly improves
  7581. performance during dragging. Thus it creates a more responsive user experience. As soon as the
  7582. user stops dragging, the last replot is done with normal antialiasing, to restore high image
  7583. quality.
  7584. \see setAntialiasedElements, setNotAntialiasedElements
  7585. */
  7586. void QCustomPlot::setNoAntialiasingOnDrag(bool enabled)
  7587. {
  7588. mNoAntialiasingOnDrag = enabled;
  7589. }
  7590. /*!
  7591. Sets the plotting hints for this QCustomPlot instance as an \a or combination of QCP::PlottingHint.
  7592. \see setPlottingHint
  7593. */
  7594. void QCustomPlot::setPlottingHints(const QCP::PlottingHints &hints)
  7595. {
  7596. mPlottingHints = hints;
  7597. }
  7598. /*!
  7599. Sets the specified plotting \a hint to \a enabled.
  7600. \see setPlottingHints
  7601. */
  7602. void QCustomPlot::setPlottingHint(QCP::PlottingHint hint, bool enabled)
  7603. {
  7604. QCP::PlottingHints newHints = mPlottingHints;
  7605. if (!enabled)
  7606. newHints &= ~hint;
  7607. else
  7608. newHints |= hint;
  7609. if (newHints != mPlottingHints)
  7610. setPlottingHints(newHints);
  7611. }
  7612. /*!
  7613. Sets the keyboard modifier that will be recognized as multi-select-modifier.
  7614. If \ref QCP::iMultiSelect is specified in \ref setInteractions, the user may select multiple objects
  7615. by clicking on them one after the other while holding down \a modifier.
  7616. By default the multi-select-modifier is set to Qt::ControlModifier.
  7617. \see setInteractions
  7618. */
  7619. void QCustomPlot::setMultiSelectModifier(Qt::KeyboardModifier modifier)
  7620. {
  7621. mMultiSelectModifier = modifier;
  7622. }
  7623. /*!
  7624. Sets the viewport of this QCustomPlot. The Viewport is the area that the top level layout
  7625. (QCustomPlot::plotLayout()) uses as its rect. Normally, the viewport is the entire widget rect.
  7626. This function is used to allow arbitrary size exports with \ref toPixmap, \ref savePng, \ref
  7627. savePdf, etc. by temporarily changing the viewport size.
  7628. */
  7629. void QCustomPlot::setViewport(const QRect &rect)
  7630. {
  7631. mViewport = rect;
  7632. if (mPlotLayout)
  7633. mPlotLayout->setOuterRect(mViewport);
  7634. }
  7635. /*!
  7636. Sets \a pm as the viewport background pixmap (see \ref setViewport). The pixmap is always drawn
  7637. below all other objects in the plot.
  7638. For cases where the provided pixmap doesn't have the same size as the viewport, scaling can be
  7639. enabled with \ref setBackgroundScaled and the scaling mode (whether and how the aspect ratio is
  7640. preserved) can be set with \ref setBackgroundScaledMode. To set all these options in one call,
  7641. consider using the overloaded version of this function.
  7642. If a background brush was set with \ref setBackground(const QBrush &brush), the viewport will
  7643. first be filled with that brush, before drawing the background pixmap. This can be useful for
  7644. background pixmaps with translucent areas.
  7645. \see setBackgroundScaled, setBackgroundScaledMode
  7646. */
  7647. void QCustomPlot::setBackground(const QPixmap &pm)
  7648. {
  7649. mBackgroundPixmap = pm;
  7650. mScaledBackgroundPixmap = QPixmap();
  7651. }
  7652. /*!
  7653. Sets the background brush of the viewport (see \ref setViewport).
  7654. Before drawing everything else, the background is filled with \a brush. If a background pixmap
  7655. was set with \ref setBackground(const QPixmap &pm), this brush will be used to fill the viewport
  7656. before the background pixmap is drawn. This can be useful for background pixmaps with translucent
  7657. areas.
  7658. Set \a brush to Qt::NoBrush or Qt::Transparent to leave background transparent. This can be
  7659. useful for exporting to image formats which support transparency, e.g. \ref savePng.
  7660. \see setBackgroundScaled, setBackgroundScaledMode
  7661. */
  7662. void QCustomPlot::setBackground(const QBrush &brush)
  7663. {
  7664. mBackgroundBrush = brush;
  7665. }
  7666. /*! \overload
  7667. Allows setting the background pixmap of the viewport, whether it shall be scaled and how it
  7668. shall be scaled in one call.
  7669. \see setBackground(const QPixmap &pm), setBackgroundScaled, setBackgroundScaledMode
  7670. */
  7671. void QCustomPlot::setBackground(const QPixmap &pm, bool scaled, Qt::AspectRatioMode mode)
  7672. {
  7673. mBackgroundPixmap = pm;
  7674. mScaledBackgroundPixmap = QPixmap();
  7675. mBackgroundScaled = scaled;
  7676. mBackgroundScaledMode = mode;
  7677. }
  7678. /*!
  7679. Sets whether the viewport background pixmap shall be scaled to fit the viewport. If \a scaled is
  7680. set to true, control whether and how the aspect ratio of the original pixmap is preserved with
  7681. \ref setBackgroundScaledMode.
  7682. Note that the scaled version of the original pixmap is buffered, so there is no performance
  7683. penalty on replots. (Except when the viewport dimensions are changed continuously.)
  7684. \see setBackground, setBackgroundScaledMode
  7685. */
  7686. void QCustomPlot::setBackgroundScaled(bool scaled)
  7687. {
  7688. mBackgroundScaled = scaled;
  7689. }
  7690. /*!
  7691. If scaling of the viewport background pixmap is enabled (\ref setBackgroundScaled), use this
  7692. function to define whether and how the aspect ratio of the original pixmap is preserved.
  7693. \see setBackground, setBackgroundScaled
  7694. */
  7695. void QCustomPlot::setBackgroundScaledMode(Qt::AspectRatioMode mode)
  7696. {
  7697. mBackgroundScaledMode = mode;
  7698. }
  7699. /*!
  7700. Returns the plottable with \a index. If the index is invalid, returns 0.
  7701. There is an overloaded version of this function with no parameter which returns the last added
  7702. plottable, see QCustomPlot::plottable()
  7703. \see plottableCount, addPlottable
  7704. */
  7705. QCPAbstractPlottable *QCustomPlot::plottable(int index)
  7706. {
  7707. if (index >= 0 && index < mPlottables.size())
  7708. {
  7709. return mPlottables.at(index);
  7710. } else
  7711. {
  7712. qDebug() << Q_FUNC_INFO << "index out of bounds:" << index;
  7713. return 0;
  7714. }
  7715. }
  7716. /*! \overload
  7717. Returns the last plottable that was added with \ref addPlottable. If there are no plottables in
  7718. the plot, returns 0.
  7719. \see plottableCount, addPlottable
  7720. */
  7721. QCPAbstractPlottable *QCustomPlot::plottable()
  7722. {
  7723. if (!mPlottables.isEmpty())
  7724. {
  7725. return mPlottables.last();
  7726. } else
  7727. return 0;
  7728. }
  7729. /*!
  7730. Adds the specified plottable to the plot and, if \ref setAutoAddPlottableToLegend is enabled, to
  7731. the legend (QCustomPlot::legend). QCustomPlot takes ownership of the plottable.
  7732. Returns true on success, i.e. when \a plottable isn't already in the plot and the parent plot of
  7733. \a plottable is this QCustomPlot (the latter is controlled by what axes were passed in the
  7734. plottable's constructor).
  7735. \see plottable, plottableCount, removePlottable, clearPlottables
  7736. */
  7737. bool QCustomPlot::addPlottable(QCPAbstractPlottable *plottable)
  7738. {
  7739. if (mPlottables.contains(plottable))
  7740. {
  7741. qDebug() << Q_FUNC_INFO << "plottable already added to this QCustomPlot:" << reinterpret_cast<quintptr>(plottable);
  7742. return false;
  7743. }
  7744. if (plottable->parentPlot() != this)
  7745. {
  7746. qDebug() << Q_FUNC_INFO << "plottable not created with this QCustomPlot as parent:" << reinterpret_cast<quintptr>(plottable);
  7747. return false;
  7748. }
  7749. mPlottables.append(plottable);
  7750. // possibly add plottable to legend:
  7751. if (mAutoAddPlottableToLegend)
  7752. plottable->addToLegend();
  7753. // special handling for QCPGraphs to maintain the simple graph interface:
  7754. if (QCPGraph *graph = qobject_cast<QCPGraph*>(plottable))
  7755. mGraphs.append(graph);
  7756. if (!plottable->layer()) // usually the layer is already set in the constructor of the plottable (via QCPLayerable constructor)
  7757. plottable->setLayer(currentLayer());
  7758. return true;
  7759. }
  7760. /*!
  7761. Removes the specified plottable from the plot and, if necessary, from the legend (QCustomPlot::legend).
  7762. Returns true on success.
  7763. \see addPlottable, clearPlottables
  7764. */
  7765. bool QCustomPlot::removePlottable(QCPAbstractPlottable *plottable)
  7766. {
  7767. if (!mPlottables.contains(plottable))
  7768. {
  7769. qDebug() << Q_FUNC_INFO << "plottable not in list:" << reinterpret_cast<quintptr>(plottable);
  7770. return false;
  7771. }
  7772. // remove plottable from legend:
  7773. plottable->removeFromLegend();
  7774. // special handling for QCPGraphs to maintain the simple graph interface:
  7775. if (QCPGraph *graph = qobject_cast<QCPGraph*>(plottable))
  7776. mGraphs.removeOne(graph);
  7777. // remove plottable:
  7778. delete plottable;
  7779. mPlottables.removeOne(plottable);
  7780. return true;
  7781. }
  7782. /*! \overload
  7783. Removes the plottable by its \a index.
  7784. */
  7785. bool QCustomPlot::removePlottable(int index)
  7786. {
  7787. if (index >= 0 && index < mPlottables.size())
  7788. return removePlottable(mPlottables[index]);
  7789. else
  7790. {
  7791. qDebug() << Q_FUNC_INFO << "index out of bounds:" << index;
  7792. return false;
  7793. }
  7794. }
  7795. /*!
  7796. Removes all plottables from the plot (and the QCustomPlot::legend, if necessary).
  7797. Returns the number of plottables removed.
  7798. \see removePlottable
  7799. */
  7800. int QCustomPlot::clearPlottables()
  7801. {
  7802. int c = mPlottables.size();
  7803. for (int i=c-1; i >= 0; --i)
  7804. removePlottable(mPlottables[i]);
  7805. return c;
  7806. }
  7807. /*!
  7808. Returns the number of currently existing plottables in the plot
  7809. \see plottable, addPlottable
  7810. */
  7811. int QCustomPlot::plottableCount() const
  7812. {
  7813. return mPlottables.size();
  7814. }
  7815. /*!
  7816. Returns a list of the selected plottables. If no plottables are currently selected, the list is empty.
  7817. There is a convenience function if you're only interested in selected graphs, see \ref selectedGraphs.
  7818. \see setInteractions, QCPAbstractPlottable::setSelectable, QCPAbstractPlottable::setSelected
  7819. */
  7820. QList<QCPAbstractPlottable*> QCustomPlot::selectedPlottables() const
  7821. {
  7822. QList<QCPAbstractPlottable*> result;
  7823. for (int i=0; i<mPlottables.size(); ++i)
  7824. {
  7825. if (mPlottables.at(i)->selected())
  7826. result.append(mPlottables.at(i));
  7827. }
  7828. return result;
  7829. }
  7830. /*!
  7831. Returns the plottable at the pixel position \a pos. Plottables that only consist of single lines
  7832. (like graphs) have a tolerance band around them, see \ref setSelectionTolerance. If multiple
  7833. plottables come into consideration, the one closest to \a pos is returned.
  7834. If \a onlySelectable is true, only plottables that are selectable
  7835. (QCPAbstractPlottable::setSelectable) are considered.
  7836. If there is no plottable at \a pos, the return value is 0.
  7837. \see itemAt, layoutElementAt
  7838. */
  7839. QCPAbstractPlottable *QCustomPlot::plottableAt(const QPointF &pos, bool onlySelectable) const
  7840. {
  7841. QCPAbstractPlottable *resultPlottable = 0;
  7842. double resultDistance = mSelectionTolerance; // only regard clicks with distances smaller than mSelectionTolerance as selections, so initialize with that value
  7843. for (int i=0; i<mPlottables.size(); ++i)
  7844. {
  7845. QCPAbstractPlottable *currentPlottable = mPlottables.at(i);
  7846. if (onlySelectable && !currentPlottable->selectable()) // we could have also passed onlySelectable to the selectTest function, but checking here is faster, because we have access to QCPabstractPlottable::selectable
  7847. continue;
  7848. if ((currentPlottable->keyAxis()->axisRect()->rect() & currentPlottable->valueAxis()->axisRect()->rect()).contains(pos.toPoint())) // only consider clicks inside the rect that is spanned by the plottable's key/value axes
  7849. {
  7850. double currentDistance = currentPlottable->selectTest(pos, false);
  7851. if (currentDistance >= 0 && currentDistance < resultDistance)
  7852. {
  7853. resultPlottable = currentPlottable;
  7854. resultDistance = currentDistance;
  7855. }
  7856. }
  7857. }
  7858. return resultPlottable;
  7859. }
  7860. /*!
  7861. Returns whether this QCustomPlot instance contains the \a plottable.
  7862. \see addPlottable
  7863. */
  7864. bool QCustomPlot::hasPlottable(QCPAbstractPlottable *plottable) const
  7865. {
  7866. return mPlottables.contains(plottable);
  7867. }
  7868. /*!
  7869. Returns the graph with \a index. If the index is invalid, returns 0.
  7870. There is an overloaded version of this function with no parameter which returns the last created
  7871. graph, see QCustomPlot::graph()
  7872. \see graphCount, addGraph
  7873. */
  7874. QCPGraph *QCustomPlot::graph(int index) const
  7875. {
  7876. if (index >= 0 && index < mGraphs.size())
  7877. {
  7878. return mGraphs.at(index);
  7879. } else
  7880. {
  7881. qDebug() << Q_FUNC_INFO << "index out of bounds:" << index;
  7882. return 0;
  7883. }
  7884. }
  7885. /*! \overload
  7886. Returns the last graph, that was created with \ref addGraph. If there are no graphs in the plot,
  7887. returns 0.
  7888. \see graphCount, addGraph
  7889. */
  7890. QCPGraph *QCustomPlot::graph() const
  7891. {
  7892. if (!mGraphs.isEmpty())
  7893. {
  7894. return mGraphs.last();
  7895. } else
  7896. return 0;
  7897. }
  7898. /*!
  7899. Creates a new graph inside the plot. If \a keyAxis and \a valueAxis are left unspecified (0), the
  7900. bottom (xAxis) is used as key and the left (yAxis) is used as value axis. If specified, \a
  7901. keyAxis and \a valueAxis must reside in this QCustomPlot.
  7902. \a keyAxis will be used as key axis (typically "x") and \a valueAxis as value axis (typically
  7903. "y") for the graph.
  7904. Returns a pointer to the newly created graph, or 0 if adding the graph failed.
  7905. \see graph, graphCount, removeGraph, clearGraphs
  7906. */
  7907. QCPGraph *QCustomPlot::addGraph(QCPAxis *keyAxis, QCPAxis *valueAxis)
  7908. {
  7909. if (!keyAxis) keyAxis = xAxis;
  7910. if (!valueAxis) valueAxis = yAxis;
  7911. if (!keyAxis || !valueAxis)
  7912. {
  7913. qDebug() << Q_FUNC_INFO << "can't use default QCustomPlot xAxis or yAxis, because at least one is invalid (has been deleted)";
  7914. return 0;
  7915. }
  7916. if (keyAxis->parentPlot() != this || valueAxis->parentPlot() != this)
  7917. {
  7918. qDebug() << Q_FUNC_INFO << "passed keyAxis or valueAxis doesn't have this QCustomPlot as parent";
  7919. return 0;
  7920. }
  7921. QCPGraph *newGraph = new QCPGraph(keyAxis, valueAxis);
  7922. if (addPlottable(newGraph))
  7923. {
  7924. newGraph->setName("Graph "+QString::number(mGraphs.size()));
  7925. return newGraph;
  7926. } else
  7927. {
  7928. delete newGraph;
  7929. return 0;
  7930. }
  7931. }
  7932. /*!
  7933. Removes the specified \a graph from the plot and, if necessary, from the QCustomPlot::legend. If
  7934. any other graphs in the plot have a channel fill set towards the removed graph, the channel fill
  7935. property of those graphs is reset to zero (no channel fill).
  7936. Returns true on success.
  7937. \see clearGraphs
  7938. */
  7939. bool QCustomPlot::removeGraph(QCPGraph *graph)
  7940. {
  7941. return removePlottable(graph);
  7942. }
  7943. /*! \overload
  7944. Removes the graph by its \a index.
  7945. */
  7946. bool QCustomPlot::removeGraph(int index)
  7947. {
  7948. if (index >= 0 && index < mGraphs.size())
  7949. return removeGraph(mGraphs[index]);
  7950. else
  7951. return false;
  7952. }
  7953. /*!
  7954. Removes all graphs from the plot (and the QCustomPlot::legend, if necessary).
  7955. Returns the number of graphs removed.
  7956. \see removeGraph
  7957. */
  7958. int QCustomPlot::clearGraphs()
  7959. {
  7960. int c = mGraphs.size();
  7961. for (int i=c-1; i >= 0; --i)
  7962. removeGraph(mGraphs[i]);
  7963. return c;
  7964. }
  7965. /*!
  7966. Returns the number of currently existing graphs in the plot
  7967. \see graph, addGraph
  7968. */
  7969. int QCustomPlot::graphCount() const
  7970. {
  7971. return mGraphs.size();
  7972. }
  7973. /*!
  7974. Returns a list of the selected graphs. If no graphs are currently selected, the list is empty.
  7975. If you are not only interested in selected graphs but other plottables like QCPCurve, QCPBars,
  7976. etc., use \ref selectedPlottables.
  7977. \see setInteractions, selectedPlottables, QCPAbstractPlottable::setSelectable, QCPAbstractPlottable::setSelected
  7978. */
  7979. QList<QCPGraph*> QCustomPlot::selectedGraphs() const
  7980. {
  7981. QList<QCPGraph*> result;
  7982. for (int i=0; i<mGraphs.size(); ++i)
  7983. {
  7984. if (mGraphs.at(i)->selected())
  7985. result.append(mGraphs.at(i));
  7986. }
  7987. return result;
  7988. }
  7989. /*!
  7990. Returns the item with \a index. If the index is invalid, returns 0.
  7991. There is an overloaded version of this function with no parameter which returns the last added
  7992. item, see QCustomPlot::item()
  7993. \see itemCount, addItem
  7994. */
  7995. QCPAbstractItem *QCustomPlot::item(int index) const
  7996. {
  7997. if (index >= 0 && index < mItems.size())
  7998. {
  7999. return mItems.at(index);
  8000. } else
  8001. {
  8002. qDebug() << Q_FUNC_INFO << "index out of bounds:" << index;
  8003. return 0;
  8004. }
  8005. }
  8006. /*! \overload
  8007. Returns the last item, that was added with \ref addItem. If there are no items in the plot,
  8008. returns 0.
  8009. \see itemCount, addItem
  8010. */
  8011. QCPAbstractItem *QCustomPlot::item() const
  8012. {
  8013. if (!mItems.isEmpty())
  8014. {
  8015. return mItems.last();
  8016. } else
  8017. return 0;
  8018. }
  8019. /*!
  8020. Adds the specified item to the plot. QCustomPlot takes ownership of the item.
  8021. Returns true on success, i.e. when \a item wasn't already in the plot and the parent plot of \a
  8022. item is this QCustomPlot.
  8023. \see item, itemCount, removeItem, clearItems
  8024. */
  8025. bool QCustomPlot::addItem(QCPAbstractItem *item)
  8026. {
  8027. if (!mItems.contains(item) && item->parentPlot() == this)
  8028. {
  8029. mItems.append(item);
  8030. return true;
  8031. } else
  8032. {
  8033. qDebug() << Q_FUNC_INFO << "item either already in list or not created with this QCustomPlot as parent:" << reinterpret_cast<quintptr>(item);
  8034. return false;
  8035. }
  8036. }
  8037. /*!
  8038. Removes the specified item from the plot.
  8039. Returns true on success.
  8040. \see addItem, clearItems
  8041. */
  8042. bool QCustomPlot::removeItem(QCPAbstractItem *item)
  8043. {
  8044. if (mItems.contains(item))
  8045. {
  8046. delete item;
  8047. mItems.removeOne(item);
  8048. return true;
  8049. } else
  8050. {
  8051. qDebug() << Q_FUNC_INFO << "item not in list:" << reinterpret_cast<quintptr>(item);
  8052. return false;
  8053. }
  8054. }
  8055. /*! \overload
  8056. Removes the item by its \a index.
  8057. */
  8058. bool QCustomPlot::removeItem(int index)
  8059. {
  8060. if (index >= 0 && index < mItems.size())
  8061. return removeItem(mItems[index]);
  8062. else
  8063. {
  8064. qDebug() << Q_FUNC_INFO << "index out of bounds:" << index;
  8065. return false;
  8066. }
  8067. }
  8068. /*!
  8069. Removes all items from the plot.
  8070. Returns the number of items removed.
  8071. \see removeItem
  8072. */
  8073. int QCustomPlot::clearItems()
  8074. {
  8075. int c = mItems.size();
  8076. for (int i=c-1; i >= 0; --i)
  8077. removeItem(mItems[i]);
  8078. return c;
  8079. }
  8080. /*!
  8081. Returns the number of currently existing items in the plot
  8082. \see item, addItem
  8083. */
  8084. int QCustomPlot::itemCount() const
  8085. {
  8086. return mItems.size();
  8087. }
  8088. /*!
  8089. Returns a list of the selected items. If no items are currently selected, the list is empty.
  8090. \see setInteractions, QCPAbstractItem::setSelectable, QCPAbstractItem::setSelected
  8091. */
  8092. QList<QCPAbstractItem*> QCustomPlot::selectedItems() const
  8093. {
  8094. QList<QCPAbstractItem*> result;
  8095. for (int i=0; i<mItems.size(); ++i)
  8096. {
  8097. if (mItems.at(i)->selected())
  8098. result.append(mItems.at(i));
  8099. }
  8100. return result;
  8101. }
  8102. /*!
  8103. Returns the item at the pixel position \a pos. Items that only consist of single lines (e.g. \ref
  8104. QCPItemLine or \ref QCPItemCurve) have a tolerance band around them, see \ref
  8105. setSelectionTolerance. If multiple items come into consideration, the one closest to \a pos is
  8106. returned.
  8107. If \a onlySelectable is true, only items that are selectable (QCPAbstractItem::setSelectable) are
  8108. considered.
  8109. If there is no item at \a pos, the return value is 0.
  8110. \see plottableAt, layoutElementAt
  8111. */
  8112. QCPAbstractItem *QCustomPlot::itemAt(const QPointF &pos, bool onlySelectable) const
  8113. {
  8114. QCPAbstractItem *resultItem = 0;
  8115. double resultDistance = mSelectionTolerance; // only regard clicks with distances smaller than mSelectionTolerance as selections, so initialize with that value
  8116. for (int i=0; i<mItems.size(); ++i)
  8117. {
  8118. QCPAbstractItem *currentItem = mItems[i];
  8119. if (onlySelectable && !currentItem->selectable()) // we could have also passed onlySelectable to the selectTest function, but checking here is faster, because we have access to QCPAbstractItem::selectable
  8120. continue;
  8121. if (!currentItem->clipToAxisRect() || currentItem->clipRect().contains(pos.toPoint())) // only consider clicks inside axis cliprect of the item if actually clipped to it
  8122. {
  8123. double currentDistance = currentItem->selectTest(pos, false);
  8124. if (currentDistance >= 0 && currentDistance < resultDistance)
  8125. {
  8126. resultItem = currentItem;
  8127. resultDistance = currentDistance;
  8128. }
  8129. }
  8130. }
  8131. return resultItem;
  8132. }
  8133. /*!
  8134. Returns whether this QCustomPlot contains the \a item.
  8135. \see addItem
  8136. */
  8137. bool QCustomPlot::hasItem(QCPAbstractItem *item) const
  8138. {
  8139. return mItems.contains(item);
  8140. }
  8141. /*!
  8142. Returns the layer with the specified \a name. If there is no layer with the specified name, 0 is
  8143. returned.
  8144. Layer names are case-sensitive.
  8145. \see addLayer, moveLayer, removeLayer
  8146. */
  8147. QCPLayer *QCustomPlot::layer(const QString &name) const
  8148. {
  8149. for (int i=0; i<mLayers.size(); ++i)
  8150. {
  8151. if (mLayers.at(i)->name() == name)
  8152. return mLayers.at(i);
  8153. }
  8154. return 0;
  8155. }
  8156. /*! \overload
  8157. Returns the layer by \a index. If the index is invalid, 0 is returned.
  8158. \see addLayer, moveLayer, removeLayer
  8159. */
  8160. QCPLayer *QCustomPlot::layer(int index) const
  8161. {
  8162. if (index >= 0 && index < mLayers.size())
  8163. {
  8164. return mLayers.at(index);
  8165. } else
  8166. {
  8167. qDebug() << Q_FUNC_INFO << "index out of bounds:" << index;
  8168. return 0;
  8169. }
  8170. }
  8171. /*!
  8172. Returns the layer that is set as current layer (see \ref setCurrentLayer).
  8173. */
  8174. QCPLayer *QCustomPlot::currentLayer() const
  8175. {
  8176. return mCurrentLayer;
  8177. }
  8178. /*!
  8179. Sets the layer with the specified \a name to be the current layer. All layerables (\ref
  8180. QCPLayerable), e.g. plottables and items, are created on the current layer.
  8181. Returns true on success, i.e. if there is a layer with the specified \a name in the QCustomPlot.
  8182. Layer names are case-sensitive.
  8183. \see addLayer, moveLayer, removeLayer, QCPLayerable::setLayer
  8184. */
  8185. bool QCustomPlot::setCurrentLayer(const QString &name)
  8186. {
  8187. if (QCPLayer *newCurrentLayer = layer(name))
  8188. {
  8189. return setCurrentLayer(newCurrentLayer);
  8190. } else
  8191. {
  8192. qDebug() << Q_FUNC_INFO << "layer with name doesn't exist:" << name;
  8193. return false;
  8194. }
  8195. }
  8196. /*! \overload
  8197. Sets the provided \a layer to be the current layer.
  8198. Returns true on success, i.e. when \a layer is a valid layer in the QCustomPlot.
  8199. \see addLayer, moveLayer, removeLayer
  8200. */
  8201. bool QCustomPlot::setCurrentLayer(QCPLayer *layer)
  8202. {
  8203. if (!mLayers.contains(layer))
  8204. {
  8205. qDebug() << Q_FUNC_INFO << "layer not a layer of this QCustomPlot:" << reinterpret_cast<quintptr>(layer);
  8206. return false;
  8207. }
  8208. mCurrentLayer = layer;
  8209. return true;
  8210. }
  8211. /*!
  8212. Returns the number of currently existing layers in the plot
  8213. \see layer, addLayer
  8214. */
  8215. int QCustomPlot::layerCount() const
  8216. {
  8217. return mLayers.size();
  8218. }
  8219. /*!
  8220. Adds a new layer to this QCustomPlot instance. The new layer will have the name \a name, which
  8221. must be unique. Depending on \a insertMode, it is positioned either below or above \a otherLayer.
  8222. Returns true on success, i.e. if there is no other layer named \a name and \a otherLayer is a
  8223. valid layer inside this QCustomPlot.
  8224. If \a otherLayer is 0, the highest layer in the QCustomPlot will be used.
  8225. For an explanation of what layers are in QCustomPlot, see the documentation of \ref QCPLayer.
  8226. \see layer, moveLayer, removeLayer
  8227. */
  8228. bool QCustomPlot::addLayer(const QString &name, QCPLayer *otherLayer, QCustomPlot::LayerInsertMode insertMode)
  8229. {
  8230. if (!otherLayer)
  8231. otherLayer = mLayers.last();
  8232. if (!mLayers.contains(otherLayer))
  8233. {
  8234. qDebug() << Q_FUNC_INFO << "otherLayer not a layer of this QCustomPlot:" << reinterpret_cast<quintptr>(otherLayer);
  8235. return false;
  8236. }
  8237. if (layer(name))
  8238. {
  8239. qDebug() << Q_FUNC_INFO << "A layer exists already with the name" << name;
  8240. return false;
  8241. }
  8242. QCPLayer *newLayer = new QCPLayer(this, name);
  8243. mLayers.insert(otherLayer->index() + (insertMode==limAbove ? 1:0), newLayer);
  8244. updateLayerIndices();
  8245. return true;
  8246. }
  8247. /*!
  8248. Removes the specified \a layer and returns true on success.
  8249. All layerables (e.g. plottables and items) on the removed layer will be moved to the layer below
  8250. \a layer. If \a layer is the bottom layer, the layerables are moved to the layer above. In both
  8251. cases, the total rendering order of all layerables in the QCustomPlot is preserved.
  8252. If \a layer is the current layer (\ref setCurrentLayer), the layer below (or above, if bottom
  8253. layer) becomes the new current layer.
  8254. It is not possible to remove the last layer of the plot.
  8255. \see layer, addLayer, moveLayer
  8256. */
  8257. bool QCustomPlot::removeLayer(QCPLayer *layer)
  8258. {
  8259. if (!mLayers.contains(layer))
  8260. {
  8261. qDebug() << Q_FUNC_INFO << "layer not a layer of this QCustomPlot:" << reinterpret_cast<quintptr>(layer);
  8262. return false;
  8263. }
  8264. if (mLayers.size() < 2)
  8265. {
  8266. qDebug() << Q_FUNC_INFO << "can't remove last layer";
  8267. return false;
  8268. }
  8269. // append all children of this layer to layer below (if this is lowest layer, prepend to layer above)
  8270. int removedIndex = layer->index();
  8271. bool isFirstLayer = removedIndex==0;
  8272. QCPLayer *targetLayer = isFirstLayer ? mLayers.at(removedIndex+1) : mLayers.at(removedIndex-1);
  8273. QList<QCPLayerable*> children = layer->children();
  8274. if (isFirstLayer) // prepend in reverse order (so order relative to each other stays the same)
  8275. {
  8276. for (int i=children.size()-1; i>=0; --i)
  8277. children.at(i)->moveToLayer(targetLayer, true);
  8278. } else // append normally
  8279. {
  8280. for (int i=0; i<children.size(); ++i)
  8281. children.at(i)->moveToLayer(targetLayer, false);
  8282. }
  8283. // if removed layer is current layer, change current layer to layer below/above:
  8284. if (layer == mCurrentLayer)
  8285. setCurrentLayer(targetLayer);
  8286. // remove layer:
  8287. delete layer;
  8288. mLayers.removeOne(layer);
  8289. updateLayerIndices();
  8290. return true;
  8291. }
  8292. /*!
  8293. Moves the specified \a layer either above or below \a otherLayer. Whether it's placed above or
  8294. below is controlled with \a insertMode.
  8295. Returns true on success, i.e. when both \a layer and \a otherLayer are valid layers in the
  8296. QCustomPlot.
  8297. \see layer, addLayer, moveLayer
  8298. */
  8299. bool QCustomPlot::moveLayer(QCPLayer *layer, QCPLayer *otherLayer, QCustomPlot::LayerInsertMode insertMode)
  8300. {
  8301. if (!mLayers.contains(layer))
  8302. {
  8303. qDebug() << Q_FUNC_INFO << "layer not a layer of this QCustomPlot:" << reinterpret_cast<quintptr>(layer);
  8304. return false;
  8305. }
  8306. if (!mLayers.contains(otherLayer))
  8307. {
  8308. qDebug() << Q_FUNC_INFO << "otherLayer not a layer of this QCustomPlot:" << reinterpret_cast<quintptr>(otherLayer);
  8309. return false;
  8310. }
  8311. mLayers.move(layer->index(), otherLayer->index() + (insertMode==limAbove ? 1:0));
  8312. updateLayerIndices();
  8313. return true;
  8314. }
  8315. /*!
  8316. Returns the number of axis rects in the plot.
  8317. All axis rects can be accessed via QCustomPlot::axisRect().
  8318. Initially, only one axis rect exists in the plot.
  8319. \see axisRect, axisRects
  8320. */
  8321. int QCustomPlot::axisRectCount() const
  8322. {
  8323. return axisRects().size();
  8324. }
  8325. /*!
  8326. Returns the axis rect with \a index.
  8327. Initially, only one axis rect (with index 0) exists in the plot. If multiple axis rects were
  8328. added, all of them may be accessed with this function in a linear fashion (even when they are
  8329. nested in a layout hierarchy or inside other axis rects via QCPAxisRect::insetLayout).
  8330. \see axisRectCount, axisRects
  8331. */
  8332. QCPAxisRect *QCustomPlot::axisRect(int index) const
  8333. {
  8334. const QList<QCPAxisRect*> rectList = axisRects();
  8335. if (index >= 0 && index < rectList.size())
  8336. {
  8337. return rectList.at(index);
  8338. } else
  8339. {
  8340. qDebug() << Q_FUNC_INFO << "invalid axis rect index" << index;
  8341. return 0;
  8342. }
  8343. }
  8344. /*!
  8345. Returns all axis rects in the plot.
  8346. \see axisRectCount, axisRect
  8347. */
  8348. QList<QCPAxisRect*> QCustomPlot::axisRects() const
  8349. {
  8350. QList<QCPAxisRect*> result;
  8351. QStack<QCPLayoutElement*> elementStack;
  8352. if (mPlotLayout)
  8353. elementStack.push(mPlotLayout);
  8354. while (!elementStack.isEmpty())
  8355. {
  8356. QList<QCPLayoutElement*> subElements = elementStack.pop()->elements(false);
  8357. for (int i=0; i<subElements.size(); ++i)
  8358. {
  8359. if (QCPLayoutElement *element = subElements.at(i))
  8360. {
  8361. elementStack.push(element);
  8362. if (QCPAxisRect *ar = qobject_cast<QCPAxisRect*>(element))
  8363. result.append(ar);
  8364. }
  8365. }
  8366. }
  8367. return result;
  8368. }
  8369. /*!
  8370. Returns the layout element at pixel position \a pos. If there is no element at that position,
  8371. returns 0.
  8372. Only visible elements are used. If \ref QCPLayoutElement::setVisible on the element itself or on
  8373. any of its parent elements is set to false, it will not be considered.
  8374. \see itemAt, plottableAt
  8375. */
  8376. QCPLayoutElement *QCustomPlot::layoutElementAt(const QPointF &pos) const
  8377. {
  8378. QCPLayoutElement *current = mPlotLayout;
  8379. bool searchSubElements = true;
  8380. while (searchSubElements && current)
  8381. {
  8382. searchSubElements = false;
  8383. const QList<QCPLayoutElement*> elements = current->elements(false);
  8384. for (int i=0; i<elements.size(); ++i)
  8385. {
  8386. if (elements.at(i) && elements.at(i)->realVisibility() && elements.at(i)->selectTest(pos, false) >= 0)
  8387. {
  8388. current = elements.at(i);
  8389. searchSubElements = true;
  8390. break;
  8391. }
  8392. }
  8393. }
  8394. return current;
  8395. }
  8396. /*!
  8397. Returns the axes that currently have selected parts, i.e. whose selection state is not \ref
  8398. QCPAxis::spNone.
  8399. \see selectedPlottables, selectedLegends, setInteractions, QCPAxis::setSelectedParts,
  8400. QCPAxis::setSelectableParts
  8401. */
  8402. QList<QCPAxis*> QCustomPlot::selectedAxes() const
  8403. {
  8404. QList<QCPAxis*> result, allAxes;
  8405. QList<QCPAxisRect*> rects = axisRects();
  8406. for (int i=0; i<rects.size(); ++i)
  8407. allAxes << rects.at(i)->axes();
  8408. for (int i=0; i<allAxes.size(); ++i)
  8409. {
  8410. if (allAxes.at(i)->selectedParts() != QCPAxis::spNone)
  8411. result.append(allAxes.at(i));
  8412. }
  8413. return result;
  8414. }
  8415. /*!
  8416. Returns the legends that currently have selected parts, i.e. whose selection state is not \ref
  8417. QCPLegend::spNone.
  8418. \see selectedPlottables, selectedAxes, setInteractions, QCPLegend::setSelectedParts,
  8419. QCPLegend::setSelectableParts, QCPLegend::selectedItems
  8420. */
  8421. QList<QCPLegend*> QCustomPlot::selectedLegends() const
  8422. {
  8423. QList<QCPLegend*> result;
  8424. QStack<QCPLayoutElement*> elementStack;
  8425. if (mPlotLayout)
  8426. elementStack.push(mPlotLayout);
  8427. while (!elementStack.isEmpty())
  8428. {
  8429. QList<QCPLayoutElement*> subElements = elementStack.pop()->elements(false);
  8430. for (int i=0; i<subElements.size(); ++i)
  8431. {
  8432. if (QCPLayoutElement *element = subElements.at(i))
  8433. {
  8434. elementStack.push(element);
  8435. if (QCPLegend *leg = qobject_cast<QCPLegend*>(element))
  8436. {
  8437. if (leg->selectedParts() != QCPLegend::spNone)
  8438. result.append(leg);
  8439. }
  8440. }
  8441. }
  8442. }
  8443. return result;
  8444. }
  8445. /*!
  8446. Deselects all layerables (plottables, items, axes, legends,...) of the QCustomPlot.
  8447. Since calling this function is not a user interaction, this does not emit the \ref
  8448. selectionChangedByUser signal. The individual selectionChanged signals are emitted though, if the
  8449. objects were previously selected.
  8450. \see setInteractions, selectedPlottables, selectedItems, selectedAxes, selectedLegends
  8451. */
  8452. void QCustomPlot::deselectAll()
  8453. {
  8454. for (int i=0; i<mLayers.size(); ++i)
  8455. {
  8456. QList<QCPLayerable*> layerables = mLayers.at(i)->children();
  8457. for (int k=0; k<layerables.size(); ++k)
  8458. layerables.at(k)->deselectEvent(0);
  8459. }
  8460. }
  8461. /*!
  8462. Causes a complete replot into the internal buffer. Finally, update() is called, to redraw the
  8463. buffer on the QCustomPlot widget surface. This is the method that must be called to make changes,
  8464. for example on the axis ranges or data points of graphs, visible.
  8465. Under a few circumstances, QCustomPlot causes a replot by itself. Those are resize events of the
  8466. QCustomPlot widget and user interactions (object selection and range dragging/zooming).
  8467. Before the replot happens, the signal \ref beforeReplot is emitted. After the replot, \ref
  8468. afterReplot is emitted. It is safe to mutually connect the replot slot with any of those two
  8469. signals on two QCustomPlots to make them replot synchronously, it won't cause an infinite
  8470. recursion.
  8471. */
  8472. void QCustomPlot::replot()
  8473. {
  8474. if (mReplotting) // incase signals loop back to replot slot
  8475. return;
  8476. mReplotting = true;
  8477. emit beforeReplot();
  8478. mPaintBuffer.fill(mBackgroundBrush.style() == Qt::SolidPattern ? mBackgroundBrush.color() : Qt::transparent);
  8479. QCPPainter painter;
  8480. painter.begin(&mPaintBuffer);
  8481. if (painter.isActive())
  8482. {
  8483. painter.setRenderHint(QPainter::HighQualityAntialiasing); // to make Antialiasing look good if using the OpenGL graphicssystem
  8484. if (mBackgroundBrush.style() != Qt::SolidPattern && mBackgroundBrush.style() != Qt::NoBrush)
  8485. painter.fillRect(mViewport, mBackgroundBrush);
  8486. draw(&painter);
  8487. painter.end();
  8488. if (mPlottingHints.testFlag(QCP::phForceRepaint))
  8489. repaint();
  8490. else
  8491. update();
  8492. } else // might happen if QCustomPlot has width or height zero
  8493. qDebug() << Q_FUNC_INFO << "Couldn't activate painter on buffer";
  8494. emit afterReplot();
  8495. mReplotting = false;
  8496. }
  8497. /*!
  8498. Rescales the axes such that all plottables (like graphs) in the plot are fully visible.
  8499. if \a onlyVisiblePlottables is set to true, only the plottables that have their visibility set to true
  8500. (QCPLayerable::setVisible), will be used to rescale the axes.
  8501. \see QCPAbstractPlottable::rescaleAxes, QCPAxis::rescale
  8502. */
  8503. void QCustomPlot::rescaleAxes(bool onlyVisiblePlottables)
  8504. {
  8505. // get a list of all axes in the plot:
  8506. QList<QCPAxis*> axes;
  8507. QList<QCPAxisRect*> rects = axisRects();
  8508. for (int i=0; i<rects.size(); ++i)
  8509. axes << rects.at(i)->axes();
  8510. // call rescale on all axes:
  8511. for (int i=0; i<axes.size(); ++i)
  8512. axes.at(i)->rescale(onlyVisiblePlottables);
  8513. }
  8514. /*!
  8515. Saves a PDF with the vectorized plot to the file \a fileName. The axis ratio as well as the scale
  8516. of texts and lines will be derived from the specified \a width and \a height. This means, the
  8517. output will look like the normal on-screen output of a QCustomPlot widget with the corresponding
  8518. pixel width and height. If either \a width or \a height is zero, the exported image will have the
  8519. same dimensions as the QCustomPlot widget currently has.
  8520. \a noCosmeticPen disables the use of cosmetic pens when drawing to the PDF file. Cosmetic pens
  8521. are pens with numerical width 0, which are always drawn as a one pixel wide line, no matter what
  8522. zoom factor is set in the PDF-Viewer. For more information about cosmetic pens, see the QPainter
  8523. and QPen documentation.
  8524. The objects of the plot will appear in the current selection state. If you don't want any
  8525. selected objects to be painted in their selected look, deselect everything with \ref deselectAll
  8526. before calling this function.
  8527. Returns true on success.
  8528. \warning
  8529. \li If you plan on editing the exported PDF file with a vector graphics editor like
  8530. Inkscape, it is advised to set \a noCosmeticPen to true to avoid losing those cosmetic lines
  8531. (which might be quite many, because cosmetic pens are the default for e.g. axes and tick marks).
  8532. \li If calling this function inside the constructor of the parent of the QCustomPlot widget
  8533. (i.e. the MainWindow constructor, if QCustomPlot is inside the MainWindow), always provide
  8534. explicit non-zero widths and heights. If you leave \a width or \a height as 0 (default), this
  8535. function uses the current width and height of the QCustomPlot widget. However, in Qt, these
  8536. aren't defined yet inside the constructor, so you would get an image that has strange
  8537. widths/heights.
  8538. \note On Android systems, this method does nothing and issues an according qDebug warning message.
  8539. \see savePng, saveBmp, saveJpg, saveRastered
  8540. */
  8541. bool QCustomPlot::savePdf(const QString &fileName, bool noCosmeticPen, int width, int height)
  8542. {
  8543. bool success = false;
  8544. #ifdef QT_NO_PRINTER
  8545. Q_UNUSED(fileName)
  8546. Q_UNUSED(noCosmeticPen)
  8547. Q_UNUSED(width)
  8548. Q_UNUSED(height)
  8549. qDebug() << Q_FUNC_INFO << "Qt was built without printer support (QT_NO_PRINTER). PDF not created.";
  8550. #else
  8551. int newWidth, newHeight;
  8552. if (width == 0 || height == 0)
  8553. {
  8554. newWidth = this->width();
  8555. newHeight = this->height();
  8556. } else
  8557. {
  8558. newWidth = width;
  8559. newHeight = height;
  8560. }
  8561. QPrinter printer(QPrinter::ScreenResolution);
  8562. printer.setOutputFileName(fileName);
  8563. printer.setOutputFormat(QPrinter::PdfFormat);
  8564. printer.setFullPage(true);
  8565. QRect oldViewport = viewport();
  8566. setViewport(QRect(0, 0, newWidth, newHeight));
  8567. printer.setPaperSize(viewport().size(), QPrinter::DevicePixel);
  8568. QCPPainter printpainter;
  8569. if (printpainter.begin(&printer))
  8570. {
  8571. printpainter.setMode(QCPPainter::pmVectorized);
  8572. printpainter.setMode(QCPPainter::pmNoCaching);
  8573. printpainter.setMode(QCPPainter::pmNonCosmetic, noCosmeticPen);
  8574. printpainter.setWindow(mViewport);
  8575. if (mBackgroundBrush.style() != Qt::NoBrush &&
  8576. mBackgroundBrush.color() != Qt::white &&
  8577. mBackgroundBrush.color() != Qt::transparent &&
  8578. mBackgroundBrush.color().alpha() > 0) // draw pdf background color if not white/transparent
  8579. printpainter.fillRect(viewport(), mBackgroundBrush);
  8580. draw(&printpainter);
  8581. printpainter.end();
  8582. success = true;
  8583. }
  8584. setViewport(oldViewport);
  8585. #endif // QT_NO_PRINTER
  8586. return success;
  8587. }
  8588. /*!
  8589. Saves a PNG image file to \a fileName on disc. The output plot will have the dimensions \a width
  8590. and \a height in pixels. If either \a width or \a height is zero, the exported image will have
  8591. the same dimensions as the QCustomPlot widget currently has. Line widths and texts etc. are not
  8592. scaled up when larger widths/heights are used. If you want that effect, use the \a scale parameter.
  8593. For example, if you set both \a width and \a height to 100 and \a scale to 2, you will end up with an
  8594. image file of size 200*200 in which all graphical elements are scaled up by factor 2 (line widths,
  8595. texts, etc.). This scaling is not done by stretching a 100*100 image, the result will have full
  8596. 200*200 pixel resolution.
  8597. If you use a high scaling factor, it is recommended to enable antialiasing for all elements via
  8598. temporarily setting \ref QCustomPlot::setAntialiasedElements to \ref QCP::aeAll as this allows
  8599. QCustomPlot to place objects with sub-pixel accuracy.
  8600. \warning If calling this function inside the constructor of the parent of the QCustomPlot widget
  8601. (i.e. the MainWindow constructor, if QCustomPlot is inside the MainWindow), always provide
  8602. explicit non-zero widths and heights. If you leave \a width or \a height as 0 (default), this
  8603. function uses the current width and height of the QCustomPlot widget. However, in Qt, these
  8604. aren't defined yet inside the constructor, so you would get an image that has strange
  8605. widths/heights.
  8606. The objects of the plot will appear in the current selection state. If you don't want any selected
  8607. objects to be painted in their selected look, deselect everything with \ref deselectAll before calling
  8608. this function.
  8609. If you want the PNG to have a transparent background, call \ref setBackground(const QBrush
  8610. &brush) with no brush (Qt::NoBrush) or a transparent color (Qt::transparent), before saving.
  8611. PNG compression can be controlled with the \a quality parameter which must be between 0 and 100 or
  8612. -1 to use the default setting.
  8613. Returns true on success. If this function fails, most likely the PNG format isn't supported by
  8614. the system, see Qt docs about QImageWriter::supportedImageFormats().
  8615. \see savePdf, saveBmp, saveJpg, saveRastered
  8616. */
  8617. bool QCustomPlot::savePng(const QString &fileName, int width, int height, double scale, int quality)
  8618. {
  8619. return saveRastered(fileName, width, height, scale, "PNG", quality);
  8620. }
  8621. /*!
  8622. Saves a JPG image file to \a fileName on disc. The output plot will have the dimensions \a width
  8623. and \a height in pixels. If either \a width or \a height is zero, the exported image will have
  8624. the same dimensions as the QCustomPlot widget currently has. Line widths and texts etc. are not
  8625. scaled up when larger widths/heights are used. If you want that effect, use the \a scale parameter.
  8626. For example, if you set both \a width and \a height to 100 and \a scale to 2, you will end up with an
  8627. image file of size 200*200 in which all graphical elements are scaled up by factor 2 (line widths,
  8628. texts, etc.). This scaling is not done by stretching a 100*100 image, the result will have full
  8629. 200*200 pixel resolution.
  8630. If you use a high scaling factor, it is recommended to enable antialiasing for all elements via
  8631. temporarily setting \ref QCustomPlot::setAntialiasedElements to \ref QCP::aeAll as this allows
  8632. QCustomPlot to place objects with sub-pixel accuracy.
  8633. \warning If calling this function inside the constructor of the parent of the QCustomPlot widget
  8634. (i.e. the MainWindow constructor, if QCustomPlot is inside the MainWindow), always provide
  8635. explicit non-zero widths and heights. If you leave \a width or \a height as 0 (default), this
  8636. function uses the current width and height of the QCustomPlot widget. However, in Qt, these
  8637. aren't defined yet inside the constructor, so you would get an image that has strange
  8638. widths/heights.
  8639. The objects of the plot will appear in the current selection state. If you don't want any selected
  8640. objects to be painted in their selected look, deselect everything with \ref deselectAll before calling
  8641. this function.
  8642. JPG compression can be controlled with the \a quality parameter which must be between 0 and 100 or
  8643. -1 to use the default setting.
  8644. Returns true on success. If this function fails, most likely the JPG format isn't supported by
  8645. the system, see Qt docs about QImageWriter::supportedImageFormats().
  8646. \see savePdf, savePng, saveBmp, saveRastered
  8647. */
  8648. bool QCustomPlot::saveJpg(const QString &fileName, int width, int height, double scale, int quality)
  8649. {
  8650. return saveRastered(fileName, width, height, scale, "JPG", quality);
  8651. }
  8652. /*!
  8653. Saves a BMP image file to \a fileName on disc. The output plot will have the dimensions \a width
  8654. and \a height in pixels. If either \a width or \a height is zero, the exported image will have
  8655. the same dimensions as the QCustomPlot widget currently has. Line widths and texts etc. are not
  8656. scaled up when larger widths/heights are used. If you want that effect, use the \a scale parameter.
  8657. For example, if you set both \a width and \a height to 100 and \a scale to 2, you will end up with an
  8658. image file of size 200*200 in which all graphical elements are scaled up by factor 2 (line widths,
  8659. texts, etc.). This scaling is not done by stretching a 100*100 image, the result will have full
  8660. 200*200 pixel resolution.
  8661. If you use a high scaling factor, it is recommended to enable antialiasing for all elements via
  8662. temporarily setting \ref QCustomPlot::setAntialiasedElements to \ref QCP::aeAll as this allows
  8663. QCustomPlot to place objects with sub-pixel accuracy.
  8664. \warning If calling this function inside the constructor of the parent of the QCustomPlot widget
  8665. (i.e. the MainWindow constructor, if QCustomPlot is inside the MainWindow), always provide
  8666. explicit non-zero widths and heights. If you leave \a width or \a height as 0 (default), this
  8667. function uses the current width and height of the QCustomPlot widget. However, in Qt, these
  8668. aren't defined yet inside the constructor, so you would get an image that has strange
  8669. widths/heights.
  8670. The objects of the plot will appear in the current selection state. If you don't want any selected
  8671. objects to be painted in their selected look, deselect everything with \ref deselectAll before calling
  8672. this function.
  8673. Returns true on success. If this function fails, most likely the BMP format isn't supported by
  8674. the system, see Qt docs about QImageWriter::supportedImageFormats().
  8675. \see savePdf, savePng, saveJpg, saveRastered
  8676. */
  8677. bool QCustomPlot::saveBmp(const QString &fileName, int width, int height, double scale)
  8678. {
  8679. return saveRastered(fileName, width, height, scale, "BMP");
  8680. }
  8681. /*! \internal
  8682. Returns a minimum size hint that corresponds to the minimum size of the top level layout
  8683. (\ref plotLayout). To prevent QCustomPlot from being collapsed to size/width zero, set a minimum
  8684. size (setMinimumSize) either on the whole QCustomPlot or on any layout elements inside the plot.
  8685. This is especially important, when placed in a QLayout where other components try to take in as
  8686. much space as possible (e.g. QMdiArea).
  8687. */
  8688. QSize QCustomPlot::minimumSizeHint() const
  8689. {
  8690. return mPlotLayout->minimumSizeHint();
  8691. }
  8692. /*! \internal
  8693. Returns a size hint that is the same as \ref minimumSizeHint.
  8694. */
  8695. QSize QCustomPlot::sizeHint() const
  8696. {
  8697. return mPlotLayout->minimumSizeHint();
  8698. }
  8699. /*! \internal
  8700. Event handler for when the QCustomPlot widget needs repainting. This does not cause a \ref replot, but
  8701. draws the internal buffer on the widget surface.
  8702. */
  8703. void QCustomPlot::paintEvent(QPaintEvent *event)
  8704. {
  8705. Q_UNUSED(event);
  8706. QPainter painter(this);
  8707. painter.drawPixmap(0, 0, mPaintBuffer);
  8708. }
  8709. /*! \internal
  8710. Event handler for a resize of the QCustomPlot widget. Causes the internal buffer to be resized to
  8711. the new size. The viewport (which becomes the outer rect of mPlotLayout) is resized
  8712. appropriately. Finally a \ref replot is performed.
  8713. */
  8714. void QCustomPlot::resizeEvent(QResizeEvent *event)
  8715. {
  8716. // resize and repaint the buffer:
  8717. mPaintBuffer = QPixmap(event->size());
  8718. setViewport(rect());
  8719. replot();
  8720. }
  8721. /*! \internal
  8722. Event handler for when a double click occurs. Emits the \ref mouseDoubleClick signal, then emits
  8723. the specialized signals when certain objecs are clicked (e.g. \ref plottableDoubleClick, \ref
  8724. axisDoubleClick, etc.). Finally determines the affected layout element and forwards the event to
  8725. it.
  8726. \see mousePressEvent, mouseReleaseEvent
  8727. */
  8728. void QCustomPlot::mouseDoubleClickEvent(QMouseEvent *event)
  8729. {
  8730. emit mouseDoubleClick(event);
  8731. QVariant details;
  8732. QCPLayerable *clickedLayerable = layerableAt(event->pos(), false, &details);
  8733. // emit specialized object double click signals:
  8734. if (QCPAbstractPlottable *ap = qobject_cast<QCPAbstractPlottable*>(clickedLayerable))
  8735. emit plottableDoubleClick(ap, event);
  8736. else if (QCPAxis *ax = qobject_cast<QCPAxis*>(clickedLayerable))
  8737. emit axisDoubleClick(ax, details.value<QCPAxis::SelectablePart>(), event);
  8738. else if (QCPAbstractItem *ai = qobject_cast<QCPAbstractItem*>(clickedLayerable))
  8739. emit itemDoubleClick(ai, event);
  8740. else if (QCPLegend *lg = qobject_cast<QCPLegend*>(clickedLayerable))
  8741. emit legendDoubleClick(lg, 0, event);
  8742. else if (QCPAbstractLegendItem *li = qobject_cast<QCPAbstractLegendItem*>(clickedLayerable))
  8743. emit legendDoubleClick(li->parentLegend(), li, event);
  8744. else if (QCPPlotTitle *pt = qobject_cast<QCPPlotTitle*>(clickedLayerable))
  8745. emit titleDoubleClick(event, pt);
  8746. // call double click event of affected layout element:
  8747. if (QCPLayoutElement *el = layoutElementAt(event->pos()))
  8748. el->mouseDoubleClickEvent(event);
  8749. // call release event of affected layout element (as in mouseReleaseEvent, since the mouseDoubleClick replaces the second release event in double click case):
  8750. if (mMouseEventElement)
  8751. {
  8752. mMouseEventElement->mouseReleaseEvent(event);
  8753. mMouseEventElement = 0;
  8754. }
  8755. //QWidget::mouseDoubleClickEvent(event); don't call base class implementation because it would just cause a mousePress/ReleaseEvent, which we don't want.
  8756. }
  8757. /*! \internal
  8758. Event handler for when a mouse button is pressed. Emits the mousePress signal. Then determines
  8759. the affected layout element and forwards the event to it.
  8760. \see mouseMoveEvent, mouseReleaseEvent
  8761. */
  8762. void QCustomPlot::mousePressEvent(QMouseEvent *event)
  8763. {
  8764. emit mousePress(event);
  8765. mMousePressPos = event->pos(); // need this to determine in releaseEvent whether it was a click (no position change between press and release)
  8766. // call event of affected layout element:
  8767. mMouseEventElement = layoutElementAt(event->pos());
  8768. if (mMouseEventElement)
  8769. mMouseEventElement->mousePressEvent(event);
  8770. QWidget::mousePressEvent(event);
  8771. }
  8772. /*! \internal
  8773. Event handler for when the cursor is moved. Emits the \ref mouseMove signal.
  8774. If a layout element has mouse capture focus (a mousePressEvent happened on top of the layout
  8775. element before), the mouseMoveEvent is forwarded to that element.
  8776. \see mousePressEvent, mouseReleaseEvent
  8777. */
  8778. void QCustomPlot::mouseMoveEvent(QMouseEvent *event)
  8779. {
  8780. emit mouseMove(event);
  8781. // call event of affected layout element:
  8782. if (mMouseEventElement)
  8783. mMouseEventElement->mouseMoveEvent(event);
  8784. QWidget::mouseMoveEvent(event);
  8785. }
  8786. /*! \internal
  8787. Event handler for when a mouse button is released. Emits the \ref mouseRelease signal.
  8788. If the mouse was moved less than a certain threshold in any direction since the \ref
  8789. mousePressEvent, it is considered a click which causes the selection mechanism (if activated via
  8790. \ref setInteractions) to possibly change selection states accordingly. Further, specialized mouse
  8791. click signals are emitted (e.g. \ref plottableClick, \ref axisClick, etc.)
  8792. If a layout element has mouse capture focus (a \ref mousePressEvent happened on top of the layout
  8793. element before), the \ref mouseReleaseEvent is forwarded to that element.
  8794. \see mousePressEvent, mouseMoveEvent
  8795. */
  8796. void QCustomPlot::mouseReleaseEvent(QMouseEvent *event)
  8797. {
  8798. emit mouseRelease(event);
  8799. bool doReplot = false;
  8800. if ((mMousePressPos-event->pos()).manhattanLength() < 5) // determine whether it was a click operation
  8801. {
  8802. if (event->button() == Qt::LeftButton)
  8803. {
  8804. // handle selection mechanism:
  8805. QVariant details;
  8806. QCPLayerable *clickedLayerable = layerableAt(event->pos(), true, &details);
  8807. bool selectionStateChanged = false;
  8808. bool additive = mInteractions.testFlag(QCP::iMultiSelect) && event->modifiers().testFlag(mMultiSelectModifier);
  8809. if (clickedLayerable && mInteractions.testFlag(clickedLayerable->selectionCategory()))
  8810. {
  8811. // a layerable was actually clicked, call its selectEvent:
  8812. bool selChanged = false;
  8813. clickedLayerable->selectEvent(event, additive, details, &selChanged);
  8814. selectionStateChanged |= selChanged;
  8815. }
  8816. // deselect all other layerables if not additive selection:
  8817. if (!additive)
  8818. {
  8819. for (int i=0; i<mLayers.size(); ++i)
  8820. {
  8821. QList<QCPLayerable*> layerables = mLayers.at(i)->children();
  8822. for (int k=0; k<layerables.size(); ++k)
  8823. {
  8824. if (layerables.at(k) != clickedLayerable && mInteractions.testFlag(layerables.at(k)->selectionCategory()))
  8825. {
  8826. bool selChanged = false;
  8827. layerables.at(k)->deselectEvent(&selChanged);
  8828. selectionStateChanged |= selChanged;
  8829. }
  8830. }
  8831. }
  8832. }
  8833. doReplot = true;
  8834. if (selectionStateChanged)
  8835. emit selectionChangedByUser();
  8836. }
  8837. // emit specialized object click signals:
  8838. QVariant details;
  8839. QCPLayerable *clickedLayerable = layerableAt(event->pos(), false, &details); // for these signals, selectability is ignored, that's why we call this again with onlySelectable set to false
  8840. if (QCPAbstractPlottable *ap = qobject_cast<QCPAbstractPlottable*>(clickedLayerable))
  8841. emit plottableClick(ap, event);
  8842. else if (QCPAxis *ax = qobject_cast<QCPAxis*>(clickedLayerable))
  8843. emit axisClick(ax, details.value<QCPAxis::SelectablePart>(), event);
  8844. else if (QCPAbstractItem *ai = qobject_cast<QCPAbstractItem*>(clickedLayerable))
  8845. emit itemClick(ai, event);
  8846. else if (QCPLegend *lg = qobject_cast<QCPLegend*>(clickedLayerable))
  8847. emit legendClick(lg, 0, event);
  8848. else if (QCPAbstractLegendItem *li = qobject_cast<QCPAbstractLegendItem*>(clickedLayerable))
  8849. emit legendClick(li->parentLegend(), li, event);
  8850. else if (QCPPlotTitle *pt = qobject_cast<QCPPlotTitle*>(clickedLayerable))
  8851. emit titleClick(event, pt);
  8852. }
  8853. // call event of affected layout element:
  8854. if (mMouseEventElement)
  8855. {
  8856. mMouseEventElement->mouseReleaseEvent(event);
  8857. mMouseEventElement = 0;
  8858. }
  8859. if (doReplot || noAntialiasingOnDrag())
  8860. replot();
  8861. QWidget::mouseReleaseEvent(event);
  8862. }
  8863. /*! \internal
  8864. Event handler for mouse wheel events. First, the \ref mouseWheel signal is emitted. Then
  8865. determines the affected layout element and forwards the event to it.
  8866. */
  8867. void QCustomPlot::wheelEvent(QWheelEvent *event)
  8868. {
  8869. emit mouseWheel(event);
  8870. // call event of affected layout element:
  8871. if (QCPLayoutElement *el = layoutElementAt(event->pos()))
  8872. el->wheelEvent(event);
  8873. QWidget::wheelEvent(event);
  8874. }
  8875. /*! \internal
  8876. This is the main draw function. It draws the entire plot, including background pixmap, with the
  8877. specified \a painter. Note that it does not fill the background with the background brush (as the
  8878. user may specify with \ref setBackground(const QBrush &brush)), this is up to the respective
  8879. functions calling this method (e.g. \ref replot, \ref toPixmap and \ref toPainter).
  8880. */
  8881. void QCustomPlot::draw(QCPPainter *painter)
  8882. {
  8883. // update all axis tick vectors:
  8884. QList<QCPAxisRect*> rects = axisRects();
  8885. for (int i=0; i<rects.size(); ++i)
  8886. {
  8887. QList<QCPAxis*> axes = rects.at(i)->axes();
  8888. for (int k=0; k<axes.size(); ++k)
  8889. axes.at(k)->setupTickVectors();
  8890. }
  8891. // recalculate layout:
  8892. mPlotLayout->update();
  8893. // draw viewport background pixmap:
  8894. drawBackground(painter);
  8895. // draw all layered objects (grid, axes, plottables, items, legend,...):
  8896. for (int layerIndex=0; layerIndex < mLayers.size(); ++layerIndex)
  8897. {
  8898. QList<QCPLayerable*> layerChildren = mLayers.at(layerIndex)->children();
  8899. for (int k=0; k < layerChildren.size(); ++k)
  8900. {
  8901. QCPLayerable *child = layerChildren.at(k);
  8902. if (child->realVisibility())
  8903. {
  8904. painter->save();
  8905. painter->setClipRect(child->clipRect().translated(0, -1));
  8906. child->applyDefaultAntialiasingHint(painter);
  8907. child->draw(painter);
  8908. painter->restore();
  8909. }
  8910. }
  8911. }
  8912. }
  8913. /*! \internal
  8914. Draws the viewport background pixmap of the plot.
  8915. If a pixmap was provided via \ref setBackground, this function buffers the scaled version
  8916. depending on \ref setBackgroundScaled and \ref setBackgroundScaledMode and then draws it inside
  8917. the viewport with the provided \a painter. The scaled version is buffered in
  8918. mScaledBackgroundPixmap to prevent expensive rescaling at every redraw. It is only updated, when
  8919. the axis rect has changed in a way that requires a rescale of the background pixmap (this is
  8920. dependant on the \ref setBackgroundScaledMode), or when a differend axis backgroud pixmap was
  8921. set.
  8922. Note that this function does not draw a fill with the background brush (\ref setBackground(const
  8923. QBrush &brush)) beneath the pixmap.
  8924. \see setBackground, setBackgroundScaled, setBackgroundScaledMode
  8925. */
  8926. void QCustomPlot::drawBackground(QCPPainter *painter)
  8927. {
  8928. // Note: background color is handled in individual replot/save functions
  8929. // draw background pixmap (on top of fill, if brush specified):
  8930. if (!mBackgroundPixmap.isNull())
  8931. {
  8932. if (mBackgroundScaled)
  8933. {
  8934. // check whether mScaledBackground needs to be updated:
  8935. QSize scaledSize(mBackgroundPixmap.size());
  8936. scaledSize.scale(mViewport.size(), mBackgroundScaledMode);
  8937. if (mScaledBackgroundPixmap.size() != scaledSize)
  8938. mScaledBackgroundPixmap = mBackgroundPixmap.scaled(mViewport.size(), mBackgroundScaledMode, Qt::SmoothTransformation);
  8939. painter->drawPixmap(mViewport.topLeft(), mScaledBackgroundPixmap, QRect(0, 0, mViewport.width(), mViewport.height()) & mScaledBackgroundPixmap.rect());
  8940. } else
  8941. {
  8942. painter->drawPixmap(mViewport.topLeft(), mBackgroundPixmap, QRect(0, 0, mViewport.width(), mViewport.height()));
  8943. }
  8944. }
  8945. }
  8946. /*! \internal
  8947. This method is used by \ref QCPAxisRect::removeAxis to report removed axes to the QCustomPlot
  8948. so it may clear its QCustomPlot::xAxis, yAxis, xAxis2 and yAxis2 members accordingly.
  8949. */
  8950. void QCustomPlot::axisRemoved(QCPAxis *axis)
  8951. {
  8952. if (xAxis == axis)
  8953. xAxis = 0;
  8954. if (xAxis2 == axis)
  8955. xAxis2 = 0;
  8956. if (yAxis == axis)
  8957. yAxis = 0;
  8958. if (yAxis2 == axis)
  8959. yAxis2 = 0;
  8960. // Note: No need to take care of range drag axes and range zoom axes, because they are stored in smart pointers
  8961. }
  8962. /*! \internal
  8963. This method is used by the QCPLegend destructor to report legend removal to the QCustomPlot so
  8964. it may clear its QCustomPlot::legend member accordingly.
  8965. */
  8966. void QCustomPlot::legendRemoved(QCPLegend *legend)
  8967. {
  8968. if (this->legend == legend)
  8969. this->legend = 0;
  8970. }
  8971. /*! \internal
  8972. Assigns all layers their index (QCPLayer::mIndex) in the mLayers list. This method is thus called
  8973. after every operation that changes the layer indices, like layer removal, layer creation, layer
  8974. moving.
  8975. */
  8976. void QCustomPlot::updateLayerIndices() const
  8977. {
  8978. for (int i=0; i<mLayers.size(); ++i)
  8979. mLayers.at(i)->mIndex = i;
  8980. }
  8981. /*! \internal
  8982. Returns the layerable at pixel position \a pos. If \a onlySelectable is set to true, only those
  8983. layerables that are selectable will be considered. (Layerable subclasses communicate their
  8984. selectability via the QCPLayerable::selectTest method, by returning -1.)
  8985. \a selectionDetails is an output parameter that contains selection specifics of the affected
  8986. layerable. This is useful if the respective layerable shall be given a subsequent
  8987. QCPLayerable::selectEvent (like in \ref mouseReleaseEvent). \a selectionDetails usually contains
  8988. information about which part of the layerable was hit, in multi-part layerables (e.g.
  8989. QCPAxis::SelectablePart).
  8990. */
  8991. QCPLayerable *QCustomPlot::layerableAt(const QPointF &pos, bool onlySelectable, QVariant *selectionDetails) const
  8992. {
  8993. for (int layerIndex=mLayers.size()-1; layerIndex>=0; --layerIndex)
  8994. {
  8995. const QList<QCPLayerable*> layerables = mLayers.at(layerIndex)->children();
  8996. double minimumDistance = selectionTolerance()*1.1;
  8997. QCPLayerable *minimumDistanceLayerable = 0;
  8998. for (int i=layerables.size()-1; i>=0; --i)
  8999. {
  9000. if (!layerables.at(i)->realVisibility())
  9001. continue;
  9002. QVariant details;
  9003. double dist = layerables.at(i)->selectTest(pos, onlySelectable, &details);
  9004. if (dist >= 0 && dist < minimumDistance)
  9005. {
  9006. minimumDistance = dist;
  9007. minimumDistanceLayerable = layerables.at(i);
  9008. if (selectionDetails) *selectionDetails = details;
  9009. }
  9010. }
  9011. if (minimumDistance < selectionTolerance())
  9012. return minimumDistanceLayerable;
  9013. }
  9014. return 0;
  9015. }
  9016. /*!
  9017. Saves the plot to a rastered image file \a fileName in the image format \a format. The plot is
  9018. sized to \a width and \a height in pixels and scaled with \a scale. (width 100 and scale 2.0 lead
  9019. to a full resolution file with width 200.) If the \a format supports compression, \a quality may
  9020. be between 0 and 100 to control it.
  9021. Returns true on success. If this function fails, most likely the given \a format isn't supported
  9022. by the system, see Qt docs about QImageWriter::supportedImageFormats().
  9023. \see saveBmp, saveJpg, savePng, savePdf
  9024. */
  9025. bool QCustomPlot::saveRastered(const QString &fileName, int width, int height, double scale, const char *format, int quality)
  9026. {
  9027. QPixmap buffer = toPixmap(width, height, scale);
  9028. if (!buffer.isNull())
  9029. return buffer.save(fileName, format, quality);
  9030. else
  9031. return false;
  9032. }
  9033. /*!
  9034. Renders the plot to a pixmap and returns it.
  9035. The plot is sized to \a width and \a height in pixels and scaled with \a scale. (width 100 and
  9036. scale 2.0 lead to a full resolution pixmap with width 200.)
  9037. \see toPainter, saveRastered, saveBmp, savePng, saveJpg, savePdf
  9038. */
  9039. QPixmap QCustomPlot::toPixmap(int width, int height, double scale)
  9040. {
  9041. // this method is somewhat similar to toPainter. Change something here, and a change in toPainter might be necessary, too.
  9042. int newWidth, newHeight;
  9043. if (width == 0 || height == 0)
  9044. {
  9045. newWidth = this->width();
  9046. newHeight = this->height();
  9047. } else
  9048. {
  9049. newWidth = width;
  9050. newHeight = height;
  9051. }
  9052. int scaledWidth = qRound(scale*newWidth);
  9053. int scaledHeight = qRound(scale*newHeight);
  9054. QPixmap result(scaledWidth, scaledHeight);
  9055. result.fill(mBackgroundBrush.style() == Qt::SolidPattern ? mBackgroundBrush.color() : Qt::transparent); // if using non-solid pattern, make transparent now and draw brush pattern later
  9056. QCPPainter painter;
  9057. painter.begin(&result);
  9058. if (painter.isActive())
  9059. {
  9060. QRect oldViewport = viewport();
  9061. setViewport(QRect(0, 0, newWidth, newHeight));
  9062. painter.setMode(QCPPainter::pmNoCaching);
  9063. if (!qFuzzyCompare(scale, 1.0))
  9064. {
  9065. if (scale > 1.0) // for scale < 1 we always want cosmetic pens where possible, because else lines might disappear for very small scales
  9066. painter.setMode(QCPPainter::pmNonCosmetic);
  9067. painter.scale(scale, scale);
  9068. }
  9069. if (mBackgroundBrush.style() != Qt::SolidPattern && mBackgroundBrush.style() != Qt::NoBrush)
  9070. painter.fillRect(mViewport, mBackgroundBrush);
  9071. draw(&painter);
  9072. setViewport(oldViewport);
  9073. painter.end();
  9074. } else // might happen if pixmap has width or height zero
  9075. {
  9076. qDebug() << Q_FUNC_INFO << "Couldn't activate painter on pixmap";
  9077. return QPixmap();
  9078. }
  9079. return result;
  9080. }
  9081. /*!
  9082. Renders the plot using the passed \a painter.
  9083. The plot is sized to \a width and \a height in pixels. If the \a painter's scale is not 1.0, the resulting plot will
  9084. appear scaled accordingly.
  9085. \note If you are restricted to using a QPainter (instead of QCPPainter), create a temporary QPicture and open a QCPPainter
  9086. on it. Then call \ref toPainter with this QCPPainter. After ending the paint operation on the picture, draw it with
  9087. the QPainter. This will reproduce the painter actions the QCPPainter took, with a QPainter.
  9088. \see toPixmap
  9089. */
  9090. void QCustomPlot::toPainter(QCPPainter *painter, int width, int height)
  9091. {
  9092. // this method is somewhat similar to toPixmap. Change something here, and a change in toPixmap might be necessary, too.
  9093. int newWidth, newHeight;
  9094. if (width == 0 || height == 0)
  9095. {
  9096. newWidth = this->width();
  9097. newHeight = this->height();
  9098. } else
  9099. {
  9100. newWidth = width;
  9101. newHeight = height;
  9102. }
  9103. if (painter->isActive())
  9104. {
  9105. QRect oldViewport = viewport();
  9106. setViewport(QRect(0, 0, newWidth, newHeight));
  9107. painter->setMode(QCPPainter::pmNoCaching);
  9108. // warning: the following is different in toPixmap, because a solid background color is applied there via QPixmap::fill
  9109. // here, we need to do this via QPainter::fillRect.
  9110. if (mBackgroundBrush.style() != Qt::NoBrush)
  9111. painter->fillRect(mViewport, mBackgroundBrush);
  9112. draw(painter);
  9113. setViewport(oldViewport);
  9114. } else
  9115. qDebug() << Q_FUNC_INFO << "Passed painter is not active";
  9116. }
  9117. ////////////////////////////////////////////////////////////////////////////////////////////////////
  9118. //////////////////// QCPData
  9119. ////////////////////////////////////////////////////////////////////////////////////////////////////
  9120. /*! \class QCPData
  9121. \brief Holds the data of one single data point for QCPGraph.
  9122. The container for storing multiple data points is \ref QCPDataMap.
  9123. The stored data is:
  9124. \li \a key: coordinate on the key axis of this data point
  9125. \li \a value: coordinate on the value axis of this data point
  9126. \li \a keyErrorMinus: negative error in the key dimension (for error bars)
  9127. \li \a keyErrorPlus: positive error in the key dimension (for error bars)
  9128. \li \a valueErrorMinus: negative error in the value dimension (for error bars)
  9129. \li \a valueErrorPlus: positive error in the value dimension (for error bars)
  9130. \see QCPDataMap
  9131. */
  9132. /*!
  9133. Constructs a data point with key, value and all errors set to zero.
  9134. */
  9135. QCPData::QCPData() :
  9136. key(0),
  9137. value(0),
  9138. keyErrorPlus(0),
  9139. keyErrorMinus(0),
  9140. valueErrorPlus(0),
  9141. valueErrorMinus(0)
  9142. {
  9143. }
  9144. /*!
  9145. Constructs a data point with the specified \a key and \a value. All errors are set to zero.
  9146. */
  9147. QCPData::QCPData(double key, double value) :
  9148. key(key),
  9149. value(value),
  9150. keyErrorPlus(0),
  9151. keyErrorMinus(0),
  9152. valueErrorPlus(0),
  9153. valueErrorMinus(0)
  9154. {
  9155. }
  9156. ////////////////////////////////////////////////////////////////////////////////////////////////////
  9157. //////////////////// QCPGraph
  9158. ////////////////////////////////////////////////////////////////////////////////////////////////////
  9159. /*! \class QCPGraph
  9160. \brief A plottable representing a graph in a plot.
  9161. \image html QCPGraph.png
  9162. Usually QCustomPlot creates graphs internally via QCustomPlot::addGraph and the resulting
  9163. instance is accessed via QCustomPlot::graph.
  9164. To plot data, assign it with the \ref setData or \ref addData functions.
  9165. Graphs are used to display single-valued data. Single-valued means that there should only be one
  9166. data point per unique key coordinate. In other words, the graph can't have \a loops. If you do
  9167. want to plot non-single-valued curves, rather use the QCPCurve plottable.
  9168. \section appearance Changing the appearance
  9169. The appearance of the graph is mainly determined by the line style, scatter style, brush and pen
  9170. of the graph (\ref setLineStyle, \ref setScatterStyle, \ref setBrush, \ref setPen).
  9171. \subsection filling Filling under or between graphs
  9172. QCPGraph knows two types of fills: Normal graph fills towards the zero-value-line parallel to
  9173. the key axis of the graph, and fills between two graphs, called channel fills. To enable a fill,
  9174. just set a brush with \ref setBrush which is neither Qt::NoBrush nor fully transparent.
  9175. By default, a normal fill towards the zero-value-line will be drawn. To set up a channel fill
  9176. between this graph and another one, call \ref setChannelFillGraph with the other graph as
  9177. parameter.
  9178. \see QCustomPlot::addGraph, QCustomPlot::graph, QCPLegend::addGraph
  9179. */
  9180. /*!
  9181. Constructs a graph which uses \a keyAxis as its key axis ("x") and \a valueAxis as its value
  9182. axis ("y"). \a keyAxis and \a valueAxis must reside in the same QCustomPlot instance and not have
  9183. the same orientation. If either of these restrictions is violated, a corresponding message is
  9184. printed to the debug output (qDebug), the construction is not aborted, though.
  9185. The constructed QCPGraph can be added to the plot with QCustomPlot::addPlottable, QCustomPlot
  9186. then takes ownership of the graph.
  9187. To directly create a graph inside a plot, you can also use the simpler QCustomPlot::addGraph function.
  9188. */
  9189. QCPGraph::QCPGraph(QCPAxis *keyAxis, QCPAxis *valueAxis) :
  9190. QCPAbstractPlottable(keyAxis, valueAxis)
  9191. {
  9192. mData = new QCPDataMap;
  9193. setPen(QPen(Qt::blue, 0));
  9194. setErrorPen(QPen(Qt::black));
  9195. setBrush(Qt::NoBrush);
  9196. setSelectedPen(QPen(QColor(80, 80, 255), 2.5));
  9197. setSelectedBrush(Qt::NoBrush);
  9198. setLineStyle(lsLine);
  9199. setErrorType(etNone);
  9200. setErrorBarSize(6);
  9201. setErrorBarSkipSymbol(true);
  9202. setChannelFillGraph(0);
  9203. }
  9204. QCPGraph::~QCPGraph()
  9205. {
  9206. delete mData;
  9207. }
  9208. /*!
  9209. Replaces the current data with the provided \a data.
  9210. If \a copy is set to true, data points in \a data will only be copied. if false, the graph
  9211. takes ownership of the passed data and replaces the internal data pointer with it. This is
  9212. significantly faster than copying for large datasets.
  9213. */
  9214. void QCPGraph::setData(QCPDataMap *data, bool copy)
  9215. {
  9216. if (copy)
  9217. {
  9218. *mData = *data;
  9219. } else
  9220. {
  9221. delete mData;
  9222. mData = data;
  9223. }
  9224. }
  9225. /*! \overload
  9226. Replaces the current data with the provided points in \a key and \a value pairs. The provided
  9227. vectors should have equal length. Else, the number of added points will be the size of the
  9228. smallest vector.
  9229. */
  9230. void QCPGraph::setData(const QVector<double> &key, const QVector<double> &value)
  9231. {
  9232. mData->clear();
  9233. int n = key.size();
  9234. n = qMin(n, value.size());
  9235. QCPData newData;
  9236. for (int i=0; i<n; ++i)
  9237. {
  9238. newData.key = key[i];
  9239. newData.value = value[i];
  9240. mData->insertMulti(newData.key, newData);
  9241. }
  9242. }
  9243. /*!
  9244. Replaces the current data with the provided points in \a key and \a value pairs. Additionally the
  9245. symmetrical value error of the data points are set to the values in \a valueError.
  9246. For error bars to show appropriately, see \ref setErrorType.
  9247. The provided vectors should have equal length. Else, the number of added points will be the size of the
  9248. smallest vector.
  9249. For asymmetrical errors (plus different from minus), see the overloaded version of this function.
  9250. */
  9251. void QCPGraph::setDataValueError(const QVector<double> &key, const QVector<double> &value, const QVector<double> &valueError)
  9252. {
  9253. mData->clear();
  9254. int n = key.size();
  9255. n = qMin(n, value.size());
  9256. n = qMin(n, valueError.size());
  9257. QCPData newData;
  9258. for (int i=0; i<n; ++i)
  9259. {
  9260. newData.key = key[i];
  9261. newData.value = value[i];
  9262. newData.valueErrorMinus = valueError[i];
  9263. newData.valueErrorPlus = valueError[i];
  9264. mData->insertMulti(key[i], newData);
  9265. }
  9266. }
  9267. /*!
  9268. \overload
  9269. Replaces the current data with the provided points in \a key and \a value pairs. Additionally the
  9270. negative value error of the data points are set to the values in \a valueErrorMinus, the positive
  9271. value error to \a valueErrorPlus.
  9272. For error bars to show appropriately, see \ref setErrorType.
  9273. The provided vectors should have equal length. Else, the number of added points will be the size of the
  9274. smallest vector.
  9275. */
  9276. void QCPGraph::setDataValueError(const QVector<double> &key, const QVector<double> &value, const QVector<double> &valueErrorMinus, const QVector<double> &valueErrorPlus)
  9277. {
  9278. mData->clear();
  9279. int n = key.size();
  9280. n = qMin(n, value.size());
  9281. n = qMin(n, valueErrorMinus.size());
  9282. n = qMin(n, valueErrorPlus.size());
  9283. QCPData newData;
  9284. for (int i=0; i<n; ++i)
  9285. {
  9286. newData.key = key[i];
  9287. newData.value = value[i];
  9288. newData.valueErrorMinus = valueErrorMinus[i];
  9289. newData.valueErrorPlus = valueErrorPlus[i];
  9290. mData->insertMulti(key[i], newData);
  9291. }
  9292. }
  9293. /*!
  9294. Replaces the current data with the provided points in \a key and \a value pairs. Additionally the
  9295. symmetrical key error of the data points are set to the values in \a keyError.
  9296. For error bars to show appropriately, see \ref setErrorType.
  9297. The provided vectors should have equal length. Else, the number of added points will be the size of the
  9298. smallest vector.
  9299. For asymmetrical errors (plus different from minus), see the overloaded version of this function.
  9300. */
  9301. void QCPGraph::setDataKeyError(const QVector<double> &key, const QVector<double> &value, const QVector<double> &keyError)
  9302. {
  9303. mData->clear();
  9304. int n = key.size();
  9305. n = qMin(n, value.size());
  9306. n = qMin(n, keyError.size());
  9307. QCPData newData;
  9308. for (int i=0; i<n; ++i)
  9309. {
  9310. newData.key = key[i];
  9311. newData.value = value[i];
  9312. newData.keyErrorMinus = keyError[i];
  9313. newData.keyErrorPlus = keyError[i];
  9314. mData->insertMulti(key[i], newData);
  9315. }
  9316. }
  9317. /*!
  9318. \overload
  9319. Replaces the current data with the provided points in \a key and \a value pairs. Additionally the
  9320. negative key error of the data points are set to the values in \a keyErrorMinus, the positive
  9321. key error to \a keyErrorPlus.
  9322. For error bars to show appropriately, see \ref setErrorType.
  9323. The provided vectors should have equal length. Else, the number of added points will be the size of the
  9324. smallest vector.
  9325. */
  9326. void QCPGraph::setDataKeyError(const QVector<double> &key, const QVector<double> &value, const QVector<double> &keyErrorMinus, const QVector<double> &keyErrorPlus)
  9327. {
  9328. mData->clear();
  9329. int n = key.size();
  9330. n = qMin(n, value.size());
  9331. n = qMin(n, keyErrorMinus.size());
  9332. n = qMin(n, keyErrorPlus.size());
  9333. QCPData newData;
  9334. for (int i=0; i<n; ++i)
  9335. {
  9336. newData.key = key[i];
  9337. newData.value = value[i];
  9338. newData.keyErrorMinus = keyErrorMinus[i];
  9339. newData.keyErrorPlus = keyErrorPlus[i];
  9340. mData->insertMulti(key[i], newData);
  9341. }
  9342. }
  9343. /*!
  9344. Replaces the current data with the provided points in \a key and \a value pairs. Additionally the
  9345. symmetrical key and value errors of the data points are set to the values in \a keyError and \a valueError.
  9346. For error bars to show appropriately, see \ref setErrorType.
  9347. The provided vectors should have equal length. Else, the number of added points will be the size of the
  9348. smallest vector.
  9349. For asymmetrical errors (plus different from minus), see the overloaded version of this function.
  9350. */
  9351. void QCPGraph::setDataBothError(const QVector<double> &key, const QVector<double> &value, const QVector<double> &keyError, const QVector<double> &valueError)
  9352. {
  9353. mData->clear();
  9354. int n = key.size();
  9355. n = qMin(n, value.size());
  9356. n = qMin(n, valueError.size());
  9357. n = qMin(n, keyError.size());
  9358. QCPData newData;
  9359. for (int i=0; i<n; ++i)
  9360. {
  9361. newData.key = key[i];
  9362. newData.value = value[i];
  9363. newData.keyErrorMinus = keyError[i];
  9364. newData.keyErrorPlus = keyError[i];
  9365. newData.valueErrorMinus = valueError[i];
  9366. newData.valueErrorPlus = valueError[i];
  9367. mData->insertMulti(key[i], newData);
  9368. }
  9369. }
  9370. /*!
  9371. \overload
  9372. Replaces the current data with the provided points in \a key and \a value pairs. Additionally the
  9373. negative key and value errors of the data points are set to the values in \a keyErrorMinus and \a valueErrorMinus. The positive
  9374. key and value errors are set to the values in \a keyErrorPlus \a valueErrorPlus.
  9375. For error bars to show appropriately, see \ref setErrorType.
  9376. The provided vectors should have equal length. Else, the number of added points will be the size of the
  9377. smallest vector.
  9378. */
  9379. void QCPGraph::setDataBothError(const QVector<double> &key, const QVector<double> &value, const QVector<double> &keyErrorMinus, const QVector<double> &keyErrorPlus, const QVector<double> &valueErrorMinus, const QVector<double> &valueErrorPlus)
  9380. {
  9381. mData->clear();
  9382. int n = key.size();
  9383. n = qMin(n, value.size());
  9384. n = qMin(n, valueErrorMinus.size());
  9385. n = qMin(n, valueErrorPlus.size());
  9386. n = qMin(n, keyErrorMinus.size());
  9387. n = qMin(n, keyErrorPlus.size());
  9388. QCPData newData;
  9389. for (int i=0; i<n; ++i)
  9390. {
  9391. newData.key = key[i];
  9392. newData.value = value[i];
  9393. newData.keyErrorMinus = keyErrorMinus[i];
  9394. newData.keyErrorPlus = keyErrorPlus[i];
  9395. newData.valueErrorMinus = valueErrorMinus[i];
  9396. newData.valueErrorPlus = valueErrorPlus[i];
  9397. mData->insertMulti(key[i], newData);
  9398. }
  9399. }
  9400. /*!
  9401. Sets how the single data points are connected in the plot. For scatter-only plots, set \a ls to
  9402. \ref lsNone and \ref setScatterStyle to the desired scatter style.
  9403. \see setScatterStyle
  9404. */
  9405. void QCPGraph::setLineStyle(LineStyle ls)
  9406. {
  9407. mLineStyle = ls;
  9408. }
  9409. /*!
  9410. Sets the visual appearance of single data points in the plot. If set to \ref QCPScatterStyle::ssNone, no scatter points
  9411. are drawn (e.g. for line-only-plots with appropriate line style).
  9412. \see QCPScatterStyle, setLineStyle
  9413. */
  9414. void QCPGraph::setScatterStyle(const QCPScatterStyle &style)
  9415. {
  9416. mScatterStyle = style;
  9417. }
  9418. /*!
  9419. Sets which kind of error bars (Key Error, Value Error or both) should be drawn on each data
  9420. point. If you set \a errorType to something other than \ref etNone, make sure to actually pass
  9421. error data via the specific setData functions along with the data points (e.g. \ref
  9422. setDataValueError, \ref setDataKeyError, \ref setDataBothError).
  9423. \see ErrorType
  9424. */
  9425. void QCPGraph::setErrorType(ErrorType errorType)
  9426. {
  9427. mErrorType = errorType;
  9428. }
  9429. /*!
  9430. Sets the pen with which the error bars will be drawn.
  9431. \see setErrorBarSize, setErrorType
  9432. */
  9433. void QCPGraph::setErrorPen(const QPen &pen)
  9434. {
  9435. mErrorPen = pen;
  9436. }
  9437. /*!
  9438. Sets the width of the handles at both ends of an error bar in pixels.
  9439. */
  9440. void QCPGraph::setErrorBarSize(double size)
  9441. {
  9442. mErrorBarSize = size;
  9443. }
  9444. /*!
  9445. If \a enabled is set to true, the error bar will not be drawn as a solid line under the scatter symbol but
  9446. leave some free space around the symbol.
  9447. This feature uses the current scatter size (\ref QCPScatterStyle::setSize) to determine the size
  9448. of the area to leave blank. So when drawing Pixmaps as scatter points (\ref
  9449. QCPScatterStyle::ssPixmap), the scatter size must be set manually to a value corresponding to the
  9450. size of the Pixmap, if the error bars should leave gaps to its boundaries.
  9451. \ref setErrorType, setErrorBarSize, setScatterStyle
  9452. */
  9453. void QCPGraph::setErrorBarSkipSymbol(bool enabled)
  9454. {
  9455. mErrorBarSkipSymbol = enabled;
  9456. }
  9457. /*!
  9458. Sets the target graph for filling the area between this graph and \a targetGraph with the current
  9459. brush (\ref setBrush).
  9460. When \a targetGraph is set to 0, a normal graph fill to the zero-value-line will be shown. To
  9461. disable any filling, set the brush to Qt::NoBrush.
  9462. \see setBrush
  9463. */
  9464. void QCPGraph::setChannelFillGraph(QCPGraph *targetGraph)
  9465. {
  9466. // prevent setting channel target to this graph itself:
  9467. if (targetGraph == this)
  9468. {
  9469. qDebug() << Q_FUNC_INFO << "targetGraph is this graph itself";
  9470. mChannelFillGraph = 0;
  9471. return;
  9472. }
  9473. // prevent setting channel target to a graph not in the plot:
  9474. if (targetGraph && targetGraph->mParentPlot != mParentPlot)
  9475. {
  9476. qDebug() << Q_FUNC_INFO << "targetGraph not in same plot";
  9477. mChannelFillGraph = 0;
  9478. return;
  9479. }
  9480. mChannelFillGraph = targetGraph;
  9481. }
  9482. /*!
  9483. Adds the provided data points in \a dataMap to the current data.
  9484. \see removeData
  9485. */
  9486. void QCPGraph::addData(const QCPDataMap &dataMap)
  9487. {
  9488. mData->unite(dataMap);
  9489. }
  9490. /*! \overload
  9491. Adds the provided single data point in \a data to the current data.
  9492. \see removeData
  9493. */
  9494. void QCPGraph::addData(const QCPData &data)
  9495. {
  9496. mData->insertMulti(data.key, data);
  9497. }
  9498. /*! \overload
  9499. Adds the provided single data point as \a key and \a value pair to the current data.
  9500. \see removeData
  9501. */
  9502. void QCPGraph::addData(double key, double value)
  9503. {
  9504. QCPData newData;
  9505. newData.key = key;
  9506. newData.value = value;
  9507. mData->insertMulti(newData.key, newData);
  9508. }
  9509. /*! \overload
  9510. Adds the provided data points as \a key and \a value pairs to the current data.
  9511. \see removeData
  9512. */
  9513. void QCPGraph::addData(const QVector<double> &keys, const QVector<double> &values)
  9514. {
  9515. int n = qMin(keys.size(), values.size());
  9516. QCPData newData;
  9517. for (int i=0; i<n; ++i)
  9518. {
  9519. newData.key = keys[i];
  9520. newData.value = values[i];
  9521. mData->insertMulti(newData.key, newData);
  9522. }
  9523. }
  9524. /*!
  9525. Removes all data points with keys smaller than \a key.
  9526. \see addData, clearData
  9527. */
  9528. void QCPGraph::removeDataBefore(double key)
  9529. {
  9530. QCPDataMap::iterator it = mData->begin();
  9531. while (it != mData->end() && it.key() < key)
  9532. it = mData->erase(it);
  9533. }
  9534. /*!
  9535. Removes all data points with keys greater than \a key.
  9536. \see addData, clearData
  9537. */
  9538. void QCPGraph::removeDataAfter(double key)
  9539. {
  9540. if (mData->isEmpty()) return;
  9541. QCPDataMap::iterator it = mData->upperBound(key);
  9542. while (it != mData->end())
  9543. it = mData->erase(it);
  9544. }
  9545. /*!
  9546. Removes all data points with keys between \a fromKey and \a toKey.
  9547. if \a fromKey is greater or equal to \a toKey, the function does nothing. To remove
  9548. a single data point with known key, use \ref removeData(double key).
  9549. \see addData, clearData
  9550. */
  9551. void QCPGraph::removeData(double fromKey, double toKey)
  9552. {
  9553. if (fromKey >= toKey || mData->isEmpty()) return;
  9554. QCPDataMap::iterator it = mData->upperBound(fromKey);
  9555. QCPDataMap::iterator itEnd = mData->upperBound(toKey);
  9556. while (it != itEnd)
  9557. it = mData->erase(it);
  9558. }
  9559. /*! \overload
  9560. Removes a single data point at \a key. If the position is not known with absolute precision,
  9561. consider using \ref removeData(double fromKey, double toKey) with a small fuzziness interval around
  9562. the suspected position, depeding on the precision with which the key is known.
  9563. \see addData, clearData
  9564. */
  9565. void QCPGraph::removeData(double key)
  9566. {
  9567. mData->remove(key);
  9568. }
  9569. /*!
  9570. Removes all data points.
  9571. \see removeData, removeDataAfter, removeDataBefore
  9572. */
  9573. void QCPGraph::clearData()
  9574. {
  9575. mData->clear();
  9576. }
  9577. /* inherits documentation from base class */
  9578. double QCPGraph::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  9579. {
  9580. Q_UNUSED(details)
  9581. if ((onlySelectable && !mSelectable) || mData->isEmpty())
  9582. return -1;
  9583. return pointDistance(pos);
  9584. }
  9585. /*! \overload
  9586. Allows to define whether error bars are taken into consideration when determining the new axis
  9587. range.
  9588. \see rescaleKeyAxis, rescaleValueAxis, QCPAbstractPlottable::rescaleAxes, QCustomPlot::rescaleAxes
  9589. */
  9590. void QCPGraph::rescaleAxes(bool onlyEnlarge, bool includeErrorBars) const
  9591. {
  9592. rescaleKeyAxis(onlyEnlarge, includeErrorBars);
  9593. rescaleValueAxis(onlyEnlarge, includeErrorBars);
  9594. }
  9595. /*! \overload
  9596. Allows to define whether error bars (of kind \ref QCPGraph::etKey) are taken into consideration
  9597. when determining the new axis range.
  9598. \see rescaleAxes, QCPAbstractPlottable::rescaleKeyAxis
  9599. */
  9600. void QCPGraph::rescaleKeyAxis(bool onlyEnlarge, bool includeErrorBars) const
  9601. {
  9602. // this code is a copy of QCPAbstractPlottable::rescaleKeyAxis with the only change
  9603. // that getKeyRange is passed the includeErrorBars value.
  9604. if (mData->isEmpty()) return;
  9605. QCPAxis *keyAxis = mKeyAxis.data();
  9606. if (!keyAxis) { qDebug() << Q_FUNC_INFO << "invalid key axis"; return; }
  9607. SignDomain signDomain = sdBoth;
  9608. if (keyAxis->scaleType() == QCPAxis::stLogarithmic)
  9609. signDomain = (keyAxis->range().upper < 0 ? sdNegative : sdPositive);
  9610. bool validRange;
  9611. QCPRange newRange = getKeyRange(validRange, signDomain, includeErrorBars);
  9612. if (validRange)
  9613. {
  9614. if (onlyEnlarge)
  9615. {
  9616. if (keyAxis->range().lower < newRange.lower)
  9617. newRange.lower = keyAxis->range().lower;
  9618. if (keyAxis->range().upper > newRange.upper)
  9619. newRange.upper = keyAxis->range().upper;
  9620. }
  9621. keyAxis->setRange(newRange);
  9622. }
  9623. }
  9624. /*! \overload
  9625. Allows to define whether error bars (of kind \ref QCPGraph::etValue) are taken into consideration
  9626. when determining the new axis range.
  9627. \see rescaleAxes, QCPAbstractPlottable::rescaleValueAxis
  9628. */
  9629. void QCPGraph::rescaleValueAxis(bool onlyEnlarge, bool includeErrorBars) const
  9630. {
  9631. // this code is a copy of QCPAbstractPlottable::rescaleValueAxis with the only change
  9632. // is that getValueRange is passed the includeErrorBars value.
  9633. if (mData->isEmpty()) return;
  9634. QCPAxis *valueAxis = mValueAxis.data();
  9635. if (!valueAxis) { qDebug() << Q_FUNC_INFO << "invalid value axis"; return; }
  9636. SignDomain signDomain = sdBoth;
  9637. if (valueAxis->scaleType() == QCPAxis::stLogarithmic)
  9638. signDomain = (valueAxis->range().upper < 0 ? sdNegative : sdPositive);
  9639. bool validRange;
  9640. QCPRange newRange = getValueRange(validRange, signDomain, includeErrorBars);
  9641. if (validRange)
  9642. {
  9643. if (onlyEnlarge)
  9644. {
  9645. if (valueAxis->range().lower < newRange.lower)
  9646. newRange.lower = valueAxis->range().lower;
  9647. if (valueAxis->range().upper > newRange.upper)
  9648. newRange.upper = valueAxis->range().upper;
  9649. }
  9650. valueAxis->setRange(newRange);
  9651. }
  9652. }
  9653. /* inherits documentation from base class */
  9654. void QCPGraph::draw(QCPPainter *painter)
  9655. {
  9656. if (!mKeyAxis || !mValueAxis) { qDebug() << Q_FUNC_INFO << "invalid key or value axis"; return; }
  9657. if (mKeyAxis.data()->range().size() <= 0 || mData->isEmpty()) return;
  9658. if (mLineStyle == lsNone && mScatterStyle.isNone()) return;
  9659. // allocate line and (if necessary) point vectors:
  9660. QVector<QPointF> *lineData = new QVector<QPointF>;
  9661. QVector<QCPData> *pointData = 0;
  9662. if (!mScatterStyle.isNone())
  9663. pointData = new QVector<QCPData>;
  9664. // fill vectors with data appropriate to plot style:
  9665. getPlotData(lineData, pointData);
  9666. // check data validity if flag set:
  9667. #ifdef QCUSTOMPLOT_CHECK_DATA
  9668. QCPDataMap::const_iterator it;
  9669. for (it = mData->constBegin(); it != mData->constEnd(); ++it)
  9670. {
  9671. if (QCP::isInvalidData(it.value().key, it.value().value) ||
  9672. QCP::isInvalidData(it.value().keyErrorPlus, it.value().keyErrorMinus) ||
  9673. QCP::isInvalidData(it.value().valueErrorPlus, it.value().valueErrorPlus))
  9674. qDebug() << Q_FUNC_INFO << "Data point at" << it.key() << "invalid." << "Plottable name:" << name();
  9675. }
  9676. #endif
  9677. // draw fill of graph:
  9678. drawFill(painter, lineData);
  9679. // draw line:
  9680. if (mLineStyle == lsImpulse)
  9681. drawImpulsePlot(painter, lineData);
  9682. else if (mLineStyle != lsNone)
  9683. drawLinePlot(painter, lineData); // also step plots can be drawn as a line plot
  9684. // draw scatters:
  9685. if (pointData)
  9686. drawScatterPlot(painter, pointData);
  9687. // free allocated line and point vectors:
  9688. delete lineData;
  9689. if (pointData)
  9690. delete pointData;
  9691. }
  9692. /* inherits documentation from base class */
  9693. void QCPGraph::drawLegendIcon(QCPPainter *painter, const QRectF &rect) const
  9694. {
  9695. // draw fill:
  9696. if (mBrush.style() != Qt::NoBrush)
  9697. {
  9698. applyFillAntialiasingHint(painter);
  9699. painter->fillRect(QRectF(rect.left(), rect.top()+rect.height()/2.0, rect.width(), rect.height()/3.0), mBrush);
  9700. }
  9701. // draw line vertically centered:
  9702. if (mLineStyle != lsNone)
  9703. {
  9704. applyDefaultAntialiasingHint(painter);
  9705. painter->setPen(mPen);
  9706. painter->drawLine(QLineF(rect.left(), rect.top()+rect.height()/2.0, rect.right()+5, rect.top()+rect.height()/2.0)); // +5 on x2 else last segment is missing from dashed/dotted pens
  9707. }
  9708. // draw scatter symbol:
  9709. if (!mScatterStyle.isNone())
  9710. {
  9711. applyScattersAntialiasingHint(painter);
  9712. // scale scatter pixmap if it's too large to fit in legend icon rect:
  9713. if (mScatterStyle.shape() == QCPScatterStyle::ssPixmap && (mScatterStyle.pixmap().size().width() > rect.width() || mScatterStyle.pixmap().size().height() > rect.height()))
  9714. {
  9715. QCPScatterStyle scaledStyle(mScatterStyle);
  9716. scaledStyle.setPixmap(scaledStyle.pixmap().scaled(rect.size().toSize(), Qt::KeepAspectRatio, Qt::SmoothTransformation));
  9717. scaledStyle.applyTo(painter, mPen);
  9718. scaledStyle.drawShape(painter, QRectF(rect).center());
  9719. } else
  9720. {
  9721. mScatterStyle.applyTo(painter, mPen);
  9722. mScatterStyle.drawShape(painter, QRectF(rect).center());
  9723. }
  9724. }
  9725. }
  9726. /*! \internal
  9727. This function branches out to the line style specific "get(...)PlotData" functions, according to
  9728. the line style of the graph.
  9729. \a lineData will be filled with raw points that will be drawn with the according draw functions,
  9730. e.g. \ref drawLinePlot and \ref drawImpulsePlot. These aren't necessarily the original data
  9731. points, since for step plots for example, additional points are needed for drawing lines that
  9732. make up steps. If the line style of the graph is \ref lsNone, the \a lineData vector will be left
  9733. untouched.
  9734. \a pointData will be filled with the original data points so \ref drawScatterPlot can draw the
  9735. scatter symbols accordingly. If no scatters need to be drawn, i.e. the scatter style's shape is
  9736. \ref QCPScatterStyle::ssNone, pass 0 as \a pointData, and this step will be skipped.
  9737. \see getScatterPlotData, getLinePlotData, getStepLeftPlotData, getStepRightPlotData,
  9738. getStepCenterPlotData, getImpulsePlotData
  9739. */
  9740. void QCPGraph::getPlotData(QVector<QPointF> *lineData, QVector<QCPData> *pointData) const
  9741. {
  9742. switch(mLineStyle)
  9743. {
  9744. case lsNone: getScatterPlotData(pointData); break;
  9745. case lsLine: getLinePlotData(lineData, pointData); break;
  9746. case lsStepLeft: getStepLeftPlotData(lineData, pointData); break;
  9747. case lsStepRight: getStepRightPlotData(lineData, pointData); break;
  9748. case lsStepCenter: getStepCenterPlotData(lineData, pointData); break;
  9749. case lsImpulse: getImpulsePlotData(lineData, pointData); break;
  9750. }
  9751. }
  9752. /*! \internal
  9753. If line style is \ref lsNone and the scatter style's shape is not \ref QCPScatterStyle::ssNone,
  9754. this function serves at providing the visible data points in \a pointData, so the \ref
  9755. drawScatterPlot function can draw the scatter points accordingly.
  9756. If line style is not \ref lsNone, this function is not called and the data for the scatter points
  9757. are (if needed) calculated inside the corresponding other "get(...)PlotData" functions.
  9758. \see drawScatterPlot
  9759. */
  9760. void QCPGraph::getScatterPlotData(QVector<QCPData> *pointData) const
  9761. {
  9762. if (!pointData) return;
  9763. QCPAxis *keyAxis = mKeyAxis.data();
  9764. if (!keyAxis) { qDebug() << Q_FUNC_INFO << "invalid key axis"; return; }
  9765. // get visible data range:
  9766. QCPDataMap::const_iterator lower, upper;
  9767. int dataCount = 0;
  9768. getVisibleDataBounds(lower, upper, dataCount);
  9769. if (dataCount > 0)
  9770. {
  9771. // prepare vectors:
  9772. pointData->resize(dataCount);
  9773. // position data points:
  9774. QCPDataMap::const_iterator it = lower;
  9775. QCPDataMap::const_iterator upperEnd = upper+1;
  9776. int i = 0;
  9777. while (it != upperEnd)
  9778. {
  9779. (*pointData)[i] = it.value();
  9780. ++i;
  9781. ++it;
  9782. }
  9783. }
  9784. }
  9785. /*! \internal
  9786. Places the raw data points needed for a normal linearly connected graph in \a lineData.
  9787. As for all plot data retrieval functions, \a pointData just contains all unaltered data (scatter)
  9788. points that are visible for drawing scatter points, if necessary. If drawing scatter points is
  9789. disabled (i.e. the scatter style's shape is \ref QCPScatterStyle::ssNone), pass 0 as \a
  9790. pointData, and the function will skip filling the vector.
  9791. \see drawLinePlot
  9792. */
  9793. void QCPGraph::getLinePlotData(QVector<QPointF> *lineData, QVector<QCPData> *pointData) const
  9794. {
  9795. QCPAxis *keyAxis = mKeyAxis.data();
  9796. QCPAxis *valueAxis = mValueAxis.data();
  9797. if (!keyAxis || !valueAxis) { qDebug() << Q_FUNC_INFO << "invalid key or value axis"; return; }
  9798. if (!lineData) { qDebug() << Q_FUNC_INFO << "null pointer passed as lineData"; return; }
  9799. // get visible data range:
  9800. QCPDataMap::const_iterator lower, upper;
  9801. int dataCount = 0;
  9802. getVisibleDataBounds(lower, upper, dataCount);
  9803. if (dataCount > 0)
  9804. {
  9805. lineData->reserve(dataCount+2); // added 2 to reserve memory for lower/upper fill base points that might be needed for fill
  9806. lineData->resize(dataCount);
  9807. if (pointData)
  9808. pointData->resize(dataCount);
  9809. // position data points:
  9810. QCPDataMap::const_iterator it = lower;
  9811. QCPDataMap::const_iterator upperEnd = upper+1;
  9812. int i = 0;
  9813. if (keyAxis->orientation() == Qt::Vertical)
  9814. {
  9815. while (it != upperEnd)
  9816. {
  9817. if (pointData)
  9818. (*pointData)[i] = it.value();
  9819. (*lineData)[i].setX(valueAxis->coordToPixel(it.value().value));
  9820. (*lineData)[i].setY(keyAxis->coordToPixel(it.key()));
  9821. ++i;
  9822. ++it;
  9823. }
  9824. } else // key axis is horizontal
  9825. {
  9826. while (it != upperEnd)
  9827. {
  9828. if (pointData)
  9829. (*pointData)[i] = it.value();
  9830. (*lineData)[i].setX(keyAxis->coordToPixel(it.key()));
  9831. (*lineData)[i].setY(valueAxis->coordToPixel(it.value().value));
  9832. ++i;
  9833. ++it;
  9834. }
  9835. }
  9836. }
  9837. }
  9838. /*!
  9839. \internal
  9840. Places the raw data points needed for a step plot with left oriented steps in \a lineData.
  9841. As for all plot data retrieval functions, \a pointData just contains all unaltered data (scatter)
  9842. points that are visible for drawing scatter points, if necessary. If drawing scatter points is
  9843. disabled (i.e. the scatter style's shape is \ref QCPScatterStyle::ssNone), pass 0 as \a
  9844. pointData, and the function will skip filling the vector.
  9845. \see drawLinePlot
  9846. */
  9847. void QCPGraph::getStepLeftPlotData(QVector<QPointF> *lineData, QVector<QCPData> *pointData) const
  9848. {
  9849. QCPAxis *keyAxis = mKeyAxis.data();
  9850. QCPAxis *valueAxis = mValueAxis.data();
  9851. if (!keyAxis || !valueAxis) { qDebug() << Q_FUNC_INFO << "invalid key or value axis"; return; }
  9852. if (!lineData) { qDebug() << Q_FUNC_INFO << "null pointer passed as lineData"; return; }
  9853. // get visible data range:
  9854. QCPDataMap::const_iterator lower, upper;
  9855. int dataCount = 0;
  9856. getVisibleDataBounds(lower, upper, dataCount);
  9857. if (dataCount > 0)
  9858. {
  9859. lineData->reserve(dataCount*2+2); // added 2 to reserve memory for lower/upper fill base points that might be needed for fill
  9860. lineData->resize(dataCount*2); // multiplied by 2 because step plot needs two polyline points per one actual data point
  9861. if (pointData)
  9862. pointData->resize(dataCount);
  9863. // position data points:
  9864. QCPDataMap::const_iterator it = lower;
  9865. QCPDataMap::const_iterator upperEnd = upper+1;
  9866. int i = 0;
  9867. int ipoint = 0;
  9868. if (keyAxis->orientation() == Qt::Vertical)
  9869. {
  9870. double lastValue = valueAxis->coordToPixel(it.value().value);
  9871. double key;
  9872. while (it != upperEnd)
  9873. {
  9874. if (pointData)
  9875. {
  9876. (*pointData)[ipoint] = it.value();
  9877. ++ipoint;
  9878. }
  9879. key = keyAxis->coordToPixel(it.key());
  9880. (*lineData)[i].setX(lastValue);
  9881. (*lineData)[i].setY(key);
  9882. ++i;
  9883. lastValue = valueAxis->coordToPixel(it.value().value);
  9884. (*lineData)[i].setX(lastValue);
  9885. (*lineData)[i].setY(key);
  9886. ++i;
  9887. ++it;
  9888. }
  9889. } else // key axis is horizontal
  9890. {
  9891. double lastValue = valueAxis->coordToPixel(it.value().value);
  9892. double key;
  9893. while (it != upperEnd)
  9894. {
  9895. if (pointData)
  9896. {
  9897. (*pointData)[ipoint] = it.value();
  9898. ++ipoint;
  9899. }
  9900. key = keyAxis->coordToPixel(it.key());
  9901. (*lineData)[i].setX(key);
  9902. (*lineData)[i].setY(lastValue);
  9903. ++i;
  9904. lastValue = valueAxis->coordToPixel(it.value().value);
  9905. (*lineData)[i].setX(key);
  9906. (*lineData)[i].setY(lastValue);
  9907. ++i;
  9908. ++it;
  9909. }
  9910. }
  9911. }
  9912. }
  9913. /*!
  9914. \internal
  9915. Places the raw data points needed for a step plot with right oriented steps in \a lineData.
  9916. As for all plot data retrieval functions, \a pointData just contains all unaltered data (scatter)
  9917. points that are visible for drawing scatter points, if necessary. If drawing scatter points is
  9918. disabled (i.e. the scatter style's shape is \ref QCPScatterStyle::ssNone), pass 0 as \a
  9919. pointData, and the function will skip filling the vector.
  9920. \see drawLinePlot
  9921. */
  9922. void QCPGraph::getStepRightPlotData(QVector<QPointF> *lineData, QVector<QCPData> *pointData) const
  9923. {
  9924. QCPAxis *keyAxis = mKeyAxis.data();
  9925. QCPAxis *valueAxis = mValueAxis.data();
  9926. if (!keyAxis || !valueAxis) { qDebug() << Q_FUNC_INFO << "invalid key or value axis"; return; }
  9927. if (!lineData) { qDebug() << Q_FUNC_INFO << "null pointer passed as lineData"; return; }
  9928. // get visible data range:
  9929. QCPDataMap::const_iterator lower, upper;
  9930. int dataCount = 0;
  9931. getVisibleDataBounds(lower, upper, dataCount);
  9932. if (dataCount > 0)
  9933. {
  9934. lineData->reserve(dataCount*2+2); // added 2 to reserve memory for lower/upper fill base points that might be needed for fill
  9935. lineData->resize(dataCount*2); // multiplied by 2 because step plot needs two polyline points per one actual data point
  9936. if (pointData)
  9937. pointData->resize(dataCount);
  9938. // position points:
  9939. QCPDataMap::const_iterator it = lower;
  9940. QCPDataMap::const_iterator upperEnd = upper+1;
  9941. int i = 0;
  9942. int ipoint = 0;
  9943. if (keyAxis->orientation() == Qt::Vertical)
  9944. {
  9945. double lastKey = keyAxis->coordToPixel(it.key());
  9946. double value;
  9947. while (it != upperEnd)
  9948. {
  9949. if (pointData)
  9950. {
  9951. (*pointData)[ipoint] = it.value();
  9952. ++ipoint;
  9953. }
  9954. value = valueAxis->coordToPixel(it.value().value);
  9955. (*lineData)[i].setX(value);
  9956. (*lineData)[i].setY(lastKey);
  9957. ++i;
  9958. lastKey = keyAxis->coordToPixel(it.key());
  9959. (*lineData)[i].setX(value);
  9960. (*lineData)[i].setY(lastKey);
  9961. ++i;
  9962. ++it;
  9963. }
  9964. } else // key axis is horizontal
  9965. {
  9966. double lastKey = keyAxis->coordToPixel(it.key());
  9967. double value;
  9968. while (it != upperEnd)
  9969. {
  9970. if (pointData)
  9971. {
  9972. (*pointData)[ipoint] = it.value();
  9973. ++ipoint;
  9974. }
  9975. value = valueAxis->coordToPixel(it.value().value);
  9976. (*lineData)[i].setX(lastKey);
  9977. (*lineData)[i].setY(value);
  9978. ++i;
  9979. lastKey = keyAxis->coordToPixel(it.key());
  9980. (*lineData)[i].setX(lastKey);
  9981. (*lineData)[i].setY(value);
  9982. ++i;
  9983. ++it;
  9984. }
  9985. }
  9986. }
  9987. }
  9988. /*!
  9989. \internal
  9990. Places the raw data points needed for a step plot with centered steps in \a lineData.
  9991. As for all plot data retrieval functions, \a pointData just contains all unaltered data (scatter)
  9992. points that are visible for drawing scatter points, if necessary. If drawing scatter points is
  9993. disabled (i.e. the scatter style's shape is \ref QCPScatterStyle::ssNone), pass 0 as \a
  9994. pointData, and the function will skip filling the vector.
  9995. \see drawLinePlot
  9996. */
  9997. void QCPGraph::getStepCenterPlotData(QVector<QPointF> *lineData, QVector<QCPData> *pointData) const
  9998. {
  9999. QCPAxis *keyAxis = mKeyAxis.data();
  10000. QCPAxis *valueAxis = mValueAxis.data();
  10001. if (!keyAxis || !valueAxis) { qDebug() << Q_FUNC_INFO << "invalid key or value axis"; return; }
  10002. if (!lineData) { qDebug() << Q_FUNC_INFO << "null pointer passed as lineData"; return; }
  10003. // get visible data range:
  10004. QCPDataMap::const_iterator lower, upper;
  10005. int dataCount = 0;
  10006. getVisibleDataBounds(lower, upper, dataCount);
  10007. if (dataCount > 0)
  10008. {
  10009. // added 2 to reserve memory for lower/upper fill base points that might be needed for base fill
  10010. // multiplied by 2 because step plot needs two polyline points per one actual data point
  10011. lineData->reserve(dataCount*2+2);
  10012. lineData->resize(dataCount*2);
  10013. if (pointData)
  10014. pointData->resize(dataCount);
  10015. // position points:
  10016. QCPDataMap::const_iterator it = lower;
  10017. QCPDataMap::const_iterator upperEnd = upper+1;
  10018. int i = 0;
  10019. int ipoint = 0;
  10020. if (keyAxis->orientation() == Qt::Vertical)
  10021. {
  10022. double lastKey = keyAxis->coordToPixel(it.key());
  10023. double lastValue = valueAxis->coordToPixel(it.value().value);
  10024. double key;
  10025. if (pointData)
  10026. {
  10027. (*pointData)[ipoint] = it.value();
  10028. ++ipoint;
  10029. }
  10030. (*lineData)[i].setX(lastValue);
  10031. (*lineData)[i].setY(lastKey);
  10032. ++it;
  10033. ++i;
  10034. while (it != upperEnd)
  10035. {
  10036. if (pointData)
  10037. {
  10038. (*pointData)[ipoint] = it.value();
  10039. ++ipoint;
  10040. }
  10041. key = (keyAxis->coordToPixel(it.key())-lastKey)*0.5 + lastKey;
  10042. (*lineData)[i].setX(lastValue);
  10043. (*lineData)[i].setY(key);
  10044. ++i;
  10045. lastValue = valueAxis->coordToPixel(it.value().value);
  10046. lastKey = keyAxis->coordToPixel(it.key());
  10047. (*lineData)[i].setX(lastValue);
  10048. (*lineData)[i].setY(key);
  10049. ++it;
  10050. ++i;
  10051. }
  10052. (*lineData)[i].setX(lastValue);
  10053. (*lineData)[i].setY(lastKey);
  10054. } else // key axis is horizontal
  10055. {
  10056. double lastKey = keyAxis->coordToPixel(it.key());
  10057. double lastValue = valueAxis->coordToPixel(it.value().value);
  10058. double key;
  10059. if (pointData)
  10060. {
  10061. (*pointData)[ipoint] = it.value();
  10062. ++ipoint;
  10063. }
  10064. (*lineData)[i].setX(lastKey);
  10065. (*lineData)[i].setY(lastValue);
  10066. ++it;
  10067. ++i;
  10068. while (it != upperEnd)
  10069. {
  10070. if (pointData)
  10071. {
  10072. (*pointData)[ipoint] = it.value();
  10073. ++ipoint;
  10074. }
  10075. key = (keyAxis->coordToPixel(it.key())-lastKey)*0.5 + lastKey;
  10076. (*lineData)[i].setX(key);
  10077. (*lineData)[i].setY(lastValue);
  10078. ++i;
  10079. lastValue = valueAxis->coordToPixel(it.value().value);
  10080. lastKey = keyAxis->coordToPixel(it.key());
  10081. (*lineData)[i].setX(key);
  10082. (*lineData)[i].setY(lastValue);
  10083. ++it;
  10084. ++i;
  10085. }
  10086. (*lineData)[i].setX(lastKey);
  10087. (*lineData)[i].setY(lastValue);
  10088. }
  10089. }
  10090. }
  10091. /*!
  10092. \internal
  10093. Places the raw data points needed for an impulse plot in \a lineData.
  10094. As for all plot data retrieval functions, \a pointData just contains all unaltered data (scatter)
  10095. points that are visible for drawing scatter points, if necessary. If drawing scatter points is
  10096. disabled (i.e. the scatter style's shape is \ref QCPScatterStyle::ssNone), pass 0 as \a
  10097. pointData, and the function will skip filling the vector.
  10098. \see drawImpulsePlot
  10099. */
  10100. void QCPGraph::getImpulsePlotData(QVector<QPointF> *lineData, QVector<QCPData> *pointData) const
  10101. {
  10102. QCPAxis *keyAxis = mKeyAxis.data();
  10103. QCPAxis *valueAxis = mValueAxis.data();
  10104. if (!keyAxis || !valueAxis) { qDebug() << Q_FUNC_INFO << "invalid key or value axis"; return; }
  10105. if (!lineData) { qDebug() << Q_FUNC_INFO << "null pointer passed as lineData"; return; }
  10106. // get visible data range:
  10107. QCPDataMap::const_iterator lower, upper;
  10108. int dataCount = 0;
  10109. getVisibleDataBounds(lower, upper, dataCount);
  10110. if (dataCount > 0)
  10111. {
  10112. lineData->resize(dataCount*2); // no need to reserve 2 extra points, because there is no fill for impulse plot
  10113. if (pointData)
  10114. pointData->resize(dataCount);
  10115. // position data points:
  10116. QCPDataMap::const_iterator it = lower;
  10117. QCPDataMap::const_iterator upperEnd = upper+1;
  10118. int i = 0;
  10119. int ipoint = 0;
  10120. if (keyAxis->orientation() == Qt::Vertical)
  10121. {
  10122. double zeroPointX = valueAxis->coordToPixel(0);
  10123. double key;
  10124. while (it != upperEnd)
  10125. {
  10126. if (pointData)
  10127. {
  10128. (*pointData)[ipoint] = it.value();
  10129. ++ipoint;
  10130. }
  10131. key = keyAxis->coordToPixel(it.key());
  10132. (*lineData)[i].setX(zeroPointX);
  10133. (*lineData)[i].setY(key);
  10134. ++i;
  10135. (*lineData)[i].setX(valueAxis->coordToPixel(it.value().value));
  10136. (*lineData)[i].setY(key);
  10137. ++i;
  10138. ++it;
  10139. }
  10140. } else // key axis is horizontal
  10141. {
  10142. double zeroPointY = valueAxis->coordToPixel(0);
  10143. double key;
  10144. while (it != upperEnd)
  10145. {
  10146. if (pointData)
  10147. {
  10148. (*pointData)[ipoint] = it.value();
  10149. ++ipoint;
  10150. }
  10151. key = keyAxis->coordToPixel(it.key());
  10152. (*lineData)[i].setX(key);
  10153. (*lineData)[i].setY(zeroPointY);
  10154. ++i;
  10155. (*lineData)[i].setX(key);
  10156. (*lineData)[i].setY(valueAxis->coordToPixel(it.value().value));
  10157. ++i;
  10158. ++it;
  10159. }
  10160. }
  10161. }
  10162. }
  10163. /*! \internal
  10164. Draws the fill of the graph with the specified brush.
  10165. If the fill is a normal fill towards the zero-value-line, only the \a lineData is required (and
  10166. two extra points at the zero-value-line, which are added by \ref addFillBasePoints and removed by
  10167. \ref removeFillBasePoints after the fill drawing is done).
  10168. If the fill is a channel fill between this QCPGraph and another QCPGraph (mChannelFillGraph), the
  10169. more complex polygon is calculated with the \ref getChannelFillPolygon function.
  10170. \see drawLinePlot
  10171. */
  10172. void QCPGraph::drawFill(QCPPainter *painter, QVector<QPointF> *lineData) const
  10173. {
  10174. if (mLineStyle == lsImpulse) return; // fill doesn't make sense for impulse plot
  10175. if (mainBrush().style() == Qt::NoBrush || mainBrush().color().alpha() == 0) return;
  10176. applyFillAntialiasingHint(painter);
  10177. if (!mChannelFillGraph)
  10178. {
  10179. // draw base fill under graph, fill goes all the way to the zero-value-line:
  10180. addFillBasePoints(lineData);
  10181. painter->setPen(Qt::NoPen);
  10182. painter->setBrush(mainBrush());
  10183. painter->drawPolygon(QPolygonF(*lineData));
  10184. removeFillBasePoints(lineData);
  10185. } else
  10186. {
  10187. // draw channel fill between this graph and mChannelFillGraph:
  10188. painter->setPen(Qt::NoPen);
  10189. painter->setBrush(mainBrush());
  10190. painter->drawPolygon(getChannelFillPolygon(lineData));
  10191. }
  10192. }
  10193. /*! \internal
  10194. Draws scatter symbols at every data point passed in \a pointData. scatter symbols are independent
  10195. of the line style and are always drawn if the scatter style's shape is not \ref
  10196. QCPScatterStyle::ssNone. Hence, the \a pointData vector is outputted by all "get(...)PlotData"
  10197. functions, together with the (line style dependent) line data.
  10198. \see drawLinePlot, drawImpulsePlot
  10199. */
  10200. void QCPGraph::drawScatterPlot(QCPPainter *painter, QVector<QCPData> *pointData) const
  10201. {
  10202. QCPAxis *keyAxis = mKeyAxis.data();
  10203. QCPAxis *valueAxis = mValueAxis.data();
  10204. if (!keyAxis || !valueAxis) { qDebug() << Q_FUNC_INFO << "invalid key or value axis"; return; }
  10205. // draw error bars:
  10206. if (mErrorType != etNone)
  10207. {
  10208. applyErrorBarsAntialiasingHint(painter);
  10209. painter->setPen(mErrorPen);
  10210. if (keyAxis->orientation() == Qt::Vertical)
  10211. {
  10212. for (int i=0; i<pointData->size(); ++i)
  10213. drawError(painter, valueAxis->coordToPixel(pointData->at(i).value), keyAxis->coordToPixel(pointData->at(i).key), pointData->at(i));
  10214. } else
  10215. {
  10216. for (int i=0; i<pointData->size(); ++i)
  10217. drawError(painter, keyAxis->coordToPixel(pointData->at(i).key), valueAxis->coordToPixel(pointData->at(i).value), pointData->at(i));
  10218. }
  10219. }
  10220. // draw scatter point symbols:
  10221. applyScattersAntialiasingHint(painter);
  10222. mScatterStyle.applyTo(painter, mPen);
  10223. if (keyAxis->orientation() == Qt::Vertical)
  10224. {
  10225. for (int i=0; i<pointData->size(); ++i)
  10226. mScatterStyle.drawShape(painter, valueAxis->coordToPixel(pointData->at(i).value), keyAxis->coordToPixel(pointData->at(i).key));
  10227. } else
  10228. {
  10229. for (int i=0; i<pointData->size(); ++i)
  10230. mScatterStyle.drawShape(painter, keyAxis->coordToPixel(pointData->at(i).key), valueAxis->coordToPixel(pointData->at(i).value));
  10231. }
  10232. }
  10233. /*! \internal
  10234. Draws line graphs from the provided data. It connects all points in \a lineData, which was
  10235. created by one of the "get(...)PlotData" functions for line styles that require simple line
  10236. connections between the point vector they create. These are for example \ref getLinePlotData,
  10237. \ref getStepLeftPlotData, \ref getStepRightPlotData and \ref getStepCenterPlotData.
  10238. \see drawScatterPlot, drawImpulsePlot
  10239. */
  10240. void QCPGraph::drawLinePlot(QCPPainter *painter, QVector<QPointF> *lineData) const
  10241. {
  10242. // draw line of graph:
  10243. if (mainPen().style() != Qt::NoPen && mainPen().color().alpha() != 0)
  10244. {
  10245. applyDefaultAntialiasingHint(painter);
  10246. painter->setPen(mainPen());
  10247. painter->setBrush(Qt::NoBrush);
  10248. /* Draws polyline in batches, currently not used:
  10249. int p = 0;
  10250. while (p < lineData->size())
  10251. {
  10252. int batch = qMin(25, lineData->size()-p);
  10253. if (p != 0)
  10254. {
  10255. ++batch;
  10256. --p; // to draw the connection lines between two batches
  10257. }
  10258. painter->drawPolyline(lineData->constData()+p, batch);
  10259. p += batch;
  10260. }
  10261. */
  10262. // if drawing solid line and not in PDF, use much faster line drawing instead of polyline:
  10263. if (mParentPlot->plottingHints().testFlag(QCP::phFastPolylines) &&
  10264. painter->pen().style() == Qt::SolidLine &&
  10265. !painter->modes().testFlag(QCPPainter::pmVectorized)&&
  10266. !painter->modes().testFlag(QCPPainter::pmNoCaching))
  10267. {
  10268. for (int i=1; i<lineData->size(); ++i)
  10269. painter->drawLine(lineData->at(i-1), lineData->at(i));
  10270. } else
  10271. {
  10272. painter->drawPolyline(QPolygonF(*lineData));
  10273. }
  10274. }
  10275. }
  10276. /*! \internal
  10277. Draws impulses from the provided data, i.e. it connects all line pairs in \a lineData, which was
  10278. created by \ref getImpulsePlotData.
  10279. \see drawScatterPlot, drawLinePlot
  10280. */
  10281. void QCPGraph::drawImpulsePlot(QCPPainter *painter, QVector<QPointF> *lineData) const
  10282. {
  10283. // draw impulses:
  10284. if (mainPen().style() != Qt::NoPen && mainPen().color().alpha() != 0)
  10285. {
  10286. applyDefaultAntialiasingHint(painter);
  10287. QPen pen = mainPen();
  10288. pen.setCapStyle(Qt::FlatCap); // so impulse line doesn't reach beyond zero-line
  10289. painter->setPen(pen);
  10290. painter->setBrush(Qt::NoBrush);
  10291. painter->drawLines(*lineData);
  10292. }
  10293. }
  10294. /*! \internal
  10295. called by the scatter drawing function (\ref drawScatterPlot) to draw the error bars on one data
  10296. point. \a x and \a y pixel positions of the data point are passed since they are already known in
  10297. pixel coordinates in the drawing function, so we save some extra coordToPixel transforms here. \a
  10298. data is therefore only used for the errors, not key and value.
  10299. */
  10300. void QCPGraph::drawError(QCPPainter *painter, double x, double y, const QCPData &data) const
  10301. {
  10302. QCPAxis *keyAxis = mKeyAxis.data();
  10303. QCPAxis *valueAxis = mValueAxis.data();
  10304. if (!keyAxis || !valueAxis) { qDebug() << Q_FUNC_INFO << "invalid key or value axis"; return; }
  10305. double a, b; // positions of error bar bounds in pixels
  10306. double barWidthHalf = mErrorBarSize*0.5;
  10307. double skipSymbolMargin = mScatterStyle.size(); // pixels left blank per side, when mErrorBarSkipSymbol is true
  10308. if (keyAxis->orientation() == Qt::Vertical)
  10309. {
  10310. // draw key error vertically and value error horizontally
  10311. if (mErrorType == etKey || mErrorType == etBoth)
  10312. {
  10313. a = keyAxis->coordToPixel(data.key-data.keyErrorMinus);
  10314. b = keyAxis->coordToPixel(data.key+data.keyErrorPlus);
  10315. if (keyAxis->rangeReversed())
  10316. qSwap(a,b);
  10317. // draw spine:
  10318. if (mErrorBarSkipSymbol)
  10319. {
  10320. if (a-y > skipSymbolMargin) // don't draw spine if error is so small it's within skipSymbolmargin
  10321. painter->drawLine(QLineF(x, a, x, y+skipSymbolMargin));
  10322. if (y-b > skipSymbolMargin)
  10323. painter->drawLine(QLineF(x, y-skipSymbolMargin, x, b));
  10324. } else
  10325. painter->drawLine(QLineF(x, a, x, b));
  10326. // draw handles:
  10327. painter->drawLine(QLineF(x-barWidthHalf, a, x+barWidthHalf, a));
  10328. painter->drawLine(QLineF(x-barWidthHalf, b, x+barWidthHalf, b));
  10329. }
  10330. if (mErrorType == etValue || mErrorType == etBoth)
  10331. {
  10332. a = valueAxis->coordToPixel(data.value-data.valueErrorMinus);
  10333. b = valueAxis->coordToPixel(data.value+data.valueErrorPlus);
  10334. if (valueAxis->rangeReversed())
  10335. qSwap(a,b);
  10336. // draw spine:
  10337. if (mErrorBarSkipSymbol)
  10338. {
  10339. if (x-a > skipSymbolMargin) // don't draw spine if error is so small it's within skipSymbolmargin
  10340. painter->drawLine(QLineF(a, y, x-skipSymbolMargin, y));
  10341. if (b-x > skipSymbolMargin)
  10342. painter->drawLine(QLineF(x+skipSymbolMargin, y, b, y));
  10343. } else
  10344. painter->drawLine(QLineF(a, y, b, y));
  10345. // draw handles:
  10346. painter->drawLine(QLineF(a, y-barWidthHalf, a, y+barWidthHalf));
  10347. painter->drawLine(QLineF(b, y-barWidthHalf, b, y+barWidthHalf));
  10348. }
  10349. } else // mKeyAxis->orientation() is Qt::Horizontal
  10350. {
  10351. // draw value error vertically and key error horizontally
  10352. if (mErrorType == etKey || mErrorType == etBoth)
  10353. {
  10354. a = keyAxis->coordToPixel(data.key-data.keyErrorMinus);
  10355. b = keyAxis->coordToPixel(data.key+data.keyErrorPlus);
  10356. if (keyAxis->rangeReversed())
  10357. qSwap(a,b);
  10358. // draw spine:
  10359. if (mErrorBarSkipSymbol)
  10360. {
  10361. if (x-a > skipSymbolMargin) // don't draw spine if error is so small it's within skipSymbolmargin
  10362. painter->drawLine(QLineF(a, y, x-skipSymbolMargin, y));
  10363. if (b-x > skipSymbolMargin)
  10364. painter->drawLine(QLineF(x+skipSymbolMargin, y, b, y));
  10365. } else
  10366. painter->drawLine(QLineF(a, y, b, y));
  10367. // draw handles:
  10368. painter->drawLine(QLineF(a, y-barWidthHalf, a, y+barWidthHalf));
  10369. painter->drawLine(QLineF(b, y-barWidthHalf, b, y+barWidthHalf));
  10370. }
  10371. if (mErrorType == etValue || mErrorType == etBoth)
  10372. {
  10373. a = valueAxis->coordToPixel(data.value-data.valueErrorMinus);
  10374. b = valueAxis->coordToPixel(data.value+data.valueErrorPlus);
  10375. if (valueAxis->rangeReversed())
  10376. qSwap(a,b);
  10377. // draw spine:
  10378. if (mErrorBarSkipSymbol)
  10379. {
  10380. if (a-y > skipSymbolMargin) // don't draw spine if error is so small it's within skipSymbolmargin
  10381. painter->drawLine(QLineF(x, a, x, y+skipSymbolMargin));
  10382. if (y-b > skipSymbolMargin)
  10383. painter->drawLine(QLineF(x, y-skipSymbolMargin, x, b));
  10384. } else
  10385. painter->drawLine(QLineF(x, a, x, b));
  10386. // draw handles:
  10387. painter->drawLine(QLineF(x-barWidthHalf, a, x+barWidthHalf, a));
  10388. painter->drawLine(QLineF(x-barWidthHalf, b, x+barWidthHalf, b));
  10389. }
  10390. }
  10391. }
  10392. /*! \internal
  10393. called by the specific plot data generating functions "get(...)PlotData" to determine which data
  10394. range is visible, so only that needs to be processed.
  10395. \a lower returns an iterator to the lowest data point that needs to be taken into account when
  10396. plotting. Note that in order to get a clean plot all the way to the edge of the axes, \a lower
  10397. may still be outside the visible range.
  10398. \a upper returns an iterator to the highest data point. Same as before, \a upper may also lie
  10399. outside of the visible range.
  10400. \a count number of data points that need plotting, i.e. points between \a lower and \a upper,
  10401. including them. This is useful for allocating the array of <tt>QPointF</tt>s in the specific
  10402. drawing functions.
  10403. if the graph contains no data, \a count is zero and both \a lower and \a upper point to constEnd.
  10404. */
  10405. void QCPGraph::getVisibleDataBounds(QCPDataMap::const_iterator &lower, QCPDataMap::const_iterator &upper, int &count) const
  10406. {
  10407. if (!mKeyAxis) { qDebug() << Q_FUNC_INFO << "invalid key axis"; return; }
  10408. if (mData->isEmpty())
  10409. {
  10410. lower = mData->constEnd();
  10411. upper = mData->constEnd();
  10412. count = 0;
  10413. return;
  10414. }
  10415. // get visible data range as QMap iterators
  10416. QCPDataMap::const_iterator lbound = mData->lowerBound(mKeyAxis.data()->range().lower);
  10417. QCPDataMap::const_iterator ubound = mData->upperBound(mKeyAxis.data()->range().upper);
  10418. bool lowoutlier = lbound != mData->constBegin(); // indicates whether there exist points below axis range
  10419. bool highoutlier = ubound != mData->constEnd(); // indicates whether there exist points above axis range
  10420. lower = (lowoutlier ? lbound-1 : lbound); // data point range that will be actually drawn
  10421. upper = (highoutlier ? ubound : ubound-1); // data point range that will be actually drawn
  10422. // count number of points in range lower to upper (including them), so we can allocate array for them in draw functions:
  10423. QCPDataMap::const_iterator it = lower;
  10424. count = 1;
  10425. while (it != upper)
  10426. {
  10427. ++it;
  10428. ++count;
  10429. }
  10430. }
  10431. /*! \internal
  10432. The line data vector generated by e.g. getLinePlotData contains only the line that connects the
  10433. data points. If the graph needs to be filled, two additional points need to be added at the
  10434. value-zero-line in the lower and upper key positions of the graph. This function calculates these
  10435. points and adds them to the end of \a lineData. Since the fill is typically drawn before the line
  10436. stroke, these added points need to be removed again after the fill is done, with the
  10437. removeFillBasePoints function.
  10438. The expanding of \a lineData by two points will not cause unnecessary memory reallocations,
  10439. because the data vector generation functions (getLinePlotData etc.) reserve two extra points when
  10440. they allocate memory for \a lineData.
  10441. \see removeFillBasePoints, lowerFillBasePoint, upperFillBasePoint
  10442. */
  10443. void QCPGraph::addFillBasePoints(QVector<QPointF> *lineData) const
  10444. {
  10445. if (!mKeyAxis) { qDebug() << Q_FUNC_INFO << "invalid key axis"; return; }
  10446. // append points that close the polygon fill at the key axis:
  10447. if (mKeyAxis.data()->orientation() == Qt::Vertical)
  10448. {
  10449. *lineData << upperFillBasePoint(lineData->last().y());
  10450. *lineData << lowerFillBasePoint(lineData->first().y());
  10451. } else
  10452. {
  10453. *lineData << upperFillBasePoint(lineData->last().x());
  10454. *lineData << lowerFillBasePoint(lineData->first().x());
  10455. }
  10456. }
  10457. /*! \internal
  10458. removes the two points from \a lineData that were added by \ref addFillBasePoints.
  10459. \see addFillBasePoints, lowerFillBasePoint, upperFillBasePoint
  10460. */
  10461. void QCPGraph::removeFillBasePoints(QVector<QPointF> *lineData) const
  10462. {
  10463. lineData->remove(lineData->size()-2, 2);
  10464. }
  10465. /*! \internal
  10466. called by \ref addFillBasePoints to conveniently assign the point which closes the fill polygon
  10467. on the lower side of the zero-value-line parallel to the key axis. The logarithmic axis scale
  10468. case is a bit special, since the zero-value-line in pixel coordinates is in positive or negative
  10469. infinity. So this case is handled separately by just closing the fill polygon on the axis which
  10470. lies in the direction towards the zero value.
  10471. \a lowerKey will be the the key (in pixels) of the returned point. Depending on whether the key
  10472. axis is horizontal or vertical, \a lowerKey will end up as the x or y value of the returned
  10473. point, respectively.
  10474. \see upperFillBasePoint, addFillBasePoints
  10475. */
  10476. QPointF QCPGraph::lowerFillBasePoint(double lowerKey) const
  10477. {
  10478. QCPAxis *keyAxis = mKeyAxis.data();
  10479. QCPAxis *valueAxis = mValueAxis.data();
  10480. if (!keyAxis || !valueAxis) { qDebug() << Q_FUNC_INFO << "invalid key or value axis"; return QPointF(); }
  10481. QPointF point;
  10482. if (valueAxis->scaleType() == QCPAxis::stLinear)
  10483. {
  10484. if (keyAxis->axisType() == QCPAxis::atLeft)
  10485. {
  10486. point.setX(valueAxis->coordToPixel(0));
  10487. point.setY(lowerKey);
  10488. } else if (keyAxis->axisType() == QCPAxis::atRight)
  10489. {
  10490. point.setX(valueAxis->coordToPixel(0));
  10491. point.setY(lowerKey);
  10492. } else if (keyAxis->axisType() == QCPAxis::atTop)
  10493. {
  10494. point.setX(lowerKey);
  10495. point.setY(valueAxis->coordToPixel(0));
  10496. } else if (keyAxis->axisType() == QCPAxis::atBottom)
  10497. {
  10498. point.setX(lowerKey);
  10499. point.setY(valueAxis->coordToPixel(0));
  10500. }
  10501. } else // valueAxis->mScaleType == QCPAxis::stLogarithmic
  10502. {
  10503. // In logarithmic scaling we can't just draw to value zero so we just fill all the way
  10504. // to the axis which is in the direction towards zero
  10505. if (keyAxis->orientation() == Qt::Vertical)
  10506. {
  10507. if ((valueAxis->range().upper < 0 && !valueAxis->rangeReversed()) ||
  10508. (valueAxis->range().upper > 0 && valueAxis->rangeReversed())) // if range is negative, zero is on opposite side of key axis
  10509. point.setX(keyAxis->axisRect()->right());
  10510. else
  10511. point.setX(keyAxis->axisRect()->left());
  10512. point.setY(lowerKey);
  10513. } else if (keyAxis->axisType() == QCPAxis::atTop || keyAxis->axisType() == QCPAxis::atBottom)
  10514. {
  10515. point.setX(lowerKey);
  10516. if ((valueAxis->range().upper < 0 && !valueAxis->rangeReversed()) ||
  10517. (valueAxis->range().upper > 0 && valueAxis->rangeReversed())) // if range is negative, zero is on opposite side of key axis
  10518. point.setY(keyAxis->axisRect()->top());
  10519. else
  10520. point.setY(keyAxis->axisRect()->bottom());
  10521. }
  10522. }
  10523. return point;
  10524. }
  10525. /*! \internal
  10526. called by \ref addFillBasePoints to conveniently assign the point which closes the fill
  10527. polygon on the upper side of the zero-value-line parallel to the key axis. The logarithmic axis
  10528. scale case is a bit special, since the zero-value-line in pixel coordinates is in positive or
  10529. negative infinity. So this case is handled separately by just closing the fill polygon on the
  10530. axis which lies in the direction towards the zero value.
  10531. \a upperKey will be the the key (in pixels) of the returned point. Depending on whether the key
  10532. axis is horizontal or vertical, \a upperKey will end up as the x or y value of the returned
  10533. point, respectively.
  10534. \see lowerFillBasePoint, addFillBasePoints
  10535. */
  10536. QPointF QCPGraph::upperFillBasePoint(double upperKey) const
  10537. {
  10538. QCPAxis *keyAxis = mKeyAxis.data();
  10539. QCPAxis *valueAxis = mValueAxis.data();
  10540. if (!keyAxis || !valueAxis) { qDebug() << Q_FUNC_INFO << "invalid key or value axis"; return QPointF(); }
  10541. QPointF point;
  10542. if (valueAxis->scaleType() == QCPAxis::stLinear)
  10543. {
  10544. if (keyAxis->axisType() == QCPAxis::atLeft)
  10545. {
  10546. point.setX(valueAxis->coordToPixel(0));
  10547. point.setY(upperKey);
  10548. } else if (keyAxis->axisType() == QCPAxis::atRight)
  10549. {
  10550. point.setX(valueAxis->coordToPixel(0));
  10551. point.setY(upperKey);
  10552. } else if (keyAxis->axisType() == QCPAxis::atTop)
  10553. {
  10554. point.setX(upperKey);
  10555. point.setY(valueAxis->coordToPixel(0));
  10556. } else if (keyAxis->axisType() == QCPAxis::atBottom)
  10557. {
  10558. point.setX(upperKey);
  10559. point.setY(valueAxis->coordToPixel(0));
  10560. }
  10561. } else // valueAxis->mScaleType == QCPAxis::stLogarithmic
  10562. {
  10563. // In logarithmic scaling we can't just draw to value 0 so we just fill all the way
  10564. // to the axis which is in the direction towards 0
  10565. if (keyAxis->orientation() == Qt::Vertical)
  10566. {
  10567. if ((valueAxis->range().upper < 0 && !valueAxis->rangeReversed()) ||
  10568. (valueAxis->range().upper > 0 && valueAxis->rangeReversed())) // if range is negative, zero is on opposite side of key axis
  10569. point.setX(keyAxis->axisRect()->right());
  10570. else
  10571. point.setX(keyAxis->axisRect()->left());
  10572. point.setY(upperKey);
  10573. } else if (keyAxis->axisType() == QCPAxis::atTop || keyAxis->axisType() == QCPAxis::atBottom)
  10574. {
  10575. point.setX(upperKey);
  10576. if ((valueAxis->range().upper < 0 && !valueAxis->rangeReversed()) ||
  10577. (valueAxis->range().upper > 0 && valueAxis->rangeReversed())) // if range is negative, zero is on opposite side of key axis
  10578. point.setY(keyAxis->axisRect()->top());
  10579. else
  10580. point.setY(keyAxis->axisRect()->bottom());
  10581. }
  10582. }
  10583. return point;
  10584. }
  10585. /*! \internal
  10586. Generates the polygon needed for drawing channel fills between this graph (data passed via \a
  10587. lineData) and the graph specified by mChannelFillGraph (data generated by calling its \ref
  10588. getPlotData function). May return an empty polygon if the key ranges have no overlap or fill
  10589. target graph and this graph don't have same orientation (i.e. both key axes horizontal or both
  10590. key axes vertical). For increased performance (due to implicit sharing), keep the returned
  10591. QPolygonF const.
  10592. */
  10593. const QPolygonF QCPGraph::getChannelFillPolygon(const QVector<QPointF> *lineData) const
  10594. {
  10595. if (!mChannelFillGraph)
  10596. return QPolygonF();
  10597. QCPAxis *keyAxis = mKeyAxis.data();
  10598. QCPAxis *valueAxis = mValueAxis.data();
  10599. if (!keyAxis || !valueAxis) { qDebug() << Q_FUNC_INFO << "invalid key or value axis"; return QPolygonF(); }
  10600. if (!mChannelFillGraph.data()->mKeyAxis) { qDebug() << Q_FUNC_INFO << "channel fill target key axis invalid"; return QPolygonF(); }
  10601. if (mChannelFillGraph.data()->mKeyAxis.data()->orientation() != keyAxis->orientation())
  10602. return QPolygonF(); // don't have same axis orientation, can't fill that (Note: if keyAxis fits, valueAxis will fit too, because it's always orthogonal to keyAxis)
  10603. if (lineData->isEmpty()) return QPolygonF();
  10604. QVector<QPointF> otherData;
  10605. mChannelFillGraph.data()->getPlotData(&otherData, 0);
  10606. if (otherData.isEmpty()) return QPolygonF();
  10607. QVector<QPointF> thisData;
  10608. thisData.reserve(lineData->size()+otherData.size()); // because we will join both vectors at end of this function
  10609. for (int i=0; i<lineData->size(); ++i) // don't use the vector<<(vector), it squeezes internally, which ruins the performance tuning with reserve()
  10610. thisData << lineData->at(i);
  10611. // pointers to be able to swap them, depending which data range needs cropping:
  10612. QVector<QPointF> *staticData = &thisData;
  10613. QVector<QPointF> *croppedData = &otherData;
  10614. // crop both vectors to ranges in which the keys overlap (which coord is key, depends on axisType):
  10615. if (keyAxis->orientation() == Qt::Horizontal)
  10616. {
  10617. // x is key
  10618. // if an axis range is reversed, the data point keys will be descending. Reverse them, since following algorithm assumes ascending keys:
  10619. if (staticData->first().x() > staticData->last().x())
  10620. {
  10621. int size = staticData->size();
  10622. for (int i=0; i<size/2; ++i)
  10623. qSwap((*staticData)[i], (*staticData)[size-1-i]);
  10624. }
  10625. if (croppedData->first().x() > croppedData->last().x())
  10626. {
  10627. int size = croppedData->size();
  10628. for (int i=0; i<size/2; ++i)
  10629. qSwap((*croppedData)[i], (*croppedData)[size-1-i]);
  10630. }
  10631. // crop lower bound:
  10632. if (staticData->first().x() < croppedData->first().x()) // other one must be cropped
  10633. qSwap(staticData, croppedData);
  10634. int lowBound = findIndexBelowX(croppedData, staticData->first().x());
  10635. if (lowBound == -1) return QPolygonF(); // key ranges have no overlap
  10636. croppedData->remove(0, lowBound);
  10637. // set lowest point of cropped data to fit exactly key position of first static data
  10638. // point via linear interpolation:
  10639. if (croppedData->size() < 2) return QPolygonF(); // need at least two points for interpolation
  10640. double slope;
  10641. if (croppedData->at(1).x()-croppedData->at(0).x() != 0)
  10642. slope = (croppedData->at(1).y()-croppedData->at(0).y())/(croppedData->at(1).x()-croppedData->at(0).x());
  10643. else
  10644. slope = 0;
  10645. (*croppedData)[0].setY(croppedData->at(0).y()+slope*(staticData->first().x()-croppedData->at(0).x()));
  10646. (*croppedData)[0].setX(staticData->first().x());
  10647. // crop upper bound:
  10648. if (staticData->last().x() > croppedData->last().x()) // other one must be cropped
  10649. qSwap(staticData, croppedData);
  10650. int highBound = findIndexAboveX(croppedData, staticData->last().x());
  10651. if (highBound == -1) return QPolygonF(); // key ranges have no overlap
  10652. croppedData->remove(highBound+1, croppedData->size()-(highBound+1));
  10653. // set highest point of cropped data to fit exactly key position of last static data
  10654. // point via linear interpolation:
  10655. if (croppedData->size() < 2) return QPolygonF(); // need at least two points for interpolation
  10656. int li = croppedData->size()-1; // last index
  10657. if (croppedData->at(li).x()-croppedData->at(li-1).x() != 0)
  10658. slope = (croppedData->at(li).y()-croppedData->at(li-1).y())/(croppedData->at(li).x()-croppedData->at(li-1).x());
  10659. else
  10660. slope = 0;
  10661. (*croppedData)[li].setY(croppedData->at(li-1).y()+slope*(staticData->last().x()-croppedData->at(li-1).x()));
  10662. (*croppedData)[li].setX(staticData->last().x());
  10663. } else // mKeyAxis->orientation() == Qt::Vertical
  10664. {
  10665. // y is key
  10666. // similar to "x is key" but switched x,y. Further, lower/upper meaning is inverted compared to x,
  10667. // because in pixel coordinates, y increases from top to bottom, not bottom to top like data coordinate.
  10668. // if an axis range is reversed, the data point keys will be descending. Reverse them, since following algorithm assumes ascending keys:
  10669. if (staticData->first().y() < staticData->last().y())
  10670. {
  10671. int size = staticData->size();
  10672. for (int i=0; i<size/2; ++i)
  10673. qSwap((*staticData)[i], (*staticData)[size-1-i]);
  10674. }
  10675. if (croppedData->first().y() < croppedData->last().y())
  10676. {
  10677. int size = croppedData->size();
  10678. for (int i=0; i<size/2; ++i)
  10679. qSwap((*croppedData)[i], (*croppedData)[size-1-i]);
  10680. }
  10681. // crop lower bound:
  10682. if (staticData->first().y() > croppedData->first().y()) // other one must be cropped
  10683. qSwap(staticData, croppedData);
  10684. int lowBound = findIndexAboveY(croppedData, staticData->first().y());
  10685. if (lowBound == -1) return QPolygonF(); // key ranges have no overlap
  10686. croppedData->remove(0, lowBound);
  10687. // set lowest point of cropped data to fit exactly key position of first static data
  10688. // point via linear interpolation:
  10689. if (croppedData->size() < 2) return QPolygonF(); // need at least two points for interpolation
  10690. double slope;
  10691. if (croppedData->at(1).y()-croppedData->at(0).y() != 0) // avoid division by zero in step plots
  10692. slope = (croppedData->at(1).x()-croppedData->at(0).x())/(croppedData->at(1).y()-croppedData->at(0).y());
  10693. else
  10694. slope = 0;
  10695. (*croppedData)[0].setX(croppedData->at(0).x()+slope*(staticData->first().y()-croppedData->at(0).y()));
  10696. (*croppedData)[0].setY(staticData->first().y());
  10697. // crop upper bound:
  10698. if (staticData->last().y() < croppedData->last().y()) // other one must be cropped
  10699. qSwap(staticData, croppedData);
  10700. int highBound = findIndexBelowY(croppedData, staticData->last().y());
  10701. if (highBound == -1) return QPolygonF(); // key ranges have no overlap
  10702. croppedData->remove(highBound+1, croppedData->size()-(highBound+1));
  10703. // set highest point of cropped data to fit exactly key position of last static data
  10704. // point via linear interpolation:
  10705. if (croppedData->size() < 2) return QPolygonF(); // need at least two points for interpolation
  10706. int li = croppedData->size()-1; // last index
  10707. if (croppedData->at(li).y()-croppedData->at(li-1).y() != 0) // avoid division by zero in step plots
  10708. slope = (croppedData->at(li).x()-croppedData->at(li-1).x())/(croppedData->at(li).y()-croppedData->at(li-1).y());
  10709. else
  10710. slope = 0;
  10711. (*croppedData)[li].setX(croppedData->at(li-1).x()+slope*(staticData->last().y()-croppedData->at(li-1).y()));
  10712. (*croppedData)[li].setY(staticData->last().y());
  10713. }
  10714. // return joined:
  10715. for (int i=otherData.size()-1; i>=0; --i) // insert reversed, otherwise the polygon will be twisted
  10716. thisData << otherData.at(i);
  10717. return QPolygonF(thisData);
  10718. }
  10719. /*! \internal
  10720. Finds the smallest index of \a data, whose points x value is just above \a x. Assumes x values in
  10721. \a data points are ordered ascending, as is the case when plotting with horizontal key axis.
  10722. Used to calculate the channel fill polygon, see \ref getChannelFillPolygon.
  10723. */
  10724. int QCPGraph::findIndexAboveX(const QVector<QPointF> *data, double x) const
  10725. {
  10726. for (int i=data->size()-1; i>=0; --i)
  10727. {
  10728. if (data->at(i).x() < x)
  10729. {
  10730. if (i<data->size()-1)
  10731. return i+1;
  10732. else
  10733. return data->size()-1;
  10734. }
  10735. }
  10736. return -1;
  10737. }
  10738. /*! \internal
  10739. Finds the highest index of \a data, whose points x value is just below \a x. Assumes x values in
  10740. \a data points are ordered ascending, as is the case when plotting with horizontal key axis.
  10741. Used to calculate the channel fill polygon, see \ref getChannelFillPolygon.
  10742. */
  10743. int QCPGraph::findIndexBelowX(const QVector<QPointF> *data, double x) const
  10744. {
  10745. for (int i=0; i<data->size(); ++i)
  10746. {
  10747. if (data->at(i).x() > x)
  10748. {
  10749. if (i>0)
  10750. return i-1;
  10751. else
  10752. return 0;
  10753. }
  10754. }
  10755. return -1;
  10756. }
  10757. /*! \internal
  10758. Finds the smallest index of \a data, whose points y value is just above \a y. Assumes y values in
  10759. \a data points are ordered descending, as is the case when plotting with vertical key axis.
  10760. Used to calculate the channel fill polygon, see \ref getChannelFillPolygon.
  10761. */
  10762. int QCPGraph::findIndexAboveY(const QVector<QPointF> *data, double y) const
  10763. {
  10764. for (int i=0; i<data->size(); ++i)
  10765. {
  10766. if (data->at(i).y() < y)
  10767. {
  10768. if (i>0)
  10769. return i-1;
  10770. else
  10771. return 0;
  10772. }
  10773. }
  10774. return -1;
  10775. }
  10776. /*! \internal
  10777. Calculates the (minimum) distance (in pixels) the graph's representation has from the given \a
  10778. pixelPoint in pixels. This is used to determine whether the graph was clicked or not, e.g. in
  10779. \ref selectTest.
  10780. If either the graph has no data or if the line style is \ref lsNone and the scatter style's shape
  10781. is \ref QCPScatterStyle::ssNone (i.e. there is no visual representation of the graph), returns
  10782. 500.
  10783. */
  10784. double QCPGraph::pointDistance(const QPointF &pixelPoint) const
  10785. {
  10786. if (mData->isEmpty())
  10787. {
  10788. qDebug() << Q_FUNC_INFO << "requested point distance on graph" << mName << "without data";
  10789. return 500;
  10790. }
  10791. if (mData->size() == 1)
  10792. {
  10793. QPointF dataPoint = coordsToPixels(mData->constBegin().key(), mData->constBegin().value().value);
  10794. return QVector2D(dataPoint-pixelPoint).length();
  10795. }
  10796. if (mLineStyle == lsNone && mScatterStyle.isNone())
  10797. return 500;
  10798. // calculate minimum distances to graph representation:
  10799. if (mLineStyle == lsNone)
  10800. {
  10801. // no line displayed, only calculate distance to scatter points:
  10802. QVector<QCPData> *pointData = new QVector<QCPData>;
  10803. getScatterPlotData(pointData);
  10804. double minDistSqr = std::numeric_limits<double>::max();
  10805. QPointF ptA;
  10806. QPointF ptB = coordsToPixels(pointData->at(0).key, pointData->at(0).value); // getScatterPlotData returns in plot coordinates, so transform to pixels
  10807. for (int i=1; i<pointData->size(); ++i)
  10808. {
  10809. ptA = ptB;
  10810. ptB = coordsToPixels(pointData->at(i).key, pointData->at(i).value);
  10811. double currentDistSqr = distSqrToLine(ptA, ptB, pixelPoint);
  10812. if (currentDistSqr < minDistSqr)
  10813. minDistSqr = currentDistSqr;
  10814. }
  10815. delete pointData;
  10816. return sqrt(minDistSqr);
  10817. } else
  10818. {
  10819. // line displayed calculate distance to line segments:
  10820. QVector<QPointF> *lineData = new QVector<QPointF>;
  10821. getPlotData(lineData, 0); // unlike with getScatterPlotData we get pixel coordinates here
  10822. double minDistSqr = std::numeric_limits<double>::max();
  10823. if (mLineStyle == lsImpulse)
  10824. {
  10825. // impulse plot differs from other line styles in that the lineData points are only pairwise connected:
  10826. for (int i=0; i<lineData->size()-1; i+=2) // iterate pairs
  10827. {
  10828. double currentDistSqr = distSqrToLine(lineData->at(i), lineData->at(i+1), pixelPoint);
  10829. if (currentDistSqr < minDistSqr)
  10830. minDistSqr = currentDistSqr;
  10831. }
  10832. } else
  10833. {
  10834. // all other line plots (line and step) connect points directly:
  10835. for (int i=0; i<lineData->size()-1; ++i)
  10836. {
  10837. double currentDistSqr = distSqrToLine(lineData->at(i), lineData->at(i+1), pixelPoint);
  10838. if (currentDistSqr < minDistSqr)
  10839. minDistSqr = currentDistSqr;
  10840. }
  10841. }
  10842. delete lineData;
  10843. return sqrt(minDistSqr);
  10844. }
  10845. }
  10846. /*! \internal
  10847. Finds the highest index of \a data, whose points y value is just below \a y. Assumes y values in
  10848. \a data points are ordered descending, as is the case when plotting with vertical key axis (since
  10849. keys are ordered ascending).
  10850. Used to calculate the channel fill polygon, see \ref getChannelFillPolygon.
  10851. */
  10852. int QCPGraph::findIndexBelowY(const QVector<QPointF> *data, double y) const
  10853. {
  10854. for (int i=data->size()-1; i>=0; --i)
  10855. {
  10856. if (data->at(i).y() > y)
  10857. {
  10858. if (i<data->size()-1)
  10859. return i+1;
  10860. else
  10861. return data->size()-1;
  10862. }
  10863. }
  10864. return -1;
  10865. }
  10866. /* inherits documentation from base class */
  10867. QCPRange QCPGraph::getKeyRange(bool &validRange, SignDomain inSignDomain) const
  10868. {
  10869. // just call the specialized version which takes an additional argument whether error bars
  10870. // should also be taken into consideration for range calculation. We set this to true here.
  10871. return getKeyRange(validRange, inSignDomain, true);
  10872. }
  10873. /* inherits documentation from base class */
  10874. QCPRange QCPGraph::getValueRange(bool &validRange, SignDomain inSignDomain) const
  10875. {
  10876. // just call the specialized version which takes an additional argument whether error bars
  10877. // should also be taken into consideration for range calculation. We set this to true here.
  10878. return getValueRange(validRange, inSignDomain, true);
  10879. }
  10880. /*! \overload
  10881. Allows to specify whether the error bars should be included in the range calculation.
  10882. \see getKeyRange(bool &validRange, SignDomain inSignDomain)
  10883. */
  10884. QCPRange QCPGraph::getKeyRange(bool &validRange, SignDomain inSignDomain, bool includeErrors) const
  10885. {
  10886. QCPRange range;
  10887. bool haveLower = false;
  10888. bool haveUpper = false;
  10889. double current, currentErrorMinus, currentErrorPlus;
  10890. if (inSignDomain == sdBoth) // range may be anywhere
  10891. {
  10892. QCPDataMap::const_iterator it = mData->constBegin();
  10893. while (it != mData->constEnd())
  10894. {
  10895. current = it.value().key;
  10896. currentErrorMinus = (includeErrors ? it.value().keyErrorMinus : 0);
  10897. currentErrorPlus = (includeErrors ? it.value().keyErrorPlus : 0);
  10898. if (current-currentErrorMinus < range.lower || !haveLower)
  10899. {
  10900. range.lower = current-currentErrorMinus;
  10901. haveLower = true;
  10902. }
  10903. if (current+currentErrorPlus > range.upper || !haveUpper)
  10904. {
  10905. range.upper = current+currentErrorPlus;
  10906. haveUpper = true;
  10907. }
  10908. ++it;
  10909. }
  10910. } else if (inSignDomain == sdNegative) // range may only be in the negative sign domain
  10911. {
  10912. QCPDataMap::const_iterator it = mData->constBegin();
  10913. while (it != mData->constEnd())
  10914. {
  10915. current = it.value().key;
  10916. currentErrorMinus = (includeErrors ? it.value().keyErrorMinus : 0);
  10917. currentErrorPlus = (includeErrors ? it.value().keyErrorPlus : 0);
  10918. if ((current-currentErrorMinus < range.lower || !haveLower) && current-currentErrorMinus < 0)
  10919. {
  10920. range.lower = current-currentErrorMinus;
  10921. haveLower = true;
  10922. }
  10923. if ((current+currentErrorPlus > range.upper || !haveUpper) && current+currentErrorPlus < 0)
  10924. {
  10925. range.upper = current+currentErrorPlus;
  10926. haveUpper = true;
  10927. }
  10928. if (includeErrors) // in case point is in valid sign domain but errobars stretch beyond it, we still want to geht that point.
  10929. {
  10930. if ((current < range.lower || !haveLower) && current < 0)
  10931. {
  10932. range.lower = current;
  10933. haveLower = true;
  10934. }
  10935. if ((current > range.upper || !haveUpper) && current < 0)
  10936. {
  10937. range.upper = current;
  10938. haveUpper = true;
  10939. }
  10940. }
  10941. ++it;
  10942. }
  10943. } else if (inSignDomain == sdPositive) // range may only be in the positive sign domain
  10944. {
  10945. QCPDataMap::const_iterator it = mData->constBegin();
  10946. while (it != mData->constEnd())
  10947. {
  10948. current = it.value().key;
  10949. currentErrorMinus = (includeErrors ? it.value().keyErrorMinus : 0);
  10950. currentErrorPlus = (includeErrors ? it.value().keyErrorPlus : 0);
  10951. if ((current-currentErrorMinus < range.lower || !haveLower) && current-currentErrorMinus > 0)
  10952. {
  10953. range.lower = current-currentErrorMinus;
  10954. haveLower = true;
  10955. }
  10956. if ((current+currentErrorPlus > range.upper || !haveUpper) && current+currentErrorPlus > 0)
  10957. {
  10958. range.upper = current+currentErrorPlus;
  10959. haveUpper = true;
  10960. }
  10961. if (includeErrors) // in case point is in valid sign domain but errobars stretch beyond it, we still want to get that point.
  10962. {
  10963. if ((current < range.lower || !haveLower) && current > 0)
  10964. {
  10965. range.lower = current;
  10966. haveLower = true;
  10967. }
  10968. if ((current > range.upper || !haveUpper) && current > 0)
  10969. {
  10970. range.upper = current;
  10971. haveUpper = true;
  10972. }
  10973. }
  10974. ++it;
  10975. }
  10976. }
  10977. validRange = haveLower && haveUpper;
  10978. return range;
  10979. }
  10980. /*! \overload
  10981. Allows to specify whether the error bars should be included in the range calculation.
  10982. \see getValueRange(bool &validRange, SignDomain inSignDomain)
  10983. */
  10984. QCPRange QCPGraph::getValueRange(bool &validRange, SignDomain inSignDomain, bool includeErrors) const
  10985. {
  10986. QCPRange range;
  10987. bool haveLower = false;
  10988. bool haveUpper = false;
  10989. double current, currentErrorMinus, currentErrorPlus;
  10990. if (inSignDomain == sdBoth) // range may be anywhere
  10991. {
  10992. QCPDataMap::const_iterator it = mData->constBegin();
  10993. while (it != mData->constEnd())
  10994. {
  10995. current = it.value().value;
  10996. currentErrorMinus = (includeErrors ? it.value().valueErrorMinus : 0);
  10997. currentErrorPlus = (includeErrors ? it.value().valueErrorPlus : 0);
  10998. if (current-currentErrorMinus < range.lower || !haveLower)
  10999. {
  11000. range.lower = current-currentErrorMinus;
  11001. haveLower = true;
  11002. }
  11003. if (current+currentErrorPlus > range.upper || !haveUpper)
  11004. {
  11005. range.upper = current+currentErrorPlus;
  11006. haveUpper = true;
  11007. }
  11008. ++it;
  11009. }
  11010. } else if (inSignDomain == sdNegative) // range may only be in the negative sign domain
  11011. {
  11012. QCPDataMap::const_iterator it = mData->constBegin();
  11013. while (it != mData->constEnd())
  11014. {
  11015. current = it.value().value;
  11016. currentErrorMinus = (includeErrors ? it.value().valueErrorMinus : 0);
  11017. currentErrorPlus = (includeErrors ? it.value().valueErrorPlus : 0);
  11018. if ((current-currentErrorMinus < range.lower || !haveLower) && current-currentErrorMinus < 0)
  11019. {
  11020. range.lower = current-currentErrorMinus;
  11021. haveLower = true;
  11022. }
  11023. if ((current+currentErrorPlus > range.upper || !haveUpper) && current+currentErrorPlus < 0)
  11024. {
  11025. range.upper = current+currentErrorPlus;
  11026. haveUpper = true;
  11027. }
  11028. if (includeErrors) // in case point is in valid sign domain but errobars stretch beyond it, we still want to get that point.
  11029. {
  11030. if ((current < range.lower || !haveLower) && current < 0)
  11031. {
  11032. range.lower = current;
  11033. haveLower = true;
  11034. }
  11035. if ((current > range.upper || !haveUpper) && current < 0)
  11036. {
  11037. range.upper = current;
  11038. haveUpper = true;
  11039. }
  11040. }
  11041. ++it;
  11042. }
  11043. } else if (inSignDomain == sdPositive) // range may only be in the positive sign domain
  11044. {
  11045. QCPDataMap::const_iterator it = mData->constBegin();
  11046. while (it != mData->constEnd())
  11047. {
  11048. current = it.value().value;
  11049. currentErrorMinus = (includeErrors ? it.value().valueErrorMinus : 0);
  11050. currentErrorPlus = (includeErrors ? it.value().valueErrorPlus : 0);
  11051. if ((current-currentErrorMinus < range.lower || !haveLower) && current-currentErrorMinus > 0)
  11052. {
  11053. range.lower = current-currentErrorMinus;
  11054. haveLower = true;
  11055. }
  11056. if ((current+currentErrorPlus > range.upper || !haveUpper) && current+currentErrorPlus > 0)
  11057. {
  11058. range.upper = current+currentErrorPlus;
  11059. haveUpper = true;
  11060. }
  11061. if (includeErrors) // in case point is in valid sign domain but errobars stretch beyond it, we still want to geht that point.
  11062. {
  11063. if ((current < range.lower || !haveLower) && current > 0)
  11064. {
  11065. range.lower = current;
  11066. haveLower = true;
  11067. }
  11068. if ((current > range.upper || !haveUpper) && current > 0)
  11069. {
  11070. range.upper = current;
  11071. haveUpper = true;
  11072. }
  11073. }
  11074. ++it;
  11075. }
  11076. }
  11077. validRange = haveLower && haveUpper;
  11078. return range;
  11079. }
  11080. ////////////////////////////////////////////////////////////////////////////////////////////////////
  11081. //////////////////// QCPCurveData
  11082. ////////////////////////////////////////////////////////////////////////////////////////////////////
  11083. /*! \class QCPCurveData
  11084. \brief Holds the data of one single data point for QCPCurve.
  11085. The container for storing multiple data points is \ref QCPCurveDataMap.
  11086. The stored data is:
  11087. \li \a t: the free parameter of the curve at this curve point (cp. the mathematical vector <em>(x(t), y(t))</em>)
  11088. \li \a key: coordinate on the key axis of this curve point
  11089. \li \a value: coordinate on the value axis of this curve point
  11090. \see QCPCurveDataMap
  11091. */
  11092. /*!
  11093. Constructs a curve data point with t, key and value set to zero.
  11094. */
  11095. QCPCurveData::QCPCurveData() :
  11096. t(0),
  11097. key(0),
  11098. value(0)
  11099. {
  11100. }
  11101. /*!
  11102. Constructs a curve data point with the specified \a t, \a key and \a value.
  11103. */
  11104. QCPCurveData::QCPCurveData(double t, double key, double value) :
  11105. t(t),
  11106. key(key),
  11107. value(value)
  11108. {
  11109. }
  11110. ////////////////////////////////////////////////////////////////////////////////////////////////////
  11111. //////////////////// QCPCurve
  11112. ////////////////////////////////////////////////////////////////////////////////////////////////////
  11113. /*! \class QCPCurve
  11114. \brief A plottable representing a parametric curve in a plot.
  11115. \image html QCPCurve.png
  11116. Unlike QCPGraph, plottables of this type may have multiple points with the same key coordinate,
  11117. so their visual representation can have \a loops. This is realized by introducing a third
  11118. coordinate \a t, which defines the order of the points described by the other two coordinates \a
  11119. x and \a y.
  11120. To plot data, assign it with the \ref setData or \ref addData functions.
  11121. \section appearance Changing the appearance
  11122. The appearance of the curve is determined by the pen and the brush (\ref setPen, \ref setBrush).
  11123. \section usage Usage
  11124. Like all data representing objects in QCustomPlot, the QCPCurve is a plottable (QCPAbstractPlottable). So
  11125. the plottable-interface of QCustomPlot applies (QCustomPlot::plottable, QCustomPlot::addPlottable, QCustomPlot::removePlottable, etc.)
  11126. Usually, you first create an instance:
  11127. \code
  11128. QCPCurve *newCurve = new QCPCurve(customPlot->xAxis, customPlot->yAxis);\endcode
  11129. add it to the customPlot with QCustomPlot::addPlottable:
  11130. \code
  11131. customPlot->addPlottable(newCurve);\endcode
  11132. and then modify the properties of the newly created plottable, e.g.:
  11133. \code
  11134. newCurve->setName("Fermat's Spiral");
  11135. newCurve->setData(tData, xData, yData);\endcode
  11136. */
  11137. /*!
  11138. Constructs a curve which uses \a keyAxis as its key axis ("x") and \a valueAxis as its value
  11139. axis ("y"). \a keyAxis and \a valueAxis must reside in the same QCustomPlot instance and not have
  11140. the same orientation. If either of these restrictions is violated, a corresponding message is
  11141. printed to the debug output (qDebug), the construction is not aborted, though.
  11142. The constructed QCPCurve can be added to the plot with QCustomPlot::addPlottable, QCustomPlot
  11143. then takes ownership of the graph.
  11144. */
  11145. QCPCurve::QCPCurve(QCPAxis *keyAxis, QCPAxis *valueAxis) :
  11146. QCPAbstractPlottable(keyAxis, valueAxis)
  11147. {
  11148. mData = new QCPCurveDataMap;
  11149. mPen.setColor(Qt::blue);
  11150. mPen.setStyle(Qt::SolidLine);
  11151. mBrush.setColor(Qt::blue);
  11152. mBrush.setStyle(Qt::NoBrush);
  11153. mSelectedPen = mPen;
  11154. mSelectedPen.setWidthF(2.5);
  11155. mSelectedPen.setColor(QColor(80, 80, 255)); // lighter than Qt::blue of mPen
  11156. mSelectedBrush = mBrush;
  11157. setScatterStyle(QCPScatterStyle());
  11158. setLineStyle(lsLine);
  11159. }
  11160. QCPCurve::~QCPCurve()
  11161. {
  11162. delete mData;
  11163. }
  11164. /*!
  11165. Replaces the current data with the provided \a data.
  11166. If \a copy is set to true, data points in \a data will only be copied. if false, the plottable
  11167. takes ownership of the passed data and replaces the internal data pointer with it. This is
  11168. significantly faster than copying for large datasets.
  11169. */
  11170. void QCPCurve::setData(QCPCurveDataMap *data, bool copy)
  11171. {
  11172. if (copy)
  11173. {
  11174. *mData = *data;
  11175. } else
  11176. {
  11177. delete mData;
  11178. mData = data;
  11179. }
  11180. }
  11181. /*! \overload
  11182. Replaces the current data with the provided points in \a t, \a key and \a value tuples. The
  11183. provided vectors should have equal length. Else, the number of added points will be the size of
  11184. the smallest vector.
  11185. */
  11186. void QCPCurve::setData(const QVector<double> &t, const QVector<double> &key, const QVector<double> &value)
  11187. {
  11188. mData->clear();
  11189. int n = t.size();
  11190. n = qMin(n, key.size());
  11191. n = qMin(n, value.size());
  11192. QCPCurveData newData;
  11193. for (int i=0; i<n; ++i)
  11194. {
  11195. newData.t = t[i];
  11196. newData.key = key[i];
  11197. newData.value = value[i];
  11198. mData->insertMulti(newData.t, newData);
  11199. }
  11200. }
  11201. /*! \overload
  11202. Replaces the current data with the provided \a key and \a value pairs. The t parameter
  11203. of each data point will be set to the integer index of the respective key/value pair.
  11204. */
  11205. void QCPCurve::setData(const QVector<double> &key, const QVector<double> &value)
  11206. {
  11207. mData->clear();
  11208. int n = key.size();
  11209. n = qMin(n, value.size());
  11210. QCPCurveData newData;
  11211. for (int i=0; i<n; ++i)
  11212. {
  11213. newData.t = i; // no t vector given, so we assign t the index of the key/value pair
  11214. newData.key = key[i];
  11215. newData.value = value[i];
  11216. mData->insertMulti(newData.t, newData);
  11217. }
  11218. }
  11219. /*!
  11220. Sets the visual appearance of single data points in the plot. If set to \ref
  11221. QCPScatterStyle::ssNone, no scatter points are drawn (e.g. for line-only plots with appropriate
  11222. line style).
  11223. \see QCPScatterStyle, setLineStyle
  11224. */
  11225. void QCPCurve::setScatterStyle(const QCPScatterStyle &style)
  11226. {
  11227. mScatterStyle = style;
  11228. }
  11229. /*!
  11230. Sets how the single data points are connected in the plot or how they are represented visually
  11231. apart from the scatter symbol. For scatter-only plots, set \a style to \ref lsNone and \ref
  11232. setScatterStyle to the desired scatter style.
  11233. \see setScatterStyle
  11234. */
  11235. void QCPCurve::setLineStyle(QCPCurve::LineStyle style)
  11236. {
  11237. mLineStyle = style;
  11238. }
  11239. /*!
  11240. Adds the provided data points in \a dataMap to the current data.
  11241. \see removeData
  11242. */
  11243. void QCPCurve::addData(const QCPCurveDataMap &dataMap)
  11244. {
  11245. mData->unite(dataMap);
  11246. }
  11247. /*! \overload
  11248. Adds the provided single data point in \a data to the current data.
  11249. \see removeData
  11250. */
  11251. void QCPCurve::addData(const QCPCurveData &data)
  11252. {
  11253. mData->insertMulti(data.t, data);
  11254. }
  11255. /*! \overload
  11256. Adds the provided single data point as \a t, \a key and \a value tuple to the current data
  11257. \see removeData
  11258. */
  11259. void QCPCurve::addData(double t, double key, double value)
  11260. {
  11261. QCPCurveData newData;
  11262. newData.t = t;
  11263. newData.key = key;
  11264. newData.value = value;
  11265. mData->insertMulti(newData.t, newData);
  11266. }
  11267. /*! \overload
  11268. Adds the provided single data point as \a key and \a value pair to the current data The t
  11269. parameter of the data point is set to the t of the last data point plus 1. If there is no last
  11270. data point, t will be set to 0.
  11271. \see removeData
  11272. */
  11273. void QCPCurve::addData(double key, double value)
  11274. {
  11275. QCPCurveData newData;
  11276. if (!mData->isEmpty())
  11277. newData.t = (mData->constEnd()-1).key()+1;
  11278. else
  11279. newData.t = 0;
  11280. newData.key = key;
  11281. newData.value = value;
  11282. mData->insertMulti(newData.t, newData);
  11283. }
  11284. /*! \overload
  11285. Adds the provided data points as \a t, \a key and \a value tuples to the current data.
  11286. \see removeData
  11287. */
  11288. void QCPCurve::addData(const QVector<double> &ts, const QVector<double> &keys, const QVector<double> &values)
  11289. {
  11290. int n = ts.size();
  11291. n = qMin(n, keys.size());
  11292. n = qMin(n, values.size());
  11293. QCPCurveData newData;
  11294. for (int i=0; i<n; ++i)
  11295. {
  11296. newData.t = ts[i];
  11297. newData.key = keys[i];
  11298. newData.value = values[i];
  11299. mData->insertMulti(newData.t, newData);
  11300. }
  11301. }
  11302. /*!
  11303. Removes all data points with curve parameter t smaller than \a t.
  11304. \see addData, clearData
  11305. */
  11306. void QCPCurve::removeDataBefore(double t)
  11307. {
  11308. QCPCurveDataMap::iterator it = mData->begin();
  11309. while (it != mData->end() && it.key() < t)
  11310. it = mData->erase(it);
  11311. }
  11312. /*!
  11313. Removes all data points with curve parameter t greater than \a t.
  11314. \see addData, clearData
  11315. */
  11316. void QCPCurve::removeDataAfter(double t)
  11317. {
  11318. if (mData->isEmpty()) return;
  11319. QCPCurveDataMap::iterator it = mData->upperBound(t);
  11320. while (it != mData->end())
  11321. it = mData->erase(it);
  11322. }
  11323. /*!
  11324. Removes all data points with curve parameter t between \a fromt and \a tot. if \a fromt is
  11325. greater or equal to \a tot, the function does nothing. To remove a single data point with known
  11326. t, use \ref removeData(double t).
  11327. \see addData, clearData
  11328. */
  11329. void QCPCurve::removeData(double fromt, double tot)
  11330. {
  11331. if (fromt >= tot || mData->isEmpty()) return;
  11332. QCPCurveDataMap::iterator it = mData->upperBound(fromt);
  11333. QCPCurveDataMap::iterator itEnd = mData->upperBound(tot);
  11334. while (it != itEnd)
  11335. it = mData->erase(it);
  11336. }
  11337. /*! \overload
  11338. Removes a single data point at curve parameter \a t. If the position is not known with absolute
  11339. precision, consider using \ref removeData(double fromt, double tot) with a small fuzziness
  11340. interval around the suspected position, depeding on the precision with which the curve parameter
  11341. is known.
  11342. \see addData, clearData
  11343. */
  11344. void QCPCurve::removeData(double t)
  11345. {
  11346. mData->remove(t);
  11347. }
  11348. /*!
  11349. Removes all data points.
  11350. \see removeData, removeDataAfter, removeDataBefore
  11351. */
  11352. void QCPCurve::clearData()
  11353. {
  11354. mData->clear();
  11355. }
  11356. /* inherits documentation from base class */
  11357. double QCPCurve::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  11358. {
  11359. Q_UNUSED(details)
  11360. if ((onlySelectable && !mSelectable) || mData->isEmpty())
  11361. return -1;
  11362. return pointDistance(pos);
  11363. }
  11364. /* inherits documentation from base class */
  11365. void QCPCurve::draw(QCPPainter *painter)
  11366. {
  11367. if (mData->isEmpty()) return;
  11368. // allocate line vector:
  11369. QVector<QPointF> *lineData = new QVector<QPointF>;
  11370. // fill with curve data:
  11371. getCurveData(lineData);
  11372. // check data validity if flag set:
  11373. #ifdef QCUSTOMPLOT_CHECK_DATA
  11374. QCPCurveDataMap::const_iterator it;
  11375. for (it = mData->constBegin(); it != mData->constEnd(); ++it)
  11376. {
  11377. if (QCP::isInvalidData(it.value().t) ||
  11378. QCP::isInvalidData(it.value().key, it.value().value))
  11379. qDebug() << Q_FUNC_INFO << "Data point at" << it.key() << "invalid." << "Plottable name:" << name();
  11380. }
  11381. #endif
  11382. // draw curve fill:
  11383. if (mainBrush().style() != Qt::NoBrush && mainBrush().color().alpha() != 0)
  11384. {
  11385. applyFillAntialiasingHint(painter);
  11386. painter->setPen(Qt::NoPen);
  11387. painter->setBrush(mainBrush());
  11388. painter->drawPolygon(QPolygonF(*lineData));
  11389. }
  11390. // draw curve line:
  11391. if (mLineStyle != lsNone && mainPen().style() != Qt::NoPen && mainPen().color().alpha() != 0)
  11392. {
  11393. applyDefaultAntialiasingHint(painter);
  11394. painter->setPen(mainPen());
  11395. painter->setBrush(Qt::NoBrush);
  11396. // if drawing solid line and not in PDF, use much faster line drawing instead of polyline:
  11397. if (mParentPlot->plottingHints().testFlag(QCP::phFastPolylines) &&
  11398. painter->pen().style() == Qt::SolidLine &&
  11399. !painter->modes().testFlag(QCPPainter::pmVectorized) &&
  11400. !painter->modes().testFlag(QCPPainter::pmNoCaching))
  11401. {
  11402. for (int i=1; i<lineData->size(); ++i)
  11403. painter->drawLine(lineData->at(i-1), lineData->at(i));
  11404. } else
  11405. {
  11406. painter->drawPolyline(QPolygonF(*lineData));
  11407. }
  11408. }
  11409. // draw scatters:
  11410. if (!mScatterStyle.isNone())
  11411. drawScatterPlot(painter, lineData);
  11412. // free allocated line data:
  11413. delete lineData;
  11414. }
  11415. /* inherits documentation from base class */
  11416. void QCPCurve::drawLegendIcon(QCPPainter *painter, const QRectF &rect) const
  11417. {
  11418. // draw fill:
  11419. if (mBrush.style() != Qt::NoBrush)
  11420. {
  11421. applyFillAntialiasingHint(painter);
  11422. painter->fillRect(QRectF(rect.left(), rect.top()+rect.height()/2.0, rect.width(), rect.height()/3.0), mBrush);
  11423. }
  11424. // draw line vertically centered:
  11425. if (mLineStyle != lsNone)
  11426. {
  11427. applyDefaultAntialiasingHint(painter);
  11428. painter->setPen(mPen);
  11429. painter->drawLine(QLineF(rect.left(), rect.top()+rect.height()/2.0, rect.right()+5, rect.top()+rect.height()/2.0)); // +5 on x2 else last segment is missing from dashed/dotted pens
  11430. }
  11431. // draw scatter symbol:
  11432. if (!mScatterStyle.isNone())
  11433. {
  11434. applyScattersAntialiasingHint(painter);
  11435. // scale scatter pixmap if it's too large to fit in legend icon rect:
  11436. if (mScatterStyle.shape() == QCPScatterStyle::ssPixmap && (mScatterStyle.pixmap().size().width() > rect.width() || mScatterStyle.pixmap().size().height() > rect.height()))
  11437. {
  11438. QCPScatterStyle scaledStyle(mScatterStyle);
  11439. scaledStyle.setPixmap(scaledStyle.pixmap().scaled(rect.size().toSize(), Qt::KeepAspectRatio, Qt::SmoothTransformation));
  11440. scaledStyle.applyTo(painter, mPen);
  11441. scaledStyle.drawShape(painter, QRectF(rect).center());
  11442. } else
  11443. {
  11444. mScatterStyle.applyTo(painter, mPen);
  11445. mScatterStyle.drawShape(painter, QRectF(rect).center());
  11446. }
  11447. }
  11448. }
  11449. /*! \internal
  11450. Draws scatter symbols at every data point passed in \a pointData. scatter symbols are independent of
  11451. the line style and are always drawn if scatter shape is not \ref QCPScatterStyle::ssNone.
  11452. */
  11453. void QCPCurve::drawScatterPlot(QCPPainter *painter, const QVector<QPointF> *pointData) const
  11454. {
  11455. // draw scatter point symbols:
  11456. applyScattersAntialiasingHint(painter);
  11457. mScatterStyle.applyTo(painter, mPen);
  11458. for (int i=0; i<pointData->size(); ++i)
  11459. mScatterStyle.drawShape(painter, pointData->at(i));
  11460. }
  11461. /*! \internal
  11462. called by QCPCurve::draw to generate a point vector (pixels) which represents the line of the
  11463. curve. Line segments that aren't visible in the current axis rect are handled in an optimized
  11464. way.
  11465. */
  11466. void QCPCurve::getCurveData(QVector<QPointF> *lineData) const
  11467. {
  11468. /* Extended sides of axis rect R divide space into 9 regions:
  11469. 1__|_4_|__7
  11470. 2__|_R_|__8
  11471. 3 | 6 | 9
  11472. General idea: If the two points of a line segment are in the same region (that is not R), the line segment corner is removed.
  11473. Curves outside R become straight lines closely outside of R which greatly reduces drawing time, yet keeps the look of lines and
  11474. fills inside R consistent.
  11475. The region R has index 5.
  11476. */
  11477. QCPAxis *keyAxis = mKeyAxis.data();
  11478. QCPAxis *valueAxis = mValueAxis.data();
  11479. if (!keyAxis || !valueAxis) { qDebug() << Q_FUNC_INFO << "invalid key or value axis"; return; }
  11480. QRect axisRect = mKeyAxis.data()->axisRect()->rect() & mValueAxis.data()->axisRect()->rect();
  11481. lineData->reserve(mData->size());
  11482. QCPCurveDataMap::const_iterator it;
  11483. int lastRegion = 5;
  11484. int currentRegion = 5;
  11485. double RLeft = keyAxis->range().lower;
  11486. double RRight = keyAxis->range().upper;
  11487. double RBottom = valueAxis->range().lower;
  11488. double RTop = valueAxis->range().upper;
  11489. double x, y; // current key/value
  11490. bool addedLastAlready = true;
  11491. bool firstPoint = true; // first point must always be drawn, to make sure fill works correctly
  11492. for (it = mData->constBegin(); it != mData->constEnd(); ++it)
  11493. {
  11494. x = it.value().key;
  11495. y = it.value().value;
  11496. // determine current region:
  11497. if (x < RLeft) // region 123
  11498. {
  11499. if (y > RTop)
  11500. currentRegion = 1;
  11501. else if (y < RBottom)
  11502. currentRegion = 3;
  11503. else
  11504. currentRegion = 2;
  11505. } else if (x > RRight) // region 789
  11506. {
  11507. if (y > RTop)
  11508. currentRegion = 7;
  11509. else if (y < RBottom)
  11510. currentRegion = 9;
  11511. else
  11512. currentRegion = 8;
  11513. } else // region 456
  11514. {
  11515. if (y > RTop)
  11516. currentRegion = 4;
  11517. else if (y < RBottom)
  11518. currentRegion = 6;
  11519. else
  11520. currentRegion = 5;
  11521. }
  11522. /*
  11523. Watch out, the next part is very tricky. It modifies the curve such that it seems like the
  11524. whole thing is still drawn, but actually the points outside the axisRect are simplified
  11525. ("optimized") greatly. There are some subtle special cases when line segments are large and
  11526. thereby each subsequent point may be in a different region or even skip some.
  11527. */
  11528. // determine whether to keep current point:
  11529. if (currentRegion == 5 || (firstPoint && mBrush.style() != Qt::NoBrush)) // current is in R, add current and last if it wasn't added already
  11530. {
  11531. if (!addedLastAlready) // in case curve just entered R, make sure the last point outside R is also drawn correctly
  11532. lineData->append(coordsToPixels((it-1).value().key, (it-1).value().value)); // add last point to vector
  11533. else if (lastRegion != 5) // added last already. If that's the case, we probably added it at optimized position. So go back and make sure it's at original position (else the angle changes under which this segment enters R)
  11534. {
  11535. if (!firstPoint) // because on firstPoint, currentRegion is 5 and addedLastAlready is true, although there is no last point
  11536. lineData->replace(lineData->size()-1, coordsToPixels((it-1).value().key, (it-1).value().value));
  11537. }
  11538. lineData->append(coordsToPixels(it.value().key, it.value().value)); // add current point to vector
  11539. addedLastAlready = true; // so in next iteration, we don't add this point twice
  11540. } else if (currentRegion != lastRegion) // changed region, add current and last if not added already
  11541. {
  11542. // using outsideCoordsToPixels instead of coorsToPixels for optimized point placement (places points just outside axisRect instead of potentially far away)
  11543. // if we're coming from R or we skip diagonally over the corner regions (so line might still be visible in R), we can't place points optimized
  11544. if (lastRegion == 5 || // coming from R
  11545. ((lastRegion==2 && currentRegion==4) || (lastRegion==4 && currentRegion==2)) || // skip top left diagonal
  11546. ((lastRegion==4 && currentRegion==8) || (lastRegion==8 && currentRegion==4)) || // skip top right diagonal
  11547. ((lastRegion==8 && currentRegion==6) || (lastRegion==6 && currentRegion==8)) || // skip bottom right diagonal
  11548. ((lastRegion==6 && currentRegion==2) || (lastRegion==2 && currentRegion==6)) // skip bottom left diagonal
  11549. )
  11550. {
  11551. // always add last point if not added already, original:
  11552. if (!addedLastAlready)
  11553. lineData->append(coordsToPixels((it-1).value().key, (it-1).value().value));
  11554. // add current point, original:
  11555. lineData->append(coordsToPixels(it.value().key, it.value().value));
  11556. } else // no special case that forbids optimized point placement, so do it:
  11557. {
  11558. // always add last point if not added already, optimized:
  11559. if (!addedLastAlready)
  11560. lineData->append(outsideCoordsToPixels((it-1).value().key, (it-1).value().value, currentRegion, axisRect));
  11561. // add current point, optimized:
  11562. lineData->append(outsideCoordsToPixels(it.value().key, it.value().value, currentRegion, axisRect));
  11563. }
  11564. addedLastAlready = true; // so that if next point enters 5, or crosses another region boundary, we don't add this point twice
  11565. } else // neither in R, nor crossed a region boundary, skip current point
  11566. {
  11567. addedLastAlready = false;
  11568. }
  11569. lastRegion = currentRegion;
  11570. firstPoint = false;
  11571. }
  11572. // If curve ends outside R, we want to add very last point so the fill looks like it should when the curve started inside R:
  11573. if (lastRegion != 5 && mBrush.style() != Qt::NoBrush && !mData->isEmpty())
  11574. lineData->append(coordsToPixels((mData->constEnd()-1).value().key, (mData->constEnd()-1).value().value));
  11575. }
  11576. /*! \internal
  11577. Calculates the (minimum) distance (in pixels) the curve's representation has from the given \a
  11578. pixelPoint in pixels. This is used to determine whether the curve was clicked or not, e.g. in
  11579. \ref selectTest.
  11580. */
  11581. double QCPCurve::pointDistance(const QPointF &pixelPoint) const
  11582. {
  11583. if (mData->isEmpty())
  11584. {
  11585. qDebug() << Q_FUNC_INFO << "requested point distance on curve" << mName << "without data";
  11586. return 500;
  11587. }
  11588. if (mData->size() == 1)
  11589. {
  11590. QPointF dataPoint = coordsToPixels(mData->constBegin().key(), mData->constBegin().value().value);
  11591. return QVector2D(dataPoint-pixelPoint).length();
  11592. }
  11593. // calculate minimum distance to line segments:
  11594. QVector<QPointF> *lineData = new QVector<QPointF>;
  11595. getCurveData(lineData);
  11596. double minDistSqr = std::numeric_limits<double>::max();
  11597. for (int i=0; i<lineData->size()-1; ++i)
  11598. {
  11599. double currentDistSqr = distSqrToLine(lineData->at(i), lineData->at(i+1), pixelPoint);
  11600. if (currentDistSqr < minDistSqr)
  11601. minDistSqr = currentDistSqr;
  11602. }
  11603. delete lineData;
  11604. return sqrt(minDistSqr);
  11605. }
  11606. /*! \internal
  11607. This is a specialized \ref coordsToPixels function for points that are outside the visible
  11608. axisRect and just crossing a boundary (since \ref getCurveData reduces non-visible curve segments
  11609. to those line segments that cross region boundaries, see documentation there). It only uses the
  11610. coordinate parallel to the region boundary of the axisRect. The other coordinate is picked just
  11611. outside the axisRect (how far is determined by the scatter size and the line width). Together
  11612. with the optimization in \ref getCurveData this improves performance for large curves (or zoomed
  11613. in ones) significantly while keeping the illusion the whole curve and its filling is still being
  11614. drawn for the viewer.
  11615. */
  11616. QPointF QCPCurve::outsideCoordsToPixels(double key, double value, int region, QRect axisRect) const
  11617. {
  11618. int margin = qCeil(qMax(mScatterStyle.size(), (double)mPen.widthF())) + 2;
  11619. QPointF result = coordsToPixels(key, value);
  11620. switch (region)
  11621. {
  11622. case 2: result.setX(axisRect.left()-margin); break; // left
  11623. case 8: result.setX(axisRect.right()+margin); break; // right
  11624. case 4: result.setY(axisRect.top()-margin); break; // top
  11625. case 6: result.setY(axisRect.bottom()+margin); break; // bottom
  11626. case 1: result.setX(axisRect.left()-margin);
  11627. result.setY(axisRect.top()-margin); break; // top left
  11628. case 7: result.setX(axisRect.right()+margin);
  11629. result.setY(axisRect.top()-margin); break; // top right
  11630. case 9: result.setX(axisRect.right()+margin);
  11631. result.setY(axisRect.bottom()+margin); break; // bottom right
  11632. case 3: result.setX(axisRect.left()-margin);
  11633. result.setY(axisRect.bottom()+margin); break; // bottom left
  11634. }
  11635. return result;
  11636. }
  11637. /* inherits documentation from base class */
  11638. QCPRange QCPCurve::getKeyRange(bool &validRange, SignDomain inSignDomain) const
  11639. {
  11640. QCPRange range;
  11641. bool haveLower = false;
  11642. bool haveUpper = false;
  11643. double current;
  11644. QCPCurveDataMap::const_iterator it = mData->constBegin();
  11645. while (it != mData->constEnd())
  11646. {
  11647. current = it.value().key;
  11648. if (inSignDomain == sdBoth || (inSignDomain == sdNegative && current < 0) || (inSignDomain == sdPositive && current > 0))
  11649. {
  11650. if (current < range.lower || !haveLower)
  11651. {
  11652. range.lower = current;
  11653. haveLower = true;
  11654. }
  11655. if (current > range.upper || !haveUpper)
  11656. {
  11657. range.upper = current;
  11658. haveUpper = true;
  11659. }
  11660. }
  11661. ++it;
  11662. }
  11663. validRange = haveLower && haveUpper;
  11664. return range;
  11665. }
  11666. /* inherits documentation from base class */
  11667. QCPRange QCPCurve::getValueRange(bool &validRange, SignDomain inSignDomain) const
  11668. {
  11669. QCPRange range;
  11670. bool haveLower = false;
  11671. bool haveUpper = false;
  11672. double current;
  11673. QCPCurveDataMap::const_iterator it = mData->constBegin();
  11674. while (it != mData->constEnd())
  11675. {
  11676. current = it.value().value;
  11677. if (inSignDomain == sdBoth || (inSignDomain == sdNegative && current < 0) || (inSignDomain == sdPositive && current > 0))
  11678. {
  11679. if (current < range.lower || !haveLower)
  11680. {
  11681. range.lower = current;
  11682. haveLower = true;
  11683. }
  11684. if (current > range.upper || !haveUpper)
  11685. {
  11686. range.upper = current;
  11687. haveUpper = true;
  11688. }
  11689. }
  11690. ++it;
  11691. }
  11692. validRange = haveLower && haveUpper;
  11693. return range;
  11694. }
  11695. ////////////////////////////////////////////////////////////////////////////////////////////////////
  11696. //////////////////// QCPBarData
  11697. ////////////////////////////////////////////////////////////////////////////////////////////////////
  11698. /*! \class QCPBarData
  11699. \brief Holds the data of one single data point (one bar) for QCPBars.
  11700. The container for storing multiple data points is \ref QCPBarDataMap.
  11701. The stored data is:
  11702. \li \a key: coordinate on the key axis of this bar
  11703. \li \a value: height coordinate on the value axis of this bar
  11704. \see QCPBarDataaMap
  11705. */
  11706. /*!
  11707. Constructs a bar data point with key and value set to zero.
  11708. */
  11709. QCPBarData::QCPBarData() :
  11710. key(0),
  11711. value(0)
  11712. {
  11713. }
  11714. /*!
  11715. Constructs a bar data point with the specified \a key and \a value.
  11716. */
  11717. QCPBarData::QCPBarData(double key, double value) :
  11718. key(key),
  11719. value(value)
  11720. {
  11721. }
  11722. ////////////////////////////////////////////////////////////////////////////////////////////////////
  11723. //////////////////// QCPBars
  11724. ////////////////////////////////////////////////////////////////////////////////////////////////////
  11725. /*! \class QCPBars
  11726. \brief A plottable representing a bar chart in a plot.
  11727. \image html QCPBars.png
  11728. To plot data, assign it with the \ref setData or \ref addData functions.
  11729. \section appearance Changing the appearance
  11730. The appearance of the bars is determined by the pen and the brush (\ref setPen, \ref setBrush).
  11731. Bar charts are stackable. This means, Two QCPBars plottables can be placed on top of each other
  11732. (see \ref QCPBars::moveAbove). Then, when two bars are at the same key position, they will appear
  11733. stacked.
  11734. \section usage Usage
  11735. Like all data representing objects in QCustomPlot, the QCPBars is a plottable
  11736. (QCPAbstractPlottable). So the plottable-interface of QCustomPlot applies
  11737. (QCustomPlot::plottable, QCustomPlot::addPlottable, QCustomPlot::removePlottable, etc.)
  11738. Usually, you first create an instance:
  11739. \code
  11740. QCPBars *newBars = new QCPBars(customPlot->xAxis, customPlot->yAxis);\endcode
  11741. add it to the customPlot with QCustomPlot::addPlottable:
  11742. \code
  11743. customPlot->addPlottable(newBars);\endcode
  11744. and then modify the properties of the newly created plottable, e.g.:
  11745. \code
  11746. newBars->setName("Country population");
  11747. newBars->setData(xData, yData);\endcode
  11748. */
  11749. /*! \fn QCPBars *QCPBars::barBelow() const
  11750. Returns the bars plottable that is directly below this bars plottable.
  11751. If there is no such plottable, returns 0.
  11752. \see barAbove, moveBelow, moveAbove
  11753. */
  11754. /*! \fn QCPBars *QCPBars::barAbove() const
  11755. Returns the bars plottable that is directly above this bars plottable.
  11756. If there is no such plottable, returns 0.
  11757. \see barBelow, moveBelow, moveAbove
  11758. */
  11759. /*!
  11760. Constructs a bar chart which uses \a keyAxis as its key axis ("x") and \a valueAxis as its value
  11761. axis ("y"). \a keyAxis and \a valueAxis must reside in the same QCustomPlot instance and not have
  11762. the same orientation. If either of these restrictions is violated, a corresponding message is
  11763. printed to the debug output (qDebug), the construction is not aborted, though.
  11764. The constructed QCPBars can be added to the plot with QCustomPlot::addPlottable, QCustomPlot
  11765. then takes ownership of the bar chart.
  11766. */
  11767. QCPBars::QCPBars(QCPAxis *keyAxis, QCPAxis *valueAxis) :
  11768. QCPAbstractPlottable(keyAxis, valueAxis)
  11769. {
  11770. mData = new QCPBarDataMap;
  11771. mPen.setColor(Qt::blue);
  11772. mPen.setStyle(Qt::SolidLine);
  11773. mBrush.setColor(QColor(40, 50, 255, 30));
  11774. mBrush.setStyle(Qt::SolidPattern);
  11775. mSelectedPen = mPen;
  11776. mSelectedPen.setWidthF(2.5);
  11777. mSelectedPen.setColor(QColor(80, 80, 255)); // lighter than Qt::blue of mPen
  11778. mSelectedBrush = mBrush;
  11779. mWidth = 0.75;
  11780. }
  11781. QCPBars::~QCPBars()
  11782. {
  11783. if (mBarBelow || mBarAbove)
  11784. connectBars(mBarBelow.data(), mBarAbove.data()); // take this bar out of any stacking
  11785. delete mData;
  11786. }
  11787. /*!
  11788. Sets the width of the bars in plot (key) coordinates.
  11789. */
  11790. void QCPBars::setWidth(double width)
  11791. {
  11792. mWidth = width;
  11793. }
  11794. /*!
  11795. Replaces the current data with the provided \a data.
  11796. If \a copy is set to true, data points in \a data will only be copied. if false, the plottable
  11797. takes ownership of the passed data and replaces the internal data pointer with it. This is
  11798. significantly faster than copying for large datasets.
  11799. */
  11800. void QCPBars::setData(QCPBarDataMap *data, bool copy)
  11801. {
  11802. if (copy)
  11803. {
  11804. *mData = *data;
  11805. } else
  11806. {
  11807. delete mData;
  11808. mData = data;
  11809. }
  11810. }
  11811. /*! \overload
  11812. Replaces the current data with the provided points in \a key and \a value tuples. The
  11813. provided vectors should have equal length. Else, the number of added points will be the size of
  11814. the smallest vector.
  11815. */
  11816. void QCPBars::setData(const QVector<double> &key, const QVector<double> &value)
  11817. {
  11818. mData->clear();
  11819. int n = key.size();
  11820. n = qMin(n, value.size());
  11821. QCPBarData newData;
  11822. for (int i=0; i<n; ++i)
  11823. {
  11824. newData.key = key[i];
  11825. newData.value = value[i];
  11826. mData->insertMulti(newData.key, newData);
  11827. }
  11828. }
  11829. /*!
  11830. Moves this bars plottable below \a bars. In other words, the bars of this plottable will appear
  11831. below the bars of \a bars. The move target \a bars must use the same key and value axis as this
  11832. plottable.
  11833. Inserting into and removing from existing bar stacking is handled gracefully. If \a bars already
  11834. has a bars object below itself, this bars object is inserted between the two. If this bars object
  11835. is already between two other bars, the two other bars will be stacked on top of each other after
  11836. the operation.
  11837. To remove this bars plottable from any stacking, set \a bars to 0.
  11838. \see moveBelow, barAbove, barBelow
  11839. */
  11840. void QCPBars::moveBelow(QCPBars *bars)
  11841. {
  11842. if (bars == this) return;
  11843. if (bars && (bars->keyAxis() != mKeyAxis.data() || bars->valueAxis() != mValueAxis.data()))
  11844. {
  11845. qDebug() << Q_FUNC_INFO << "passed QCPBars* doesn't have same key and value axis as this QCPBars";
  11846. return;
  11847. }
  11848. // remove from stacking:
  11849. connectBars(mBarBelow.data(), mBarAbove.data()); // Note: also works if one (or both) of them is 0
  11850. // if new bar given, insert this bar below it:
  11851. if (bars)
  11852. {
  11853. if (bars->mBarBelow)
  11854. connectBars(bars->mBarBelow.data(), this);
  11855. connectBars(this, bars);
  11856. }
  11857. }
  11858. /*!
  11859. Moves this bars plottable above \a bars. In other words, the bars of this plottable will appear
  11860. above the bars of \a bars. The move target \a bars must use the same key and value axis as this
  11861. plottable.
  11862. Inserting into and removing from existing bar stacking is handled gracefully. If \a bars already
  11863. has a bars object below itself, this bars object is inserted between the two. If this bars object
  11864. is already between two other bars, the two other bars will be stacked on top of each other after
  11865. the operation.
  11866. To remove this bars plottable from any stacking, set \a bars to 0.
  11867. \see moveBelow, barBelow, barAbove
  11868. */
  11869. void QCPBars::moveAbove(QCPBars *bars)
  11870. {
  11871. if (bars == this) return;
  11872. if (bars && (bars->keyAxis() != mKeyAxis.data() || bars->valueAxis() != mValueAxis.data()))
  11873. {
  11874. qDebug() << Q_FUNC_INFO << "passed QCPBars* doesn't have same key and value axis as this QCPBars";
  11875. return;
  11876. }
  11877. // remove from stacking:
  11878. connectBars(mBarBelow.data(), mBarAbove.data()); // Note: also works if one (or both) of them is 0
  11879. // if new bar given, insert this bar above it:
  11880. if (bars)
  11881. {
  11882. if (bars->mBarAbove)
  11883. connectBars(this, bars->mBarAbove.data());
  11884. connectBars(bars, this);
  11885. }
  11886. }
  11887. /*!
  11888. Adds the provided data points in \a dataMap to the current data.
  11889. \see removeData
  11890. */
  11891. void QCPBars::addData(const QCPBarDataMap &dataMap)
  11892. {
  11893. mData->unite(dataMap);
  11894. }
  11895. /*! \overload
  11896. Adds the provided single data point in \a data to the current data.
  11897. \see removeData
  11898. */
  11899. void QCPBars::addData(const QCPBarData &data)
  11900. {
  11901. mData->insertMulti(data.key, data);
  11902. }
  11903. /*! \overload
  11904. Adds the provided single data point as \a key and \a value tuple to the current data
  11905. \see removeData
  11906. */
  11907. void QCPBars::addData(double key, double value)
  11908. {
  11909. QCPBarData newData;
  11910. newData.key = key;
  11911. newData.value = value;
  11912. mData->insertMulti(newData.key, newData);
  11913. }
  11914. /*! \overload
  11915. Adds the provided data points as \a key and \a value tuples to the current data.
  11916. \see removeData
  11917. */
  11918. void QCPBars::addData(const QVector<double> &keys, const QVector<double> &values)
  11919. {
  11920. int n = keys.size();
  11921. n = qMin(n, values.size());
  11922. QCPBarData newData;
  11923. for (int i=0; i<n; ++i)
  11924. {
  11925. newData.key = keys[i];
  11926. newData.value = values[i];
  11927. mData->insertMulti(newData.key, newData);
  11928. }
  11929. }
  11930. /*!
  11931. Removes all data points with key smaller than \a key.
  11932. \see addData, clearData
  11933. */
  11934. void QCPBars::removeDataBefore(double key)
  11935. {
  11936. QCPBarDataMap::iterator it = mData->begin();
  11937. while (it != mData->end() && it.key() < key)
  11938. it = mData->erase(it);
  11939. }
  11940. /*!
  11941. Removes all data points with key greater than \a key.
  11942. \see addData, clearData
  11943. */
  11944. void QCPBars::removeDataAfter(double key)
  11945. {
  11946. if (mData->isEmpty()) return;
  11947. QCPBarDataMap::iterator it = mData->upperBound(key);
  11948. while (it != mData->end())
  11949. it = mData->erase(it);
  11950. }
  11951. /*!
  11952. Removes all data points with key between \a fromKey and \a toKey. if \a fromKey is
  11953. greater or equal to \a toKey, the function does nothing. To remove a single data point with known
  11954. key, use \ref removeData(double key).
  11955. \see addData, clearData
  11956. */
  11957. void QCPBars::removeData(double fromKey, double toKey)
  11958. {
  11959. if (fromKey >= toKey || mData->isEmpty()) return;
  11960. QCPBarDataMap::iterator it = mData->upperBound(fromKey);
  11961. QCPBarDataMap::iterator itEnd = mData->upperBound(toKey);
  11962. while (it != itEnd)
  11963. it = mData->erase(it);
  11964. }
  11965. /*! \overload
  11966. Removes a single data point at \a key. If the position is not known with absolute precision,
  11967. consider using \ref removeData(double fromKey, double toKey) with a small fuzziness interval
  11968. around the suspected position, depeding on the precision with which the key is known.
  11969. \see addData, clearData
  11970. */
  11971. void QCPBars::removeData(double key)
  11972. {
  11973. mData->remove(key);
  11974. }
  11975. /*!
  11976. Removes all data points.
  11977. \see removeData, removeDataAfter, removeDataBefore
  11978. */
  11979. void QCPBars::clearData()
  11980. {
  11981. mData->clear();
  11982. }
  11983. /* inherits documentation from base class */
  11984. double QCPBars::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  11985. {
  11986. Q_UNUSED(details)
  11987. if (onlySelectable && !mSelectable)
  11988. return -1;
  11989. QCPBarDataMap::ConstIterator it;
  11990. double posKey, posValue;
  11991. pixelsToCoords(pos, posKey, posValue);
  11992. for (it = mData->constBegin(); it != mData->constEnd(); ++it)
  11993. {
  11994. double baseValue = getBaseValue(it.key(), it.value().value >=0);
  11995. QCPRange keyRange(it.key()-mWidth*0.5, it.key()+mWidth*0.5);
  11996. QCPRange valueRange(baseValue, baseValue+it.value().value);
  11997. if (keyRange.contains(posKey) && valueRange.contains(posValue))
  11998. return mParentPlot->selectionTolerance()*0.99;
  11999. }
  12000. return -1;
  12001. }
  12002. /* inherits documentation from base class */
  12003. void QCPBars::draw(QCPPainter *painter)
  12004. {
  12005. if (!mKeyAxis || !mValueAxis) { qDebug() << Q_FUNC_INFO << "invalid key or value axis"; return; }
  12006. if (mData->isEmpty()) return;
  12007. QCPBarDataMap::const_iterator it;
  12008. for (it = mData->constBegin(); it != mData->constEnd(); ++it)
  12009. {
  12010. // skip bar if not visible in key axis range:
  12011. if (it.key()+mWidth*0.5 < mKeyAxis.data()->range().lower || it.key()-mWidth*0.5 > mKeyAxis.data()->range().upper)
  12012. continue;
  12013. // check data validity if flag set:
  12014. #ifdef QCUSTOMPLOT_CHECK_DATA
  12015. if (QCP::isInvalidData(it.value().key, it.value().value))
  12016. qDebug() << Q_FUNC_INFO << "Data point at" << it.key() << "of drawn range invalid." << "Plottable name:" << name();
  12017. #endif
  12018. QPolygonF barPolygon = getBarPolygon(it.key(), it.value().value);
  12019. // draw bar fill:
  12020. if (mainBrush().style() != Qt::NoBrush && mainBrush().color().alpha() != 0)
  12021. {
  12022. applyFillAntialiasingHint(painter);
  12023. painter->setPen(Qt::NoPen);
  12024. painter->setBrush(mainBrush());
  12025. painter->drawPolygon(barPolygon);
  12026. }
  12027. // draw bar line:
  12028. if (mainPen().style() != Qt::NoPen && mainPen().color().alpha() != 0)
  12029. {
  12030. applyDefaultAntialiasingHint(painter);
  12031. painter->setPen(mainPen());
  12032. painter->setBrush(Qt::NoBrush);
  12033. painter->drawPolyline(barPolygon);
  12034. }
  12035. }
  12036. }
  12037. /* inherits documentation from base class */
  12038. void QCPBars::drawLegendIcon(QCPPainter *painter, const QRectF &rect) const
  12039. {
  12040. // draw filled rect:
  12041. applyDefaultAntialiasingHint(painter);
  12042. painter->setBrush(mBrush);
  12043. painter->setPen(mPen);
  12044. QRectF r = QRectF(0, 0, rect.width()*0.67, rect.height()*0.67);
  12045. r.moveCenter(rect.center());
  12046. painter->drawRect(r);
  12047. }
  12048. /*! \internal
  12049. Returns the polygon of a single bar with \a key and \a value. The Polygon is open at the bottom
  12050. and shifted according to the bar stacking (see \ref moveAbove).
  12051. */
  12052. QPolygonF QCPBars::getBarPolygon(double key, double value) const
  12053. {
  12054. QPolygonF result;
  12055. double baseValue = getBaseValue(key, value >= 0);
  12056. result << coordsToPixels(key-mWidth*0.5, baseValue);
  12057. result << coordsToPixels(key-mWidth*0.5, baseValue+value);
  12058. result << coordsToPixels(key+mWidth*0.5, baseValue+value);
  12059. result << coordsToPixels(key+mWidth*0.5, baseValue);
  12060. return result;
  12061. }
  12062. /*! \internal
  12063. This function is called to find at which value to start drawing the base of a bar at \a key, when
  12064. it is stacked on top of another QCPBars (e.g. with \ref moveAbove).
  12065. positive and negative bars are separated per stack (positive are stacked above 0-value upwards,
  12066. negative are stacked below 0-value downwards). This can be indicated with \a positive. So if the
  12067. bar for which we need the base value is negative, set \a positive to false.
  12068. */
  12069. double QCPBars::getBaseValue(double key, bool positive) const
  12070. {
  12071. if (mBarBelow)
  12072. {
  12073. double max = 0;
  12074. // find bars of mBarBelow that are approximately at key and find largest one:
  12075. QCPBarDataMap::const_iterator it = mBarBelow.data()->mData->lowerBound(key-mWidth*0.1);
  12076. QCPBarDataMap::const_iterator itEnd = mBarBelow.data()->mData->upperBound(key+mWidth*0.1);
  12077. while (it != itEnd)
  12078. {
  12079. if ((positive && it.value().value > max) ||
  12080. (!positive && it.value().value < max))
  12081. max = it.value().value;
  12082. ++it;
  12083. }
  12084. // recurse down the bar-stack to find the total height:
  12085. return max + mBarBelow.data()->getBaseValue(key, positive);
  12086. } else
  12087. return 0;
  12088. }
  12089. /*! \internal
  12090. Connects \a below and \a above to each other via their mBarAbove/mBarBelow properties.
  12091. The bar(s) currently below lower and upper will become disconnected to lower/upper.
  12092. If lower is zero, upper will be disconnected at the bottom.
  12093. If upper is zero, lower will be disconnected at the top.
  12094. */
  12095. void QCPBars::connectBars(QCPBars *lower, QCPBars *upper)
  12096. {
  12097. if (!lower && !upper) return;
  12098. if (!lower) // disconnect upper at bottom
  12099. {
  12100. // disconnect old bar below upper:
  12101. if (upper->mBarBelow && upper->mBarBelow.data()->mBarAbove.data() == upper)
  12102. upper->mBarBelow.data()->mBarAbove = 0;
  12103. upper->mBarBelow = 0;
  12104. } else if (!upper) // disconnect lower at top
  12105. {
  12106. // disconnect old bar above lower:
  12107. if (lower->mBarAbove && lower->mBarAbove.data()->mBarBelow.data() == lower)
  12108. lower->mBarAbove.data()->mBarBelow = 0;
  12109. lower->mBarAbove = 0;
  12110. } else // connect lower and upper
  12111. {
  12112. // disconnect old bar above lower:
  12113. if (lower->mBarAbove && lower->mBarAbove.data()->mBarBelow.data() == lower)
  12114. lower->mBarAbove.data()->mBarBelow = 0;
  12115. // disconnect old bar below upper:
  12116. if (upper->mBarBelow && upper->mBarBelow.data()->mBarAbove.data() == upper)
  12117. upper->mBarBelow.data()->mBarAbove = 0;
  12118. lower->mBarAbove = upper;
  12119. upper->mBarBelow = lower;
  12120. }
  12121. }
  12122. /* inherits documentation from base class */
  12123. QCPRange QCPBars::getKeyRange(bool &validRange, SignDomain inSignDomain) const
  12124. {
  12125. QCPRange range;
  12126. bool haveLower = false;
  12127. bool haveUpper = false;
  12128. double current;
  12129. double barWidthHalf = mWidth*0.5;
  12130. QCPBarDataMap::const_iterator it = mData->constBegin();
  12131. while (it != mData->constEnd())
  12132. {
  12133. current = it.value().key;
  12134. if (inSignDomain == sdBoth || (inSignDomain == sdNegative && current+barWidthHalf < 0) || (inSignDomain == sdPositive && current-barWidthHalf > 0))
  12135. {
  12136. if (current-barWidthHalf < range.lower || !haveLower)
  12137. {
  12138. range.lower = current-barWidthHalf;
  12139. haveLower = true;
  12140. }
  12141. if (current+barWidthHalf > range.upper || !haveUpper)
  12142. {
  12143. range.upper = current+barWidthHalf;
  12144. haveUpper = true;
  12145. }
  12146. }
  12147. ++it;
  12148. }
  12149. validRange = haveLower && haveUpper;
  12150. return range;
  12151. }
  12152. /* inherits documentation from base class */
  12153. QCPRange QCPBars::getValueRange(bool &validRange, SignDomain inSignDomain) const
  12154. {
  12155. QCPRange range;
  12156. bool haveLower = true; // set to true, because 0 should always be visible in bar charts
  12157. bool haveUpper = true; // set to true, because 0 should always be visible in bar charts
  12158. double current;
  12159. QCPBarDataMap::const_iterator it = mData->constBegin();
  12160. while (it != mData->constEnd())
  12161. {
  12162. current = it.value().value + getBaseValue(it.value().key, it.value().value >= 0);
  12163. if (inSignDomain == sdBoth || (inSignDomain == sdNegative && current < 0) || (inSignDomain == sdPositive && current > 0))
  12164. {
  12165. if (current < range.lower || !haveLower)
  12166. {
  12167. range.lower = current;
  12168. haveLower = true;
  12169. }
  12170. if (current > range.upper || !haveUpper)
  12171. {
  12172. range.upper = current;
  12173. haveUpper = true;
  12174. }
  12175. }
  12176. ++it;
  12177. }
  12178. validRange = range.lower < range.upper;
  12179. return range;
  12180. }
  12181. ////////////////////////////////////////////////////////////////////////////////////////////////////
  12182. //////////////////// QCPStatisticalBox
  12183. ////////////////////////////////////////////////////////////////////////////////////////////////////
  12184. /*! \class QCPStatisticalBox
  12185. \brief A plottable representing a single statistical box in a plot.
  12186. \image html QCPStatisticalBox.png
  12187. To plot data, assign it with the individual parameter functions or use \ref setData to set all
  12188. parameters at once. The individual funcions are:
  12189. \li \ref setMinimum
  12190. \li \ref setLowerQuartile
  12191. \li \ref setMedian
  12192. \li \ref setUpperQuartile
  12193. \li \ref setMaximum
  12194. Additionally you can define a list of outliers, drawn as circle datapoints:
  12195. \li \ref setOutliers
  12196. \section appearance Changing the appearance
  12197. The appearance of the box itself is controlled via \ref setPen and \ref setBrush. You may change
  12198. the width of the box with \ref setWidth in plot coordinates (not pixels).
  12199. Analog functions exist for the minimum/maximum-whiskers: \ref setWhiskerPen, \ref
  12200. setWhiskerBarPen, \ref setWhiskerWidth. The whisker width is the width of the bar at the top
  12201. (maximum) and bottom (minimum).
  12202. The median indicator line has its own pen, \ref setMedianPen.
  12203. If the whisker backbone pen is changed, make sure to set the capStyle to Qt::FlatCap. Else, the
  12204. backbone line might exceed the whisker bars by a few pixels due to the pen cap being not
  12205. perfectly flat.
  12206. The Outlier data points are drawn as normal scatter points. Their look can be controlled with
  12207. \ref setOutlierStyle
  12208. \section usage Usage
  12209. Like all data representing objects in QCustomPlot, the QCPStatisticalBox is a plottable
  12210. (QCPAbstractPlottable). So the plottable-interface of QCustomPlot applies
  12211. (QCustomPlot::plottable, QCustomPlot::addPlottable, QCustomPlot::removePlottable, etc.)
  12212. Usually, you first create an instance:
  12213. \code
  12214. QCPStatisticalBox *newBox = new QCPStatisticalBox(customPlot->xAxis, customPlot->yAxis);\endcode
  12215. add it to the customPlot with QCustomPlot::addPlottable:
  12216. \code
  12217. customPlot->addPlottable(newBox);\endcode
  12218. and then modify the properties of the newly created plottable, e.g.:
  12219. \code
  12220. newBox->setName("Measurement Series 1");
  12221. newBox->setData(1, 3, 4, 5, 7);
  12222. newBox->setOutliers(QVector<double>() << 0.5 << 0.64 << 7.2 << 7.42);\endcode
  12223. */
  12224. /*!
  12225. Constructs a statistical box which uses \a keyAxis as its key axis ("x") and \a valueAxis as its
  12226. value axis ("y"). \a keyAxis and \a valueAxis must reside in the same QCustomPlot instance and
  12227. not have the same orientation. If either of these restrictions is violated, a corresponding
  12228. message is printed to the debug output (qDebug), the construction is not aborted, though.
  12229. The constructed statistical box can be added to the plot with QCustomPlot::addPlottable,
  12230. QCustomPlot then takes ownership of the statistical box.
  12231. */
  12232. QCPStatisticalBox::QCPStatisticalBox(QCPAxis *keyAxis, QCPAxis *valueAxis) :
  12233. QCPAbstractPlottable(keyAxis, valueAxis),
  12234. mKey(0),
  12235. mMinimum(0),
  12236. mLowerQuartile(0),
  12237. mMedian(0),
  12238. mUpperQuartile(0),
  12239. mMaximum(0)
  12240. {
  12241. setOutlierStyle(QCPScatterStyle(QCPScatterStyle::ssCircle, Qt::blue, 6));
  12242. setWhiskerWidth(0.2);
  12243. setWidth(0.5);
  12244. setPen(QPen(Qt::black));
  12245. setSelectedPen(QPen(Qt::blue, 2.5));
  12246. setMedianPen(QPen(Qt::black, 3, Qt::SolidLine, Qt::FlatCap));
  12247. setWhiskerPen(QPen(Qt::black, 0, Qt::DashLine, Qt::FlatCap));
  12248. setWhiskerBarPen(QPen(Qt::black));
  12249. setBrush(Qt::NoBrush);
  12250. setSelectedBrush(Qt::NoBrush);
  12251. }
  12252. /*!
  12253. Sets the key coordinate of the statistical box.
  12254. */
  12255. void QCPStatisticalBox::setKey(double key)
  12256. {
  12257. mKey = key;
  12258. }
  12259. /*!
  12260. Sets the parameter "minimum" of the statistical box plot. This is the position of the lower
  12261. whisker, typically the minimum measurement of the sample that's not considered an outlier.
  12262. \see setMaximum, setWhiskerPen, setWhiskerBarPen, setWhiskerWidth
  12263. */
  12264. void QCPStatisticalBox::setMinimum(double value)
  12265. {
  12266. mMinimum = value;
  12267. }
  12268. /*!
  12269. Sets the parameter "lower Quartile" of the statistical box plot. This is the lower end of the
  12270. box. The lower and the upper quartiles are the two statistical quartiles around the median of the
  12271. sample, they contain 50% of the sample data.
  12272. \see setUpperQuartile, setPen, setBrush, setWidth
  12273. */
  12274. void QCPStatisticalBox::setLowerQuartile(double value)
  12275. {
  12276. mLowerQuartile = value;
  12277. }
  12278. /*!
  12279. Sets the parameter "median" of the statistical box plot. This is the value of the median mark
  12280. inside the quartile box. The median separates the sample data in half (50% of the sample data is
  12281. below/above the median).
  12282. \see setMedianPen
  12283. */
  12284. void QCPStatisticalBox::setMedian(double value)
  12285. {
  12286. mMedian = value;
  12287. }
  12288. /*!
  12289. Sets the parameter "upper Quartile" of the statistical box plot. This is the upper end of the
  12290. box. The lower and the upper quartiles are the two statistical quartiles around the median of the
  12291. sample, they contain 50% of the sample data.
  12292. \see setLowerQuartile, setPen, setBrush, setWidth
  12293. */
  12294. void QCPStatisticalBox::setUpperQuartile(double value)
  12295. {
  12296. mUpperQuartile = value;
  12297. }
  12298. /*!
  12299. Sets the parameter "maximum" of the statistical box plot. This is the position of the upper
  12300. whisker, typically the maximum measurement of the sample that's not considered an outlier.
  12301. \see setMinimum, setWhiskerPen, setWhiskerBarPen, setWhiskerWidth
  12302. */
  12303. void QCPStatisticalBox::setMaximum(double value)
  12304. {
  12305. mMaximum = value;
  12306. }
  12307. /*!
  12308. Sets a vector of outlier values that will be drawn as circles. Any data points in the sample that
  12309. are not within the whiskers (\ref setMinimum, \ref setMaximum) should be considered outliers and
  12310. displayed as such.
  12311. \see setOutlierStyle
  12312. */
  12313. void QCPStatisticalBox::setOutliers(const QVector<double> &values)
  12314. {
  12315. mOutliers = values;
  12316. }
  12317. /*!
  12318. Sets all parameters of the statistical box plot at once.
  12319. \see setKey, setMinimum, setLowerQuartile, setMedian, setUpperQuartile, setMaximum
  12320. */
  12321. void QCPStatisticalBox::setData(double key, double minimum, double lowerQuartile, double median, double upperQuartile, double maximum)
  12322. {
  12323. setKey(key);
  12324. setMinimum(minimum);
  12325. setLowerQuartile(lowerQuartile);
  12326. setMedian(median);
  12327. setUpperQuartile(upperQuartile);
  12328. setMaximum(maximum);
  12329. }
  12330. /*!
  12331. Sets the width of the box in key coordinates.
  12332. \see setWhiskerWidth
  12333. */
  12334. void QCPStatisticalBox::setWidth(double width)
  12335. {
  12336. mWidth = width;
  12337. }
  12338. /*!
  12339. Sets the width of the whiskers (\ref setMinimum, \ref setMaximum) in key coordinates.
  12340. \see setWidth
  12341. */
  12342. void QCPStatisticalBox::setWhiskerWidth(double width)
  12343. {
  12344. mWhiskerWidth = width;
  12345. }
  12346. /*!
  12347. Sets the pen used for drawing the whisker backbone (That's the line parallel to the value axis).
  12348. Make sure to set the \a pen capStyle to Qt::FlatCap to prevent the whisker backbone from reaching
  12349. a few pixels past the whisker bars, when using a non-zero pen width.
  12350. \see setWhiskerBarPen
  12351. */
  12352. void QCPStatisticalBox::setWhiskerPen(const QPen &pen)
  12353. {
  12354. mWhiskerPen = pen;
  12355. }
  12356. /*!
  12357. Sets the pen used for drawing the whisker bars (Those are the lines parallel to the key axis at
  12358. each end of the whisker backbone).
  12359. \see setWhiskerPen
  12360. */
  12361. void QCPStatisticalBox::setWhiskerBarPen(const QPen &pen)
  12362. {
  12363. mWhiskerBarPen = pen;
  12364. }
  12365. /*!
  12366. Sets the pen used for drawing the median indicator line inside the statistical box.
  12367. */
  12368. void QCPStatisticalBox::setMedianPen(const QPen &pen)
  12369. {
  12370. mMedianPen = pen;
  12371. }
  12372. /*!
  12373. Sets the appearance of the outlier data points.
  12374. \see setOutliers
  12375. */
  12376. void QCPStatisticalBox::setOutlierStyle(const QCPScatterStyle &style)
  12377. {
  12378. mOutlierStyle = style;
  12379. }
  12380. /* inherits documentation from base class */
  12381. void QCPStatisticalBox::clearData()
  12382. {
  12383. setOutliers(QVector<double>());
  12384. setKey(0);
  12385. setMinimum(0);
  12386. setLowerQuartile(0);
  12387. setMedian(0);
  12388. setUpperQuartile(0);
  12389. setMaximum(0);
  12390. }
  12391. /* inherits documentation from base class */
  12392. double QCPStatisticalBox::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  12393. {
  12394. Q_UNUSED(details)
  12395. if (onlySelectable && !mSelectable)
  12396. return -1;
  12397. if (!mKeyAxis || !mValueAxis) { qDebug() << Q_FUNC_INFO << "invalid key or value axis"; return -1; }
  12398. double posKey, posValue;
  12399. pixelsToCoords(pos, posKey, posValue);
  12400. // quartile box:
  12401. QCPRange keyRange(mKey-mWidth*0.5, mKey+mWidth*0.5);
  12402. QCPRange valueRange(mLowerQuartile, mUpperQuartile);
  12403. if (keyRange.contains(posKey) && valueRange.contains(posValue))
  12404. return mParentPlot->selectionTolerance()*0.99;
  12405. // min/max whiskers:
  12406. if (QCPRange(mMinimum, mMaximum).contains(posValue))
  12407. return qAbs(mKeyAxis.data()->coordToPixel(mKey)-mKeyAxis.data()->coordToPixel(posKey));
  12408. return -1;
  12409. }
  12410. /* inherits documentation from base class */
  12411. void QCPStatisticalBox::draw(QCPPainter *painter)
  12412. {
  12413. if (!mKeyAxis || !mValueAxis) { qDebug() << Q_FUNC_INFO << "invalid key or value axis"; return; }
  12414. // check data validity if flag set:
  12415. #ifdef QCUSTOMPLOT_CHECK_DATA
  12416. if (QCP::isInvalidData(mKey, mMedian) ||
  12417. QCP::isInvalidData(mLowerQuartile, mUpperQuartile) ||
  12418. QCP::isInvalidData(mMinimum, mMaximum))
  12419. qDebug() << Q_FUNC_INFO << "Data point at" << mKey << "of drawn range has invalid data." << "Plottable name:" << name();
  12420. for (int i=0; i<mOutliers.size(); ++i)
  12421. if (QCP::isInvalidData(mOutliers.at(i)))
  12422. qDebug() << Q_FUNC_INFO << "Data point outlier at" << mKey << "of drawn range invalid." << "Plottable name:" << name();
  12423. #endif
  12424. QRectF quartileBox;
  12425. drawQuartileBox(painter, &quartileBox);
  12426. painter->save();
  12427. painter->setClipRect(quartileBox, Qt::IntersectClip);
  12428. drawMedian(painter);
  12429. painter->restore();
  12430. drawWhiskers(painter);
  12431. drawOutliers(painter);
  12432. }
  12433. /* inherits documentation from base class */
  12434. void QCPStatisticalBox::drawLegendIcon(QCPPainter *painter, const QRectF &rect) const
  12435. {
  12436. // draw filled rect:
  12437. applyDefaultAntialiasingHint(painter);
  12438. painter->setPen(mPen);
  12439. painter->setBrush(mBrush);
  12440. QRectF r = QRectF(0, 0, rect.width()*0.67, rect.height()*0.67);
  12441. r.moveCenter(rect.center());
  12442. painter->drawRect(r);
  12443. }
  12444. /*! \internal
  12445. Draws the quartile box. \a box is an output parameter that returns the quartile box (in pixel
  12446. coordinates) which is used to set the clip rect of the painter before calling \ref drawMedian (so
  12447. the median doesn't draw outside the quartile box).
  12448. */
  12449. void QCPStatisticalBox::drawQuartileBox(QCPPainter *painter, QRectF *quartileBox) const
  12450. {
  12451. QRectF box;
  12452. box.setTopLeft(coordsToPixels(mKey-mWidth*0.5, mUpperQuartile));
  12453. box.setBottomRight(coordsToPixels(mKey+mWidth*0.5, mLowerQuartile));
  12454. applyDefaultAntialiasingHint(painter);
  12455. painter->setPen(mainPen());
  12456. painter->setBrush(mainBrush());
  12457. painter->drawRect(box);
  12458. if (quartileBox)
  12459. *quartileBox = box;
  12460. }
  12461. /*! \internal
  12462. Draws the median line inside the quartile box.
  12463. */
  12464. void QCPStatisticalBox::drawMedian(QCPPainter *painter) const
  12465. {
  12466. QLineF medianLine;
  12467. medianLine.setP1(coordsToPixels(mKey-mWidth*0.5, mMedian));
  12468. medianLine.setP2(coordsToPixels(mKey+mWidth*0.5, mMedian));
  12469. applyDefaultAntialiasingHint(painter);
  12470. painter->setPen(mMedianPen);
  12471. painter->drawLine(medianLine);
  12472. }
  12473. /*! \internal
  12474. Draws both whisker backbones and bars.
  12475. */
  12476. void QCPStatisticalBox::drawWhiskers(QCPPainter *painter) const
  12477. {
  12478. QLineF backboneMin, backboneMax, barMin, barMax;
  12479. backboneMax.setPoints(coordsToPixels(mKey, mUpperQuartile), coordsToPixels(mKey, mMaximum));
  12480. backboneMin.setPoints(coordsToPixels(mKey, mLowerQuartile), coordsToPixels(mKey, mMinimum));
  12481. barMax.setPoints(coordsToPixels(mKey-mWhiskerWidth*0.5, mMaximum), coordsToPixels(mKey+mWhiskerWidth*0.5, mMaximum));
  12482. barMin.setPoints(coordsToPixels(mKey-mWhiskerWidth*0.5, mMinimum), coordsToPixels(mKey+mWhiskerWidth*0.5, mMinimum));
  12483. applyErrorBarsAntialiasingHint(painter);
  12484. painter->setPen(mWhiskerPen);
  12485. painter->drawLine(backboneMin);
  12486. painter->drawLine(backboneMax);
  12487. painter->setPen(mWhiskerBarPen);
  12488. painter->drawLine(barMin);
  12489. painter->drawLine(barMax);
  12490. }
  12491. /*! \internal
  12492. Draws the outlier scatter points.
  12493. */
  12494. void QCPStatisticalBox::drawOutliers(QCPPainter *painter) const
  12495. {
  12496. applyScattersAntialiasingHint(painter);
  12497. mOutlierStyle.applyTo(painter, mPen);
  12498. for (int i=0; i<mOutliers.size(); ++i)
  12499. mOutlierStyle.drawShape(painter, coordsToPixels(mKey, mOutliers.at(i)));
  12500. }
  12501. /* inherits documentation from base class */
  12502. QCPRange QCPStatisticalBox::getKeyRange(bool &validRange, SignDomain inSignDomain) const
  12503. {
  12504. validRange = mWidth > 0;
  12505. if (inSignDomain == sdBoth)
  12506. {
  12507. return QCPRange(mKey-mWidth*0.5, mKey+mWidth*0.5);
  12508. } else if (inSignDomain == sdNegative)
  12509. {
  12510. if (mKey+mWidth*0.5 < 0)
  12511. return QCPRange(mKey-mWidth*0.5, mKey+mWidth*0.5);
  12512. else if (mKey < 0)
  12513. return QCPRange(mKey-mWidth*0.5, mKey);
  12514. else
  12515. {
  12516. validRange = false;
  12517. return QCPRange();
  12518. }
  12519. } else if (inSignDomain == sdPositive)
  12520. {
  12521. if (mKey-mWidth*0.5 > 0)
  12522. return QCPRange(mKey-mWidth*0.5, mKey+mWidth*0.5);
  12523. else if (mKey > 0)
  12524. return QCPRange(mKey, mKey+mWidth*0.5);
  12525. else
  12526. {
  12527. validRange = false;
  12528. return QCPRange();
  12529. }
  12530. }
  12531. validRange = false;
  12532. return QCPRange();
  12533. }
  12534. /* inherits documentation from base class */
  12535. QCPRange QCPStatisticalBox::getValueRange(bool &validRange, SignDomain inSignDomain) const
  12536. {
  12537. if (inSignDomain == sdBoth)
  12538. {
  12539. double lower = qMin(mMinimum, qMin(mMedian, mLowerQuartile));
  12540. double upper = qMax(mMaximum, qMax(mMedian, mUpperQuartile));
  12541. for (int i=0; i<mOutliers.size(); ++i)
  12542. {
  12543. if (mOutliers.at(i) < lower)
  12544. lower = mOutliers.at(i);
  12545. if (mOutliers.at(i) > upper)
  12546. upper = mOutliers.at(i);
  12547. }
  12548. validRange = upper > lower;
  12549. return QCPRange(lower, upper);
  12550. } else
  12551. {
  12552. QVector<double> values; // values that must be considered (i.e. all outliers and the five box-parameters)
  12553. values.reserve(mOutliers.size() + 5);
  12554. values << mMaximum << mUpperQuartile << mMedian << mLowerQuartile << mMinimum;
  12555. values << mOutliers;
  12556. // go through values and find the ones in legal range:
  12557. bool haveUpper = false;
  12558. bool haveLower = false;
  12559. double upper = 0;
  12560. double lower = 0;
  12561. for (int i=0; i<values.size(); ++i)
  12562. {
  12563. if ((inSignDomain == sdNegative && values.at(i) < 0) ||
  12564. (inSignDomain == sdPositive && values.at(i) > 0))
  12565. {
  12566. if (values.at(i) > upper || !haveUpper)
  12567. {
  12568. upper = values.at(i);
  12569. haveUpper = true;
  12570. }
  12571. if (values.at(i) < lower || !haveLower)
  12572. {
  12573. lower = values.at(i);
  12574. haveLower = true;
  12575. }
  12576. }
  12577. }
  12578. // return the bounds if we found some sensible values:
  12579. if (haveLower && haveUpper && lower < upper)
  12580. {
  12581. validRange = true;
  12582. return QCPRange(lower, upper);
  12583. } else
  12584. {
  12585. validRange = false;
  12586. return QCPRange();
  12587. }
  12588. }
  12589. }
  12590. ////////////////////////////////////////////////////////////////////////////////////////////////////
  12591. //////////////////// QCPItemStraightLine
  12592. ////////////////////////////////////////////////////////////////////////////////////////////////////
  12593. /*! \class QCPItemStraightLine
  12594. \brief A straight line that spans infinitely in both directions
  12595. \image html QCPItemStraightLine.png "Straight line example. Blue dotted circles are anchors, solid blue discs are positions."
  12596. It has two positions, \a point1 and \a point2, which define the straight line.
  12597. */
  12598. /*!
  12599. Creates a straight line item and sets default values.
  12600. The constructed item can be added to the plot with QCustomPlot::addItem.
  12601. */
  12602. QCPItemStraightLine::QCPItemStraightLine(QCustomPlot *parentPlot) :
  12603. QCPAbstractItem(parentPlot),
  12604. point1(createPosition("point1")),
  12605. point2(createPosition("point2"))
  12606. {
  12607. point1->setCoords(0, 0);
  12608. point2->setCoords(1, 1);
  12609. setPen(QPen(Qt::black));
  12610. setSelectedPen(QPen(Qt::blue,2));
  12611. }
  12612. QCPItemStraightLine::~QCPItemStraightLine()
  12613. {
  12614. }
  12615. /*!
  12616. Sets the pen that will be used to draw the line
  12617. \see setSelectedPen
  12618. */
  12619. void QCPItemStraightLine::setPen(const QPen &pen)
  12620. {
  12621. mPen = pen;
  12622. }
  12623. /*!
  12624. Sets the pen that will be used to draw the line when selected
  12625. \see setPen, setSelected
  12626. */
  12627. void QCPItemStraightLine::setSelectedPen(const QPen &pen)
  12628. {
  12629. mSelectedPen = pen;
  12630. }
  12631. /* inherits documentation from base class */
  12632. double QCPItemStraightLine::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  12633. {
  12634. Q_UNUSED(details)
  12635. if (onlySelectable && !mSelectable)
  12636. return -1;
  12637. return distToStraightLine(QVector2D(point1->pixelPoint()), QVector2D(point2->pixelPoint()-point1->pixelPoint()), QVector2D(pos));
  12638. }
  12639. /* inherits documentation from base class */
  12640. void QCPItemStraightLine::draw(QCPPainter *painter)
  12641. {
  12642. QVector2D start(point1->pixelPoint());
  12643. QVector2D end(point2->pixelPoint());
  12644. // get visible segment of straight line inside clipRect:
  12645. double clipPad = mainPen().widthF();
  12646. QLineF line = getRectClippedStraightLine(start, end-start, clipRect().adjusted(-clipPad, -clipPad, clipPad, clipPad));
  12647. // paint visible segment, if existent:
  12648. if (!line.isNull())
  12649. {
  12650. painter->setPen(mainPen());
  12651. painter->drawLine(line);
  12652. }
  12653. }
  12654. /*! \internal
  12655. finds the shortest distance of \a point to the straight line defined by the base point \a
  12656. base and the direction vector \a vec.
  12657. This is a helper function for \ref selectTest.
  12658. */
  12659. double QCPItemStraightLine::distToStraightLine(const QVector2D &base, const QVector2D &vec, const QVector2D &point) const
  12660. {
  12661. return qAbs((base.y()-point.y())*vec.x()-(base.x()-point.x())*vec.y())/vec.length();
  12662. }
  12663. /*! \internal
  12664. Returns the section of the straight line defined by \a base and direction vector \a
  12665. vec, that is visible in the specified \a rect.
  12666. This is a helper function for \ref draw.
  12667. */
  12668. QLineF QCPItemStraightLine::getRectClippedStraightLine(const QVector2D &base, const QVector2D &vec, const QRect &rect) const
  12669. {
  12670. double bx, by;
  12671. double gamma;
  12672. QLineF result;
  12673. if (vec.x() == 0 && vec.y() == 0)
  12674. return result;
  12675. if (qFuzzyIsNull(vec.x())) // line is vertical
  12676. {
  12677. // check top of rect:
  12678. bx = rect.left();
  12679. by = rect.top();
  12680. gamma = base.x()-bx + (by-base.y())*vec.x()/vec.y();
  12681. if (gamma >= 0 && gamma <= rect.width())
  12682. result.setLine(bx+gamma, rect.top(), bx+gamma, rect.bottom()); // no need to check bottom because we know line is vertical
  12683. } else if (qFuzzyIsNull(vec.y())) // line is horizontal
  12684. {
  12685. // check left of rect:
  12686. bx = rect.left();
  12687. by = rect.top();
  12688. gamma = base.y()-by + (bx-base.x())*vec.y()/vec.x();
  12689. if (gamma >= 0 && gamma <= rect.height())
  12690. result.setLine(rect.left(), by+gamma, rect.right(), by+gamma); // no need to check right because we know line is horizontal
  12691. } else // line is skewed
  12692. {
  12693. QList<QVector2D> pointVectors;
  12694. // check top of rect:
  12695. bx = rect.left();
  12696. by = rect.top();
  12697. gamma = base.x()-bx + (by-base.y())*vec.x()/vec.y();
  12698. if (gamma >= 0 && gamma <= rect.width())
  12699. pointVectors.append(QVector2D(bx+gamma, by));
  12700. // check bottom of rect:
  12701. bx = rect.left();
  12702. by = rect.bottom();
  12703. gamma = base.x()-bx + (by-base.y())*vec.x()/vec.y();
  12704. if (gamma >= 0 && gamma <= rect.width())
  12705. pointVectors.append(QVector2D(bx+gamma, by));
  12706. // check left of rect:
  12707. bx = rect.left();
  12708. by = rect.top();
  12709. gamma = base.y()-by + (bx-base.x())*vec.y()/vec.x();
  12710. if (gamma >= 0 && gamma <= rect.height())
  12711. pointVectors.append(QVector2D(bx, by+gamma));
  12712. // check right of rect:
  12713. bx = rect.right();
  12714. by = rect.top();
  12715. gamma = base.y()-by + (bx-base.x())*vec.y()/vec.x();
  12716. if (gamma >= 0 && gamma <= rect.height())
  12717. pointVectors.append(QVector2D(bx, by+gamma));
  12718. // evaluate points:
  12719. if (pointVectors.size() == 2)
  12720. {
  12721. result.setPoints(pointVectors.at(0).toPointF(), pointVectors.at(1).toPointF());
  12722. } else if (pointVectors.size() > 2)
  12723. {
  12724. // line probably goes through corner of rect, and we got two points there. single out the point pair with greatest distance:
  12725. double distSqrMax = 0;
  12726. QVector2D pv1, pv2;
  12727. for (int i=0; i<pointVectors.size()-1; ++i)
  12728. {
  12729. for (int k=i+1; k<pointVectors.size(); ++k)
  12730. {
  12731. double distSqr = (pointVectors.at(i)-pointVectors.at(k)).lengthSquared();
  12732. if (distSqr > distSqrMax)
  12733. {
  12734. pv1 = pointVectors.at(i);
  12735. pv2 = pointVectors.at(k);
  12736. distSqrMax = distSqr;
  12737. }
  12738. }
  12739. }
  12740. result.setPoints(pv1.toPointF(), pv2.toPointF());
  12741. }
  12742. }
  12743. return result;
  12744. }
  12745. /*! \internal
  12746. Returns the pen that should be used for drawing lines. Returns mPen when the
  12747. item is not selected and mSelectedPen when it is.
  12748. */
  12749. QPen QCPItemStraightLine::mainPen() const
  12750. {
  12751. return mSelected ? mSelectedPen : mPen;
  12752. }
  12753. ////////////////////////////////////////////////////////////////////////////////////////////////////
  12754. //////////////////// QCPItemLine
  12755. ////////////////////////////////////////////////////////////////////////////////////////////////////
  12756. /*! \class QCPItemLine
  12757. \brief A line from one point to another
  12758. \image html QCPItemLine.png "Line example. Blue dotted circles are anchors, solid blue discs are positions."
  12759. It has two positions, \a start and \a end, which define the end points of the line.
  12760. With \ref setHead and \ref setTail you may set different line ending styles, e.g. to create an arrow.
  12761. */
  12762. /*!
  12763. Creates a line item and sets default values.
  12764. The constructed item can be added to the plot with QCustomPlot::addItem.
  12765. */
  12766. QCPItemLine::QCPItemLine(QCustomPlot *parentPlot) :
  12767. QCPAbstractItem(parentPlot),
  12768. start(createPosition("start")),
  12769. end(createPosition("end"))
  12770. {
  12771. start->setCoords(0, 0);
  12772. end->setCoords(1, 1);
  12773. setPen(QPen(Qt::black));
  12774. setSelectedPen(QPen(Qt::blue,2));
  12775. }
  12776. QCPItemLine::~QCPItemLine()
  12777. {
  12778. }
  12779. /*!
  12780. Sets the pen that will be used to draw the line
  12781. \see setSelectedPen
  12782. */
  12783. void QCPItemLine::setPen(const QPen &pen)
  12784. {
  12785. mPen = pen;
  12786. }
  12787. /*!
  12788. Sets the pen that will be used to draw the line when selected
  12789. \see setPen, setSelected
  12790. */
  12791. void QCPItemLine::setSelectedPen(const QPen &pen)
  12792. {
  12793. mSelectedPen = pen;
  12794. }
  12795. /*!
  12796. Sets the line ending style of the head. The head corresponds to the \a end position.
  12797. Note that due to the overloaded QCPLineEnding constructor, you may directly specify
  12798. a QCPLineEnding::EndingStyle here, e.g. \code setHead(QCPLineEnding::esSpikeArrow) \endcode
  12799. \see setTail
  12800. */
  12801. void QCPItemLine::setHead(const QCPLineEnding &head)
  12802. {
  12803. mHead = head;
  12804. }
  12805. /*!
  12806. Sets the line ending style of the tail. The tail corresponds to the \a start position.
  12807. Note that due to the overloaded QCPLineEnding constructor, you may directly specify
  12808. a QCPLineEnding::EndingStyle here, e.g. \code setTail(QCPLineEnding::esSpikeArrow) \endcode
  12809. \see setHead
  12810. */
  12811. void QCPItemLine::setTail(const QCPLineEnding &tail)
  12812. {
  12813. mTail = tail;
  12814. }
  12815. /* inherits documentation from base class */
  12816. double QCPItemLine::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  12817. {
  12818. Q_UNUSED(details)
  12819. if (onlySelectable && !mSelectable)
  12820. return -1;
  12821. return qSqrt(distSqrToLine(start->pixelPoint(), end->pixelPoint(), pos));
  12822. }
  12823. /* inherits documentation from base class */
  12824. void QCPItemLine::draw(QCPPainter *painter)
  12825. {
  12826. QVector2D startVec(start->pixelPoint());
  12827. QVector2D endVec(end->pixelPoint());
  12828. if (startVec.toPoint() == endVec.toPoint())
  12829. return;
  12830. // get visible segment of straight line inside clipRect:
  12831. double clipPad = qMax(mHead.boundingDistance(), mTail.boundingDistance());
  12832. clipPad = qMax(clipPad, (double)mainPen().widthF());
  12833. QLineF line = getRectClippedLine(startVec, endVec, clipRect().adjusted(-clipPad, -clipPad, clipPad, clipPad));
  12834. // paint visible segment, if existent:
  12835. if (!line.isNull())
  12836. {
  12837. painter->setPen(mainPen());
  12838. painter->drawLine(line);
  12839. painter->setBrush(Qt::SolidPattern);
  12840. if (mTail.style() != QCPLineEnding::esNone)
  12841. mTail.draw(painter, startVec, startVec-endVec);
  12842. if (mHead.style() != QCPLineEnding::esNone)
  12843. mHead.draw(painter, endVec, endVec-startVec);
  12844. }
  12845. }
  12846. /*! \internal
  12847. Returns the section of the line defined by \a start and \a end, that is visible in the specified
  12848. \a rect.
  12849. This is a helper function for \ref draw.
  12850. */
  12851. QLineF QCPItemLine::getRectClippedLine(const QVector2D &start, const QVector2D &end, const QRect &rect) const
  12852. {
  12853. bool containsStart = rect.contains(start.x(), start.y());
  12854. bool containsEnd = rect.contains(end.x(), end.y());
  12855. if (containsStart && containsEnd)
  12856. return QLineF(start.toPointF(), end.toPointF());
  12857. QVector2D base = start;
  12858. QVector2D vec = end-start;
  12859. double bx, by;
  12860. double gamma, mu;
  12861. QLineF result;
  12862. QList<QVector2D> pointVectors;
  12863. if (!qFuzzyIsNull(vec.y())) // line is not horizontal
  12864. {
  12865. // check top of rect:
  12866. bx = rect.left();
  12867. by = rect.top();
  12868. mu = (by-base.y())/vec.y();
  12869. if (mu >= 0 && mu <= 1)
  12870. {
  12871. gamma = base.x()-bx + mu*vec.x();
  12872. if (gamma >= 0 && gamma <= rect.width())
  12873. pointVectors.append(QVector2D(bx+gamma, by));
  12874. }
  12875. // check bottom of rect:
  12876. bx = rect.left();
  12877. by = rect.bottom();
  12878. mu = (by-base.y())/vec.y();
  12879. if (mu >= 0 && mu <= 1)
  12880. {
  12881. gamma = base.x()-bx + mu*vec.x();
  12882. if (gamma >= 0 && gamma <= rect.width())
  12883. pointVectors.append(QVector2D(bx+gamma, by));
  12884. }
  12885. }
  12886. if (!qFuzzyIsNull(vec.x())) // line is not vertical
  12887. {
  12888. // check left of rect:
  12889. bx = rect.left();
  12890. by = rect.top();
  12891. mu = (bx-base.x())/vec.x();
  12892. if (mu >= 0 && mu <= 1)
  12893. {
  12894. gamma = base.y()-by + mu*vec.y();
  12895. if (gamma >= 0 && gamma <= rect.height())
  12896. pointVectors.append(QVector2D(bx, by+gamma));
  12897. }
  12898. // check right of rect:
  12899. bx = rect.right();
  12900. by = rect.top();
  12901. mu = (bx-base.x())/vec.x();
  12902. if (mu >= 0 && mu <= 1)
  12903. {
  12904. gamma = base.y()-by + mu*vec.y();
  12905. if (gamma >= 0 && gamma <= rect.height())
  12906. pointVectors.append(QVector2D(bx, by+gamma));
  12907. }
  12908. }
  12909. if (containsStart)
  12910. pointVectors.append(start);
  12911. if (containsEnd)
  12912. pointVectors.append(end);
  12913. // evaluate points:
  12914. if (pointVectors.size() == 2)
  12915. {
  12916. result.setPoints(pointVectors.at(0).toPointF(), pointVectors.at(1).toPointF());
  12917. } else if (pointVectors.size() > 2)
  12918. {
  12919. // line probably goes through corner of rect, and we got two points there. single out the point pair with greatest distance:
  12920. double distSqrMax = 0;
  12921. QVector2D pv1, pv2;
  12922. for (int i=0; i<pointVectors.size()-1; ++i)
  12923. {
  12924. for (int k=i+1; k<pointVectors.size(); ++k)
  12925. {
  12926. double distSqr = (pointVectors.at(i)-pointVectors.at(k)).lengthSquared();
  12927. if (distSqr > distSqrMax)
  12928. {
  12929. pv1 = pointVectors.at(i);
  12930. pv2 = pointVectors.at(k);
  12931. distSqrMax = distSqr;
  12932. }
  12933. }
  12934. }
  12935. result.setPoints(pv1.toPointF(), pv2.toPointF());
  12936. }
  12937. return result;
  12938. }
  12939. /*! \internal
  12940. Returns the pen that should be used for drawing lines. Returns mPen when the
  12941. item is not selected and mSelectedPen when it is.
  12942. */
  12943. QPen QCPItemLine::mainPen() const
  12944. {
  12945. return mSelected ? mSelectedPen : mPen;
  12946. }
  12947. ////////////////////////////////////////////////////////////////////////////////////////////////////
  12948. //////////////////// QCPItemCurve
  12949. ////////////////////////////////////////////////////////////////////////////////////////////////////
  12950. /*! \class QCPItemCurve
  12951. \brief A curved line from one point to another
  12952. \image html QCPItemCurve.png "Curve example. Blue dotted circles are anchors, solid blue discs are positions."
  12953. It has four positions, \a start and \a end, which define the end points of the line, and two
  12954. control points which define the direction the line exits from the start and the direction from
  12955. which it approaches the end: \a startDir and \a endDir.
  12956. With \ref setHead and \ref setTail you may set different line ending styles, e.g. to create an
  12957. arrow.
  12958. Often it is desirable for the control points to stay at fixed relative positions to the start/end
  12959. point. This can be achieved by setting the parent anchor e.g. of \a startDir simply to \a start,
  12960. and then specify the desired pixel offset with QCPItemPosition::setCoords on \a startDir.
  12961. */
  12962. /*!
  12963. Creates a curve item and sets default values.
  12964. The constructed item can be added to the plot with QCustomPlot::addItem.
  12965. */
  12966. QCPItemCurve::QCPItemCurve(QCustomPlot *parentPlot) :
  12967. QCPAbstractItem(parentPlot),
  12968. start(createPosition("start")),
  12969. startDir(createPosition("startDir")),
  12970. endDir(createPosition("endDir")),
  12971. end(createPosition("end"))
  12972. {
  12973. start->setCoords(0, 0);
  12974. startDir->setCoords(0.5, 0);
  12975. endDir->setCoords(0, 0.5);
  12976. end->setCoords(1, 1);
  12977. setPen(QPen(Qt::black));
  12978. setSelectedPen(QPen(Qt::blue,2));
  12979. }
  12980. QCPItemCurve::~QCPItemCurve()
  12981. {
  12982. }
  12983. /*!
  12984. Sets the pen that will be used to draw the line
  12985. \see setSelectedPen
  12986. */
  12987. void QCPItemCurve::setPen(const QPen &pen)
  12988. {
  12989. mPen = pen;
  12990. }
  12991. /*!
  12992. Sets the pen that will be used to draw the line when selected
  12993. \see setPen, setSelected
  12994. */
  12995. void QCPItemCurve::setSelectedPen(const QPen &pen)
  12996. {
  12997. mSelectedPen = pen;
  12998. }
  12999. /*!
  13000. Sets the line ending style of the head. The head corresponds to the \a end position.
  13001. Note that due to the overloaded QCPLineEnding constructor, you may directly specify
  13002. a QCPLineEnding::EndingStyle here, e.g. \code setHead(QCPLineEnding::esSpikeArrow) \endcode
  13003. \see setTail
  13004. */
  13005. void QCPItemCurve::setHead(const QCPLineEnding &head)
  13006. {
  13007. mHead = head;
  13008. }
  13009. /*!
  13010. Sets the line ending style of the tail. The tail corresponds to the \a start position.
  13011. Note that due to the overloaded QCPLineEnding constructor, you may directly specify
  13012. a QCPLineEnding::EndingStyle here, e.g. \code setTail(QCPLineEnding::esSpikeArrow) \endcode
  13013. \see setHead
  13014. */
  13015. void QCPItemCurve::setTail(const QCPLineEnding &tail)
  13016. {
  13017. mTail = tail;
  13018. }
  13019. /* inherits documentation from base class */
  13020. double QCPItemCurve::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  13021. {
  13022. Q_UNUSED(details)
  13023. if (onlySelectable && !mSelectable)
  13024. return -1;
  13025. QPointF startVec(start->pixelPoint());
  13026. QPointF startDirVec(startDir->pixelPoint());
  13027. QPointF endDirVec(endDir->pixelPoint());
  13028. QPointF endVec(end->pixelPoint());
  13029. QPainterPath cubicPath(startVec);
  13030. cubicPath.cubicTo(startDirVec, endDirVec, endVec);
  13031. QPolygonF polygon = cubicPath.toSubpathPolygons().first();
  13032. double minDistSqr = std::numeric_limits<double>::max();
  13033. for (int i=1; i<polygon.size(); ++i)
  13034. {
  13035. double distSqr = distSqrToLine(polygon.at(i-1), polygon.at(i), pos);
  13036. if (distSqr < minDistSqr)
  13037. minDistSqr = distSqr;
  13038. }
  13039. return qSqrt(minDistSqr);
  13040. }
  13041. /* inherits documentation from base class */
  13042. void QCPItemCurve::draw(QCPPainter *painter)
  13043. {
  13044. QPointF startVec(start->pixelPoint());
  13045. QPointF startDirVec(startDir->pixelPoint());
  13046. QPointF endDirVec(endDir->pixelPoint());
  13047. QPointF endVec(end->pixelPoint());
  13048. if (QVector2D(endVec-startVec).length() > 1e10) // too large curves cause crash
  13049. return;
  13050. QPainterPath cubicPath(startVec);
  13051. cubicPath.cubicTo(startDirVec, endDirVec, endVec);
  13052. // paint visible segment, if existent:
  13053. QRect clip = clipRect().adjusted(-mainPen().widthF(), -mainPen().widthF(), mainPen().widthF(), mainPen().widthF());
  13054. QRect cubicRect = cubicPath.controlPointRect().toRect();
  13055. if (cubicRect.isEmpty()) // may happen when start and end exactly on same x or y position
  13056. cubicRect.adjust(0, 0, 1, 1);
  13057. if (clip.intersects(cubicRect))
  13058. {
  13059. painter->setPen(mainPen());
  13060. painter->drawPath(cubicPath);
  13061. painter->setBrush(Qt::SolidPattern);
  13062. if (mTail.style() != QCPLineEnding::esNone)
  13063. mTail.draw(painter, QVector2D(startVec), M_PI-cubicPath.angleAtPercent(0)/180.0*M_PI);
  13064. if (mHead.style() != QCPLineEnding::esNone)
  13065. mHead.draw(painter, QVector2D(endVec), -cubicPath.angleAtPercent(1)/180.0*M_PI);
  13066. }
  13067. }
  13068. /*! \internal
  13069. Returns the pen that should be used for drawing lines. Returns mPen when the
  13070. item is not selected and mSelectedPen when it is.
  13071. */
  13072. QPen QCPItemCurve::mainPen() const
  13073. {
  13074. return mSelected ? mSelectedPen : mPen;
  13075. }
  13076. ////////////////////////////////////////////////////////////////////////////////////////////////////
  13077. //////////////////// QCPItemRect
  13078. ////////////////////////////////////////////////////////////////////////////////////////////////////
  13079. /*! \class QCPItemRect
  13080. \brief A rectangle
  13081. \image html QCPItemRect.png "Rectangle example. Blue dotted circles are anchors, solid blue discs are positions."
  13082. It has two positions, \a topLeft and \a bottomRight, which define the rectangle.
  13083. */
  13084. /*!
  13085. Creates a rectangle item and sets default values.
  13086. The constructed item can be added to the plot with QCustomPlot::addItem.
  13087. */
  13088. QCPItemRect::QCPItemRect(QCustomPlot *parentPlot) :
  13089. QCPAbstractItem(parentPlot),
  13090. topLeft(createPosition("topLeft")),
  13091. bottomRight(createPosition("bottomRight")),
  13092. top(createAnchor("top", aiTop)),
  13093. topRight(createAnchor("topRight", aiTopRight)),
  13094. right(createAnchor("right", aiRight)),
  13095. bottom(createAnchor("bottom", aiBottom)),
  13096. bottomLeft(createAnchor("bottomLeft", aiBottomLeft)),
  13097. left(createAnchor("left", aiLeft))
  13098. {
  13099. topLeft->setCoords(0, 1);
  13100. bottomRight->setCoords(1, 0);
  13101. setPen(QPen(Qt::black));
  13102. setSelectedPen(QPen(Qt::blue,2));
  13103. setBrush(Qt::NoBrush);
  13104. setSelectedBrush(Qt::NoBrush);
  13105. }
  13106. QCPItemRect::~QCPItemRect()
  13107. {
  13108. }
  13109. /*!
  13110. Sets the pen that will be used to draw the line of the rectangle
  13111. \see setSelectedPen, setBrush
  13112. */
  13113. void QCPItemRect::setPen(const QPen &pen)
  13114. {
  13115. mPen = pen;
  13116. }
  13117. /*!
  13118. Sets the pen that will be used to draw the line of the rectangle when selected
  13119. \see setPen, setSelected
  13120. */
  13121. void QCPItemRect::setSelectedPen(const QPen &pen)
  13122. {
  13123. mSelectedPen = pen;
  13124. }
  13125. /*!
  13126. Sets the brush that will be used to fill the rectangle. To disable filling, set \a brush to
  13127. Qt::NoBrush.
  13128. \see setSelectedBrush, setPen
  13129. */
  13130. void QCPItemRect::setBrush(const QBrush &brush)
  13131. {
  13132. mBrush = brush;
  13133. }
  13134. /*!
  13135. Sets the brush that will be used to fill the rectangle when selected. To disable filling, set \a
  13136. brush to Qt::NoBrush.
  13137. \see setBrush
  13138. */
  13139. void QCPItemRect::setSelectedBrush(const QBrush &brush)
  13140. {
  13141. mSelectedBrush = brush;
  13142. }
  13143. /* inherits documentation from base class */
  13144. double QCPItemRect::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  13145. {
  13146. Q_UNUSED(details)
  13147. if (onlySelectable && !mSelectable)
  13148. return -1;
  13149. QRectF rect = QRectF(topLeft->pixelPoint(), bottomRight->pixelPoint()).normalized();
  13150. bool filledRect = mBrush.style() != Qt::NoBrush && mBrush.color().alpha() != 0;
  13151. return rectSelectTest(rect, pos, filledRect);
  13152. }
  13153. /* inherits documentation from base class */
  13154. void QCPItemRect::draw(QCPPainter *painter)
  13155. {
  13156. QPointF p1 = topLeft->pixelPoint();
  13157. QPointF p2 = bottomRight->pixelPoint();
  13158. if (p1.toPoint() == p2.toPoint())
  13159. return;
  13160. QRectF rect = QRectF(p1, p2).normalized();
  13161. double clipPad = mainPen().widthF();
  13162. QRectF boundingRect = rect.adjusted(-clipPad, -clipPad, clipPad, clipPad);
  13163. if (boundingRect.intersects(clipRect())) // only draw if bounding rect of rect item is visible in cliprect
  13164. {
  13165. painter->setPen(mainPen());
  13166. painter->setBrush(mainBrush());
  13167. painter->drawRect(rect);
  13168. }
  13169. }
  13170. /* inherits documentation from base class */
  13171. QPointF QCPItemRect::anchorPixelPoint(int anchorId) const
  13172. {
  13173. QRectF rect = QRectF(topLeft->pixelPoint(), bottomRight->pixelPoint());
  13174. switch (anchorId)
  13175. {
  13176. case aiTop: return (rect.topLeft()+rect.topRight())*0.5;
  13177. case aiTopRight: return rect.topRight();
  13178. case aiRight: return (rect.topRight()+rect.bottomRight())*0.5;
  13179. case aiBottom: return (rect.bottomLeft()+rect.bottomRight())*0.5;
  13180. case aiBottomLeft: return rect.bottomLeft();
  13181. case aiLeft: return (rect.topLeft()+rect.bottomLeft())*0.5;
  13182. }
  13183. qDebug() << Q_FUNC_INFO << "invalid anchorId" << anchorId;
  13184. return QPointF();
  13185. }
  13186. /*! \internal
  13187. Returns the pen that should be used for drawing lines. Returns mPen when the item is not selected
  13188. and mSelectedPen when it is.
  13189. */
  13190. QPen QCPItemRect::mainPen() const
  13191. {
  13192. return mSelected ? mSelectedPen : mPen;
  13193. }
  13194. /*! \internal
  13195. Returns the brush that should be used for drawing fills of the item. Returns mBrush when the item
  13196. is not selected and mSelectedBrush when it is.
  13197. */
  13198. QBrush QCPItemRect::mainBrush() const
  13199. {
  13200. return mSelected ? mSelectedBrush : mBrush;
  13201. }
  13202. ////////////////////////////////////////////////////////////////////////////////////////////////////
  13203. //////////////////// QCPItemText
  13204. ////////////////////////////////////////////////////////////////////////////////////////////////////
  13205. /*! \class QCPItemText
  13206. \brief A text label
  13207. \image html QCPItemText.png "Text example. Blue dotted circles are anchors, solid blue discs are positions."
  13208. Its position is defined by the member \a position and the setting of \ref setPositionAlignment.
  13209. The latter controls which part of the text rect shall be aligned with \a position.
  13210. The text alignment itself (i.e. left, center, right) can be controlled with \ref
  13211. setTextAlignment.
  13212. The text may be rotated around the \a position point with \ref setRotation.
  13213. */
  13214. /*!
  13215. Creates a text item and sets default values.
  13216. The constructed item can be added to the plot with QCustomPlot::addItem.
  13217. */
  13218. QCPItemText::QCPItemText(QCustomPlot *parentPlot) :
  13219. QCPAbstractItem(parentPlot),
  13220. position(createPosition("position")),
  13221. topLeft(createAnchor("topLeft", aiTopLeft)),
  13222. top(createAnchor("top", aiTop)),
  13223. topRight(createAnchor("topRight", aiTopRight)),
  13224. right(createAnchor("right", aiRight)),
  13225. bottomRight(createAnchor("bottomRight", aiBottomRight)),
  13226. bottom(createAnchor("bottom", aiBottom)),
  13227. bottomLeft(createAnchor("bottomLeft", aiBottomLeft)),
  13228. left(createAnchor("left", aiLeft))
  13229. {
  13230. position->setCoords(0, 0);
  13231. setRotation(0);
  13232. setTextAlignment(Qt::AlignTop|Qt::AlignHCenter);
  13233. setPositionAlignment(Qt::AlignCenter);
  13234. setText("text");
  13235. setPen(Qt::NoPen);
  13236. setSelectedPen(Qt::NoPen);
  13237. setBrush(Qt::NoBrush);
  13238. setSelectedBrush(Qt::NoBrush);
  13239. setColor(Qt::black);
  13240. setSelectedColor(Qt::blue);
  13241. }
  13242. QCPItemText::~QCPItemText()
  13243. {
  13244. }
  13245. /*!
  13246. Sets the color of the text.
  13247. */
  13248. void QCPItemText::setColor(const QColor &color)
  13249. {
  13250. mColor = color;
  13251. }
  13252. /*!
  13253. Sets the color of the text that will be used when the item is selected.
  13254. */
  13255. void QCPItemText::setSelectedColor(const QColor &color)
  13256. {
  13257. mSelectedColor = color;
  13258. }
  13259. /*!
  13260. Sets the pen that will be used do draw a rectangular border around the text. To disable the
  13261. border, set \a pen to Qt::NoPen.
  13262. \see setSelectedPen, setBrush, setPadding
  13263. */
  13264. void QCPItemText::setPen(const QPen &pen)
  13265. {
  13266. mPen = pen;
  13267. }
  13268. /*!
  13269. Sets the pen that will be used do draw a rectangular border around the text, when the item is
  13270. selected. To disable the border, set \a pen to Qt::NoPen.
  13271. \see setPen
  13272. */
  13273. void QCPItemText::setSelectedPen(const QPen &pen)
  13274. {
  13275. mSelectedPen = pen;
  13276. }
  13277. /*!
  13278. Sets the brush that will be used do fill the background of the text. To disable the
  13279. background, set \a brush to Qt::NoBrush.
  13280. \see setSelectedBrush, setPen, setPadding
  13281. */
  13282. void QCPItemText::setBrush(const QBrush &brush)
  13283. {
  13284. mBrush = brush;
  13285. }
  13286. /*!
  13287. Sets the brush that will be used do fill the background of the text, when the item is selected. To disable the
  13288. background, set \a brush to Qt::NoBrush.
  13289. \see setBrush
  13290. */
  13291. void QCPItemText::setSelectedBrush(const QBrush &brush)
  13292. {
  13293. mSelectedBrush = brush;
  13294. }
  13295. /*!
  13296. Sets the font of the text.
  13297. \see setSelectedFont, setColor
  13298. */
  13299. void QCPItemText::setFont(const QFont &font)
  13300. {
  13301. mFont = font;
  13302. }
  13303. /*!
  13304. Sets the font of the text that will be used when the item is selected.
  13305. \see setFont
  13306. */
  13307. void QCPItemText::setSelectedFont(const QFont &font)
  13308. {
  13309. mSelectedFont = font;
  13310. }
  13311. /*!
  13312. Sets the text that will be displayed. Multi-line texts are supported by inserting a line break
  13313. character, e.g. '\n'.
  13314. \see setFont, setColor, setTextAlignment
  13315. */
  13316. void QCPItemText::setText(const QString &text)
  13317. {
  13318. mText = text;
  13319. }
  13320. /*!
  13321. Sets which point of the text rect shall be aligned with \a position.
  13322. Examples:
  13323. \li If \a alignment is <tt>Qt::AlignHCenter | Qt::AlignTop</tt>, the text will be positioned such
  13324. that the top of the text rect will be horizontally centered on \a position.
  13325. \li If \a alignment is <tt>Qt::AlignLeft | Qt::AlignBottom</tt>, \a position will indicate the
  13326. bottom left corner of the text rect.
  13327. If you want to control the alignment of (multi-lined) text within the text rect, use \ref
  13328. setTextAlignment.
  13329. */
  13330. void QCPItemText::setPositionAlignment(Qt::Alignment alignment)
  13331. {
  13332. mPositionAlignment = alignment;
  13333. }
  13334. /*!
  13335. Controls how (multi-lined) text is aligned inside the text rect (typically Qt::AlignLeft, Qt::AlignCenter or Qt::AlignRight).
  13336. */
  13337. void QCPItemText::setTextAlignment(Qt::Alignment alignment)
  13338. {
  13339. mTextAlignment = alignment;
  13340. }
  13341. /*!
  13342. Sets the angle in degrees by which the text (and the text rectangle, if visible) will be rotated
  13343. around \a position.
  13344. */
  13345. void QCPItemText::setRotation(double degrees)
  13346. {
  13347. mRotation = degrees;
  13348. }
  13349. /*!
  13350. Sets the distance between the border of the text rectangle and the text. The appearance (and
  13351. visibility) of the text rectangle can be controlled with \ref setPen and \ref setBrush.
  13352. */
  13353. void QCPItemText::setPadding(const QMargins &padding)
  13354. {
  13355. mPadding = padding;
  13356. }
  13357. /* inherits documentation from base class */
  13358. double QCPItemText::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  13359. {
  13360. Q_UNUSED(details)
  13361. if (onlySelectable && !mSelectable)
  13362. return -1;
  13363. // The rect may be rotated, so we transform the actual clicked pos to the rotated
  13364. // coordinate system, so we can use the normal rectSelectTest function for non-rotated rects:
  13365. QPointF positionPixels(position->pixelPoint());
  13366. QTransform inputTransform;
  13367. inputTransform.translate(positionPixels.x(), positionPixels.y());
  13368. inputTransform.rotate(-mRotation);
  13369. inputTransform.translate(-positionPixels.x(), -positionPixels.y());
  13370. QPointF rotatedPos = inputTransform.map(pos);
  13371. QFontMetrics fontMetrics(mFont);
  13372. QRect textRect = fontMetrics.boundingRect(0, 0, 0, 0, Qt::TextDontClip|mTextAlignment, mText);
  13373. QRect textBoxRect = textRect.adjusted(-mPadding.left(), -mPadding.top(), mPadding.right(), mPadding.bottom());
  13374. QPointF textPos = getTextDrawPoint(positionPixels, textBoxRect, mPositionAlignment);
  13375. textBoxRect.moveTopLeft(textPos.toPoint());
  13376. return rectSelectTest(textBoxRect, rotatedPos, true);
  13377. }
  13378. /* inherits documentation from base class */
  13379. void QCPItemText::draw(QCPPainter *painter)
  13380. {
  13381. QPointF pos(position->pixelPoint());
  13382. QTransform transform = painter->transform();
  13383. transform.translate(pos.x(), pos.y());
  13384. if (!qFuzzyIsNull(mRotation))
  13385. transform.rotate(mRotation);
  13386. painter->setFont(mainFont());
  13387. QRect textRect = painter->fontMetrics().boundingRect(0, 0, 0, 0, Qt::TextDontClip|mTextAlignment, mText);
  13388. QRect textBoxRect = textRect.adjusted(-mPadding.left(), -mPadding.top(), mPadding.right(), mPadding.bottom());
  13389. QPointF textPos = getTextDrawPoint(QPointF(0, 0), textBoxRect, mPositionAlignment); // 0, 0 because the transform does the translation
  13390. textRect.moveTopLeft(textPos.toPoint()+QPoint(mPadding.left(), mPadding.top()));
  13391. textBoxRect.moveTopLeft(textPos.toPoint());
  13392. double clipPad = mainPen().widthF();
  13393. QRect boundingRect = textBoxRect.adjusted(-clipPad, -clipPad, clipPad, clipPad);
  13394. if (transform.mapRect(boundingRect).intersects(painter->transform().mapRect(clipRect())))
  13395. {
  13396. painter->setTransform(transform);
  13397. if ((mainBrush().style() != Qt::NoBrush && mainBrush().color().alpha() != 0) ||
  13398. (mainPen().style() != Qt::NoPen && mainPen().color().alpha() != 0))
  13399. {
  13400. painter->setPen(mainPen());
  13401. painter->setBrush(mainBrush());
  13402. painter->drawRect(textBoxRect);
  13403. }
  13404. painter->setBrush(Qt::NoBrush);
  13405. painter->setPen(QPen(mainColor()));
  13406. painter->drawText(textRect, Qt::TextDontClip|mTextAlignment, mText);
  13407. }
  13408. }
  13409. /* inherits documentation from base class */
  13410. QPointF QCPItemText::anchorPixelPoint(int anchorId) const
  13411. {
  13412. // get actual rect points (pretty much copied from draw function):
  13413. QPointF pos(position->pixelPoint());
  13414. QTransform transform;
  13415. transform.translate(pos.x(), pos.y());
  13416. if (!qFuzzyIsNull(mRotation))
  13417. transform.rotate(mRotation);
  13418. QFontMetrics fontMetrics(mainFont());
  13419. QRect textRect = fontMetrics.boundingRect(0, 0, 0, 0, Qt::TextDontClip|mTextAlignment, mText);
  13420. QRectF textBoxRect = textRect.adjusted(-mPadding.left(), -mPadding.top(), mPadding.right(), mPadding.bottom());
  13421. QPointF textPos = getTextDrawPoint(QPointF(0, 0), textBoxRect, mPositionAlignment); // 0, 0 because the transform does the translation
  13422. textBoxRect.moveTopLeft(textPos.toPoint());
  13423. QPolygonF rectPoly = transform.map(QPolygonF(textBoxRect));
  13424. switch (anchorId)
  13425. {
  13426. case aiTopLeft: return rectPoly.at(0);
  13427. case aiTop: return (rectPoly.at(0)+rectPoly.at(1))*0.5;
  13428. case aiTopRight: return rectPoly.at(1);
  13429. case aiRight: return (rectPoly.at(1)+rectPoly.at(2))*0.5;
  13430. case aiBottomRight: return rectPoly.at(2);
  13431. case aiBottom: return (rectPoly.at(2)+rectPoly.at(3))*0.5;
  13432. case aiBottomLeft: return rectPoly.at(3);
  13433. case aiLeft: return (rectPoly.at(3)+rectPoly.at(0))*0.5;
  13434. }
  13435. qDebug() << Q_FUNC_INFO << "invalid anchorId" << anchorId;
  13436. return QPointF();
  13437. }
  13438. /*! \internal
  13439. Returns the point that must be given to the QPainter::drawText function (which expects the top
  13440. left point of the text rect), according to the position \a pos, the text bounding box \a rect and
  13441. the requested \a positionAlignment.
  13442. For example, if \a positionAlignment is <tt>Qt::AlignLeft | Qt::AlignBottom</tt> the returned point
  13443. will be shifted upward by the height of \a rect, starting from \a pos. So if the text is finally
  13444. drawn at that point, the lower left corner of the resulting text rect is at \a pos.
  13445. */
  13446. QPointF QCPItemText::getTextDrawPoint(const QPointF &pos, const QRectF &rect, Qt::Alignment positionAlignment) const
  13447. {
  13448. if (positionAlignment == 0 || positionAlignment == (Qt::AlignLeft|Qt::AlignTop))
  13449. return pos;
  13450. QPointF result = pos; // start at top left
  13451. if (positionAlignment.testFlag(Qt::AlignHCenter))
  13452. result.rx() -= rect.width()/2.0;
  13453. else if (positionAlignment.testFlag(Qt::AlignRight))
  13454. result.rx() -= rect.width();
  13455. if (positionAlignment.testFlag(Qt::AlignVCenter))
  13456. result.ry() -= rect.height()/2.0;
  13457. else if (positionAlignment.testFlag(Qt::AlignBottom))
  13458. result.ry() -= rect.height();
  13459. return result;
  13460. }
  13461. /*! \internal
  13462. Returns the font that should be used for drawing text. Returns mFont when the item is not selected
  13463. and mSelectedFont when it is.
  13464. */
  13465. QFont QCPItemText::mainFont() const
  13466. {
  13467. return mSelected ? mSelectedFont : mFont;
  13468. }
  13469. /*! \internal
  13470. Returns the color that should be used for drawing text. Returns mColor when the item is not
  13471. selected and mSelectedColor when it is.
  13472. */
  13473. QColor QCPItemText::mainColor() const
  13474. {
  13475. return mSelected ? mSelectedColor : mColor;
  13476. }
  13477. /*! \internal
  13478. Returns the pen that should be used for drawing lines. Returns mPen when the item is not selected
  13479. and mSelectedPen when it is.
  13480. */
  13481. QPen QCPItemText::mainPen() const
  13482. {
  13483. return mSelected ? mSelectedPen : mPen;
  13484. }
  13485. /*! \internal
  13486. Returns the brush that should be used for drawing fills of the item. Returns mBrush when the item
  13487. is not selected and mSelectedBrush when it is.
  13488. */
  13489. QBrush QCPItemText::mainBrush() const
  13490. {
  13491. return mSelected ? mSelectedBrush : mBrush;
  13492. }
  13493. ////////////////////////////////////////////////////////////////////////////////////////////////////
  13494. //////////////////// QCPItemEllipse
  13495. ////////////////////////////////////////////////////////////////////////////////////////////////////
  13496. /*! \class QCPItemEllipse
  13497. \brief An ellipse
  13498. \image html QCPItemEllipse.png "Ellipse example. Blue dotted circles are anchors, solid blue discs are positions."
  13499. It has two positions, \a topLeft and \a bottomRight, which define the rect the ellipse will be drawn in.
  13500. */
  13501. /*!
  13502. Creates an ellipse item and sets default values.
  13503. The constructed item can be added to the plot with QCustomPlot::addItem.
  13504. */
  13505. QCPItemEllipse::QCPItemEllipse(QCustomPlot *parentPlot) :
  13506. QCPAbstractItem(parentPlot),
  13507. topLeft(createPosition("topLeft")),
  13508. bottomRight(createPosition("bottomRight")),
  13509. topLeftRim(createAnchor("topLeftRim", aiTopLeftRim)),
  13510. top(createAnchor("top", aiTop)),
  13511. topRightRim(createAnchor("topRightRim", aiTopRightRim)),
  13512. right(createAnchor("right", aiRight)),
  13513. bottomRightRim(createAnchor("bottomRightRim", aiBottomRightRim)),
  13514. bottom(createAnchor("bottom", aiBottom)),
  13515. bottomLeftRim(createAnchor("bottomLeftRim", aiBottomLeftRim)),
  13516. left(createAnchor("left", aiLeft)),
  13517. center(createAnchor("center", aiCenter))
  13518. {
  13519. topLeft->setCoords(0, 1);
  13520. bottomRight->setCoords(1, 0);
  13521. setPen(QPen(Qt::black));
  13522. setSelectedPen(QPen(Qt::blue, 2));
  13523. setBrush(Qt::NoBrush);
  13524. setSelectedBrush(Qt::NoBrush);
  13525. }
  13526. QCPItemEllipse::~QCPItemEllipse()
  13527. {
  13528. }
  13529. /*!
  13530. Sets the pen that will be used to draw the line of the ellipse
  13531. \see setSelectedPen, setBrush
  13532. */
  13533. void QCPItemEllipse::setPen(const QPen &pen)
  13534. {
  13535. mPen = pen;
  13536. }
  13537. /*!
  13538. Sets the pen that will be used to draw the line of the ellipse when selected
  13539. \see setPen, setSelected
  13540. */
  13541. void QCPItemEllipse::setSelectedPen(const QPen &pen)
  13542. {
  13543. mSelectedPen = pen;
  13544. }
  13545. /*!
  13546. Sets the brush that will be used to fill the ellipse. To disable filling, set \a brush to
  13547. Qt::NoBrush.
  13548. \see setSelectedBrush, setPen
  13549. */
  13550. void QCPItemEllipse::setBrush(const QBrush &brush)
  13551. {
  13552. mBrush = brush;
  13553. }
  13554. /*!
  13555. Sets the brush that will be used to fill the ellipse when selected. To disable filling, set \a
  13556. brush to Qt::NoBrush.
  13557. \see setBrush
  13558. */
  13559. void QCPItemEllipse::setSelectedBrush(const QBrush &brush)
  13560. {
  13561. mSelectedBrush = brush;
  13562. }
  13563. /* inherits documentation from base class */
  13564. double QCPItemEllipse::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  13565. {
  13566. Q_UNUSED(details)
  13567. if (onlySelectable && !mSelectable)
  13568. return -1;
  13569. double result = -1;
  13570. QPointF p1 = topLeft->pixelPoint();
  13571. QPointF p2 = bottomRight->pixelPoint();
  13572. QPointF center((p1+p2)/2.0);
  13573. double a = qAbs(p1.x()-p2.x())/2.0;
  13574. double b = qAbs(p1.y()-p2.y())/2.0;
  13575. double x = pos.x()-center.x();
  13576. double y = pos.y()-center.y();
  13577. // distance to border:
  13578. double c = 1.0/qSqrt(x*x/(a*a)+y*y/(b*b));
  13579. result = qAbs(c-1)*qSqrt(x*x+y*y);
  13580. // filled ellipse, allow click inside to count as hit:
  13581. if (result > mParentPlot->selectionTolerance()*0.99 && mBrush.style() != Qt::NoBrush && mBrush.color().alpha() != 0)
  13582. {
  13583. if (x*x/(a*a) + y*y/(b*b) <= 1)
  13584. result = mParentPlot->selectionTolerance()*0.99;
  13585. }
  13586. return result;
  13587. }
  13588. /* inherits documentation from base class */
  13589. void QCPItemEllipse::draw(QCPPainter *painter)
  13590. {
  13591. QPointF p1 = topLeft->pixelPoint();
  13592. QPointF p2 = bottomRight->pixelPoint();
  13593. if (p1.toPoint() == p2.toPoint())
  13594. return;
  13595. QRectF ellipseRect = QRectF(p1, p2).normalized();
  13596. QRect clip = clipRect().adjusted(-mainPen().widthF(), -mainPen().widthF(), mainPen().widthF(), mainPen().widthF());
  13597. if (ellipseRect.intersects(clip)) // only draw if bounding rect of ellipse is visible in cliprect
  13598. {
  13599. painter->setPen(mainPen());
  13600. painter->setBrush(mainBrush());
  13601. #ifdef __EXCEPTIONS
  13602. try // drawEllipse sometimes throws exceptions if ellipse is too big
  13603. {
  13604. #endif
  13605. painter->drawEllipse(ellipseRect);
  13606. #ifdef __EXCEPTIONS
  13607. } catch (...)
  13608. {
  13609. qDebug() << Q_FUNC_INFO << "Item too large for memory, setting invisible";
  13610. setVisible(false);
  13611. }
  13612. #endif
  13613. }
  13614. }
  13615. /* inherits documentation from base class */
  13616. QPointF QCPItemEllipse::anchorPixelPoint(int anchorId) const
  13617. {
  13618. QRectF rect = QRectF(topLeft->pixelPoint(), bottomRight->pixelPoint());
  13619. switch (anchorId)
  13620. {
  13621. case aiTopLeftRim: return rect.center()+(rect.topLeft()-rect.center())*1/qSqrt(2);
  13622. case aiTop: return (rect.topLeft()+rect.topRight())*0.5;
  13623. case aiTopRightRim: return rect.center()+(rect.topRight()-rect.center())*1/qSqrt(2);
  13624. case aiRight: return (rect.topRight()+rect.bottomRight())*0.5;
  13625. case aiBottomRightRim: return rect.center()+(rect.bottomRight()-rect.center())*1/qSqrt(2);
  13626. case aiBottom: return (rect.bottomLeft()+rect.bottomRight())*0.5;
  13627. case aiBottomLeftRim: return rect.center()+(rect.bottomLeft()-rect.center())*1/qSqrt(2);
  13628. case aiLeft: return (rect.topLeft()+rect.bottomLeft())*0.5;
  13629. case aiCenter: return (rect.topLeft()+rect.bottomRight())*0.5;
  13630. }
  13631. qDebug() << Q_FUNC_INFO << "invalid anchorId" << anchorId;
  13632. return QPointF();
  13633. }
  13634. /*! \internal
  13635. Returns the pen that should be used for drawing lines. Returns mPen when the item is not selected
  13636. and mSelectedPen when it is.
  13637. */
  13638. QPen QCPItemEllipse::mainPen() const
  13639. {
  13640. return mSelected ? mSelectedPen : mPen;
  13641. }
  13642. /*! \internal
  13643. Returns the brush that should be used for drawing fills of the item. Returns mBrush when the item
  13644. is not selected and mSelectedBrush when it is.
  13645. */
  13646. QBrush QCPItemEllipse::mainBrush() const
  13647. {
  13648. return mSelected ? mSelectedBrush : mBrush;
  13649. }
  13650. ////////////////////////////////////////////////////////////////////////////////////////////////////
  13651. //////////////////// QCPItemPixmap
  13652. ////////////////////////////////////////////////////////////////////////////////////////////////////
  13653. /*! \class QCPItemPixmap
  13654. \brief An arbitrary pixmap
  13655. \image html QCPItemPixmap.png "Pixmap example. Blue dotted circles are anchors, solid blue discs are positions."
  13656. It has two positions, \a topLeft and \a bottomRight, which define the rectangle the pixmap will
  13657. be drawn in. Depending on the scale setting (\ref setScaled), the pixmap will be either scaled to
  13658. fit the rectangle or be drawn aligned to the topLeft position.
  13659. If scaling is enabled and \a topLeft is further to the bottom/right than \a bottomRight (as shown
  13660. on the right side of the example image), the pixmap will be flipped in the respective
  13661. orientations.
  13662. */
  13663. /*!
  13664. Creates a rectangle item and sets default values.
  13665. The constructed item can be added to the plot with QCustomPlot::addItem.
  13666. */
  13667. QCPItemPixmap::QCPItemPixmap(QCustomPlot *parentPlot) :
  13668. QCPAbstractItem(parentPlot),
  13669. topLeft(createPosition("topLeft")),
  13670. bottomRight(createPosition("bottomRight")),
  13671. top(createAnchor("top", aiTop)),
  13672. topRight(createAnchor("topRight", aiTopRight)),
  13673. right(createAnchor("right", aiRight)),
  13674. bottom(createAnchor("bottom", aiBottom)),
  13675. bottomLeft(createAnchor("bottomLeft", aiBottomLeft)),
  13676. left(createAnchor("left", aiLeft))
  13677. {
  13678. topLeft->setCoords(0, 1);
  13679. bottomRight->setCoords(1, 0);
  13680. setPen(Qt::NoPen);
  13681. setSelectedPen(QPen(Qt::blue));
  13682. setScaled(false, Qt::KeepAspectRatio);
  13683. }
  13684. QCPItemPixmap::~QCPItemPixmap()
  13685. {
  13686. }
  13687. /*!
  13688. Sets the pixmap that will be displayed.
  13689. */
  13690. void QCPItemPixmap::setPixmap(const QPixmap &pixmap)
  13691. {
  13692. mPixmap = pixmap;
  13693. if (mPixmap.isNull())
  13694. qDebug() << Q_FUNC_INFO << "pixmap is null";
  13695. }
  13696. /*!
  13697. Sets whether the pixmap will be scaled to fit the rectangle defined by the \a topLeft and \a
  13698. bottomRight positions.
  13699. */
  13700. void QCPItemPixmap::setScaled(bool scaled, Qt::AspectRatioMode aspectRatioMode)
  13701. {
  13702. mScaled = scaled;
  13703. mAspectRatioMode = aspectRatioMode;
  13704. updateScaledPixmap();
  13705. }
  13706. /*!
  13707. Sets the pen that will be used to draw a border around the pixmap.
  13708. \see setSelectedPen, setBrush
  13709. */
  13710. void QCPItemPixmap::setPen(const QPen &pen)
  13711. {
  13712. mPen = pen;
  13713. }
  13714. /*!
  13715. Sets the pen that will be used to draw a border around the pixmap when selected
  13716. \see setPen, setSelected
  13717. */
  13718. void QCPItemPixmap::setSelectedPen(const QPen &pen)
  13719. {
  13720. mSelectedPen = pen;
  13721. }
  13722. /* inherits documentation from base class */
  13723. double QCPItemPixmap::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  13724. {
  13725. Q_UNUSED(details)
  13726. if (onlySelectable && !mSelectable)
  13727. return -1;
  13728. return rectSelectTest(getFinalRect(), pos, true);
  13729. }
  13730. /* inherits documentation from base class */
  13731. void QCPItemPixmap::draw(QCPPainter *painter)
  13732. {
  13733. bool flipHorz = false;
  13734. bool flipVert = false;
  13735. QRect rect = getFinalRect(&flipHorz, &flipVert);
  13736. double clipPad = mainPen().style() == Qt::NoPen ? 0 : mainPen().widthF();
  13737. QRect boundingRect = rect.adjusted(-clipPad, -clipPad, clipPad, clipPad);
  13738. if (boundingRect.intersects(clipRect()))
  13739. {
  13740. updateScaledPixmap(rect, flipHorz, flipVert);
  13741. painter->drawPixmap(rect.topLeft(), mScaled ? mScaledPixmap : mPixmap);
  13742. QPen pen = mainPen();
  13743. if (pen.style() != Qt::NoPen)
  13744. {
  13745. painter->setPen(pen);
  13746. painter->setBrush(Qt::NoBrush);
  13747. painter->drawRect(rect);
  13748. }
  13749. }
  13750. }
  13751. /* inherits documentation from base class */
  13752. QPointF QCPItemPixmap::anchorPixelPoint(int anchorId) const
  13753. {
  13754. bool flipHorz;
  13755. bool flipVert;
  13756. QRect rect = getFinalRect(&flipHorz, &flipVert);
  13757. // we actually want denormal rects (negative width/height) here, so restore
  13758. // the flipped state:
  13759. if (flipHorz)
  13760. rect.adjust(rect.width(), 0, -rect.width(), 0);
  13761. if (flipVert)
  13762. rect.adjust(0, rect.height(), 0, -rect.height());
  13763. switch (anchorId)
  13764. {
  13765. case aiTop: return (rect.topLeft()+rect.topRight())*0.5;
  13766. case aiTopRight: return rect.topRight();
  13767. case aiRight: return (rect.topRight()+rect.bottomRight())*0.5;
  13768. case aiBottom: return (rect.bottomLeft()+rect.bottomRight())*0.5;
  13769. case aiBottomLeft: return rect.bottomLeft();
  13770. case aiLeft: return (rect.topLeft()+rect.bottomLeft())*0.5;;
  13771. }
  13772. qDebug() << Q_FUNC_INFO << "invalid anchorId" << anchorId;
  13773. return QPointF();
  13774. }
  13775. /*! \internal
  13776. Creates the buffered scaled image (\a mScaledPixmap) to fit the specified \a finalRect. The
  13777. parameters \a flipHorz and \a flipVert control whether the resulting image shall be flipped
  13778. horizontally or vertically. (This is used when \a topLeft is further to the bottom/right than \a
  13779. bottomRight.)
  13780. This function only creates the scaled pixmap when the buffered pixmap has a different size than
  13781. the expected result, so calling this function repeatedly, e.g. in the \ref draw function, does
  13782. not cause expensive rescaling every time.
  13783. If scaling is disabled, sets mScaledPixmap to a null QPixmap.
  13784. */
  13785. void QCPItemPixmap::updateScaledPixmap(QRect finalRect, bool flipHorz, bool flipVert)
  13786. {
  13787. if (mPixmap.isNull())
  13788. return;
  13789. if (mScaled)
  13790. {
  13791. if (finalRect.isNull())
  13792. finalRect = getFinalRect(&flipHorz, &flipVert);
  13793. if (finalRect.size() != mScaledPixmap.size())
  13794. {
  13795. mScaledPixmap = mPixmap.scaled(finalRect.size(), mAspectRatioMode, Qt::SmoothTransformation);
  13796. if (flipHorz || flipVert)
  13797. mScaledPixmap = QPixmap::fromImage(mScaledPixmap.toImage().mirrored(flipHorz, flipVert));
  13798. }
  13799. } else if (!mScaledPixmap.isNull())
  13800. mScaledPixmap = QPixmap();
  13801. }
  13802. /*! \internal
  13803. Returns the final (tight) rect the pixmap is drawn in, depending on the current item positions
  13804. and scaling settings.
  13805. The output parameters \a flippedHorz and \a flippedVert return whether the pixmap should be drawn
  13806. flipped horizontally or vertically in the returned rect. (The returned rect itself is always
  13807. normalized, i.e. the top left corner of the rect is actually further to the top/left than the
  13808. bottom right corner). This is the case when the item position \a topLeft is further to the
  13809. bottom/right than \a bottomRight.
  13810. If scaling is disabled, returns a rect with size of the original pixmap and the top left corner
  13811. aligned with the item position \a topLeft. The position \a bottomRight is ignored.
  13812. */
  13813. QRect QCPItemPixmap::getFinalRect(bool *flippedHorz, bool *flippedVert) const
  13814. {
  13815. QRect result;
  13816. bool flipHorz = false;
  13817. bool flipVert = false;
  13818. QPoint p1 = topLeft->pixelPoint().toPoint();
  13819. QPoint p2 = bottomRight->pixelPoint().toPoint();
  13820. if (p1 == p2)
  13821. return QRect(p1, QSize(0, 0));
  13822. if (mScaled)
  13823. {
  13824. QSize newSize = QSize(p2.x()-p1.x(), p2.y()-p1.y());
  13825. QPoint topLeft = p1;
  13826. if (newSize.width() < 0)
  13827. {
  13828. flipHorz = true;
  13829. newSize.rwidth() *= -1;
  13830. topLeft.setX(p2.x());
  13831. }
  13832. if (newSize.height() < 0)
  13833. {
  13834. flipVert = true;
  13835. newSize.rheight() *= -1;
  13836. topLeft.setY(p2.y());
  13837. }
  13838. QSize scaledSize = mPixmap.size();
  13839. scaledSize.scale(newSize, mAspectRatioMode);
  13840. result = QRect(topLeft, scaledSize);
  13841. } else
  13842. {
  13843. result = QRect(p1, mPixmap.size());
  13844. }
  13845. if (flippedHorz)
  13846. *flippedHorz = flipHorz;
  13847. if (flippedVert)
  13848. *flippedVert = flipVert;
  13849. return result;
  13850. }
  13851. /*! \internal
  13852. Returns the pen that should be used for drawing lines. Returns mPen when the item is not selected
  13853. and mSelectedPen when it is.
  13854. */
  13855. QPen QCPItemPixmap::mainPen() const
  13856. {
  13857. return mSelected ? mSelectedPen : mPen;
  13858. }
  13859. ////////////////////////////////////////////////////////////////////////////////////////////////////
  13860. //////////////////// QCPItemTracer
  13861. ////////////////////////////////////////////////////////////////////////////////////////////////////
  13862. /*! \class QCPItemTracer
  13863. \brief Item that sticks to QCPGraph data points
  13864. \image html QCPItemTracer.png "Tracer example. Blue dotted circles are anchors, solid blue discs are positions."
  13865. The tracer can be connected with a QCPGraph via \ref setGraph. Then it will automatically adopt
  13866. the coordinate axes of the graph and update its \a position to be on the graph's data. This means
  13867. the key stays controllable via \ref setGraphKey, but the value will follow the graph data. If a
  13868. QCPGraph is connected, note that setting the coordinates of the tracer item directly via \a
  13869. position will have no effect because they will be overriden in the next redraw (this is when the
  13870. coordinate update happens).
  13871. If the specified key in \ref setGraphKey is outside the key bounds of the graph, the tracer will
  13872. stay at the corresponding end of the graph.
  13873. With \ref setInterpolating you may specify whether the tracer may only stay exactly on data
  13874. points or whether it interpolates data points linearly, if given a key that lies between two data
  13875. points of the graph.
  13876. The tracer has different visual styles, see \ref setStyle. It is also possible to make the tracer
  13877. have no own visual appearance (set the style to \ref tsNone), and just connect other item
  13878. positions to the tracer \a position (used as an anchor) via \ref
  13879. QCPItemPosition::setParentAnchor.
  13880. \note The tracer position is only automatically updated upon redraws. So when the data of the
  13881. graph changes and immediately afterwards (without a redraw) the a position coordinates of the
  13882. tracer are retrieved, they will not reflect the updated data of the graph. In this case \ref
  13883. updatePosition must be called manually, prior to reading the tracer coordinates.
  13884. */
  13885. /*!
  13886. Creates a tracer item and sets default values.
  13887. The constructed item can be added to the plot with QCustomPlot::addItem.
  13888. */
  13889. QCPItemTracer::QCPItemTracer(QCustomPlot *parentPlot) :
  13890. QCPAbstractItem(parentPlot),
  13891. position(createPosition("position")),
  13892. mGraph(0)
  13893. {
  13894. position->setCoords(0, 0);
  13895. setBrush(Qt::NoBrush);
  13896. setSelectedBrush(Qt::NoBrush);
  13897. setPen(QPen(Qt::black));
  13898. setSelectedPen(QPen(Qt::blue, 2));
  13899. setStyle(tsCrosshair);
  13900. setSize(6);
  13901. setInterpolating(false);
  13902. setGraphKey(0);
  13903. }
  13904. QCPItemTracer::~QCPItemTracer()
  13905. {
  13906. }
  13907. /*!
  13908. Sets the pen that will be used to draw the line of the tracer
  13909. \see setSelectedPen, setBrush
  13910. */
  13911. void QCPItemTracer::setPen(const QPen &pen)
  13912. {
  13913. mPen = pen;
  13914. }
  13915. /*!
  13916. Sets the pen that will be used to draw the line of the tracer when selected
  13917. \see setPen, setSelected
  13918. */
  13919. void QCPItemTracer::setSelectedPen(const QPen &pen)
  13920. {
  13921. mSelectedPen = pen;
  13922. }
  13923. /*!
  13924. Sets the brush that will be used to draw any fills of the tracer
  13925. \see setSelectedBrush, setPen
  13926. */
  13927. void QCPItemTracer::setBrush(const QBrush &brush)
  13928. {
  13929. mBrush = brush;
  13930. }
  13931. /*!
  13932. Sets the brush that will be used to draw any fills of the tracer, when selected.
  13933. \see setBrush, setSelected
  13934. */
  13935. void QCPItemTracer::setSelectedBrush(const QBrush &brush)
  13936. {
  13937. mSelectedBrush = brush;
  13938. }
  13939. /*!
  13940. Sets the size of the tracer in pixels, if the style supports setting a size (e.g. \ref tsSquare
  13941. does, \ref tsCrosshair does not).
  13942. */
  13943. void QCPItemTracer::setSize(double size)
  13944. {
  13945. mSize = size;
  13946. }
  13947. /*!
  13948. Sets the style/visual appearance of the tracer.
  13949. If you only want to use the tracer \a position as an anchor for other items, set \a style to
  13950. \ref tsNone.
  13951. */
  13952. void QCPItemTracer::setStyle(QCPItemTracer::TracerStyle style)
  13953. {
  13954. mStyle = style;
  13955. }
  13956. /*!
  13957. Sets the QCPGraph this tracer sticks to. The tracer \a position will be set to type
  13958. QCPItemPosition::ptPlotCoords and the axes will be set to the axes of \a graph.
  13959. To free the tracer from any graph, set \a graph to 0. The tracer \a position can then be placed
  13960. freely like any other item position. This is the state the tracer will assume when its graph gets
  13961. deleted while still attached to it.
  13962. \see setGraphKey
  13963. */
  13964. void QCPItemTracer::setGraph(QCPGraph *graph)
  13965. {
  13966. if (graph)
  13967. {
  13968. if (graph->parentPlot() == mParentPlot)
  13969. {
  13970. position->setType(QCPItemPosition::ptPlotCoords);
  13971. position->setAxes(graph->keyAxis(), graph->valueAxis());
  13972. mGraph = graph;
  13973. updatePosition();
  13974. } else
  13975. qDebug() << Q_FUNC_INFO << "graph isn't in same QCustomPlot instance as this item";
  13976. } else
  13977. {
  13978. mGraph = 0;
  13979. }
  13980. }
  13981. /*!
  13982. Sets the key of the graph's data point the tracer will be positioned at. This is the only free
  13983. coordinate of a tracer when attached to a graph.
  13984. Depending on \ref setInterpolating, the tracer will be either positioned on the data point
  13985. closest to \a key, or will stay exactly at \a key and interpolate the value linearly.
  13986. \see setGraph, setInterpolating
  13987. */
  13988. void QCPItemTracer::setGraphKey(double key)
  13989. {
  13990. mGraphKey = key;
  13991. }
  13992. /*!
  13993. Sets whether the value of the graph's data points shall be interpolated, when positioning the
  13994. tracer.
  13995. If \a enabled is set to false and a key is given with \ref setGraphKey, the tracer is placed on
  13996. the data point of the graph which is closest to the key, but which is not necessarily exactly
  13997. there. If \a enabled is true, the tracer will be positioned exactly at the specified key, and
  13998. the appropriate value will be interpolated from the graph's data points linearly.
  13999. \see setGraph, setGraphKey
  14000. */
  14001. void QCPItemTracer::setInterpolating(bool enabled)
  14002. {
  14003. mInterpolating = enabled;
  14004. }
  14005. /* inherits documentation from base class */
  14006. double QCPItemTracer::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  14007. {
  14008. Q_UNUSED(details)
  14009. if (onlySelectable && !mSelectable)
  14010. return -1;
  14011. QPointF center(position->pixelPoint());
  14012. double w = mSize/2.0;
  14013. QRect clip = clipRect();
  14014. switch (mStyle)
  14015. {
  14016. case tsNone: return -1;
  14017. case tsPlus:
  14018. {
  14019. if (clipRect().intersects(QRectF(center-QPointF(w, w), center+QPointF(w, w)).toRect()))
  14020. return qSqrt(qMin(distSqrToLine(center+QPointF(-w, 0), center+QPointF(w, 0), pos),
  14021. distSqrToLine(center+QPointF(0, -w), center+QPointF(0, w), pos)));
  14022. break;
  14023. }
  14024. case tsCrosshair:
  14025. {
  14026. return qSqrt(qMin(distSqrToLine(QPointF(clip.left(), center.y()), QPointF(clip.right(), center.y()), pos),
  14027. distSqrToLine(QPointF(center.x(), clip.top()), QPointF(center.x(), clip.bottom()), pos)));
  14028. }
  14029. case tsCircle:
  14030. {
  14031. if (clip.intersects(QRectF(center-QPointF(w, w), center+QPointF(w, w)).toRect()))
  14032. {
  14033. // distance to border:
  14034. double centerDist = QVector2D(center-pos).length();
  14035. double circleLine = w;
  14036. double result = qAbs(centerDist-circleLine);
  14037. // filled ellipse, allow click inside to count as hit:
  14038. if (result > mParentPlot->selectionTolerance()*0.99 && mBrush.style() != Qt::NoBrush && mBrush.color().alpha() != 0)
  14039. {
  14040. if (centerDist <= circleLine)
  14041. result = mParentPlot->selectionTolerance()*0.99;
  14042. }
  14043. return result;
  14044. }
  14045. break;
  14046. }
  14047. case tsSquare:
  14048. {
  14049. if (clip.intersects(QRectF(center-QPointF(w, w), center+QPointF(w, w)).toRect()))
  14050. {
  14051. QRectF rect = QRectF(center-QPointF(w, w), center+QPointF(w, w));
  14052. bool filledRect = mBrush.style() != Qt::NoBrush && mBrush.color().alpha() != 0;
  14053. return rectSelectTest(rect, pos, filledRect);
  14054. }
  14055. break;
  14056. }
  14057. }
  14058. return -1;
  14059. }
  14060. /* inherits documentation from base class */
  14061. void QCPItemTracer::draw(QCPPainter *painter)
  14062. {
  14063. updatePosition();
  14064. if (mStyle == tsNone)
  14065. return;
  14066. painter->setPen(mainPen());
  14067. painter->setBrush(mainBrush());
  14068. QPointF center(position->pixelPoint());
  14069. double w = mSize/2.0;
  14070. QRect clip = clipRect();
  14071. switch (mStyle)
  14072. {
  14073. case tsNone: return;
  14074. case tsPlus:
  14075. {
  14076. if (clip.intersects(QRectF(center-QPointF(w, w), center+QPointF(w, w)).toRect()))
  14077. {
  14078. painter->drawLine(QLineF(center+QPointF(-w, 0), center+QPointF(w, 0)));
  14079. painter->drawLine(QLineF(center+QPointF(0, -w), center+QPointF(0, w)));
  14080. }
  14081. break;
  14082. }
  14083. case tsCrosshair:
  14084. {
  14085. if (center.y() > clip.top() && center.y() < clip.bottom())
  14086. painter->drawLine(QLineF(clip.left(), center.y(), clip.right(), center.y()));
  14087. if (center.x() > clip.left() && center.x() < clip.right())
  14088. painter->drawLine(QLineF(center.x(), clip.top(), center.x(), clip.bottom()));
  14089. break;
  14090. }
  14091. case tsCircle:
  14092. {
  14093. if (clip.intersects(QRectF(center-QPointF(w, w), center+QPointF(w, w)).toRect()))
  14094. painter->drawEllipse(center, w, w);
  14095. break;
  14096. }
  14097. case tsSquare:
  14098. {
  14099. if (clip.intersects(QRectF(center-QPointF(w, w), center+QPointF(w, w)).toRect()))
  14100. painter->drawRect(QRectF(center-QPointF(w, w), center+QPointF(w, w)));
  14101. break;
  14102. }
  14103. }
  14104. }
  14105. /*!
  14106. If the tracer is connected with a graph (\ref setGraph), this function updates the tracer's \a
  14107. position to reside on the graph data, depending on the configured key (\ref setGraphKey).
  14108. It is called automatically on every redraw and normally doesn't need to be called manually. One
  14109. exception is when you want to read the tracer coordinates via \a position and are not sure that
  14110. the graph's data (or the tracer key with \ref setGraphKey) hasn't changed since the last redraw.
  14111. In that situation, call this function before accessing \a position, to make sure you don't get
  14112. out-of-date coordinates.
  14113. If there is no graph set on this tracer, this function does nothing.
  14114. */
  14115. void QCPItemTracer::updatePosition()
  14116. {
  14117. if (mGraph)
  14118. {
  14119. if (mParentPlot->hasPlottable(mGraph))
  14120. {
  14121. if (mGraph->data()->size() > 1)
  14122. {
  14123. QCPDataMap::const_iterator first = mGraph->data()->constBegin();
  14124. QCPDataMap::const_iterator last = mGraph->data()->constEnd()-1;
  14125. if (mGraphKey < first.key())
  14126. position->setCoords(first.key(), first.value().value);
  14127. else if (mGraphKey > last.key())
  14128. position->setCoords(last.key(), last.value().value);
  14129. else
  14130. {
  14131. QCPDataMap::const_iterator it = mGraph->data()->lowerBound(mGraphKey);
  14132. if (it != first) // mGraphKey is somewhere between iterators
  14133. {
  14134. QCPDataMap::const_iterator prevIt = it-1;
  14135. if (mInterpolating)
  14136. {
  14137. // interpolate between iterators around mGraphKey:
  14138. double slope = (it.value().value-prevIt.value().value)/(it.key()-prevIt.key());
  14139. position->setCoords(mGraphKey, (mGraphKey-prevIt.key())*slope+prevIt.value().value);
  14140. } else
  14141. {
  14142. // find iterator with key closest to mGraphKey:
  14143. if (mGraphKey < (prevIt.key()+it.key())*0.5)
  14144. it = prevIt;
  14145. position->setCoords(it.key(), it.value().value);
  14146. }
  14147. } else // mGraphKey is exactly on first iterator
  14148. position->setCoords(it.key(), it.value().value);
  14149. }
  14150. } else if (mGraph->data()->size() == 1)
  14151. {
  14152. QCPDataMap::const_iterator it = mGraph->data()->constBegin();
  14153. position->setCoords(it.key(), it.value().value);
  14154. } else
  14155. qDebug() << Q_FUNC_INFO << "graph has no data";
  14156. } else
  14157. qDebug() << Q_FUNC_INFO << "graph not contained in QCustomPlot instance (anymore)";
  14158. }
  14159. }
  14160. /*! \internal
  14161. Returns the pen that should be used for drawing lines. Returns mPen when the item is not selected
  14162. and mSelectedPen when it is.
  14163. */
  14164. QPen QCPItemTracer::mainPen() const
  14165. {
  14166. return mSelected ? mSelectedPen : mPen;
  14167. }
  14168. /*! \internal
  14169. Returns the brush that should be used for drawing fills of the item. Returns mBrush when the item
  14170. is not selected and mSelectedBrush when it is.
  14171. */
  14172. QBrush QCPItemTracer::mainBrush() const
  14173. {
  14174. return mSelected ? mSelectedBrush : mBrush;
  14175. }
  14176. ////////////////////////////////////////////////////////////////////////////////////////////////////
  14177. //////////////////// QCPItemBracket
  14178. ////////////////////////////////////////////////////////////////////////////////////////////////////
  14179. /*! \class QCPItemBracket
  14180. \brief A bracket for referencing/highlighting certain parts in the plot.
  14181. \image html QCPItemBracket.png "Bracket example. Blue dotted circles are anchors, solid blue discs are positions."
  14182. It has two positions, \a left and \a right, which define the span of the bracket. If \a left is
  14183. actually farther to the left than \a right, the bracket is opened to the bottom, as shown in the
  14184. example image.
  14185. The bracket supports multiple styles via \ref setStyle. The length, i.e. how far the bracket
  14186. stretches away from the embraced span, can be controlled with \ref setLength.
  14187. \image html QCPItemBracket-length.png
  14188. <center>Demonstrating the effect of different values for \ref setLength, for styles \ref
  14189. bsCalligraphic and \ref bsSquare. Anchors and positions are displayed for reference.</center>
  14190. It provides an anchor \a center, to allow connection of other items, e.g. an arrow (QCPItemLine
  14191. or QCPItemCurve) or a text label (QCPItemText), to the bracket.
  14192. */
  14193. /*!
  14194. Creates a bracket item and sets default values.
  14195. The constructed item can be added to the plot with QCustomPlot::addItem.
  14196. */
  14197. QCPItemBracket::QCPItemBracket(QCustomPlot *parentPlot) :
  14198. QCPAbstractItem(parentPlot),
  14199. left(createPosition("left")),
  14200. right(createPosition("right")),
  14201. center(createAnchor("center", aiCenter))
  14202. {
  14203. left->setCoords(0, 0);
  14204. right->setCoords(1, 1);
  14205. setPen(QPen(Qt::black));
  14206. setSelectedPen(QPen(Qt::blue, 2));
  14207. setLength(8);
  14208. setStyle(bsCalligraphic);
  14209. }
  14210. QCPItemBracket::~QCPItemBracket()
  14211. {
  14212. }
  14213. /*!
  14214. Sets the pen that will be used to draw the bracket.
  14215. Note that when the style is \ref bsCalligraphic, only the color will be taken from the pen, the
  14216. stroke and width are ignored. To change the apparent stroke width of a calligraphic bracket, use
  14217. \ref setLength, which has a similar effect.
  14218. \see setSelectedPen
  14219. */
  14220. void QCPItemBracket::setPen(const QPen &pen)
  14221. {
  14222. mPen = pen;
  14223. }
  14224. /*!
  14225. Sets the pen that will be used to draw the bracket when selected
  14226. \see setPen, setSelected
  14227. */
  14228. void QCPItemBracket::setSelectedPen(const QPen &pen)
  14229. {
  14230. mSelectedPen = pen;
  14231. }
  14232. /*!
  14233. Sets the \a length in pixels how far the bracket extends in the direction towards the embraced
  14234. span of the bracket (i.e. perpendicular to the <i>left</i>-<i>right</i>-direction)
  14235. \image html QCPItemBracket-length.png
  14236. <center>Demonstrating the effect of different values for \ref setLength, for styles \ref
  14237. bsCalligraphic and \ref bsSquare. Anchors and positions are displayed for reference.</center>
  14238. */
  14239. void QCPItemBracket::setLength(double length)
  14240. {
  14241. mLength = length;
  14242. }
  14243. /*!
  14244. Sets the style of the bracket, i.e. the shape/visual appearance.
  14245. \see setPen
  14246. */
  14247. void QCPItemBracket::setStyle(QCPItemBracket::BracketStyle style)
  14248. {
  14249. mStyle = style;
  14250. }
  14251. /* inherits documentation from base class */
  14252. double QCPItemBracket::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  14253. {
  14254. Q_UNUSED(details)
  14255. if (onlySelectable && !mSelectable)
  14256. return -1;
  14257. QVector2D leftVec(left->pixelPoint());
  14258. QVector2D rightVec(right->pixelPoint());
  14259. if (leftVec.toPoint() == rightVec.toPoint())
  14260. return -1;
  14261. QVector2D widthVec = (rightVec-leftVec)*0.5;
  14262. QVector2D lengthVec(-widthVec.y(), widthVec.x());
  14263. lengthVec = lengthVec.normalized()*mLength;
  14264. QVector2D centerVec = (rightVec+leftVec)*0.5-lengthVec;
  14265. return qSqrt(distSqrToLine((centerVec-widthVec).toPointF(), (centerVec+widthVec).toPointF(), pos));
  14266. }
  14267. /* inherits documentation from base class */
  14268. void QCPItemBracket::draw(QCPPainter *painter)
  14269. {
  14270. QVector2D leftVec(left->pixelPoint());
  14271. QVector2D rightVec(right->pixelPoint());
  14272. if (leftVec.toPoint() == rightVec.toPoint())
  14273. return;
  14274. QVector2D widthVec = (rightVec-leftVec)*0.5;
  14275. QVector2D lengthVec(-widthVec.y(), widthVec.x());
  14276. lengthVec = lengthVec.normalized()*mLength;
  14277. QVector2D centerVec = (rightVec+leftVec)*0.5-lengthVec;
  14278. QPolygon boundingPoly;
  14279. boundingPoly << leftVec.toPoint() << rightVec.toPoint()
  14280. << (rightVec-lengthVec).toPoint() << (leftVec-lengthVec).toPoint();
  14281. QRect clip = clipRect().adjusted(-mainPen().widthF(), -mainPen().widthF(), mainPen().widthF(), mainPen().widthF());
  14282. if (clip.intersects(boundingPoly.boundingRect()))
  14283. {
  14284. painter->setPen(mainPen());
  14285. switch (mStyle)
  14286. {
  14287. case bsSquare:
  14288. {
  14289. painter->drawLine((centerVec+widthVec).toPointF(), (centerVec-widthVec).toPointF());
  14290. painter->drawLine((centerVec+widthVec).toPointF(), (centerVec+widthVec+lengthVec).toPointF());
  14291. painter->drawLine((centerVec-widthVec).toPointF(), (centerVec-widthVec+lengthVec).toPointF());
  14292. break;
  14293. }
  14294. case bsRound:
  14295. {
  14296. painter->setBrush(Qt::NoBrush);
  14297. QPainterPath path;
  14298. path.moveTo((centerVec+widthVec+lengthVec).toPointF());
  14299. path.cubicTo((centerVec+widthVec).toPointF(), (centerVec+widthVec).toPointF(), centerVec.toPointF());
  14300. path.cubicTo((centerVec-widthVec).toPointF(), (centerVec-widthVec).toPointF(), (centerVec-widthVec+lengthVec).toPointF());
  14301. painter->drawPath(path);
  14302. break;
  14303. }
  14304. case bsCurly:
  14305. {
  14306. painter->setBrush(Qt::NoBrush);
  14307. QPainterPath path;
  14308. path.moveTo((centerVec+widthVec+lengthVec).toPointF());
  14309. path.cubicTo((centerVec+widthVec*1-lengthVec*0.8).toPointF(), (centerVec+0.4*widthVec+1*lengthVec).toPointF(), centerVec.toPointF());
  14310. path.cubicTo((centerVec-0.4*widthVec+1*lengthVec).toPointF(), (centerVec-widthVec*1-lengthVec*0.8).toPointF(), (centerVec-widthVec+lengthVec).toPointF());
  14311. painter->drawPath(path);
  14312. break;
  14313. }
  14314. case bsCalligraphic:
  14315. {
  14316. painter->setPen(Qt::NoPen);
  14317. painter->setBrush(QBrush(mainPen().color()));
  14318. QPainterPath path;
  14319. path.moveTo((centerVec+widthVec+lengthVec).toPointF());
  14320. path.cubicTo((centerVec+widthVec*1-lengthVec*0.8).toPointF(), (centerVec+0.4*widthVec+0.8*lengthVec).toPointF(), centerVec.toPointF());
  14321. path.cubicTo((centerVec-0.4*widthVec+0.8*lengthVec).toPointF(), (centerVec-widthVec*1-lengthVec*0.8).toPointF(), (centerVec-widthVec+lengthVec).toPointF());
  14322. path.cubicTo((centerVec-widthVec*1-lengthVec*0.5).toPointF(), (centerVec-0.2*widthVec+1.2*lengthVec).toPointF(), (centerVec+lengthVec*0.2).toPointF());
  14323. path.cubicTo((centerVec+0.2*widthVec+1.2*lengthVec).toPointF(), (centerVec+widthVec*1-lengthVec*0.5).toPointF(), (centerVec+widthVec+lengthVec).toPointF());
  14324. painter->drawPath(path);
  14325. break;
  14326. }
  14327. }
  14328. }
  14329. }
  14330. /* inherits documentation from base class */
  14331. QPointF QCPItemBracket::anchorPixelPoint(int anchorId) const
  14332. {
  14333. QVector2D leftVec(left->pixelPoint());
  14334. QVector2D rightVec(right->pixelPoint());
  14335. if (leftVec.toPoint() == rightVec.toPoint())
  14336. return leftVec.toPointF();
  14337. QVector2D widthVec = (rightVec-leftVec)*0.5;
  14338. QVector2D lengthVec(-widthVec.y(), widthVec.x());
  14339. lengthVec = lengthVec.normalized()*mLength;
  14340. QVector2D centerVec = (rightVec+leftVec)*0.5-lengthVec;
  14341. switch (anchorId)
  14342. {
  14343. case aiCenter:
  14344. return centerVec.toPointF();
  14345. }
  14346. qDebug() << Q_FUNC_INFO << "invalid anchorId" << anchorId;
  14347. return QPointF();
  14348. }
  14349. /*! \internal
  14350. Returns the pen that should be used for drawing lines. Returns mPen when the
  14351. item is not selected and mSelectedPen when it is.
  14352. */
  14353. QPen QCPItemBracket::mainPen() const
  14354. {
  14355. return mSelected ? mSelectedPen : mPen;
  14356. }
  14357. ////////////////////////////////////////////////////////////////////////////////////////////////////
  14358. //////////////////// QCPAxisRect
  14359. ////////////////////////////////////////////////////////////////////////////////////////////////////
  14360. /*! \class QCPAxisRect
  14361. \brief Holds multiple axes and arranges them in a rectangular shape.
  14362. This class represents an axis rect, a rectangular area that is bounded on all sides with an
  14363. arbitrary number of axes.
  14364. Initially QCustomPlot has one axis rect, accessible via QCustomPlot::axisRect(). However, the
  14365. layout system allows to have multiple axis rects, e.g. arranged in a grid layout
  14366. (QCustomPlot::plotLayout).
  14367. By default, QCPAxisRect comes with four axes, at bottom, top, left and right. They can be
  14368. accessed via \ref axis by providing the respective axis type (\ref QCPAxis::AxisType) and index.
  14369. If you need all axes in the axis rect, use \ref axes. The top and right axes are set to be
  14370. invisible initially (QCPAxis::setVisible). To add more axes to a side, use \ref addAxis or \ref
  14371. addAxes. To remove an axis, use \ref removeAxis.
  14372. The axis rect layerable itself only draws a background pixmap or color, if specified (\ref
  14373. setBackground). It is placed on the "background" layer initially (see \ref QCPLayer for an
  14374. explanation of the QCustomPlot layer system). The axes that are held by the axis rect can be
  14375. placed on other layers, independently of the axis rect.
  14376. Every axis rect has a child layout of type \ref QCPLayoutInset. It is accessible via \ref
  14377. insetLayout and can be used to have other layout elements (or even other layouts with multiple
  14378. elements) hovering inside the axis rect.
  14379. If an axis rect is clicked and dragged, it processes this by moving certain axis ranges. The
  14380. behaviour can be controlled with \ref setRangeDrag and \ref setRangeDragAxes. If the mouse wheel
  14381. is scrolled while the cursor is on the axis rect, certain axes are scaled. This is controllable
  14382. via \ref setRangeZoom, \ref setRangeZoomAxes and \ref setRangeZoomFactor. These interactions are
  14383. only enabled if \ref QCustomPlot::setInteractions contains \ref QCP::iRangeDrag and \ref
  14384. QCP::iRangeZoom.
  14385. \image html AxisRectSpacingOverview.png
  14386. <center>Overview of the spacings and paddings that define the geometry of an axis. The dashed
  14387. line on the far left indicates the viewport/widget border.</center>
  14388. */
  14389. /* start documentation of inline functions */
  14390. /*! \fn QCPLayoutInset *QCPAxisRect::insetLayout() const
  14391. Returns the inset layout of this axis rect. It can be used to place other layout elements (or
  14392. even layouts with multiple other elements) inside/on top of an axis rect.
  14393. \see QCPLayoutInset
  14394. */
  14395. /*! \fn int QCPAxisRect::left() const
  14396. Returns the pixel position of the left border of this axis rect. Margins are not taken into
  14397. account here, so the returned value is with respect to the inner \ref rect.
  14398. */
  14399. /*! \fn int QCPAxisRect::right() const
  14400. Returns the pixel position of the right border of this axis rect. Margins are not taken into
  14401. account here, so the returned value is with respect to the inner \ref rect.
  14402. */
  14403. /*! \fn int QCPAxisRect::top() const
  14404. Returns the pixel position of the top border of this axis rect. Margins are not taken into
  14405. account here, so the returned value is with respect to the inner \ref rect.
  14406. */
  14407. /*! \fn int QCPAxisRect::bottom() const
  14408. Returns the pixel position of the bottom border of this axis rect. Margins are not taken into
  14409. account here, so the returned value is with respect to the inner \ref rect.
  14410. */
  14411. /*! \fn int QCPAxisRect::width() const
  14412. Returns the pixel width of this axis rect. Margins are not taken into account here, so the
  14413. returned value is with respect to the inner \ref rect.
  14414. */
  14415. /*! \fn int QCPAxisRect::height() const
  14416. Returns the pixel height of this axis rect. Margins are not taken into account here, so the
  14417. returned value is with respect to the inner \ref rect.
  14418. */
  14419. /*! \fn QSize QCPAxisRect::size() const
  14420. Returns the pixel size of this axis rect. Margins are not taken into account here, so the
  14421. returned value is with respect to the inner \ref rect.
  14422. */
  14423. /*! \fn QPoint QCPAxisRect::topLeft() const
  14424. Returns the top left corner of this axis rect in pixels. Margins are not taken into account here,
  14425. so the returned value is with respect to the inner \ref rect.
  14426. */
  14427. /*! \fn QPoint QCPAxisRect::topRight() const
  14428. Returns the top right corner of this axis rect in pixels. Margins are not taken into account
  14429. here, so the returned value is with respect to the inner \ref rect.
  14430. */
  14431. /*! \fn QPoint QCPAxisRect::bottomLeft() const
  14432. Returns the bottom left corner of this axis rect in pixels. Margins are not taken into account
  14433. here, so the returned value is with respect to the inner \ref rect.
  14434. */
  14435. /*! \fn QPoint QCPAxisRect::bottomRight() const
  14436. Returns the bottom right corner of this axis rect in pixels. Margins are not taken into account
  14437. here, so the returned value is with respect to the inner \ref rect.
  14438. */
  14439. /*! \fn QPoint QCPAxisRect::center() const
  14440. Returns the center of this axis rect in pixels. Margins are not taken into account here, so the
  14441. returned value is with respect to the inner \ref rect.
  14442. */
  14443. /* end documentation of inline functions */
  14444. /*!
  14445. Creates a QCPAxisRect instance and sets default values. An axis is added for each of the four
  14446. sides, the top and right axes are set invisible initially.
  14447. */
  14448. QCPAxisRect::QCPAxisRect(QCustomPlot *parentPlot, bool setupDefaultAxes) :
  14449. QCPLayoutElement(parentPlot),
  14450. mBackgroundBrush(Qt::NoBrush),
  14451. mBackgroundScaled(true),
  14452. mBackgroundScaledMode(Qt::KeepAspectRatioByExpanding),
  14453. mInsetLayout(new QCPLayoutInset),
  14454. mRangeDrag(Qt::Horizontal|Qt::Vertical),
  14455. mRangeZoom(Qt::Horizontal|Qt::Vertical),
  14456. mRangeZoomFactorHorz(0.85),
  14457. mRangeZoomFactorVert(0.85),
  14458. mDragging(false)
  14459. {
  14460. mInsetLayout->initializeParentPlot(mParentPlot);
  14461. mInsetLayout->setParentLayerable(this);
  14462. mInsetLayout->setParent(this);
  14463. setMinimumSize(50, 50);
  14464. setMinimumMargins(QMargins(15, 15, 15, 15));
  14465. mAxes.insert(QCPAxis::atLeft, QList<QCPAxis*>());
  14466. mAxes.insert(QCPAxis::atRight, QList<QCPAxis*>());
  14467. mAxes.insert(QCPAxis::atTop, QList<QCPAxis*>());
  14468. mAxes.insert(QCPAxis::atBottom, QList<QCPAxis*>());
  14469. if (setupDefaultAxes)
  14470. {
  14471. QCPAxis *xAxis = addAxis(QCPAxis::atBottom);
  14472. QCPAxis *yAxis = addAxis(QCPAxis::atLeft);
  14473. QCPAxis *xAxis2 = addAxis(QCPAxis::atTop);
  14474. QCPAxis *yAxis2 = addAxis(QCPAxis::atRight);
  14475. setRangeDragAxes(xAxis, yAxis);
  14476. setRangeZoomAxes(xAxis, yAxis);
  14477. xAxis2->setVisible(false);
  14478. yAxis2->setVisible(false);
  14479. xAxis->grid()->setVisible(true);
  14480. yAxis->grid()->setVisible(true);
  14481. xAxis2->grid()->setVisible(false);
  14482. yAxis2->grid()->setVisible(false);
  14483. xAxis2->grid()->setZeroLinePen(Qt::NoPen);
  14484. yAxis2->grid()->setZeroLinePen(Qt::NoPen);
  14485. xAxis2->grid()->setVisible(false);
  14486. yAxis2->grid()->setVisible(false);
  14487. }
  14488. }
  14489. QCPAxisRect::~QCPAxisRect()
  14490. {
  14491. delete mInsetLayout;
  14492. mInsetLayout = 0;
  14493. QList<QCPAxis*> axesList = axes();
  14494. for (int i=0; i<axesList.size(); ++i)
  14495. removeAxis(axesList.at(i));
  14496. }
  14497. /*!
  14498. Returns the number of axes on the axis rect side specified with \a type.
  14499. \see axis
  14500. */
  14501. int QCPAxisRect::axisCount(QCPAxis::AxisType type) const
  14502. {
  14503. return mAxes.value(type).size();
  14504. }
  14505. /*!
  14506. Returns the axis with the given \a index on the axis rect side specified with \a type.
  14507. \see axisCount, axes
  14508. */
  14509. QCPAxis *QCPAxisRect::axis(QCPAxis::AxisType type, int index) const
  14510. {
  14511. QList<QCPAxis*> ax(mAxes.value(type));
  14512. if (index >= 0 && index < ax.size())
  14513. {
  14514. return ax.at(index);
  14515. } else
  14516. {
  14517. qDebug() << Q_FUNC_INFO << "Axis index out of bounds:" << index;
  14518. return 0;
  14519. }
  14520. }
  14521. /*!
  14522. Returns all axes on the axis rect sides specified with \a types.
  14523. \a types may be a single \ref QCPAxis::AxisType or an <tt>or</tt>-combination, to get the axes of
  14524. multiple sides.
  14525. \see axis
  14526. */
  14527. QList<QCPAxis*> QCPAxisRect::axes(QCPAxis::AxisTypes types) const
  14528. {
  14529. QList<QCPAxis*> result;
  14530. if (types.testFlag(QCPAxis::atLeft))
  14531. result << mAxes.value(QCPAxis::atLeft);
  14532. if (types.testFlag(QCPAxis::atRight))
  14533. result << mAxes.value(QCPAxis::atRight);
  14534. if (types.testFlag(QCPAxis::atTop))
  14535. result << mAxes.value(QCPAxis::atTop);
  14536. if (types.testFlag(QCPAxis::atBottom))
  14537. result << mAxes.value(QCPAxis::atBottom);
  14538. return result;
  14539. }
  14540. /*! \overload
  14541. Returns all axes of this axis rect.
  14542. */
  14543. QList<QCPAxis*> QCPAxisRect::axes() const
  14544. {
  14545. QList<QCPAxis*> result;
  14546. QHashIterator<QCPAxis::AxisType, QList<QCPAxis*> > it(mAxes);
  14547. while (it.hasNext())
  14548. {
  14549. it.next();
  14550. result << it.value();
  14551. }
  14552. return result;
  14553. }
  14554. /*!
  14555. Adds a new axis to the axis rect side specified with \a type, and returns it.
  14556. If an axis rect side already contains one or more axes, the lower and upper endings of the new
  14557. axis (\ref QCPAxis::setLowerEnding, \ref QCPAxis::setUpperEnding) are initialized to \ref
  14558. QCPLineEnding::esHalfBar.
  14559. \see addAxes, setupFullAxesBox
  14560. */
  14561. QCPAxis *QCPAxisRect::addAxis(QCPAxis::AxisType type)
  14562. {
  14563. QCPAxis *newAxis = new QCPAxis(this, type);
  14564. if (mAxes[type].size() > 0) // multiple axes on one side, add half-bar axis ending to additional axes with offset
  14565. {
  14566. bool invert = (type == QCPAxis::atRight) || (type == QCPAxis::atBottom);
  14567. newAxis->setLowerEnding(QCPLineEnding(QCPLineEnding::esHalfBar, 6, 10, !invert));
  14568. newAxis->setUpperEnding(QCPLineEnding(QCPLineEnding::esHalfBar, 6, 10, invert));
  14569. }
  14570. mAxes[type].append(newAxis);
  14571. return newAxis;
  14572. }
  14573. /*!
  14574. Adds a new axis with \ref addAxis to each axis rect side specified in \a types. This may be an
  14575. <tt>or</tt>-combination of QCPAxis::AxisType, so axes can be added to multiple sides at once.
  14576. Returns a list of the added axes.
  14577. \see addAxis, setupFullAxesBox
  14578. */
  14579. QList<QCPAxis*> QCPAxisRect::addAxes(QCPAxis::AxisTypes types)
  14580. {
  14581. QList<QCPAxis*> result;
  14582. if (types.testFlag(QCPAxis::atLeft))
  14583. result << addAxis(QCPAxis::atLeft);
  14584. if (types.testFlag(QCPAxis::atRight))
  14585. result << addAxis(QCPAxis::atRight);
  14586. if (types.testFlag(QCPAxis::atTop))
  14587. result << addAxis(QCPAxis::atTop);
  14588. if (types.testFlag(QCPAxis::atBottom))
  14589. result << addAxis(QCPAxis::atBottom);
  14590. return result;
  14591. }
  14592. /*!
  14593. Removes the specified \a axis from the axis rect and deletes it.
  14594. Returns true on success, i.e. if \a axis was a valid axis in this axis rect.
  14595. \see addAxis
  14596. */
  14597. bool QCPAxisRect::removeAxis(QCPAxis *axis)
  14598. {
  14599. // don't access axis->axisType() to provide safety when axis is an invalid pointer, rather go through all axis containers:
  14600. QHashIterator<QCPAxis::AxisType, QList<QCPAxis*> > it(mAxes);
  14601. while (it.hasNext())
  14602. {
  14603. it.next();
  14604. if (it.value().contains(axis))
  14605. {
  14606. mAxes[it.key()].removeOne(axis);
  14607. if (qobject_cast<QCustomPlot*>(parentPlot())) // make sure this isn't called from QObject dtor when QCustomPlot is already destructed (happens when the axis rect is not in any layout and thus QObject-child of QCustomPlot)
  14608. parentPlot()->axisRemoved(axis);
  14609. delete axis;
  14610. return true;
  14611. }
  14612. }
  14613. qDebug() << Q_FUNC_INFO << "Axis isn't in axis rect:" << reinterpret_cast<quintptr>(axis);
  14614. return false;
  14615. }
  14616. /*!
  14617. Convenience function to create an axis on each side that doesn't have any axes yet, and assign
  14618. the top/right axes the following properties of the bottom/left axes (even if they already existed
  14619. and weren't created by this function):
  14620. \li range (\ref QCPAxis::setRange)
  14621. \li range reversed (\ref QCPAxis::setRangeReversed)
  14622. \li scale type (\ref QCPAxis::setScaleType)
  14623. \li scale log base (\ref QCPAxis::setScaleLogBase)
  14624. \li ticks (\ref QCPAxis::setTicks)
  14625. \li auto (major) tick count (\ref QCPAxis::setAutoTickCount)
  14626. \li sub tick count (\ref QCPAxis::setSubTickCount)
  14627. \li auto sub ticks (\ref QCPAxis::setAutoSubTicks)
  14628. \li tick step (\ref QCPAxis::setTickStep)
  14629. \li auto tick step (\ref QCPAxis::setAutoTickStep)
  14630. Tick labels (\ref QCPAxis::setTickLabels) of the right and top axes are set to false.
  14631. If \a connectRanges is true, the rangeChanged signals of the bottom and left axes are connected
  14632. to the \ref QCPAxis::setRange slots of the top and right axes.
  14633. */
  14634. void QCPAxisRect::setupFullAxesBox(bool connectRanges)
  14635. {
  14636. QCPAxis *xAxis, *yAxis, *xAxis2, *yAxis2;
  14637. if (axisCount(QCPAxis::atBottom) == 0)
  14638. xAxis = addAxis(QCPAxis::atBottom);
  14639. else
  14640. xAxis = axis(QCPAxis::atBottom);
  14641. if (axisCount(QCPAxis::atLeft) == 0)
  14642. yAxis = addAxis(QCPAxis::atLeft);
  14643. else
  14644. yAxis = axis(QCPAxis::atLeft);
  14645. if (axisCount(QCPAxis::atTop) == 0)
  14646. xAxis2 = addAxis(QCPAxis::atTop);
  14647. else
  14648. xAxis2 = axis(QCPAxis::atTop);
  14649. if (axisCount(QCPAxis::atRight) == 0)
  14650. yAxis2 = addAxis(QCPAxis::atRight);
  14651. else
  14652. yAxis2 = axis(QCPAxis::atRight);
  14653. xAxis2->setVisible(true);
  14654. xAxis2->setTickLabels(false);
  14655. if (xAxis)
  14656. {
  14657. xAxis2->setAutoSubTicks(xAxis->autoSubTicks());
  14658. xAxis2->setAutoTickCount(xAxis->autoTickCount());
  14659. xAxis2->setAutoTickStep(xAxis->autoTickStep());
  14660. xAxis2->setScaleType(xAxis->scaleType());
  14661. xAxis2->setScaleLogBase(xAxis->scaleLogBase());
  14662. xAxis2->setTicks(xAxis->ticks());
  14663. xAxis2->setSubTickCount(xAxis->subTickCount());
  14664. xAxis2->setTickStep(xAxis->tickStep());
  14665. xAxis2->setRange(xAxis->range());
  14666. xAxis2->setRangeReversed(xAxis->rangeReversed());
  14667. }
  14668. yAxis2->setVisible(true);
  14669. yAxis2->setTickLabels(false);
  14670. if (yAxis)
  14671. {
  14672. yAxis2->setAutoSubTicks(yAxis->autoSubTicks());
  14673. yAxis2->setAutoTickCount(yAxis->autoTickCount());
  14674. yAxis2->setAutoTickStep(yAxis->autoTickStep());
  14675. yAxis2->setScaleType(yAxis->scaleType());
  14676. yAxis2->setScaleLogBase(yAxis->scaleLogBase());
  14677. yAxis2->setTicks(yAxis->ticks());
  14678. yAxis2->setSubTickCount(yAxis->subTickCount());
  14679. yAxis2->setTickStep(yAxis->tickStep());
  14680. yAxis2->setRange(yAxis->range());
  14681. yAxis2->setRangeReversed(yAxis->rangeReversed());
  14682. }
  14683. if (connectRanges)
  14684. {
  14685. connect(xAxis, SIGNAL(rangeChanged(QCPRange)), xAxis2, SLOT(setRange(QCPRange)));
  14686. connect(yAxis, SIGNAL(rangeChanged(QCPRange)), yAxis2, SLOT(setRange(QCPRange)));
  14687. }
  14688. }
  14689. /*!
  14690. Returns a list of all the plottables that are associated with this axis rect.
  14691. A plottable is considered associated with an axis rect if its key or value axis (or both) is in
  14692. this axis rect.
  14693. \see graphs, items
  14694. */
  14695. QList<QCPAbstractPlottable*> QCPAxisRect::plottables() const
  14696. {
  14697. // Note: don't append all QCPAxis::plottables() into a list, because we might get duplicate entries
  14698. QList<QCPAbstractPlottable*> result;
  14699. for (int i=0; i<mParentPlot->mPlottables.size(); ++i)
  14700. {
  14701. if (mParentPlot->mPlottables.at(i)->keyAxis()->axisRect() == this ||mParentPlot->mPlottables.at(i)->valueAxis()->axisRect() == this)
  14702. result.append(mParentPlot->mPlottables.at(i));
  14703. }
  14704. return result;
  14705. }
  14706. /*!
  14707. Returns a list of all the graphs that are associated with this axis rect.
  14708. A graph is considered associated with an axis rect if its key or value axis (or both) is in
  14709. this axis rect.
  14710. \see plottables, items
  14711. */
  14712. QList<QCPGraph*> QCPAxisRect::graphs() const
  14713. {
  14714. // Note: don't append all QCPAxis::graphs() into a list, because we might get duplicate entries
  14715. QList<QCPGraph*> result;
  14716. for (int i=0; i<mParentPlot->mGraphs.size(); ++i)
  14717. {
  14718. if (mParentPlot->mGraphs.at(i)->keyAxis()->axisRect() == this || mParentPlot->mGraphs.at(i)->valueAxis()->axisRect() == this)
  14719. result.append(mParentPlot->mGraphs.at(i));
  14720. }
  14721. return result;
  14722. }
  14723. /*!
  14724. Returns a list of all the items that are associated with this axis rect.
  14725. An item is considered associated with an axis rect if any of its positions has key or value axis
  14726. set to an axis that is in this axis rect, or if any of its positions has \ref
  14727. QCPItemPosition::setAxisRect set to the axis rect, or if the clip axis rect (\ref
  14728. QCPAbstractItem::setClipAxisRect) is set to this axis rect.
  14729. \see plottables, graphs
  14730. */
  14731. QList<QCPAbstractItem *> QCPAxisRect::items() const
  14732. {
  14733. // Note: don't just append all QCPAxis::items() into a list, because we might get duplicate entries
  14734. // and miss those items that have this axis rect as clipAxisRect.
  14735. QList<QCPAbstractItem*> result;
  14736. for (int itemId=0; itemId<mParentPlot->mItems.size(); ++itemId)
  14737. {
  14738. if (mParentPlot->mItems.at(itemId)->clipAxisRect() == this)
  14739. {
  14740. result.append(mParentPlot->mItems.at(itemId));
  14741. continue;
  14742. }
  14743. QList<QCPItemPosition*> positions = mParentPlot->mItems.at(itemId)->positions();
  14744. for (int posId=0; posId<positions.size(); ++posId)
  14745. {
  14746. if (positions.at(posId)->axisRect() == this ||
  14747. positions.at(posId)->keyAxis()->axisRect() == this ||
  14748. positions.at(posId)->valueAxis()->axisRect() == this)
  14749. {
  14750. result.append(mParentPlot->mItems.at(itemId));
  14751. break;
  14752. }
  14753. }
  14754. }
  14755. return result;
  14756. }
  14757. /*!
  14758. This method is called automatically upon replot and doesn't need to be called by users of
  14759. QCPAxisRect.
  14760. Calls the base class implementation to update the margins (see \ref QCPLayoutElement::update),
  14761. and finally passes the \ref rect to the inset layout (\ref insetLayout) and calls its
  14762. QCPInsetLayout::update function.
  14763. */
  14764. void QCPAxisRect::update()
  14765. {
  14766. QCPLayoutElement::update();
  14767. // pass update call on to inset layout (doesn't happen automatically, because QCPAxisRect doesn't derive from QCPLayout):
  14768. mInsetLayout->setOuterRect(rect());
  14769. mInsetLayout->update();
  14770. }
  14771. /* inherits documentation from base class */
  14772. QList<QCPLayoutElement*> QCPAxisRect::elements(bool recursive) const
  14773. {
  14774. QList<QCPLayoutElement*> result;
  14775. if (mInsetLayout)
  14776. {
  14777. result << mInsetLayout;
  14778. if (recursive)
  14779. result << mInsetLayout->elements(recursive);
  14780. }
  14781. return result;
  14782. }
  14783. /* inherits documentation from base class */
  14784. void QCPAxisRect::applyDefaultAntialiasingHint(QCPPainter *painter) const
  14785. {
  14786. painter->setAntialiasing(false);
  14787. }
  14788. /* inherits documentation from base class */
  14789. void QCPAxisRect::draw(QCPPainter *painter)
  14790. {
  14791. drawBackground(painter);
  14792. }
  14793. /*!
  14794. Sets \a pm as the axis background pixmap. The axis background pixmap will be drawn inside the
  14795. axis rect. Since axis rects place themselves on the "background" layer by default, the axis rect
  14796. backgrounds are usually drawn below everything else.
  14797. For cases where the provided pixmap doesn't have the same size as the axis rect, scaling can be
  14798. enabled with \ref setBackgroundScaled and the scaling mode (i.e. whether and how the aspect ratio
  14799. is preserved) can be set with \ref setBackgroundScaledMode. To set all these options in one call,
  14800. consider using the overloaded version of this function.
  14801. Below the pixmap, the axis rect may be optionally filled with a brush, if specified with \ref
  14802. setBackground(const QBrush &brush).
  14803. \see setBackgroundScaled, setBackgroundScaledMode, setBackground(const QBrush &brush)
  14804. */
  14805. void QCPAxisRect::setBackground(const QPixmap &pm)
  14806. {
  14807. mBackgroundPixmap = pm;
  14808. mScaledBackgroundPixmap = QPixmap();
  14809. }
  14810. /*! \overload
  14811. Sets \a brush as the background brush. The axis rect background will be filled with this brush.
  14812. Since axis rects place themselves on the "background" layer by default, the axis rect backgrounds
  14813. are usually drawn below everything else.
  14814. The brush will be drawn before (under) any background pixmap, which may be specified with \ref
  14815. setBackground(const QPixmap &pm).
  14816. To disable drawing of a background brush, set \a brush to Qt::NoBrush.
  14817. \see setBackground(const QPixmap &pm)
  14818. */
  14819. void QCPAxisRect::setBackground(const QBrush &brush)
  14820. {
  14821. mBackgroundBrush = brush;
  14822. }
  14823. /*! \overload
  14824. Allows setting the background pixmap of the axis rect, whether it shall be scaled and how it
  14825. shall be scaled in one call.
  14826. \see setBackground(const QPixmap &pm), setBackgroundScaled, setBackgroundScaledMode
  14827. */
  14828. void QCPAxisRect::setBackground(const QPixmap &pm, bool scaled, Qt::AspectRatioMode mode)
  14829. {
  14830. mBackgroundPixmap = pm;
  14831. mScaledBackgroundPixmap = QPixmap();
  14832. mBackgroundScaled = scaled;
  14833. mBackgroundScaledMode = mode;
  14834. }
  14835. /*!
  14836. Sets whether the axis background pixmap shall be scaled to fit the axis rect or not. If \a scaled
  14837. is set to true, you may control whether and how the aspect ratio of the original pixmap is
  14838. preserved with \ref setBackgroundScaledMode.
  14839. Note that the scaled version of the original pixmap is buffered, so there is no performance
  14840. penalty on replots. (Except when the axis rect dimensions are changed continuously.)
  14841. \see setBackground, setBackgroundScaledMode
  14842. */
  14843. void QCPAxisRect::setBackgroundScaled(bool scaled)
  14844. {
  14845. mBackgroundScaled = scaled;
  14846. }
  14847. /*!
  14848. If scaling of the axis background pixmap is enabled (\ref setBackgroundScaled), use this function to
  14849. define whether and how the aspect ratio of the original pixmap passed to \ref setBackground is preserved.
  14850. \see setBackground, setBackgroundScaled
  14851. */
  14852. void QCPAxisRect::setBackgroundScaledMode(Qt::AspectRatioMode mode)
  14853. {
  14854. mBackgroundScaledMode = mode;
  14855. }
  14856. /*!
  14857. Returns the range drag axis of the \a orientation provided.
  14858. \see setRangeDragAxes
  14859. */
  14860. QCPAxis *QCPAxisRect::rangeDragAxis(Qt::Orientation orientation)
  14861. {
  14862. return (orientation == Qt::Horizontal ? mRangeDragHorzAxis.data() : mRangeDragVertAxis.data());
  14863. }
  14864. /*!
  14865. Returns the range zoom axis of the \a orientation provided.
  14866. \see setRangeZoomAxes
  14867. */
  14868. QCPAxis *QCPAxisRect::rangeZoomAxis(Qt::Orientation orientation)
  14869. {
  14870. return (orientation == Qt::Horizontal ? mRangeZoomHorzAxis.data() : mRangeZoomVertAxis.data());
  14871. }
  14872. /*!
  14873. Returns the range zoom factor of the \a orientation provided.
  14874. \see setRangeZoomFactor
  14875. */
  14876. double QCPAxisRect::rangeZoomFactor(Qt::Orientation orientation)
  14877. {
  14878. return (orientation == Qt::Horizontal ? mRangeZoomFactorHorz : mRangeZoomFactorVert);
  14879. }
  14880. /*!
  14881. Sets which axis orientation may be range dragged by the user with mouse interaction.
  14882. What orientation corresponds to which specific axis can be set with
  14883. \ref setRangeDragAxes(QCPAxis *horizontal, QCPAxis *vertical). By
  14884. default, the horizontal axis is the bottom axis (xAxis) and the vertical axis
  14885. is the left axis (yAxis).
  14886. To disable range dragging entirely, pass 0 as \a orientations or remove \ref QCP::iRangeDrag from \ref
  14887. QCustomPlot::setInteractions. To enable range dragging for both directions, pass <tt>Qt::Horizontal |
  14888. Qt::Vertical</tt> as \a orientations.
  14889. In addition to setting \a orientations to a non-zero value, make sure \ref QCustomPlot::setInteractions
  14890. contains \ref QCP::iRangeDrag to enable the range dragging interaction.
  14891. \see setRangeZoom, setRangeDragAxes, setNoAntialiasingOnDrag
  14892. */
  14893. void QCPAxisRect::setRangeDrag(Qt::Orientations orientations)
  14894. {
  14895. mRangeDrag = orientations;
  14896. }
  14897. /*!
  14898. Sets which axis orientation may be zoomed by the user with the mouse wheel. What orientation
  14899. corresponds to which specific axis can be set with \ref setRangeZoomAxes(QCPAxis *horizontal,
  14900. QCPAxis *vertical). By default, the horizontal axis is the bottom axis (xAxis) and the vertical
  14901. axis is the left axis (yAxis).
  14902. To disable range zooming entirely, pass 0 as \a orientations or remove \ref QCP::iRangeZoom from \ref
  14903. QCustomPlot::setInteractions. To enable range zooming for both directions, pass <tt>Qt::Horizontal |
  14904. Qt::Vertical</tt> as \a orientations.
  14905. In addition to setting \a orientations to a non-zero value, make sure \ref QCustomPlot::setInteractions
  14906. contains \ref QCP::iRangeZoom to enable the range zooming interaction.
  14907. \see setRangeZoomFactor, setRangeZoomAxes, setRangeDrag
  14908. */
  14909. void QCPAxisRect::setRangeZoom(Qt::Orientations orientations)
  14910. {
  14911. mRangeZoom = orientations;
  14912. }
  14913. /*!
  14914. Sets the axes whose range will be dragged when \ref setRangeDrag enables mouse range dragging
  14915. on the QCustomPlot widget.
  14916. \see setRangeZoomAxes
  14917. */
  14918. void QCPAxisRect::setRangeDragAxes(QCPAxis *horizontal, QCPAxis *vertical)
  14919. {
  14920. mRangeDragHorzAxis = horizontal;
  14921. mRangeDragVertAxis = vertical;
  14922. }
  14923. /*!
  14924. Sets the axes whose range will be zoomed when \ref setRangeZoom enables mouse wheel zooming on the
  14925. QCustomPlot widget. The two axes can be zoomed with different strengths, when different factors
  14926. are passed to \ref setRangeZoomFactor(double horizontalFactor, double verticalFactor).
  14927. \see setRangeDragAxes
  14928. */
  14929. void QCPAxisRect::setRangeZoomAxes(QCPAxis *horizontal, QCPAxis *vertical)
  14930. {
  14931. mRangeZoomHorzAxis = horizontal;
  14932. mRangeZoomVertAxis = vertical;
  14933. }
  14934. /*!
  14935. Sets how strong one rotation step of the mouse wheel zooms, when range zoom was activated with
  14936. \ref setRangeZoom. The two parameters \a horizontalFactor and \a verticalFactor provide a way to
  14937. let the horizontal axis zoom at different rates than the vertical axis. Which axis is horizontal
  14938. and which is vertical, can be set with \ref setRangeZoomAxes.
  14939. When the zoom factor is greater than one, scrolling the mouse wheel backwards (towards the user)
  14940. will zoom in (make the currently visible range smaller). For zoom factors smaller than one, the
  14941. same scrolling direction will zoom out.
  14942. */
  14943. void QCPAxisRect::setRangeZoomFactor(double horizontalFactor, double verticalFactor)
  14944. {
  14945. mRangeZoomFactorHorz = horizontalFactor;
  14946. mRangeZoomFactorVert = verticalFactor;
  14947. }
  14948. /*! \overload
  14949. Sets both the horizontal and vertical zoom \a factor.
  14950. */
  14951. void QCPAxisRect::setRangeZoomFactor(double factor)
  14952. {
  14953. mRangeZoomFactorHorz = factor;
  14954. mRangeZoomFactorVert = factor;
  14955. }
  14956. /*! \internal
  14957. Draws the background of this axis rect. It may consist of a background fill (a QBrush) and a
  14958. pixmap.
  14959. If a brush was given via \ref setBackground(const QBrush &brush), this function first draws an
  14960. according filling inside the axis rect with the provided \a painter.
  14961. Then, if a pixmap was provided via \ref setBackground, this function buffers the scaled version
  14962. depending on \ref setBackgroundScaled and \ref setBackgroundScaledMode and then draws it inside
  14963. the axis rect with the provided \a painter. The scaled version is buffered in
  14964. mScaledBackgroundPixmap to prevent expensive rescaling at every redraw. It is only updated, when
  14965. the axis rect has changed in a way that requires a rescale of the background pixmap (this is
  14966. dependant on the \ref setBackgroundScaledMode), or when a differend axis backgroud pixmap was
  14967. set.
  14968. \see setBackground, setBackgroundScaled, setBackgroundScaledMode
  14969. */
  14970. void QCPAxisRect::drawBackground(QCPPainter *painter)
  14971. {
  14972. // draw background fill:
  14973. if (mBackgroundBrush != Qt::NoBrush)
  14974. painter->fillRect(mRect, mBackgroundBrush);
  14975. // draw background pixmap (on top of fill, if brush specified):
  14976. if (!mBackgroundPixmap.isNull())
  14977. {
  14978. if (mBackgroundScaled)
  14979. {
  14980. // check whether mScaledBackground needs to be updated:
  14981. QSize scaledSize(mBackgroundPixmap.size());
  14982. scaledSize.scale(mRect.size(), mBackgroundScaledMode);
  14983. if (mScaledBackgroundPixmap.size() != scaledSize)
  14984. mScaledBackgroundPixmap = mBackgroundPixmap.scaled(mRect.size(), mBackgroundScaledMode, Qt::SmoothTransformation);
  14985. painter->drawPixmap(mRect.topLeft(), mScaledBackgroundPixmap, QRect(0, 0, mRect.width(), mRect.height()) & mScaledBackgroundPixmap.rect());
  14986. } else
  14987. {
  14988. painter->drawPixmap(mRect.topLeft(), mBackgroundPixmap, QRect(0, 0, mRect.width(), mRect.height()));
  14989. }
  14990. }
  14991. }
  14992. /*! \internal
  14993. This function makes sure multiple axes on the side specified with \a type don't collide, but are
  14994. distributed according to their respective space requirement (QCPAxis::calculateMargin).
  14995. It does this by setting an appropriate offset (\ref QCPAxis::setOffset) on all axes except the
  14996. one with index zero.
  14997. This function is called by \ref calculateAutoMargin.
  14998. */
  14999. void QCPAxisRect::updateAxesOffset(QCPAxis::AxisType type)
  15000. {
  15001. const QList<QCPAxis*> axesList = mAxes.value(type);
  15002. for (int i=1; i<axesList.size(); ++i)
  15003. axesList.at(i)->setOffset(axesList.at(i-1)->offset() + axesList.at(i-1)->calculateMargin() + axesList.at(i)->tickLengthIn());
  15004. }
  15005. /* inherits documentation from base class */
  15006. int QCPAxisRect::calculateAutoMargin(QCP::MarginSide side)
  15007. {
  15008. if (!mAutoMargins.testFlag(side))
  15009. qDebug() << Q_FUNC_INFO << "Called with side that isn't specified as auto margin";
  15010. updateAxesOffset(QCPAxis::marginSideToAxisType(side));
  15011. // note: only need to look at the last (outer most) axis to determine the total margin, due to updateAxisOffset call
  15012. const QList<QCPAxis*> axesList = mAxes.value(QCPAxis::marginSideToAxisType(side));
  15013. if (axesList.size() > 0)
  15014. return axesList.last()->offset() + axesList.last()->calculateMargin();
  15015. else
  15016. return 0;
  15017. }
  15018. /*! \internal
  15019. Event handler for when a mouse button is pressed on the axis rect. If the left mouse button is
  15020. pressed, the range dragging interaction is initialized (the actual range manipulation happens in
  15021. the \ref mouseMoveEvent).
  15022. The mDragging flag is set to true and some anchor points are set that are needed to determine the
  15023. distance the mouse was dragged in the mouse move/release events later.
  15024. \see mouseMoveEvent, mouseReleaseEvent
  15025. */
  15026. void QCPAxisRect::mousePressEvent(QMouseEvent *event)
  15027. {
  15028. mDragStart = event->pos(); // need this even when not LeftButton is pressed, to determine in releaseEvent whether it was a full click (no position change between press and release)
  15029. if (event->buttons() & Qt::LeftButton)
  15030. {
  15031. mDragging = true;
  15032. // initialize antialiasing backup in case we start dragging:
  15033. if (mParentPlot->noAntialiasingOnDrag())
  15034. {
  15035. mAADragBackup = mParentPlot->antialiasedElements();
  15036. mNotAADragBackup = mParentPlot->notAntialiasedElements();
  15037. }
  15038. // Mouse range dragging interaction:
  15039. if (mParentPlot->interactions().testFlag(QCP::iRangeDrag))
  15040. {
  15041. if (mRangeDragHorzAxis)
  15042. mDragStartHorzRange = mRangeDragHorzAxis.data()->range();
  15043. if (mRangeDragVertAxis)
  15044. mDragStartVertRange = mRangeDragVertAxis.data()->range();
  15045. }
  15046. }
  15047. }
  15048. /*! \internal
  15049. Event handler for when the mouse is moved on the axis rect. If range dragging was activated in a
  15050. preceding \ref mousePressEvent, the range is moved accordingly.
  15051. \see mousePressEvent, mouseReleaseEvent
  15052. */
  15053. void QCPAxisRect::mouseMoveEvent(QMouseEvent *event)
  15054. {
  15055. // Mouse range dragging interaction:
  15056. if (mDragging && mParentPlot->interactions().testFlag(QCP::iRangeDrag))
  15057. {
  15058. if (mRangeDrag.testFlag(Qt::Horizontal))
  15059. {
  15060. if (QCPAxis *rangeDragHorzAxis = mRangeDragHorzAxis.data())
  15061. {
  15062. if (rangeDragHorzAxis->mScaleType == QCPAxis::stLinear)
  15063. {
  15064. double diff = rangeDragHorzAxis->pixelToCoord(mDragStart.x()) - rangeDragHorzAxis->pixelToCoord(event->pos().x());
  15065. rangeDragHorzAxis->setRange(mDragStartHorzRange.lower+diff, mDragStartHorzRange.upper+diff);
  15066. } else if (rangeDragHorzAxis->mScaleType == QCPAxis::stLogarithmic)
  15067. {
  15068. double diff = rangeDragHorzAxis->pixelToCoord(mDragStart.x()) / rangeDragHorzAxis->pixelToCoord(event->pos().x());
  15069. rangeDragHorzAxis->setRange(mDragStartHorzRange.lower*diff, mDragStartHorzRange.upper*diff);
  15070. }
  15071. }
  15072. }
  15073. if (mRangeDrag.testFlag(Qt::Vertical))
  15074. {
  15075. if (QCPAxis *rangeDragVertAxis = mRangeDragVertAxis.data())
  15076. {
  15077. if (rangeDragVertAxis->mScaleType == QCPAxis::stLinear)
  15078. {
  15079. double diff = rangeDragVertAxis->pixelToCoord(mDragStart.y()) - rangeDragVertAxis->pixelToCoord(event->pos().y());
  15080. rangeDragVertAxis->setRange(mDragStartVertRange.lower+diff, mDragStartVertRange.upper+diff);
  15081. } else if (rangeDragVertAxis->mScaleType == QCPAxis::stLogarithmic)
  15082. {
  15083. double diff = rangeDragVertAxis->pixelToCoord(mDragStart.y()) / rangeDragVertAxis->pixelToCoord(event->pos().y());
  15084. rangeDragVertAxis->setRange(mDragStartVertRange.lower*diff, mDragStartVertRange.upper*diff);
  15085. }
  15086. }
  15087. }
  15088. if (mRangeDrag != 0) // if either vertical or horizontal drag was enabled, do a replot
  15089. {
  15090. if (mParentPlot->noAntialiasingOnDrag())
  15091. mParentPlot->setNotAntialiasedElements(QCP::aeAll);
  15092. mParentPlot->replot();
  15093. }
  15094. }
  15095. }
  15096. /* inherits documentation from base class */
  15097. void QCPAxisRect::mouseReleaseEvent(QMouseEvent *event)
  15098. {
  15099. Q_UNUSED(event)
  15100. mDragging = false;
  15101. if (mParentPlot->noAntialiasingOnDrag())
  15102. {
  15103. mParentPlot->setAntialiasedElements(mAADragBackup);
  15104. mParentPlot->setNotAntialiasedElements(mNotAADragBackup);
  15105. }
  15106. }
  15107. /*! \internal
  15108. Event handler for mouse wheel events. If rangeZoom is Qt::Horizontal, Qt::Vertical or both, the
  15109. ranges of the axes defined as rangeZoomHorzAxis and rangeZoomVertAxis are scaled. The center of
  15110. the scaling operation is the current cursor position inside the axis rect. The scaling factor is
  15111. dependant on the mouse wheel delta (which direction the wheel was rotated) to provide a natural
  15112. zooming feel. The Strength of the zoom can be controlled via \ref setRangeZoomFactor.
  15113. Note, that event->delta() is usually +/-120 for single rotation steps. However, if the mouse
  15114. wheel is turned rapidly, many steps may bunch up to one event, so the event->delta() may then be
  15115. multiples of 120. This is taken into account here, by calculating \a wheelSteps and using it as
  15116. exponent of the range zoom factor. This takes care of the wheel direction automatically, by
  15117. inverting the factor, when the wheel step is negative (f^-1 = 1/f).
  15118. */
  15119. void QCPAxisRect::wheelEvent(QWheelEvent *event)
  15120. {
  15121. // Mouse range zooming interaction:
  15122. if (mParentPlot->interactions().testFlag(QCP::iRangeZoom))
  15123. {
  15124. if (mRangeZoom != 0)
  15125. {
  15126. double factor;
  15127. double wheelSteps = event->delta()/120.0; // a single step delta is +/-120 usually
  15128. if (mRangeZoom.testFlag(Qt::Horizontal))
  15129. {
  15130. factor = pow(mRangeZoomFactorHorz, wheelSteps);
  15131. if (mRangeZoomHorzAxis.data())
  15132. mRangeZoomHorzAxis.data()->scaleRange(factor, mRangeZoomHorzAxis.data()->pixelToCoord(event->pos().x()));
  15133. }
  15134. if (mRangeZoom.testFlag(Qt::Vertical))
  15135. {
  15136. factor = pow(mRangeZoomFactorVert, wheelSteps);
  15137. if (mRangeZoomVertAxis.data())
  15138. mRangeZoomVertAxis.data()->scaleRange(factor, mRangeZoomVertAxis.data()->pixelToCoord(event->pos().y()));
  15139. }
  15140. mParentPlot->replot();
  15141. }
  15142. }
  15143. }
  15144. ////////////////////////////////////////////////////////////////////////////////////////////////////
  15145. //////////////////// QCPAbstractLegendItem
  15146. ////////////////////////////////////////////////////////////////////////////////////////////////////
  15147. /*! \class QCPAbstractLegendItem
  15148. \brief The abstract base class for all entries in a QCPLegend.
  15149. It defines a very basic interface for entries in a QCPLegend. For representing plottables in the
  15150. legend, the subclass \ref QCPPlottableLegendItem is more suitable.
  15151. Only derive directly from this class when you need absolute freedom (e.g. a custom legend entry
  15152. that's not even associated with a plottable).
  15153. You must implement the following pure virtual functions:
  15154. \li \ref draw (from QCPLayerable)
  15155. You inherit the following members you may use:
  15156. <table>
  15157. <tr>
  15158. <td>QCPLegend *\b mParentLegend</td>
  15159. <td>A pointer to the parent QCPLegend.</td>
  15160. </tr><tr>
  15161. <td>QFont \b mFont</td>
  15162. <td>The generic font of the item. You should use this font for all or at least the most prominent text of the item.</td>
  15163. </tr>
  15164. </table>
  15165. */
  15166. /* start of documentation of signals */
  15167. /*! \fn void QCPAbstractLegendItem::selectionChanged(bool selected)
  15168. This signal is emitted when the selection state of this legend item has changed, either by user
  15169. interaction or by a direct call to \ref setSelected.
  15170. */
  15171. /* end of documentation of signals */
  15172. /*!
  15173. Constructs a QCPAbstractLegendItem and associates it with the QCPLegend \a parent. This does not
  15174. cause the item to be added to \a parent, so \ref QCPLegend::addItem must be called separately.
  15175. */
  15176. QCPAbstractLegendItem::QCPAbstractLegendItem(QCPLegend *parent) :
  15177. QCPLayoutElement(parent->parentPlot()),
  15178. mParentLegend(parent),
  15179. mFont(parent->font()),
  15180. mTextColor(parent->textColor()),
  15181. mSelectedFont(parent->selectedFont()),
  15182. mSelectedTextColor(parent->selectedTextColor()),
  15183. mSelectable(true),
  15184. mSelected(false)
  15185. {
  15186. setLayer("legend");
  15187. setMargins(QMargins(8, 2, 8, 2));
  15188. }
  15189. /*!
  15190. Sets the default font of this specific legend item to \a font.
  15191. \see setTextColor, QCPLegend::setFont
  15192. */
  15193. void QCPAbstractLegendItem::setFont(const QFont &font)
  15194. {
  15195. mFont = font;
  15196. }
  15197. /*!
  15198. Sets the default text color of this specific legend item to \a color.
  15199. \see setFont, QCPLegend::setTextColor
  15200. */
  15201. void QCPAbstractLegendItem::setTextColor(const QColor &color)
  15202. {
  15203. mTextColor = color;
  15204. }
  15205. /*!
  15206. When this legend item is selected, \a font is used to draw generic text, instead of the normal
  15207. font set with \ref setFont.
  15208. \see setFont, QCPLegend::setSelectedFont
  15209. */
  15210. void QCPAbstractLegendItem::setSelectedFont(const QFont &font)
  15211. {
  15212. mSelectedFont = font;
  15213. }
  15214. /*!
  15215. When this legend item is selected, \a color is used to draw generic text, instead of the normal
  15216. color set with \ref setTextColor.
  15217. \see setTextColor, QCPLegend::setSelectedTextColor
  15218. */
  15219. void QCPAbstractLegendItem::setSelectedTextColor(const QColor &color)
  15220. {
  15221. mSelectedTextColor = color;
  15222. }
  15223. /*!
  15224. Sets whether this specific legend item is selectable.
  15225. \see setSelectedParts, QCustomPlot::setInteractions
  15226. */
  15227. void QCPAbstractLegendItem::setSelectable(bool selectable)
  15228. {
  15229. mSelectable = selectable;
  15230. }
  15231. /*!
  15232. Sets whether this specific legend item is selected.
  15233. It is possible to set the selection state of this item by calling this function directly, even if
  15234. setSelectable is set to false.
  15235. \see setSelectableParts, QCustomPlot::setInteractions
  15236. */
  15237. void QCPAbstractLegendItem::setSelected(bool selected)
  15238. {
  15239. if (mSelected != selected)
  15240. {
  15241. mSelected = selected;
  15242. emit selectionChanged(mSelected);
  15243. }
  15244. }
  15245. /* inherits documentation from base class */
  15246. double QCPAbstractLegendItem::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  15247. {
  15248. Q_UNUSED(details)
  15249. if (!mParentPlot) return -1;
  15250. if (onlySelectable && (!mSelectable || !mParentLegend->selectableParts().testFlag(QCPLegend::spItems)))
  15251. return -1;
  15252. if (mRect.contains(pos.toPoint()))
  15253. return mParentPlot->selectionTolerance()*0.99;
  15254. else
  15255. return -1;
  15256. }
  15257. /* inherits documentation from base class */
  15258. void QCPAbstractLegendItem::applyDefaultAntialiasingHint(QCPPainter *painter) const
  15259. {
  15260. applyAntialiasingHint(painter, mAntialiased, QCP::aeLegendItems);
  15261. }
  15262. /* inherits documentation from base class */
  15263. QRect QCPAbstractLegendItem::clipRect() const
  15264. {
  15265. return mOuterRect;
  15266. }
  15267. /* inherits documentation from base class */
  15268. void QCPAbstractLegendItem::selectEvent(QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged)
  15269. {
  15270. Q_UNUSED(event)
  15271. Q_UNUSED(details)
  15272. if (mSelectable && mParentLegend->selectableParts().testFlag(QCPLegend::spItems))
  15273. {
  15274. bool selBefore = mSelected;
  15275. setSelected(additive ? !mSelected : true);
  15276. if (selectionStateChanged)
  15277. *selectionStateChanged = mSelected != selBefore;
  15278. }
  15279. }
  15280. /* inherits documentation from base class */
  15281. void QCPAbstractLegendItem::deselectEvent(bool *selectionStateChanged)
  15282. {
  15283. if (mSelectable && mParentLegend->selectableParts().testFlag(QCPLegend::spItems))
  15284. {
  15285. bool selBefore = mSelected;
  15286. setSelected(false);
  15287. if (selectionStateChanged)
  15288. *selectionStateChanged = mSelected != selBefore;
  15289. }
  15290. }
  15291. ////////////////////////////////////////////////////////////////////////////////////////////////////
  15292. //////////////////// QCPPlottableLegendItem
  15293. ////////////////////////////////////////////////////////////////////////////////////////////////////
  15294. /*! \class QCPPlottableLegendItem
  15295. \brief A legend item representing a plottable with an icon and the plottable name.
  15296. This is the standard legend item for plottables. It displays an icon of the plottable next to the
  15297. plottable name. The icon is drawn by the respective plottable itself (\ref
  15298. QCPAbstractPlottable::drawLegendIcon), and tries to give an intuitive symbol for the plottable.
  15299. For example, the QCPGraph draws a centered horizontal line and/or a single scatter point in the
  15300. middle.
  15301. Legend items of this type are always associated with one plottable (retrievable via the
  15302. plottable() function and settable with the constructor). You may change the font of the plottable
  15303. name with \ref setFont. Icon padding and border pen is taken from the parent QCPLegend, see \ref
  15304. QCPLegend::setIconBorderPen and \ref QCPLegend::setIconTextPadding.
  15305. The function \ref QCPAbstractPlottable::addToLegend/\ref QCPAbstractPlottable::removeFromLegend
  15306. creates/removes legend items of this type in the default implementation. However, these functions
  15307. may be reimplemented such that a different kind of legend item (e.g a direct subclass of
  15308. QCPAbstractLegendItem) is used for that plottable.
  15309. Since QCPLegend is based on QCPLayoutGrid, a legend item itself is just a subclass of
  15310. QCPLayoutElement. While it could be added to a legend (or any other layout) via the normal layout
  15311. interface, QCPLegend has specialized functions for handling legend items conveniently, see the
  15312. documentation of \ref QCPLegend.
  15313. */
  15314. /*!
  15315. Creates a new legend item associated with \a plottable.
  15316. Once it's created, it can be added to the legend via \ref QCPLegend::addItem.
  15317. A more convenient way of adding/removing a plottable to/from the legend is via the functions \ref
  15318. QCPAbstractPlottable::addToLegend and \ref QCPAbstractPlottable::removeFromLegend.
  15319. */
  15320. QCPPlottableLegendItem::QCPPlottableLegendItem(QCPLegend *parent, QCPAbstractPlottable *plottable) :
  15321. QCPAbstractLegendItem(parent),
  15322. mPlottable(plottable)
  15323. {
  15324. }
  15325. /*! \internal
  15326. Returns the pen that shall be used to draw the icon border, taking into account the selection
  15327. state of this item.
  15328. */
  15329. QPen QCPPlottableLegendItem::getIconBorderPen() const
  15330. {
  15331. return mSelected ? mParentLegend->selectedIconBorderPen() : mParentLegend->iconBorderPen();
  15332. }
  15333. /*! \internal
  15334. Returns the text color that shall be used to draw text, taking into account the selection state
  15335. of this item.
  15336. */
  15337. QColor QCPPlottableLegendItem::getTextColor() const
  15338. {
  15339. return mSelected ? mSelectedTextColor : mTextColor;
  15340. }
  15341. /*! \internal
  15342. Returns the font that shall be used to draw text, taking into account the selection state of this
  15343. item.
  15344. */
  15345. QFont QCPPlottableLegendItem::getFont() const
  15346. {
  15347. return mSelected ? mSelectedFont : mFont;
  15348. }
  15349. /*! \internal
  15350. Draws the item with \a painter. The size and position of the drawn legend item is defined by the
  15351. parent layout (typically a \ref QCPLegend) and the \ref minimumSizeHint and \ref maximumSizeHint
  15352. of this legend item.
  15353. */
  15354. void QCPPlottableLegendItem::draw(QCPPainter *painter)
  15355. {
  15356. if (!mPlottable) return;
  15357. painter->setFont(getFont());
  15358. painter->setPen(QPen(getTextColor()));
  15359. QSizeF iconSize = mParentLegend->iconSize();
  15360. QRectF textRect = painter->fontMetrics().boundingRect(0, 0, 0, iconSize.height(), Qt::TextDontClip, mPlottable->name());
  15361. QRectF iconRect(mRect.topLeft(), iconSize);
  15362. int textHeight = qMax(textRect.height(), iconSize.height()); // if text has smaller height than icon, center text vertically in icon height, else align tops
  15363. painter->drawText(mRect.x()+iconSize.width()+mParentLegend->iconTextPadding(), mRect.y(), textRect.width(), textHeight, Qt::TextDontClip, mPlottable->name());
  15364. // draw icon:
  15365. painter->save();
  15366. painter->setClipRect(iconRect, Qt::IntersectClip);
  15367. mPlottable->drawLegendIcon(painter, iconRect);
  15368. painter->restore();
  15369. // draw icon border:
  15370. if (getIconBorderPen().style() != Qt::NoPen)
  15371. {
  15372. painter->setPen(getIconBorderPen());
  15373. painter->setBrush(Qt::NoBrush);
  15374. painter->drawRect(iconRect);
  15375. }
  15376. }
  15377. /*! \internal
  15378. Calculates and returns the size of this item. This includes the icon, the text and the padding in
  15379. between.
  15380. */
  15381. QSize QCPPlottableLegendItem::minimumSizeHint() const
  15382. {
  15383. if (!mPlottable) return QSize();
  15384. QSize result(0, 0);
  15385. QRect textRect;
  15386. QFontMetrics fontMetrics(getFont());
  15387. QSize iconSize = mParentLegend->iconSize();
  15388. textRect = fontMetrics.boundingRect(0, 0, 0, iconSize.height(), Qt::TextDontClip, mPlottable->name());
  15389. result.setWidth(iconSize.width() + mParentLegend->iconTextPadding() + textRect.width() + mMargins.left() + mMargins.right());
  15390. result.setHeight(qMax(textRect.height(), iconSize.height()) + mMargins.top() + mMargins.bottom());
  15391. return result;
  15392. }
  15393. ////////////////////////////////////////////////////////////////////////////////////////////////////
  15394. //////////////////// QCPLegend
  15395. ////////////////////////////////////////////////////////////////////////////////////////////////////
  15396. /*! \class QCPLegend
  15397. \brief Manages a legend inside a QCustomPlot.
  15398. A legend is a small box somewhere in the plot which lists plottables with their name and icon.
  15399. Normally, the legend is populated by calling \ref QCPAbstractPlottable::addToLegend. The
  15400. respective legend item can be removed with \ref QCPAbstractPlottable::removeFromLegend. However,
  15401. QCPLegend also offers an interface to add and manipulate legend items directly: \ref item, \ref
  15402. itemWithPlottable, \ref itemCount, \ref addItem, \ref removeItem, etc.
  15403. The QCPLegend derives from QCPLayoutGrid and as such can be placed in any position a
  15404. QCPLayoutElement may be positioned. The legend items are themselves QCPLayoutElements which are
  15405. placed in the grid layout of the legend. QCPLegend only adds an interface specialized for
  15406. handling child elements of type QCPAbstractLegendItem, as mentioned above. In principle, any
  15407. other layout elements may also be added to a legend via the normal \ref QCPLayoutGrid interface.
  15408. However, the QCPAbstractLegendItem-Interface will ignore those elements (e.g. \ref itemCount will
  15409. only return the number of items with QCPAbstractLegendItems type).
  15410. By default, every QCustomPlot has one legend (QCustomPlot::legend) which is placed in the inset
  15411. layout of the main axis rect (\ref QCPAxisRect::insetLayout). To move the legend to another
  15412. position inside the axis rect, use the methods of the \ref QCPLayoutInset. To move the legend
  15413. outside of the axis rect, place it anywhere else with the QCPLayout/QCPLayoutElement interface.
  15414. */
  15415. /* start of documentation of signals */
  15416. /*! \fn void QCPLegend::selectionChanged(QCPLegend::SelectableParts selection);
  15417. This signal is emitted when the selection state of this legend has changed.
  15418. \see setSelectedParts, setSelectableParts
  15419. */
  15420. /* end of documentation of signals */
  15421. /*!
  15422. Constructs a new QCPLegend instance with \a parentPlot as the containing plot and default values.
  15423. Note that by default, QCustomPlot already contains a legend ready to be used as
  15424. QCustomPlot::legend
  15425. */
  15426. QCPLegend::QCPLegend()
  15427. {
  15428. setRowSpacing(0);
  15429. setColumnSpacing(10);
  15430. setMargins(QMargins(2, 3, 2, 2));
  15431. setAntialiased(false);
  15432. setIconSize(32, 18);
  15433. setIconTextPadding(7);
  15434. setSelectableParts(spLegendBox | spItems);
  15435. setSelectedParts(spNone);
  15436. setBorderPen(QPen(Qt::black));
  15437. setSelectedBorderPen(QPen(Qt::blue, 2));
  15438. setIconBorderPen(Qt::NoPen);
  15439. setSelectedIconBorderPen(QPen(Qt::blue, 2));
  15440. setBrush(Qt::white);
  15441. setSelectedBrush(Qt::white);
  15442. setTextColor(Qt::black);
  15443. setSelectedTextColor(Qt::blue);
  15444. }
  15445. QCPLegend::~QCPLegend()
  15446. {
  15447. clearItems();
  15448. if (mParentPlot)
  15449. mParentPlot->legendRemoved(this);
  15450. }
  15451. /* no doc for getter, see setSelectedParts */
  15452. QCPLegend::SelectableParts QCPLegend::selectedParts() const
  15453. {
  15454. // check whether any legend elements selected, if yes, add spItems to return value
  15455. bool hasSelectedItems = false;
  15456. for (int i=0; i<itemCount(); ++i)
  15457. {
  15458. if (item(i) && item(i)->selected())
  15459. {
  15460. hasSelectedItems = true;
  15461. break;
  15462. }
  15463. }
  15464. if (hasSelectedItems)
  15465. return mSelectedParts | spItems;
  15466. else
  15467. return mSelectedParts & ~spItems;
  15468. }
  15469. /*!
  15470. Sets the pen, the border of the entire legend is drawn with.
  15471. */
  15472. void QCPLegend::setBorderPen(const QPen &pen)
  15473. {
  15474. mBorderPen = pen;
  15475. }
  15476. /*!
  15477. Sets the brush of the legend background.
  15478. */
  15479. void QCPLegend::setBrush(const QBrush &brush)
  15480. {
  15481. mBrush = brush;
  15482. }
  15483. /*!
  15484. Sets the default font of legend text. Legend items that draw text (e.g. the name of a graph) will
  15485. use this font by default. However, a different font can be specified on a per-item-basis by
  15486. accessing the specific legend item.
  15487. This function will also set \a font on all already existing legend items.
  15488. \see QCPAbstractLegendItem::setFont
  15489. */
  15490. void QCPLegend::setFont(const QFont &font)
  15491. {
  15492. mFont = font;
  15493. for (int i=0; i<itemCount(); ++i)
  15494. {
  15495. if (item(i))
  15496. item(i)->setFont(mFont);
  15497. }
  15498. }
  15499. /*!
  15500. Sets the default color of legend text. Legend items that draw text (e.g. the name of a graph)
  15501. will use this color by default. However, a different colors can be specified on a per-item-basis
  15502. by accessing the specific legend item.
  15503. This function will also set \a color on all already existing legend items.
  15504. \see QCPAbstractLegendItem::setTextColor
  15505. */
  15506. void QCPLegend::setTextColor(const QColor &color)
  15507. {
  15508. mTextColor = color;
  15509. for (int i=0; i<itemCount(); ++i)
  15510. {
  15511. if (item(i))
  15512. item(i)->setTextColor(color);
  15513. }
  15514. }
  15515. /*!
  15516. Sets the size of legend icons. Legend items that draw an icon (e.g. a visual
  15517. representation of the graph) will use this size by default.
  15518. */
  15519. void QCPLegend::setIconSize(const QSize &size)
  15520. {
  15521. mIconSize = size;
  15522. }
  15523. /*! \overload
  15524. */
  15525. void QCPLegend::setIconSize(int width, int height)
  15526. {
  15527. mIconSize.setWidth(width);
  15528. mIconSize.setHeight(height);
  15529. }
  15530. /*!
  15531. Sets the horizontal space in pixels between the legend icon and the text next to it.
  15532. Legend items that draw an icon (e.g. a visual representation of the graph) and text (e.g. the
  15533. name of the graph) will use this space by default.
  15534. */
  15535. void QCPLegend::setIconTextPadding(int padding)
  15536. {
  15537. mIconTextPadding = padding;
  15538. }
  15539. /*!
  15540. Sets the pen used to draw a border around each legend icon. Legend items that draw an
  15541. icon (e.g. a visual representation of the graph) will use this pen by default.
  15542. If no border is wanted, set this to \a Qt::NoPen.
  15543. */
  15544. void QCPLegend::setIconBorderPen(const QPen &pen)
  15545. {
  15546. mIconBorderPen = pen;
  15547. }
  15548. /*!
  15549. Sets whether the user can (de-)select the parts in \a selectable by clicking on the QCustomPlot surface.
  15550. (When \ref QCustomPlot::setInteractions contains iSelectLegend.)
  15551. However, even when \a selectable is set to a value not allowing the selection of a specific part,
  15552. it is still possible to set the selection of this part manually, by calling \ref setSelectedParts
  15553. directly.
  15554. \see SelectablePart, setSelectedParts
  15555. */
  15556. void QCPLegend::setSelectableParts(const SelectableParts &selectable)
  15557. {
  15558. mSelectableParts = selectable;
  15559. }
  15560. /*!
  15561. Sets the selected state of the respective legend parts described by \ref SelectablePart. When a part
  15562. is selected, it uses a different pen/font and brush. If some legend items are selected and \a selected
  15563. doesn't contain \ref spItems, those items become deselected.
  15564. The entire selection mechanism is handled automatically when \ref QCustomPlot::setInteractions
  15565. contains iSelectLegend. You only need to call this function when you wish to change the selection
  15566. state manually.
  15567. This function can change the selection state of a part even when \ref setSelectableParts was set to a
  15568. value that actually excludes the part.
  15569. emits the \ref selectionChanged signal when \a selected is different from the previous selection state.
  15570. Note that it doesn't make sense to set the selected state \ref spItems here when it wasn't set
  15571. before, because there's no way to specify which exact items to newly select. Do this by calling
  15572. \ref QCPAbstractLegendItem::setSelected directly on the legend item you wish to select.
  15573. \see SelectablePart, setSelectableParts, selectTest, setSelectedBorderPen, setSelectedIconBorderPen, setSelectedBrush,
  15574. setSelectedFont
  15575. */
  15576. void QCPLegend::setSelectedParts(const SelectableParts &selected)
  15577. {
  15578. SelectableParts newSelected = selected;
  15579. mSelectedParts = this->selectedParts(); // update mSelectedParts in case item selection changed
  15580. if (mSelectedParts != newSelected)
  15581. {
  15582. if (!mSelectedParts.testFlag(spItems) && newSelected.testFlag(spItems)) // attempt to set spItems flag (can't do that)
  15583. {
  15584. qDebug() << Q_FUNC_INFO << "spItems flag can not be set, it can only be unset with this function";
  15585. newSelected &= ~spItems;
  15586. }
  15587. if (mSelectedParts.testFlag(spItems) && !newSelected.testFlag(spItems)) // spItems flag was unset, so clear item selection
  15588. {
  15589. for (int i=0; i<itemCount(); ++i)
  15590. {
  15591. if (item(i))
  15592. item(i)->setSelected(false);
  15593. }
  15594. }
  15595. mSelectedParts = newSelected;
  15596. emit selectionChanged(mSelectedParts);
  15597. }
  15598. }
  15599. /*!
  15600. When the legend box is selected, this pen is used to draw the border instead of the normal pen
  15601. set via \ref setBorderPen.
  15602. \see setSelectedParts, setSelectableParts, setSelectedBrush
  15603. */
  15604. void QCPLegend::setSelectedBorderPen(const QPen &pen)
  15605. {
  15606. mSelectedBorderPen = pen;
  15607. }
  15608. /*!
  15609. Sets the pen legend items will use to draw their icon borders, when they are selected.
  15610. \see setSelectedParts, setSelectableParts, setSelectedFont
  15611. */
  15612. void QCPLegend::setSelectedIconBorderPen(const QPen &pen)
  15613. {
  15614. mSelectedIconBorderPen = pen;
  15615. }
  15616. /*!
  15617. When the legend box is selected, this brush is used to draw the legend background instead of the normal brush
  15618. set via \ref setBrush.
  15619. \see setSelectedParts, setSelectableParts, setSelectedBorderPen
  15620. */
  15621. void QCPLegend::setSelectedBrush(const QBrush &brush)
  15622. {
  15623. mSelectedBrush = brush;
  15624. }
  15625. /*!
  15626. Sets the default font that is used by legend items when they are selected.
  15627. This function will also set \a font on all already existing legend items.
  15628. \see setFont, QCPAbstractLegendItem::setSelectedFont
  15629. */
  15630. void QCPLegend::setSelectedFont(const QFont &font)
  15631. {
  15632. mSelectedFont = font;
  15633. for (int i=0; i<itemCount(); ++i)
  15634. {
  15635. if (item(i))
  15636. item(i)->setSelectedFont(font);
  15637. }
  15638. }
  15639. /*!
  15640. Sets the default text color that is used by legend items when they are selected.
  15641. This function will also set \a color on all already existing legend items.
  15642. \see setTextColor, QCPAbstractLegendItem::setSelectedTextColor
  15643. */
  15644. void QCPLegend::setSelectedTextColor(const QColor &color)
  15645. {
  15646. mSelectedTextColor = color;
  15647. for (int i=0; i<itemCount(); ++i)
  15648. {
  15649. if (item(i))
  15650. item(i)->setSelectedTextColor(color);
  15651. }
  15652. }
  15653. /*!
  15654. Returns the item with index \a i.
  15655. \see itemCount
  15656. */
  15657. QCPAbstractLegendItem *QCPLegend::item(int index) const
  15658. {
  15659. return qobject_cast<QCPAbstractLegendItem*>(elementAt(index));
  15660. }
  15661. /*!
  15662. Returns the QCPPlottableLegendItem which is associated with \a plottable (e.g. a \ref QCPGraph*).
  15663. If such an item isn't in the legend, returns 0.
  15664. \see hasItemWithPlottable
  15665. */
  15666. QCPPlottableLegendItem *QCPLegend::itemWithPlottable(const QCPAbstractPlottable *plottable) const
  15667. {
  15668. for (int i=0; i<itemCount(); ++i)
  15669. {
  15670. if (QCPPlottableLegendItem *pli = qobject_cast<QCPPlottableLegendItem*>(item(i)))
  15671. {
  15672. if (pli->plottable() == plottable)
  15673. return pli;
  15674. }
  15675. }
  15676. return 0;
  15677. }
  15678. /*!
  15679. Returns the number of items currently in the legend.
  15680. \see item
  15681. */
  15682. int QCPLegend::itemCount() const
  15683. {
  15684. return elementCount();
  15685. }
  15686. /*!
  15687. Returns whether the legend contains \a itm.
  15688. */
  15689. bool QCPLegend::hasItem(QCPAbstractLegendItem *item) const
  15690. {
  15691. for (int i=0; i<itemCount(); ++i)
  15692. {
  15693. if (item == this->item(i))
  15694. return true;
  15695. }
  15696. return false;
  15697. }
  15698. /*!
  15699. Returns whether the legend contains a QCPPlottableLegendItem which is associated with \a plottable (e.g. a \ref QCPGraph*).
  15700. If such an item isn't in the legend, returns false.
  15701. \see itemWithPlottable
  15702. */
  15703. bool QCPLegend::hasItemWithPlottable(const QCPAbstractPlottable *plottable) const
  15704. {
  15705. return itemWithPlottable(plottable);
  15706. }
  15707. /*!
  15708. Adds \a item to the legend, if it's not present already.
  15709. Returns true on sucess, i.e. if the item wasn't in the list already and has been successfuly added.
  15710. The legend takes ownership of the item.
  15711. */
  15712. bool QCPLegend::addItem(QCPAbstractLegendItem *item)
  15713. {
  15714. if (!hasItem(item))
  15715. {
  15716. return addElement(rowCount(), 0, item);
  15717. } else
  15718. return false;
  15719. }
  15720. /*!
  15721. Removes the item with index \a index from the legend.
  15722. Returns true, if successful.
  15723. \see itemCount, clearItems
  15724. */
  15725. bool QCPLegend::removeItem(int index)
  15726. {
  15727. if (QCPAbstractLegendItem *ali = item(index))
  15728. {
  15729. bool success = remove(ali);
  15730. simplify();
  15731. return success;
  15732. } else
  15733. return false;
  15734. }
  15735. /*! \overload
  15736. Removes \a item from the legend.
  15737. Returns true, if successful.
  15738. \see clearItems
  15739. */
  15740. bool QCPLegend::removeItem(QCPAbstractLegendItem *item)
  15741. {
  15742. bool success = remove(item);
  15743. simplify();
  15744. return success;
  15745. }
  15746. /*!
  15747. Removes all items from the legend.
  15748. */
  15749. void QCPLegend::clearItems()
  15750. {
  15751. for (int i=itemCount()-1; i>=0; --i)
  15752. removeItem(i);
  15753. }
  15754. /*!
  15755. Returns the legend items that are currently selected. If no items are selected,
  15756. the list is empty.
  15757. \see QCPAbstractLegendItem::setSelected, setSelectable
  15758. */
  15759. QList<QCPAbstractLegendItem *> QCPLegend::selectedItems() const
  15760. {
  15761. QList<QCPAbstractLegendItem*> result;
  15762. for (int i=0; i<itemCount(); ++i)
  15763. {
  15764. if (QCPAbstractLegendItem *ali = item(i))
  15765. {
  15766. if (ali->selected())
  15767. result.append(ali);
  15768. }
  15769. }
  15770. return result;
  15771. }
  15772. /*! \internal
  15773. A convenience function to easily set the QPainter::Antialiased hint on the provided \a painter
  15774. before drawing main legend elements.
  15775. This is the antialiasing state the painter passed to the \ref draw method is in by default.
  15776. This function takes into account the local setting of the antialiasing flag as well as the
  15777. overrides set with \ref QCustomPlot::setAntialiasedElements and \ref
  15778. QCustomPlot::setNotAntialiasedElements.
  15779. \see setAntialiased
  15780. */
  15781. void QCPLegend::applyDefaultAntialiasingHint(QCPPainter *painter) const
  15782. {
  15783. applyAntialiasingHint(painter, mAntialiased, QCP::aeLegend);
  15784. }
  15785. /*! \internal
  15786. Returns the pen used to paint the border of the legend, taking into account the selection state
  15787. of the legend box.
  15788. */
  15789. QPen QCPLegend::getBorderPen() const
  15790. {
  15791. return mSelectedParts.testFlag(spLegendBox) ? mSelectedBorderPen : mBorderPen;
  15792. }
  15793. /*! \internal
  15794. Returns the brush used to paint the background of the legend, taking into account the selection
  15795. state of the legend box.
  15796. */
  15797. QBrush QCPLegend::getBrush() const
  15798. {
  15799. return mSelectedParts.testFlag(spLegendBox) ? mSelectedBrush : mBrush;
  15800. }
  15801. /*! \internal
  15802. Draws the legend box with the provided \a painter. The individual legend items are layerables
  15803. themselves, thus are drawn independently.
  15804. */
  15805. void QCPLegend::draw(QCPPainter *painter)
  15806. {
  15807. // draw background rect:
  15808. painter->setBrush(getBrush());
  15809. painter->setPen(getBorderPen());
  15810. painter->drawRect(mOuterRect);
  15811. }
  15812. /* inherits documentation from base class */
  15813. double QCPLegend::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  15814. {
  15815. if (!mParentPlot) return -1;
  15816. if (onlySelectable && !mSelectableParts.testFlag(spLegendBox))
  15817. return -1;
  15818. if (mOuterRect.contains(pos.toPoint()))
  15819. {
  15820. if (details) details->setValue(spLegendBox);
  15821. return mParentPlot->selectionTolerance()*0.99;
  15822. }
  15823. return -1;
  15824. }
  15825. /* inherits documentation from base class */
  15826. void QCPLegend::selectEvent(QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged)
  15827. {
  15828. Q_UNUSED(event)
  15829. mSelectedParts = selectedParts(); // in case item selection has changed
  15830. if (details.value<SelectablePart>() == spLegendBox && mSelectableParts.testFlag(spLegendBox))
  15831. {
  15832. SelectableParts selBefore = mSelectedParts;
  15833. setSelectedParts(additive ? mSelectedParts^spLegendBox : mSelectedParts|spLegendBox); // no need to unset spItems in !additive case, because they will be deselected by QCustomPlot (they're normal QCPLayerables with own deselectEvent)
  15834. if (selectionStateChanged)
  15835. *selectionStateChanged = mSelectedParts != selBefore;
  15836. }
  15837. }
  15838. /* inherits documentation from base class */
  15839. void QCPLegend::deselectEvent(bool *selectionStateChanged)
  15840. {
  15841. mSelectedParts = selectedParts(); // in case item selection has changed
  15842. if (mSelectableParts.testFlag(spLegendBox))
  15843. {
  15844. SelectableParts selBefore = mSelectedParts;
  15845. setSelectedParts(selectedParts() & ~spLegendBox);
  15846. if (selectionStateChanged)
  15847. *selectionStateChanged = mSelectedParts != selBefore;
  15848. }
  15849. }
  15850. /* inherits documentation from base class */
  15851. QCP::Interaction QCPLegend::selectionCategory() const
  15852. {
  15853. return QCP::iSelectLegend;
  15854. }
  15855. /* inherits documentation from base class */
  15856. QCP::Interaction QCPAbstractLegendItem::selectionCategory() const
  15857. {
  15858. return QCP::iSelectLegend;
  15859. }
  15860. /* inherits documentation from base class */
  15861. void QCPLegend::parentPlotInitialized(QCustomPlot *parentPlot)
  15862. {
  15863. Q_UNUSED(parentPlot)
  15864. }
  15865. ////////////////////////////////////////////////////////////////////////////////////////////////////
  15866. //////////////////// QCPPlotTitle
  15867. ////////////////////////////////////////////////////////////////////////////////////////////////////
  15868. /*! \class QCPPlotTitle
  15869. \brief A layout element displaying a plot title text
  15870. The text may be specified with \ref setText, theformatting can be controlled with \ref setFont
  15871. and \ref setTextColor.
  15872. A plot title can be added as follows:
  15873. \code
  15874. customPlot->plotLayout()->insertRow(0); // inserts an empty row above the default axis rect
  15875. customPlot->plotLayout()->addElement(0, 0, new QCPPlotTitle(customPlot, "Your Plot Title"));
  15876. \endcode
  15877. Since a plot title is a common requirement, QCustomPlot offers specialized selection signals for
  15878. easy interaction with QCPPlotTitle. If a layout element of type QCPPlotTitle is clicked, the
  15879. signal \ref QCustomPlot::titleClick is emitted. A double click emits the \ref
  15880. QCustomPlot::titleDoubleClick signal.
  15881. */
  15882. /* start documentation of signals */
  15883. /*! \fn void QCPPlotTitle::selectionChanged(bool selected)
  15884. This signal is emitted when the selection state has changed to \a selected, either by user
  15885. interaction or by a direct call to \ref setSelected.
  15886. \see setSelected, setSelectable
  15887. */
  15888. /* end documentation of signals */
  15889. /*!
  15890. Creates a new QCPPlotTitle instance and sets default values. The initial text is empty (\ref setText).
  15891. To set the title text in the constructor, rather use \ref QCPPlotTitle(QCustomPlot *parentPlot, const QString &text).
  15892. */
  15893. QCPPlotTitle::QCPPlotTitle(QCustomPlot *parentPlot) :
  15894. QCPLayoutElement(parentPlot),
  15895. mFont(QFont("sans serif", 13*1.5, QFont::Bold)),
  15896. mTextColor(Qt::black),
  15897. mSelectedFont(QFont("sans serif", 13*1.6, QFont::Bold)),
  15898. mSelectedTextColor(Qt::blue),
  15899. mSelectable(false),
  15900. mSelected(false)
  15901. {
  15902. if (parentPlot)
  15903. {
  15904. setLayer(parentPlot->currentLayer());
  15905. mFont = QFont(parentPlot->font().family(), parentPlot->font().pointSize()*1.5, QFont::Bold);
  15906. mSelectedFont = QFont(parentPlot->font().family(), parentPlot->font().pointSize()*1.6, QFont::Bold);
  15907. }
  15908. setMargins(QMargins(5, 5, 5, 0));
  15909. }
  15910. /*! \overload
  15911. Creates a new QCPPlotTitle instance and sets default values. The initial text is set to \a text.
  15912. */
  15913. QCPPlotTitle::QCPPlotTitle(QCustomPlot *parentPlot, const QString &text) :
  15914. QCPLayoutElement(parentPlot),
  15915. mText(text),
  15916. mFont(QFont(parentPlot->font().family(), parentPlot->font().pointSize()*1.5, QFont::Bold)),
  15917. mTextColor(Qt::black),
  15918. mSelectedFont(QFont(parentPlot->font().family(), parentPlot->font().pointSize()*1.6, QFont::Bold)),
  15919. mSelectedTextColor(Qt::blue),
  15920. mSelectable(false),
  15921. mSelected(false)
  15922. {
  15923. setLayer("axes");
  15924. setMargins(QMargins(5, 5, 5, 0));
  15925. }
  15926. /*!
  15927. Sets the text that will be displayed to \a text. Multiple lines can be created by insertion of "\n".
  15928. \see setFont, setTextColor
  15929. */
  15930. void QCPPlotTitle::setText(const QString &text)
  15931. {
  15932. mText = text;
  15933. }
  15934. /*!
  15935. Sets the \a font of the title text.
  15936. \see setTextColor, setSelectedFont
  15937. */
  15938. void QCPPlotTitle::setFont(const QFont &font)
  15939. {
  15940. mFont = font;
  15941. }
  15942. /*!
  15943. Sets the \a color of the title text.
  15944. \see setFont, setSelectedTextColor
  15945. */
  15946. void QCPPlotTitle::setTextColor(const QColor &color)
  15947. {
  15948. mTextColor = color;
  15949. }
  15950. /*!
  15951. Sets the \a font of the title text that will be used if the plot title is selected (\ref setSelected).
  15952. \see setFont
  15953. */
  15954. void QCPPlotTitle::setSelectedFont(const QFont &font)
  15955. {
  15956. mSelectedFont = font;
  15957. }
  15958. /*!
  15959. Sets the \a color of the title text that will be used if the plot title is selected (\ref setSelected).
  15960. \see setTextColor
  15961. */
  15962. void QCPPlotTitle::setSelectedTextColor(const QColor &color)
  15963. {
  15964. mSelectedTextColor = color;
  15965. }
  15966. /*!
  15967. Sets whether the user may select this plot title to \a selectable.
  15968. Note that even when \a selectable is set to <tt>false</tt>, the selection state may be changed
  15969. programmatically via \ref setSelected.
  15970. */
  15971. void QCPPlotTitle::setSelectable(bool selectable)
  15972. {
  15973. mSelectable = selectable;
  15974. }
  15975. /*!
  15976. Sets the selection state of this plot title to \a selected. If the selection has changed, \ref
  15977. selectionChanged is emitted.
  15978. Note that this function can change the selection state independently of the current \ref
  15979. setSelectable state.
  15980. */
  15981. void QCPPlotTitle::setSelected(bool selected)
  15982. {
  15983. if (mSelected != selected)
  15984. {
  15985. mSelected = selected;
  15986. emit selectionChanged(mSelected);
  15987. }
  15988. }
  15989. /* inherits documentation from base class */
  15990. void QCPPlotTitle::applyDefaultAntialiasingHint(QCPPainter *painter) const
  15991. {
  15992. applyAntialiasingHint(painter, mAntialiased, QCP::aeNone);
  15993. }
  15994. /* inherits documentation from base class */
  15995. void QCPPlotTitle::draw(QCPPainter *painter)
  15996. {
  15997. painter->setFont(mainFont());
  15998. painter->setPen(QPen(mainTextColor()));
  15999. painter->drawText(mRect, Qt::AlignCenter, mText, &mTextBoundingRect);
  16000. }
  16001. /* inherits documentation from base class */
  16002. QSize QCPPlotTitle::minimumSizeHint() const
  16003. {
  16004. QFontMetrics metrics(mFont);
  16005. QSize result = metrics.boundingRect(0, 0, 0, 0, Qt::AlignCenter, mText).size();
  16006. result.rwidth() += mMargins.left() + mMargins.right();
  16007. result.rheight() += mMargins.top() + mMargins.bottom();
  16008. return result;
  16009. }
  16010. /* inherits documentation from base class */
  16011. QSize QCPPlotTitle::maximumSizeHint() const
  16012. {
  16013. QFontMetrics metrics(mFont);
  16014. QSize result = metrics.boundingRect(0, 0, 0, 0, Qt::AlignCenter, mText).size();
  16015. result.rheight() += mMargins.top() + mMargins.bottom();
  16016. result.setWidth(QWIDGETSIZE_MAX);
  16017. return result;
  16018. }
  16019. /* inherits documentation from base class */
  16020. void QCPPlotTitle::selectEvent(QMouseEvent *event, bool additive, const QVariant &details, bool *selectionStateChanged)
  16021. {
  16022. Q_UNUSED(event)
  16023. Q_UNUSED(details)
  16024. if (mSelectable)
  16025. {
  16026. bool selBefore = mSelected;
  16027. setSelected(additive ? !mSelected : true);
  16028. if (selectionStateChanged)
  16029. *selectionStateChanged = mSelected != selBefore;
  16030. }
  16031. }
  16032. /* inherits documentation from base class */
  16033. void QCPPlotTitle::deselectEvent(bool *selectionStateChanged)
  16034. {
  16035. if (mSelectable)
  16036. {
  16037. bool selBefore = mSelected;
  16038. setSelected(false);
  16039. if (selectionStateChanged)
  16040. *selectionStateChanged = mSelected != selBefore;
  16041. }
  16042. }
  16043. /* inherits documentation from base class */
  16044. double QCPPlotTitle::selectTest(const QPointF &pos, bool onlySelectable, QVariant *details) const
  16045. {
  16046. Q_UNUSED(details)
  16047. if (onlySelectable && !mSelectable)
  16048. return -1;
  16049. if (mTextBoundingRect.contains(pos.toPoint()))
  16050. return mParentPlot->selectionTolerance()*0.99;
  16051. else
  16052. return -1;
  16053. }
  16054. /*! \internal
  16055. Returns the main font to be used. This is mSelectedFont if \ref setSelected is set to
  16056. <tt>true</tt>, else mFont is returned.
  16057. */
  16058. QFont QCPPlotTitle::mainFont() const
  16059. {
  16060. return mSelected ? mSelectedFont : mFont;
  16061. }
  16062. /*! \internal
  16063. Returns the main color to be used. This is mSelectedTextColor if \ref setSelected is set to
  16064. <tt>true</tt>, else mTextColor is returned.
  16065. */
  16066. QColor QCPPlotTitle::mainTextColor() const
  16067. {
  16068. return mSelected ? mSelectedTextColor : mTextColor;
  16069. }