PlatformLabel Class Reference

Validator platform label - no rendering, used only for compilation. More...

#include <PlatformLabel.h>

Inheritance diagram for PlatformLabel:

Public Member Functions
	PlatformLabel (const std::string &text, counted_ptr< PEBLObjectBase > font)
	PlatformLabel (PlatformLabel &label)
	This copy constructor isn't const because the font is shared.
virtual	~PlatformLabel ()
	Standard Destructor.
virtual bool	RenderText ()
virtual bool	SetProperty (std::string, Variant v)
virtual void	SetFont (counted_ptr< PEBLObjectBase > font)
virtual void	SetText (const std::string &text)
virtual bool	Draw ()
	This method initiates everything needed to display the main window
virtual counted_ptr< PEBLObjectBase >	GetFont ()
virtual std::string	ObjectName () const
	PlatformLabel (const std::string &text, counted_ptr< PEBLObjectBase > font)
	PlatformLabel (PlatformLabel &label)
virtual	~PlatformLabel ()
virtual bool	Draw ()
	This method initiates everything needed to display the main window
virtual std::string	ObjectName () const
virtual void	SetFont (counted_ptr< PEBLObjectBase > font)
virtual bool	SetProperty (std::string name, Variant v)
virtual ObjectValidationError	ValidateProperty (std::string name, Variant v) const
virtual ObjectValidationError	ValidateProperty (std::string name) const
virtual void	SetPosition (pInt x, pInt y)
	This sets the widget's position on its parent widget.
Public Member Functions inherited from PlatformWidget
	PlatformWidget ()
virtual	~PlatformWidget ()
virtual SDL_Texture *	GetSDL_Texture ()
	Used to extract an SDL surface from the widget. Used by children drawing themselves on their parent.
void	SetParent (PlatformWidget *parent)
SDL_Surface *	GetSurface ()
virtual bool	SetRenderer (SDL_Renderer *renderer)
SDL_Renderer *	GetRenderer ()
virtual bool	AddToParentWidget (PlatformWidget *parent)
virtual bool	AddSubWidget (PlatformWidget *widget)
virtual bool	RemoveSubWidget (PlatformWidget *widget)
virtual bool	RemoveSubWidgets ()
virtual bool	RotoZoom (double angle, double zoomx, double zoomy, int smooth)
	This uses the SDL_gfx package to 'rotozoom'.
bool	SetPoint (int x, int y, PColor col)
PColor	GetPixel (int x, int y)
	PlatformWidget ()
	PlatformWidget (pInt x, pInt y, pInt width, pInt height, bool visible)
virtual	~PlatformWidget ()
virtual bool	RotoZoom (pDouble angle, pDouble zoomx, pDouble zoomy, pInt smooth)
virtual bool	SetPoint (pInt x, pInt y, PColor col)
virtual PColor	GetPixel (pInt x, pInt y)
Public Member Functions inherited from PWidget
	PWidget ()
	PWidget (const PWidget &pw)
	PWidget (pInt x, pInt y, pInt width, pInt height, bool visible)
virtual	~PWidget ()
virtual void	SetParent (PWidget *widget)
	This unconditionally sets the parent widget.
virtual PWidget *	GetParent ()
virtual bool	IsParent (PWidget *parent)
virtual void	SetZoomX (pDouble x)
	This sets the widget's position on its parent widget.
virtual void	SetZoomY (pDouble x)
	This sets the widget's position on its parent widget.
virtual void	SetRotation (pDouble x)
	This sets the widget's position on its parent widget.
virtual void	SetWidth (pInt w)
virtual void	SetHeight (pInt h)
virtual pInt	GetX () const
virtual pInt	GetY () const
virtual pInt	GetWidth () const
virtual pInt	GetHeight () const
virtual void	SetBackgroundColor (const PColor &color)
virtual PColor	GetBackgroundColor ()
virtual bool	AddSubWidget (PWidget *widget)
virtual bool	RemoveSubWidget (PWidget *widget)
virtual bool	RemoveLastSubWidget ()
	This is probably pretty useless.
virtual void	Show ()
virtual void	Hide ()
virtual bool	IsVisible () const
Public Member Functions inherited from PEBLObjectBase
	PEBLObjectBase ()
	Standard Constructor.
	PEBLObjectBase (ComplexDataType cdt)
	Standard Constructor.
	PEBLObjectBase (const PEBLObjectBase &pob)
virtual	~PEBLObjectBase ()
	Standard Destructor.
virtual bool	InitializeProperty (std::string name, Variant v)
Variant	GetProperty (std::string) const
ComplexDataType	GetType ()
virtual std::ostream &	PrintProperties (std::ostream &out)
virtual Variant	GetPropertyList ()
Public Member Functions inherited from PLabel
	PLabel ()
	PLabel (const std::string &text)
	PLabel (const PLabel &label)
virtual	~PLabel ()
virtual Variant	GetProperty (std::string) const
Public Member Functions inherited from PTextObject
	PTextObject ()
	PTextObject (const std::string &text)
	PTextObject (PTextObject &object)
virtual	~PTextObject ()
virtual void	SetDirection (int i)
virtual std::string	GetText () const
virtual unsigned long int	GetNumCharacters ()

Protected Member Functions
virtual std::ostream &	SendToStream (std::ostream &out) const
	An inheritable printing class used by PEBLObjectBase::operator<<.
virtual std::ostream &	SendToStream (std::ostream &out) const
	An inheritable printing class used by PEBLObjectBase::operator<<.
Protected Member Functions inherited from PlatformWidget
virtual void	PrintSubWidgets (std::ostream &out) const
virtual bool	LockSurface ()
	This needs to be used on some platforms/video cards.
virtual bool	UnlockSurface ()
	This needs to be used on some platforms/video cards.

Additional Inherited Members
Protected Attributes inherited from PlatformWidget
pInt	mTextureWidth
pInt	mTextureHeight
bool	mNeedsTexture
SDL_Texture *	mTexture
SDL_Surface *	mSurface
SDL_Renderer *	mRenderer
Protected Attributes inherited from PWidget
pInt	mX
pInt	mY
pInt	mDrawX
pInt	mDrawY
pInt	mWidth
pInt	mHeight
pDouble	mZoomX
pDouble	mZoomY
pDouble	mRotation
PColor	mBackgroundColor
	The background color of the widget. if alpha = 0, will not be painted.
std::list< PWidget * >	mSubWidgets
bool	mIsVisible
PWidget *	mParent
Protected Attributes inherited from PEBLObjectBase
ComplexDataType	mCDT
std::map< std::string, Variant >	mProperties
Protected Attributes inherited from PTextObject
bool	mChanged
std::string	mText
int	mDirection

Detailed Description

Validator platform label - no rendering, used only for compilation.

This class defines the SDL Platform-specific representation of a text label. It uses the SDL_ttf library (a wrapper to freetype) to render words in a box.

Definition at line 49 of file sdl/PlatformLabel.h.

Constructor & Destructor Documentation

PlatformLabel() [1/4]

PlatformLabel::PlatformLabel	(	const std::string &	text,
		counted_ptr< PEBLObjectBase >	font
	)

Definition at line 56 of file sdl/PlatformLabel.cpp.

                                                                                    :
    PlatformWidget(),
    PLabel(text),
    mFontObject(font)
{
 
    mSurface = NULL;
    mTexture = NULL;
    mRenderer = NULL;
 
    mCDT=CDT_LABEL;
 
    SetFont(font);
 
    SetText(text);
 
    //Make the font property accessible
    counted_ptr<PEBLObjectBase> myFont = counted_ptr<PEBLObjectBase>(mFontObject);
 
    PComplexData *  pcd = new PComplexData(myFont);
 
    InitializeProperty("FONT",Variant(pcd));
 
    delete pcd;
    pcd=NULL;
 
    InitializeProperty("WIDTH",Variant(0));
    InitializeProperty("HEIGHT",Variant(0));
 
    //issue draw() command to be sure the xy center is set right.
    Draw();
 
}

References CDT_LABEL, Draw(), PEBLObjectBase::InitializeProperty(), PEBLObjectBase::mCDT, PlatformWidget::mRenderer, PlatformWidget::mSurface, PlatformWidget::mTexture, NULL, SetFont(), and SetText().

PlatformLabel() [2/4]

PlatformLabel::PlatformLabel

(

PlatformLabel &

label

)

This copy constructor isn't const because the font is shared.

Definition at line 91 of file sdl/PlatformLabel.cpp.

                                                 :
    PlatformWidget(),
    PLabel(label.GetText())
 
{
    mCDT=CDT_LABEL;
    mSurface = NULL;
    mRenderer = NULL;
    mTexture = NULL;
 
    SetFont(label.GetFont());
 
 
    counted_ptr<PEBLObjectBase> myFont = counted_ptr<PEBLObjectBase>(mFontObject);
    PComplexData *  pcd = new PComplexData(myFont);
    delete pcd;
    pcd=NULL;
 
    InitializeProperty("FONT",Variant(pcd));
    InitializeProperty("WIDTH",Variant(label.GetHeight()));
    InitializeProperty("HEIGHT",Variant(label.GetWidth()));
    cerr << "Drawing new label in platformlabel\n";
    Draw();
}

References CDT_LABEL, Draw(), GetFont(), PWidget::GetHeight(), PWidget::GetWidth(), PEBLObjectBase::InitializeProperty(), PEBLObjectBase::mCDT, PlatformWidget::mRenderer, PlatformWidget::mSurface, PlatformWidget::mTexture, NULL, and SetFont().

~PlatformLabel() [1/2]

PlatformLabel::~PlatformLabel ( )

virtual

Standard Destructor.

Definition at line 118 of file sdl/PlatformLabel.cpp.

{
    //cerr << "Label destructor\n";
 
}

PlatformLabel() [3/4]

PlatformLabel::PlatformLabel	(	const std::string &	text,
		counted_ptr< PEBLObjectBase >	font
	)

PlatformLabel() [4/4]

PlatformLabel::PlatformLabel

(

PlatformLabel &

label

)

~PlatformLabel() [2/2]

virtual PlatformLabel::~PlatformLabel ( )

virtual

Member Function Documentation

Draw() [1/2]

bool PlatformLabel::Draw ( )

virtual

This method initiates everything needed to display the main window

Reimplemented from PlatformWidget.

Definition at line 377 of file sdl/PlatformLabel.cpp.

{
 
    // Check if label text changed OR if font properties changed
    if(mChanged || GetPlatformFont()->HasChanged())
        {
 
            RenderText();
            //Reposition.  This just recalculates so things are centered
            //correctly; labels are positioned based on their center.
 
            SetPosition(mX, mY);
 
            InitializeProperty("HEIGHT",mHeight);
            InitializeProperty("WIDTH",mWidth);
            GetPlatformFont()->ClearChanged();  // Clear font changed flag after re-rendering
 
            // Only clear mChanged if texture was successfully created
            // If mTexture is NULL, keep mChanged=true to retry when renderer is available
            if(mTexture)
            {
                mChanged = false;
            }
        }
    return  PlatformWidget::Draw();
 
}

References PlatformFont::ClearChanged(), PlatformWidget::Draw(), PEBLObjectBase::InitializeProperty(), PTextObject::mChanged, PWidget::mHeight, PlatformWidget::mTexture, PWidget::mWidth, PWidget::mX, PWidget::mY, RenderText(), and SetPosition().

Referenced by PlatformLabel(), PlatformLabel(), SetFont(), and SetText().

Draw() [2/2]

virtual bool PlatformLabel::Draw ( )

virtual

This method initiates everything needed to display the main window

Reimplemented from PlatformWidget.

GetFont()

virtual counted_ptr< PEBLObjectBase > PlatformLabel::GetFont ( )

inlinevirtual

Definition at line 69 of file sdl/PlatformLabel.h.

{return mFontObject;}

Referenced by PlatformLabel().

ObjectName() [1/2]

virtual std::string PlatformLabel::ObjectName ( ) const

inlinevirtual

Reimplemented from PWidget.

Definition at line 70 of file sdl/PlatformLabel.h.

{return "PlatformLabel";} ;

ObjectName() [2/2]

virtual std::string PlatformLabel::ObjectName ( ) const

inlinevirtual

Reimplemented from PWidget.

Definition at line 40 of file validator/PlatformLabel.h.

{ return "PlatformLabel (validator)"; }

RenderText()

bool PlatformLabel::RenderText ( )

virtual

RenderText is only called once the label is already added to a window/widget, so that it already has a renderer and a texture.

Definition at line 137 of file sdl/PlatformLabel.cpp.

{
    // Check if formatted text mode is enabled
    Variant formattedVar = PEBLObjectBase::GetProperty("FORMATTED");
    bool isFormatted = (formattedVar.GetInteger() != 0);
 
    SDL_Surface * finalSurface = NULL;
 
    if (isFormatted) {
        // FORMATTED TEXT RENDERING (single-line with baseline alignment)
 
        // Parse formatted text into segments
        std::vector<FormatParser::FormatSegment> segments = FormatParser::ParseFormattedText(mText);
 
        // FIRST PASS: Find maximum ascent for baseline alignment
        int maxAscent = 0;
        int totalWidth = 0;
 
        for (const FormatParser::FormatSegment& seg : segments) {
            if (!seg.text.empty()) {
                PlatformFont* segFont = GetPlatformFont();
                std::string fontFileName = segFont->GetFontFileName();
                int baseSize = segFont->GetFontSize();
                PColor baseFgColor = segFont->GetFontColor();
                PColor baseBgColor = segFont->GetBackgroundColor();
                bool antiAliased = segFont->GetAntiAliased();
 
                int segStyle = seg.style;
                int segSize = seg.hasSizeOverride ? seg.sizeOverride : baseSize;
                PColor segFgColor = seg.hasColorOverride ? seg.colorOverride : baseFgColor;
 
                PlatformFont* renderFont = new PlatformFont(
                    fontFileName, segStyle, segSize,
                    segFgColor, baseBgColor, antiAliased);
 
                // Get ascent and width for this segment
                int ascent = TTF_FontAscent(renderFont->GetTTFFont());
                if (ascent > maxAscent) maxAscent = ascent;
 
                int segWidth, segHeight;
                TTF_SizeText(renderFont->GetTTFFont(), seg.text.c_str(), &segWidth, &segHeight);
                totalWidth += segWidth;
 
                delete renderFont;
            }
        }
 
        // Calculate total height (use max ascent + max descent)
        // Note: TTF_FontDescent() returns negative values for portions below baseline
        int maxDescent = 0;
        for (const FormatParser::FormatSegment& seg : segments) {
            if (!seg.text.empty()) {
                PlatformFont* segFont = GetPlatformFont();
                std::string fontFileName = segFont->GetFontFileName();
                int baseSize = segFont->GetFontSize();
                PColor baseFgColor = segFont->GetFontColor();
                PColor baseBgColor = segFont->GetBackgroundColor();
                bool antiAliased = segFont->GetAntiAliased();
 
                int segStyle = seg.style;
                int segSize = seg.hasSizeOverride ? seg.sizeOverride : baseSize;
                PColor segFgColor = seg.hasColorOverride ? seg.colorOverride : baseFgColor;
 
                PlatformFont* renderFont = new PlatformFont(
                    fontFileName, segStyle, segSize,
                    segFgColor, baseBgColor, antiAliased);
 
                int descent = TTF_FontDescent(renderFont->GetTTFFont());
                // Convert negative descent to positive for comparison
                int absDescent = (descent < 0) ? -descent : descent;
                if (absDescent > maxDescent) maxDescent = absDescent;
 
                delete renderFont;
            }
        }
 
        int totalHeight = maxAscent + maxDescent;
 
        // Create surface for the entire label
        #if SDL_BYTEORDER == SDL_BIG_ENDIAN
            Uint32 rmask = 0xff000000;
            Uint32 gmask = 0x00ff0000;
            Uint32 bmask = 0x0000ff00;
            Uint32 amask = 0x000000ff;
        #else
            Uint32 rmask = 0x000000ff;
            Uint32 gmask = 0x0000ff00;
            Uint32 bmask = 0x00ff0000;
            Uint32 amask = 0xff000000;
        #endif
 
        finalSurface = SDL_CreateRGBSurface(0, totalWidth, totalHeight, 32,
                                            rmask, gmask, bmask, amask);
 
        if (!finalSurface) {
            return false;
        }
 
        // Fill with transparent background
        SDL_FillRect(finalSurface, NULL, SDL_MapRGBA(finalSurface->format, 0, 0, 0, 0));
 
        // SECOND PASS: Render segments with baseline alignment
        int xOffset = 0;
 
        for (const FormatParser::FormatSegment& seg : segments) {
            if (!seg.text.empty()) {
                PlatformFont* segFont = GetPlatformFont();
                std::string fontFileName = segFont->GetFontFileName();
                int baseSize = segFont->GetFontSize();
                PColor baseFgColor = segFont->GetFontColor();
                PColor baseBgColor = segFont->GetBackgroundColor();
                bool antiAliased = segFont->GetAntiAliased();
 
                int segStyle = seg.style;
                int segSize = seg.hasSizeOverride ? seg.sizeOverride : baseSize;
                PColor segFgColor = seg.hasColorOverride ? seg.colorOverride : baseFgColor;
 
                PlatformFont* renderFont = new PlatformFont(
                    fontFileName, segStyle, segSize,
                    segFgColor, baseBgColor, antiAliased);
 
                SDL_Surface* segSurface = renderFont->RenderText(seg.text.c_str());
 
                if (segSurface) {
                    // Get ascent for this specific font
                    int thisAscent = TTF_FontAscent(renderFont->GetTTFFont());
 
                    // Calculate y-offset to align baseline with max baseline
                    int yOffset = maxAscent - thisAscent;
 
                    // Position segment with baseline alignment
                    SDL_Rect segRect = {xOffset, yOffset, segSurface->w, segSurface->h};
 
                    SDL_BlitSurface(segSurface, NULL, finalSurface, &segRect);
                    SDL_FreeSurface(segSurface);
 
                    xOffset += segRect.w;
                }
 
                delete renderFont;
            }
        }
 
    } else {
        // NORMAL (NON-FORMATTED) RENDERING
        if(mDirection == 1) {
            //Re-render the text using the associated font.
            finalSurface = GetPlatformFont()->RenderText(mText.c_str());
        } else {
            std::string rtext = PEBLUtility::strrev_utf8(mText);
            //Re-render the text using the associated font.
            finalSurface = GetPlatformFont()->RenderText(rtext.c_str());
        }
    }
 
    if(finalSurface) {
        mWidth  = finalSurface->w;
        mHeight = finalSurface->h;
        mTextureWidth = mWidth;
        mTextureHeight = mHeight;
        InitializeProperty("HEIGHT",mHeight);
        InitializeProperty("WIDTH",mWidth);
 
        //textures get created
        if(mTexture) {
            SDL_DestroyTexture(mTexture);
            mTexture = NULL;
        }
 
        if(mRenderer) {
            mTexture = SDL_CreateTextureFromSurface(mRenderer, finalSurface);
            // Enable alpha blending for transparency support
            SDL_SetTextureBlendMode(mTexture, SDL_BLENDMODE_BLEND);
            // Enable best quality filtering (anisotropic) for zoomed textures
            SDL_SetTextureScaleMode(mTexture, SDL_ScaleModeBest);
 
            SDL_FreeSurface(finalSurface);
            finalSurface = NULL;
        }
 
        return true;
    } else {
        return false;
    }
}

References PFont::GetAntiAliased(), PFont::GetBackgroundColor(), PFont::GetFontColor(), PFont::GetFontFileName(), PFont::GetFontSize(), Variant::GetInteger(), PEBLObjectBase::GetProperty(), PlatformFont::GetTTFFont(), PEBLObjectBase::InitializeProperty(), PTextObject::mDirection, PWidget::mHeight, PlatformWidget::mRenderer, PTextObject::mText, PlatformWidget::mTexture, PlatformWidget::mTextureHeight, PlatformWidget::mTextureWidth, PWidget::mWidth, NULL, FormatParser::ParseFormattedText(), PlatformFont::RenderText(), and PEBLUtility::strrev_utf8().

Referenced by Draw().

SendToStream() [1/2]

std::ostream & PlatformLabel::SendToStream ( std::ostream &  out ) const

protectedvirtual

An inheritable printing class used by PEBLObjectBase::operator<<.

Reimplemented from PlatformWidget.

Definition at line 43 of file validator/PlatformLabel.cpp.

                                                             {
    out << "PlatformLabel (validator)";
    return out;
}

SendToStream() [2/2]

virtual std::ostream & PlatformLabel::SendToStream ( std::ostream &  out ) const

protectedvirtual

An inheritable printing class used by PEBLObjectBase::operator<<.

Reimplemented from PlatformWidget.

SetFont() [1/2]

void PlatformLabel::SetFont ( counted_ptr< PEBLObjectBase >  font )

virtual

Definition at line 346 of file sdl/PlatformLabel.cpp.

{
 
    mFontObject = font;
 
    // Update the FONT property so nested access works correctly
    PComplexData * pcd = new PComplexData(mFontObject);
    PEBLObjectBase::SetProperty("FONT", Variant(pcd));
    delete pcd;
 
    mChanged =true;
    Draw();
 
    //if(!RenderText()) cerr << "Unable to render text.\n";
 
}

References Draw(), PTextObject::mChanged, and PEBLObjectBase::SetProperty().

Referenced by PlatformLabel(), PlatformLabel(), PEBLObjects::SetFont(), and SetProperty().

SetFont() [2/2]

virtual void PlatformLabel::SetFont ( counted_ptr< PEBLObjectBase >  font )

inlinevirtual

Definition at line 41 of file validator/PlatformLabel.h.

{}  // Stub for validator

SetPosition()

virtual void PlatformLabel::SetPosition ( pInt  x, pInt  y  )

inlinevirtual

This sets the widget's position on its parent widget.

Sets the location of the upper left-hand corner of the image on the parent widget; unless overridden

Reimplemented from PWidget.

Definition at line 49 of file validator/PlatformLabel.h.

{ PLabel::SetPosition(x, y); }

References PLabel::SetPosition().

Referenced by Draw(), and PEBLObjects::MakeLabel().

SetProperty() [1/2]

virtual bool PlatformLabel::SetProperty ( std::string  name, Variant  v  )

inlinevirtual

Reimplemented from PWidget.

Definition at line 44 of file validator/PlatformLabel.h.

{ return PLabel::SetProperty(name, v); }

References PLabel::SetProperty().

SetProperty() [2/2]

bool PlatformLabel::SetProperty ( std::string  name, Variant  v  )

virtual

Reimplemented from PWidget.

Definition at line 324 of file sdl/PlatformLabel.cpp.

{
 
    if(name == "TEXT")
        {
 
            SetText(v);
        }
    else if(PLabel::SetProperty(name,v))
    {
        // If we set it at higher level, don't worry.
    }
    else if (name == "FONT")
        {
            SetFont(v.GetComplexData()->GetObject());
            
        }
    else return false;
    
    return true;
}

References Variant::GetComplexData(), PComplexData::GetObject(), SetFont(), PLabel::SetProperty(), and SetText().

SetText()

void PlatformLabel::SetText ( const std::string &  text )

virtual

Reimplemented from PTextObject.

Definition at line 364 of file sdl/PlatformLabel.cpp.

{
    //Chain up to parent method.
    PTextObject::SetText(text);
    mChanged =true;
    Draw();
 
    //Re-render the text onto mSurface
    //if(!RenderText()) cerr << "Unable to render text.\n";
 
}

References Draw(), PTextObject::mChanged, and PTextObject::SetText().

Referenced by PlatformLabel(), SetProperty(), and PEBLObjects::SetText().

ValidateProperty() [1/2]

virtual ObjectValidationError PlatformLabel::ValidateProperty ( std::string  name ) const

inlinevirtual

Reimplemented from PWidget.

Definition at line 46 of file validator/PlatformLabel.h.

{ return PLabel::ValidateProperty(name); }

References PLabel::ValidateProperty().

ValidateProperty() [2/2]

virtual ObjectValidationError PlatformLabel::ValidateProperty ( std::string  name, Variant  v  ) const

inlinevirtual

Reimplemented from PWidget.

Definition at line 45 of file validator/PlatformLabel.h.

{ return PLabel::ValidateProperty(name, v); }

References PLabel::ValidateProperty().

---

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

• sdl/PlatformLabel.h
• validator/PlatformLabel.h
• sdl/PlatformLabel.cpp
• validator/PlatformLabel.cpp