My Project
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
ParaEngine::CGUI4OutsideArrow Class Reference

element 0: left arrow element 1: top arrow element 2: right arrow element 3: bottom. More...

#include <GUIHighlight.h>

Inheritance diagram for ParaEngine::CGUI4OutsideArrow:
ParaEngine::CGUIHighlight ParaEngine::IObject ParaEngine::CRefCounted

Public Member Functions

virtual bool SetParameter (const char *szName, const char *szValue)
 Set effect parameter. More...
 
virtual HRESULT Render (GUIState *pGUIState, RECT &rcScreen, float fElapsedTime)
 Render the Highlight effect. More...
 
virtual const char * GetHighlightName () const
 
virtual void Clone (IObject *obj) const
 Clone the object's contains to a pointer. More...
 
virtual IObjectClone () const
 Clone the object's contains and return a pointer to the newly created object. More...
 
- Public Member Functions inherited from ParaEngine::CGUIHighlight
virtual int GetHighlightStyle () const
 
- Public Member Functions inherited from ParaEngine::IObject
virtual bool Equals (const IObject *obj) const
 Compare the object with another object. More...
 
virtual const ITypeGetType () const
 
virtual std::string ToString () const
 
WeakPtr_typeGetWeakReference ()
 get weak reference object. More...
 
virtual int ProcessObjectEvent (const ObjectEvent &event)
 this function is only used to backward compatibility of ParaObject:AddEvent() function. More...
 
- Public Member Functions inherited from ParaEngine::CRefCounted
void addref () const
 add reference count of the object. More...
 
bool delref () const
 decrease reference count of the object. More...
 
int GetRefCount () const
 get the reference count
 
virtual int Release ()
 
CRefCountedAddToAutoReleasePool ()
 addref and releases the ownership sometime soon automatically (usually at the end of the current frame). More...
 

Protected Member Functions

virtual void Init ()
 

Protected Attributes

float m_fSpeed
 
int m_nRange
 
int m_nPos
 
int m_nImageSize
 
- Protected Attributes inherited from ParaEngine::CGUIHighlight
bool m_bInit
 
CGUIResourcem_objResource
 
int m_eStyle
 
- Protected Attributes inherited from ParaEngine::IObject
WeakPtr_type m_weak_reference
 
- Protected Attributes inherited from ParaEngine::CRefCounted
int m_refcount
 

Additional Inherited Members

- Public Types inherited from ParaEngine::IObject
typedef ParaEngine::weak_ptr< IObjectWeakPtr_type
 

Detailed Description

element 0: left arrow element 1: top arrow element 2: right arrow element 3: bottom.

arrow all elements should be 32*32

Member Function Documentation

§ Clone() [1/2]

void CGUI4OutsideArrow::Clone ( IObject obj) const
virtual

Clone the object's contains to a pointer.

The caller should allocate the memory and pass the pointer to this function.. Inheritance should implement this function void Clone(IObject*) and IObject* Clone() should have the same behavior In some cases, if you want to avoid Dead Reference( one object is being referred to by many objects and you can't update all the references). It is possible to use this function to replace the contains at a given pointer. But this may result in memory leak if you do not implement this function carefully or misuse it.

Reimplemented from ParaEngine::IObject.

§ Clone() [2/2]

IObject * CGUI4OutsideArrow::Clone ( ) const
virtual

Clone the object's contains and return a pointer to the newly created object.

The caller should free the memory of the return object. Inheritance should implement this function void Clone(IObject*) and IObject* Clone() should have the same behavior

Reimplemented from ParaEngine::IObject.

§ Render()

HRESULT CGUI4OutsideArrow::Render ( GUIState pGUIState,
RECT rcScreen,
float  fElapsedTime 
)
virtual

Render the Highlight effect.

If the effect is not properly initialize, it will call Init() to initialize it

Parameters
pGUIStatethe same meaning as other GUI object
rcScreenthe edge rectangle of the control we want to highlight
fElapsedTimethe same meaning as other GUI object.

Implements ParaEngine::CGUIHighlight.

§ SetParameter()

bool CGUI4OutsideArrow::SetParameter ( const char *  szName,
const char *  szValue 
)
virtual

Set effect parameter.

the value will be properly translated to correct type.

Parameters
szNamename of the parameter
szValuenew value of the parameter
Returns
: false if the given parameter does not exist or the new value is not acceptable.

Implements ParaEngine::CGUIHighlight.


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