#include <PMovie.h>

Inheritance diagram for PMovie:

Public Member Functions
	PMovie ()

virtual	~PMovie ()

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 long int	GetLength ()

virtual void	SetPosition (int x, int y)

virtual void	SetSize (int width, int height)

virtual std::string	ObjectName () const

virtual void	SetPlaybackPosition (unsigned long int x)

virtual void	SetVolume (long double vol)

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	SetPosition (pInt x, pInt y)
	This sets the widget's position on its parent widget.

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

Public Member Functions inherited from PDevice
	PDevice ()
	The Standard constructor.

virtual	~PDevice ()
	The Standard destructor.

virtual PEBL_DEVICE_TYPE	GetDeviceType ()

virtual int	GetState (int iface) const

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

Protected Attributes
long int	mLength

double	mPlaybackPosition

double	mVolume

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 40 of file PMovie.h.

Constructor & Destructor Documentation

◆ PMovie()

PMovie::PMovie ( )

Definition at line 35 of file PMovie.cpp.

              :
    PWidget()
{
    InitializeProperty("NAME",Variant("<MOVIE>"));
    InitializeProperty("FILENAME","UNKNOWN");
    InitializeProperty("DURATION",0);
    InitializeProperty("PLAYBACKPOSITION",0);
    InitializeProperty("VOLUME",1);
    __SetProps__();
 
}

References PEBLObjectBase::InitializeProperty().

◆ ~PMovie()

virtual PMovie::~PMovie ( )

inlinevirtual

Definition at line 45 of file PMovie.h.

45{};

Member Function Documentation

◆ GetLength()

virtual long int PMovie::GetLength ( )

inlinevirtual

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

Definition at line 59 of file PMovie.h.

59{return mLength;};

PMovie::mLength

long int mLength

Definition PMovie.h:72

References mLength.

◆ GetProperty()

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

virtual

Reimplemented from PWidget.

Definition at line 115 of file PMovie.cpp.

{
 
    return PEBLObjectBase::GetProperty(name);
}

References PEBLObjectBase::GetProperty().

◆ ObjectName()

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

inlinevirtual

Reimplemented from PWidget.

Definition at line 62 of file PMovie.h.

62{return "PMovie";};

◆ SendToStream()

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

inlineprotectedvirtual

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

Reimplemented from PWidget.

Definition at line 71 of file PMovie.h.

71{return out;};

◆ SetPlaybackPosition()

void PMovie::SetPlaybackPosition ( unsigned long int x )

virtual

Definition at line 70 of file PMovie.cpp.

{
    mPlaybackPosition = pos;
    PEBLObjectBase::SetProperty("PLAYBACKPOSITION",pos);
 
}

References mPlaybackPosition, and PEBLObjectBase::SetProperty().

Referenced by SetProperty().

◆ SetPosition()

void PMovie::SetPosition	(	int	x,
		int	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.

Definition at line 50 of file PMovie.cpp.

{
 
 
    PWidget::SetPosition(x,y);
    mDrawX = x - GetWidth()/2;
    mDrawY = y - GetHeight()/2;
}

References PWidget::GetHeight(), PWidget::GetWidth(), PWidget::mDrawX, PWidget::mDrawY, and PWidget::SetPosition().

Referenced by SetProperty().

◆ SetProperty()

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

virtual

Reimplemented from PWidget.

Definition at line 85 of file PMovie.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(v,mWidth);
    else if (name == "WIDTH") SetSize(mHeight, v);
    else if (name == "DURATION")
        PEBLObjectBase::SetProperty("DURATION",v);
    else if (name == "PLAYBACKPOSITION") SetPlaybackPosition(v);
    else if (name == "VOLUME") SetVolume((pDouble)v);
    else if (name == "FILENAME") 
        PEBLObjectBase::SetProperty("FILENAME",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, pDouble, SetPlaybackPosition(), SetPosition(), PEBLObjectBase::SetProperty(), PWidget::SetProperty(), SetSize(), SetVolume(), and PWidget::Show().

◆ SetSize()

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

virtual

Definition at line 59 of file PMovie.cpp.

{
    mWidth = width;
    mHeight = height;
    
    PEBLObjectBase::SetProperty("WIDTH",width);
    PEBLObjectBase::SetProperty("HEIGHT",height);
    
}

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

Referenced by SetProperty().

◆ SetVolume()

void PMovie::SetVolume ( long double vol )

virtual

Definition at line 78 of file PMovie.cpp.

{
    PEBLObjectBase::SetProperty("VOLUME",(pDouble)v);
}

References pDouble, and PEBLObjectBase::SetProperty().

Referenced by SetProperty().

◆ ValidateProperty() [1/2]

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

virtual

Reimplemented from PWidget.

Definition at line 137 of file PMovie.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"||
            name == "DURATION"||
            name == "FILENAME"||
            name == "PLAYBACKPOSITION" ||
            name == "VOLUME" )
 
        return OVE_VALID;
    else
        return OVE_INVALID_PROPERTY_NAME;
}

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

◆ ValidateProperty() [2/2]

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

virtual

Reimplemented from PWidget.

Definition at line 122 of file PMovie.cpp.

{
    ObjectValidationError code = ValidateProperty(name);
    if((code==OVE_VALID) & (name == "VOLUME"))
        {
            
            if((pDouble)v < 0)
                {
                    code = OVE_INVALID_PROPERTY_VALUE;
                }
        }
    
    return code;
}

References OVE_INVALID_PROPERTY_VALUE, OVE_VALID, pDouble, and ValidateProperty().

Referenced by ValidateProperty().

Member Data Documentation

◆ mLength

long int PMovie::mLength

protected

Definition at line 72 of file PMovie.h.

Referenced by GetLength().

◆ mPlaybackPosition

double PMovie::mPlaybackPosition

protected

Definition at line 73 of file PMovie.h.

Referenced by SetPlaybackPosition().

◆ mVolume

double PMovie::mVolume

protected

Definition at line 74 of file PMovie.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PMovie()

◆ ~PMovie()

Member Function Documentation

◆ GetLength()

◆ GetProperty()

◆ ObjectName()

◆ SendToStream()

◆ SetPlaybackPosition()

◆ SetPosition()

◆ SetProperty()

◆ SetSize()

◆ SetVolume()

◆ ValidateProperty() [1/2]

◆ ValidateProperty() [2/2]

Member Data Documentation

◆ mLength

◆ mPlaybackPosition

◆ mVolume