Validator platform canvas - no pixel buffer, used only for compilation. More...

#include <PlatformCanvas.h>

Inheritance diagram for PlatformCanvas:

Public Member Functions
	PlatformCanvas (int width, int height, Variant bg)

	PlatformCanvas (int width, int height)

	PlatformCanvas (const PlatformCanvas &canv)
	This copy constructor isn't const because the font is shared.

virtual	~PlatformCanvas ()
	Standard Destructor.

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

virtual bool	Reset ()

virtual std::string	ObjectName () const

virtual bool	Draw ()
	This method initiates everything needed to display the main window

virtual void	SetWidth (pInt h)

virtual void	SetHeight (pInt h)

virtual void	SetZoomX (double h)

virtual void	SetZoomY (double h)

	PlatformCanvas (int width, int height)

	PlatformCanvas (int width, int height, Variant color)

virtual	~PlatformCanvas ()

virtual bool	Draw ()
	This method initiates everything needed to display the main window

virtual std::string	ObjectName () const

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

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

virtual ObjectValidationError	ValidateProperty (std::string name) const

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 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 PCanvas
	PCanvas ()

	PCanvas (int width, int height, Variant color)

	PCanvas (int width, int height)

	PCanvas (PCanvas &canvas)

virtual	~PCanvas ()

virtual Variant	GetProperty (std::string) const

virtual void	SetPosition (pInt x, pInt y)
	This sets the widget's position on its parent widget.

virtual void	SetHeight (int h)

virtual void	SetWidth (int w)

virtual void	SetColor (Variant col)

virtual bool	GetDrawBackground () const

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 PCanvas
bool	mDrawBackground

bool	mReset

Detailed Description

Validator platform canvas - no pixel buffer, used only for compilation.

This class defines an SDL-specific drawable canvas in which individual pixels can be drawn to.

Definition at line 43 of file sdl/PlatformCanvas.h.

Constructor & Destructor Documentation

◆ PlatformCanvas() [1/5]

PlatformCanvas::PlatformCanvas	(	int	width,
		int	height,
		Variant	bg
	)

Definition at line 52 of file sdl/PlatformCanvas.cpp.

                                                               :
 
    PCanvas(width, height,bg),
    mPixels(NULL),
    PlatformWidget()
 
{
 
    mTextureWidth = width;
    mTextureHeight = height;
 
    mCDT = CDT_CANVAS;
    InitializeProperty("BGCOLOR",bg);
    SetColor(bg);
 
    mSurface = NULL;
    mRenderer = NULL;
    mTexture = NULL;
    mNeedsTexture = true;
    Reset();
    Draw();
 
}

References CDT_CANVAS, Draw(), PEBLObjectBase::InitializeProperty(), PEBLObjectBase::mCDT, PlatformWidget::mNeedsTexture, PlatformWidget::mRenderer, PlatformWidget::mSurface, PlatformWidget::mTexture, PlatformWidget::mTextureHeight, PlatformWidget::mTextureWidth, NULL, Reset(), and PCanvas::SetColor().

◆ PlatformCanvas() [2/5]

PlatformCanvas::PlatformCanvas	(	int	width,
		int	height
	)

Definition at line 78 of file sdl/PlatformCanvas.cpp.

                                                   :
    mCanvasWidth(0),
    mCanvasHeight(0),
    mPixels(NULL),
    PlatformWidget(),
    PCanvas(width, height)
{
 
    mTextureWidth = width;
    mTextureHeight = height;
 
    mWidth =width;
    mHeight = height;
 
    mCDT = CDT_CANVAS;
 
    mSurface = NULL;
    mTexture = NULL;
    mRenderer = NULL;
    mNeedsTexture = true;
    Reset();
    //Draw();
 
}

References CDT_CANVAS, PEBLObjectBase::mCDT, PWidget::mHeight, PlatformWidget::mNeedsTexture, PlatformWidget::mRenderer, PlatformWidget::mSurface, PlatformWidget::mTexture, PlatformWidget::mTextureHeight, PlatformWidget::mTextureWidth, PWidget::mWidth, NULL, and Reset().

◆ PlatformCanvas() [3/5]

PlatformCanvas::PlatformCanvas ( const PlatformCanvas & canv )

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

Definition at line 106 of file sdl/PlatformCanvas.cpp.

                                                           :
    PEBLObjectBase(),
    PlatformWidget(),
    PCanvas()
{
 
    PCanvas::mDrawBackground = canvas.GetDrawBackground();
    mCDT = CDT_CANVAS;
    mWidth = canvas.GetWidth();
    mHeight = canvas.GetHeight();
    mTextureWidth = mWidth;
    mTextureHeight = mHeight;
 
    mTexture = NULL;
    mSurface = NULL;
    mNeedsTexture = true;
    Reset();   //reset initializes the canvas
    //Draw();
 
}

References CDT_CANVAS, PCanvas::GetDrawBackground(), PWidget::GetHeight(), PWidget::GetWidth(), PEBLObjectBase::mCDT, PCanvas::mDrawBackground, PWidget::mHeight, PlatformWidget::mNeedsTexture, PlatformWidget::mSurface, PlatformWidget::mTexture, PlatformWidget::mTextureHeight, PlatformWidget::mTextureWidth, PWidget::mWidth, NULL, and Reset().

◆ ~PlatformCanvas() [1/2]

PlatformCanvas::~PlatformCanvas ( )

virtual

Standard Destructor.

Definition at line 129 of file sdl/PlatformCanvas.cpp.

{
 
    // PlatformWidget frees mSurface,
    // and should free children...
 
}

◆ PlatformCanvas() [4/5]

PlatformCanvas::PlatformCanvas	(	int	width,
		int	height
	)

◆ PlatformCanvas() [5/5]

PlatformCanvas::PlatformCanvas	(	int	width,
		int	height,
		Variant	color
	)

◆ ~PlatformCanvas() [2/2]

virtual PlatformCanvas::~PlatformCanvas ( )

virtual

Member Function Documentation

◆ Draw() [1/2]

bool PlatformCanvas::Draw ( )

virtual

This method initiates everything needed to display the main window

Reimplemented from PlatformWidget.

Definition at line 268 of file sdl/PlatformCanvas.cpp.

{
    //Can we only reset if something has changed on a child?
    mReset = true;
    if(mReset)
        {
        }
            Reset();
 
 
    bool ret =     PlatformWidget::Draw();
    mReset = false;
 
 
    return  ret;
}

References PlatformWidget::Draw(), PCanvas::mReset, and Reset().

Referenced by PlatformCanvas().

◆ Draw() [2/2]

virtual bool PlatformCanvas::Draw ( )

virtual

This method initiates everything needed to display the main window

Reimplemented from PlatformWidget.

◆ ObjectName() [1/2]

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

inlinevirtual

Reimplemented from PWidget.

Definition at line 60 of file sdl/PlatformCanvas.h.

60{return "PlatformCanvas";} ;

◆ ObjectName() [2/2]

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

inlinevirtual

Reimplemented from PWidget.

Definition at line 39 of file validator/PlatformCanvas.h.

39{ return "PlatformCanvas (validator)"; }

◆ Reset()

bool PlatformCanvas::Reset ( )

virtual

This method should be called when the canvas is initialized or something is changed. It will make the mSurface pointer hold the appropriate image.

Definition at line 149 of file sdl/PlatformCanvas.cpp.

{
 
 
 
    //create a new surface on which to render the text.
 
    if(mSurface)
        {
            delete mSurface;
            mSurface = NULL;
        }
 
    //Make a transparent surface of the prescribed size.
 
#if 0
    SDL_Surface * tmp = NULL;
    //    SDL_CreateRGBSurface(SDL_SWSURFACE,
    //                         mWidth, mHeight,
    //                         32, rmask, gmask, bmask, amask);
    if(!tmp)  PError::SignalFatalError("Surface not created in Canvas::Reset.");
 
#endif
 
#ifdef SD2_DELETE
 
    SDL_SetAlpha(mSurface,0,SDL_ALPHA_TRANSPARENT);
    //   SDL_SetAlpha( tmp, 0, SDL_ALPHA_OPAQUE );
#endif
 
 
 
    //Fill the box with the background color
    //    std::cout << mBackgroundColor << "|alpha:|" << mBackgroundColor.GetAlpha() << std::endl;
 
 
 
    //    if(mBackgroundColor.GetAlpha() <.000001)
 
    //        {
    //            std::cout << "Setting transparency\n";
    //SDL_SetAlpha(mSurface,0,0);
 
    //        }
    mReset = false;  //Reset the reset flag.
 
 
    //we can only render onto a texture if renderer exists.
    //i.e., the canvas needs to be on a window.
 
    if(mTexture)
        {
 
            SDL_DestroyTexture(mTexture);
            mTexture =NULL;
            mReset = true;
        }
    else
        {
            mReset = true;
        }
 
    if(mRenderer)
        {
 
 
            //we create texture from hidden surface to allow drawing on surface.
            //mTexture =  SDL_CreateTextureFromSurface(mRenderer,tmp);
 
            mTexture =   SDL_CreateTexture(mRenderer,
                                           SDL_PIXELFORMAT_RGBA8888,
                                           SDL_TEXTUREACCESS_TARGET,
                                           (int)mTextureWidth,(int)mTextureHeight);
 
            SDL_Rect  screensize = {0,0,(int)(mTextureWidth),
                (int)mTextureHeight};
            SDL_SetRenderTarget(mRenderer,mTexture);
            SDL_RenderClear( mRenderer );
 
 
            SDL_SetRenderDrawColor(mRenderer,  (mBackgroundColor.GetRed()),
                                   (mBackgroundColor.GetGreen()),
                                   (mBackgroundColor.GetBlue()),
                                   (mBackgroundColor.GetAlpha()));
 
            SDL_RenderFillRect(mRenderer,&screensize);
 
 
            SDL_SetRenderTarget(mRenderer,NULL);
 
            //SDL_FreeSurface(tmp);
 
        }else{
        mReset = true;
    }
 
 
    if(mTexture)
        return true;
    else
        {
            mReset = true;
            return false;
        }
}

References PColor::GetAlpha(), PColor::GetBlue(), PColor::GetGreen(), PColor::GetRed(), PWidget::mBackgroundColor, PlatformWidget::mRenderer, PCanvas::mReset, PlatformWidget::mSurface, PlatformWidget::mTexture, PlatformWidget::mTextureHeight, PlatformWidget::mTextureWidth, NULL, and PError::SignalFatalError().

Referenced by Draw(), PlatformCanvas(), PlatformCanvas(), and PlatformCanvas().

◆ SendToStream() [1/2]

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

protectedvirtual

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

Reimplemented from PlatformWidget.

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

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

◆ SendToStream() [2/2]

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

protectedvirtual

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

Reimplemented from PlatformWidget.

◆ SetHeight()

void PlatformCanvas::SetHeight ( pInt h )

virtual

Reimplemented from PWidget.

Definition at line 285 of file sdl/PlatformCanvas.cpp.

{
    mHeight = h;
    mTextureHeight = h;
    PEBLObjectBase::SetProperty("HEIGHT",mHeight);
 
}

References PWidget::mHeight, PlatformWidget::mTextureHeight, and PEBLObjectBase::SetProperty().

◆ SetProperty() [1/2]

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

inlinevirtual

Reimplemented from PWidget.

Definition at line 42 of file validator/PlatformCanvas.h.

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

References PCanvas::SetProperty().

◆ SetProperty() [2/2]

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

virtual

Reimplemented from PWidget.

Definition at line 256 of file sdl/PlatformCanvas.cpp.

{
 
    //we need to handle zooming separately
    if(name == "ZOOMX")    SetZoomX((pDouble)v);
    else if(name=="ZOOMY") SetZoomY((pDouble)v);
    else     return PCanvas::SetProperty(name,v);
 
    return true;
}

References pDouble, PCanvas::SetProperty(), SetZoomX(), and SetZoomY().

Referenced by SetZoomX(), and SetZoomY().

◆ SetWidth()

void PlatformCanvas::SetWidth ( pInt h )

virtual

Reimplemented from PWidget.

Definition at line 293 of file sdl/PlatformCanvas.cpp.

{
 
    mWidth = w;
    mTextureWidth = w;
    PEBLObjectBase::SetProperty("WIDTH",mWidth);
 
}

References PlatformWidget::mTextureWidth, PWidget::mWidth, and PEBLObjectBase::SetProperty().

◆ SetZoomX()

void PlatformCanvas::SetZoomX ( double h )

virtual

Definition at line 302 of file sdl/PlatformCanvas.cpp.

{
 
    mZoomX = x;
    PEBLObjectBase::SetProperty("ZOOMX",mZoomX);
    SetProperty("X",mX); //reset X as it matters for images/labels
    mWidth = (int)(mTextureWidth*mZoomX);
    PEBLObjectBase::SetProperty("WIDTH",mWidth);
 
 
}

References PlatformWidget::mTextureWidth, PWidget::mWidth, PWidget::mX, PWidget::mZoomX, PEBLObjectBase::SetProperty(), and SetProperty().

Referenced by SetProperty().

◆ SetZoomY()

void PlatformCanvas::SetZoomY ( double h )

virtual

Definition at line 314 of file sdl/PlatformCanvas.cpp.

{
 
    mZoomY = y;
    PEBLObjectBase::SetProperty("ZOOMY",mZoomY);
    SetProperty("Y",mY); //reset X as it matters for images/labels
    mHeight =(int)(mTextureHeight*mZoomY);
    PEBLObjectBase::SetProperty("HEIGHT",mHeight);
 
 
}

References PWidget::mHeight, PlatformWidget::mTextureHeight, PWidget::mY, PWidget::mZoomY, PEBLObjectBase::SetProperty(), and SetProperty().

Referenced by SetProperty().

◆ ValidateProperty() [1/2]

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

inlinevirtual

Reimplemented from PWidget.

Definition at line 48 of file validator/PlatformCanvas.h.

                                                                         {
        return PCanvas::ValidateProperty(name);
    }

References PCanvas::ValidateProperty().

◆ ValidateProperty() [2/2]

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

inlinevirtual

Reimplemented from PWidget.

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

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

References PCanvas::ValidateProperty().

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

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PlatformCanvas() [1/5]

◆ PlatformCanvas() [2/5]

◆ PlatformCanvas() [3/5]

◆ ~PlatformCanvas() [1/2]

◆ PlatformCanvas() [4/5]

◆ PlatformCanvas() [5/5]

◆ ~PlatformCanvas() [2/2]

Member Function Documentation

◆ Draw() [1/2]

◆ Draw() [2/2]

◆ ObjectName() [1/2]

◆ ObjectName() [2/2]

◆ Reset()

◆ SendToStream() [1/2]

◆ SendToStream() [2/2]

◆ SetHeight()

◆ SetProperty() [1/2]

◆ SetProperty() [2/2]

◆ SetWidth()

◆ SetZoomX()

◆ SetZoomY()

◆ ValidateProperty() [1/2]

◆ ValidateProperty() [2/2]