#include <PImageBox.h>

Inheritance diagram for PImageBox:

Public Member Functions
	PImageBox ()

virtual	~PImageBox ()

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

virtual Variant	GetProperty (std::string) const

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

virtual ObjectValidationError	ValidateProperty (std::string) const

virtual bool	LoadImage (const std::string &imagefilename)=0

virtual void	SetPosition (pInt x, pInt y)

virtual void	SetSize (int width, int height)

virtual std::string	ObjectName () const

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

virtual void	SetParent (PWidget *widget)
	This unconditionally sets the parent widget.

virtual PWidget *	GetParent ()

virtual bool	IsParent (PWidget *parent)

virtual bool	Draw ()

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

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

Protected Member Functions
virtual std::ostream &	SendToStream (std::ostream &out) const
	An inheritable printing class used by PEBLObjectBase::operator<<.

Additional Inherited Members
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

Detailed Description

This class, a subtype of PComplexData, is the base Object class subtypes include sounds, visual objects, etc.

Definition at line 39 of file PImageBox.h.

Constructor & Destructor Documentation

◆ PImageBox()

PImageBox::PImageBox ( )

Definition at line 33 of file PImageBox.cpp.

                    :
    PWidget()
{
    InitializeProperty("NAME",Variant("<IMAGEBOX>"));
    __SetProps__();
 
}

References PEBLObjectBase::InitializeProperty().

◆ ~PImageBox()

virtual PImageBox::~PImageBox ( )

inlinevirtual

Definition at line 44 of file PImageBox.h.

44{};

Member Function Documentation

◆ GetProperty()

Variant PImageBox::GetProperty ( std::string name ) const

virtual

Reimplemented from PWidget.

Definition at line 107 of file PImageBox.cpp.

{
 
    //PEBLObjectBase::PrintProperties(cout);
    return PEBLObjectBase::GetProperty(name);
}

References PEBLObjectBase::GetProperty().

◆ LoadImage()

virtual bool PImageBox::LoadImage ( const std::string & imagefilename )

pure virtual

This will load a file into the class data, given a file name. height and width are set automatically.

Implemented in PlatformImageBox, and PlatformImageBox.

◆ ObjectName()

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

inlinevirtual

Reimplemented from PWidget.

Reimplemented in PlatformImageBox, and PlatformImageBox.

Definition at line 62 of file PImageBox.h.

62{return "PImageBox";};

◆ SendToStream()

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

inlineprotectedvirtual

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

Reimplemented from PWidget.

Reimplemented in PlatformImageBox, and PlatformImageBox.

Definition at line 68 of file PImageBox.h.

68{return out;};

◆ SetPosition()

void PImageBox::SetPosition	(	pInt	x,
		pInt	y
	)

virtual

This sets the imagebox's position on its parent widget. It overrides the parent method because images positions are set by their centers.

Reimplemented from PWidget.

Definition at line 44 of file PImageBox.cpp.

{
    
 
    //mx/my is the specified position.
    mX = x;
    mY = y;
    // PWidget::SetPosition(x,y);
    //mdrawxy is the drawn upper-left corner position.
    mDrawX = x - GetWidth()/2;
    mDrawY = y - GetHeight()/2;
 
    PEBLObjectBase::SetProperty("X",Variant(mX));
    PEBLObjectBase::SetProperty("Y",Variant(mY));
 
}

References PWidget::GetHeight(), PWidget::GetWidth(), PWidget::mDrawX, PWidget::mDrawY, PWidget::mX, PWidget::mY, and PEBLObjectBase::SetProperty().

Referenced by main(), SetProperty(), and SetSize().

◆ SetProperty()

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

virtual

Reimplemented from PWidget.

Reimplemented in PlatformImageBox.

Definition at line 79 of file PImageBox.cpp.

{
 
 
    //Width and height are not currently 'settable', in that
    //they are properties of the object.
 
    if(name == "X") SetPosition(v,mY);
    else if (name == "Y") SetPosition(mX,v);
    else if (name == "HEIGHT") SetSize((int)mWidth,v);
    else if (name == "WIDTH") SetSize(v,(int)mHeight);
    else if (name =="ZOOMX") SetZoomX(v);
    else if (name =="ZOOMY") SetZoomY(v);
    else if (name == "VISIBLE") 
        {
            if(v.GetInteger())
                Show();
            else 
                Hide();
        }
 
    
    else return PWidget::SetProperty(name,v);
 
    return true;
}

References Variant::GetInteger(), PWidget::Hide(), PWidget::mHeight, PWidget::mWidth, PWidget::mX, PWidget::mY, SetPosition(), PWidget::SetProperty(), SetSize(), PWidget::SetZoomX(), PWidget::SetZoomY(), and PWidget::Show().

Referenced by PlatformImageBox::LoadImage(), and PlatformImageBox::SetProperty().

◆ SetSize()

void PImageBox::SetSize	(	int	width,
		int	height
	)

virtual

Definition at line 61 of file PImageBox.cpp.

{
 
 
    mWidth = width;
    mHeight = height;
   
    PEBLObjectBase::SetProperty("WIDTH",width);
    PEBLObjectBase::SetProperty("HEIGHT",height);
    //Reset position so it gets centered correctly.
    SetPosition(mX,mY);
}

References PWidget::mHeight, PWidget::mWidth, PWidget::mX, PWidget::mY, SetPosition(), and PEBLObjectBase::SetProperty().

Referenced by SetProperty().

◆ ValidateProperty() [1/2]

ObjectValidationError PImageBox::ValidateProperty ( std::string name ) const

virtual

Reimplemented from PWidget.

Reimplemented in PlatformImageBox.

Definition at line 121 of file PImageBox.cpp.

{
    //All valid properties are also valid Widget properties
    ObjectValidationError ove = PWidget::ValidateProperty(name);
    if(ove == OVE_VALID)
        {
            return ove;
        }
    else if(name =="WIDTH" ||
            name == "HEIGHT")
        return OVE_VALID;
    else
        
        return OVE_INVALID_PROPERTY_NAME;
}

References OVE_INVALID_PROPERTY_NAME, OVE_VALID, and PWidget::ValidateProperty().

◆ ValidateProperty() [2/2]

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

virtual

Reimplemented from PWidget.

Reimplemented in PlatformImageBox.

Definition at line 115 of file PImageBox.cpp.

{
 
    return ValidateProperty(name);
}

References ValidateProperty().

Referenced by PlatformImageBox::ValidateProperty(), PlatformImageBox::ValidateProperty(), and 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

◆ PImageBox()

◆ ~PImageBox()

Member Function Documentation

◆ GetProperty()

◆ LoadImage()

◆ ObjectName()

◆ SendToStream()

◆ SetPosition()

◆ SetProperty()

◆ SetSize()

◆ ValidateProperty() [1/2]

◆ ValidateProperty() [2/2]