SLCLineMetrics.h

//========================================================================================
// 
// $File$
// 
// Owner: Adobe Developer Technologies
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __SLCLineMetrics_h__
#define __SLCLineMetrics_h__

#include "Trace.h"
#include "IParcel.h"

class SLCLineMetrics
{
public:
 SLCLineMetrics(void)
 {
 SetLeading(0.0);
 SetAscent(0.0);
 SetCapHeight(0.0);
 SetXHeight(0.0);
 };

 SLCLineMetrics(const SLCLineMetrics& h)
 {
 SetLeading(h.GetLeading());
 SetAscent(h.GetAscent());
 SetCapHeight(h.GetCapHeight());
 SetXHeight(h.GetXHeight());
 };

 SLCLineMetrics& operator=(const SLCLineMetrics& h)
 {
 if (this != &h)
 {
 SetLeading(h.GetLeading());
 SetAscent(h.GetAscent());
 SetCapHeight(h.GetCapHeight());
 SetXHeight(h.GetXHeight());
 }
 return *this;
 };

 void SetLeading(const PMReal& leading)
 {
 fLineHeightMetricValues [Text::kFLOLeading] = leading;
 };

 const PMReal& GetLeading(void) const
 {
 return fLineHeightMetricValues [Text::kFLOLeading];
 };

 void SetAscent(const PMReal& ascent) 
 {
 fLineHeightMetricValues [Text::kFLOAscent] = ascent; 
 // kFLOFixedHeight note: Fudge to ensure we pass
 // in a non zero value for the top of frame height when asking for tiles.
 // FixedHeight is a property of the parcel that is not affected by the
 // metrics of the text in the parcel.
 fLineHeightMetricValues [Text::kFLOFixedHeight] = ascent; 
 };

 const PMReal& GetAscent(void) const
 {
 return fLineHeightMetricValues [Text::kFLOAscent];
 };

 void SetCapHeight(const PMReal& capHeight)
 {
 fLineHeightMetricValues [Text::kFLOCapHeight] = capHeight;
 };

 const PMReal& GetCapHeight(void) const
 {
 return fLineHeightMetricValues [Text::kFLOCapHeight];
 };

 void SetXHeight(const PMReal& xHeight)
 {
 fLineHeightMetricValues [Text::kFLOxHeight] = xHeight;
 };

 const PMReal& GetXHeight(void) const
 {
 return fLineHeightMetricValues [Text::kFLOxHeight];
 };

 const PMReal& GetValue(const Text::FirstLineOffsetMetric& metric) const 
 {
 ASSERT_MSG(metric <= Text::kFLOFixedHeight, "Invalid metric");
 if (metric <= Text::kFLOFixedHeight)
 {
 return fLineHeightMetricValues [metric]; 
 }
 return fLineHeightMetricValues [Text::kFLOLeading]; 
 };

 void Dump(const char* category, const char* msg)
 {
 TRACEFLOW(category, "%s leading %f, ascent %f, capHeight %f, xHeight %f\n",
 msg,
 ::ToDouble(GetLeading()),
 ::ToDouble(GetAscent()),
 ::ToDouble(GetCapHeight()),
 ::ToDouble(GetXHeight())
 );
 };
private:
 PMReal fLineHeightMetricValues [Text::kFLOCount];
};

#endif // __SLCLineMetrics__

// End of File SLCLineMetrics.h