An abstract class "4outsideArrow", 4 arrows pointing from outside to the edge of the control "4insideArrow, 4 arrows pointing from the edge of the control to the center of the control. More...
#include <GUIHighlight.h>
Public Member Functions | |
| virtual HRESULT | Render (GUIState *pGUIState, RECT &rcScreen, float fElapsedTime)=0 |
| Render the Highlight effect. More... | |
| virtual bool | SetParameter (const char *szName, const char *szValue)=0 |
| Set effect parameter. More... | |
| virtual const char * | GetHighlightName () const =0 |
| virtual int | GetHighlightStyle () const |
 Public Member Functions inherited from ParaEngine::IObject | |
| virtual void | Clone (IObject *obj) const |
| Clone the object's contains to a pointer. More... | |
| virtual IObject * | Clone () const |
| Clone the object's contains and return a pointer to the newly created object. More... | |
| virtual bool | Equals (const IObject *obj) const |
| Compare the object with another object. More... | |
| virtual const IType * | GetType () const |
| virtual std::string | ToString () const |
| WeakPtr_type & | GetWeakReference () |
| 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 () |
| CRefCounted * | AddToAutoReleasePool () |
| addref and releases the ownership sometime soon automatically (usually at the end of the current frame). More... | |
Protected Member Functions | |
| virtual void | Init ()=0 |
Protected Attributes | |
| bool | m_bInit |
| CGUIResource * | m_objResource |
| int | m_eStyle |
| Protected Attributes inherited from ParaEngine::IObject | |
| WeakPtr_type | m_weak_reference |
| Protected Attributes inherited from ParaEngine::CRefCounted | |
| int | m_refcount |
Friends | |
| class | CGUIHighlightManager |
Additional Inherited Members | |
| Public Types inherited from ParaEngine::IObject | |
| typedef ParaEngine::weak_ptr< IObject > | WeakPtr_type |
Detailed Description
An abstract class "4outsideArrow", 4 arrows pointing from outside to the edge of the control "4insideArrow, 4 arrows pointing from the edge of the control to the center of the control.
Member Function Documentation
§ Render()
|
pure virtual |
Render the Highlight effect.
If the effect is not properly initialize, it will call Init() to initialize it
- Parameters
-
pGUIState the same meaning as other GUI object rcScreen the edge rectangle of the control we want to highlight fElapsedTime the same meaning as other GUI object.
Implemented in ParaEngine::CGUINStageAnimation, and ParaEngine::CGUI4OutsideArrow.
§ SetParameter()
|
pure virtual |
Set effect parameter.
the value will be properly translated to correct type.
- Parameters
-
szName name of the parameter szValue new value of the parameter
- Returns
- : false if the given parameter does not exist or the new value is not acceptable.
Implemented in ParaEngine::CGUINStageAnimation, and ParaEngine::CGUI4OutsideArrow.
The documentation for this class was generated from the following file:
- Client/trunk/ParaEngineClient/2dengine/GUIHighlight.h
