Public Methods |
| | GuiElement (const String &name) |
| | Constructor: do not call direct, use GuiManager::createElement. More...
|
| virtual | ~GuiElement () |
| const String & | getName (void) const |
| | Gets the name of this overlay. More...
|
| void | show (void) |
| | Shows this element if it was hidden. More...
|
| void | hide (void) |
| | Hides this element if it was visible. More...
|
| bool | isVisible (void) |
| | Returns whether or not the element is visible. More...
|
| void | setDimensions (Real width, Real height) |
| | Sets the dimensions of this element in relation to the screen (1.0 = screen width/height). More...
|
| void | setPosition (Real left, Real top) |
| | Sets the position of the top-left corner of the element, relative to the screen size (1.0 = screen width / height). More...
|
| void | setWidth (Real width) |
| | Sets the width of this element in relation to the screen (where 1.0 = screen width). More...
|
| Real | getWidth (void) const |
| | Gets the width of this element in relation to the screen (where 1.0 = screen width). More...
|
| void | setHeight (Real height) |
| | Sets the height of this element in relation to the screen (where 1.0 = screen height). More...
|
| Real | getHeight (void) const |
| | Gets the height of this element in relation to the screen (where 1.0 = screen height). More...
|
| void | setLeft (Real left) |
| | Sets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right). More...
|
| Real | getLeft (void) const |
| | Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right). More...
|
| void | setTop (Real Top) |
| | Sets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom). More...
|
| Real | getTop (void) const |
| | Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom). More...
|
| virtual const String & | getMaterialName (void) const |
| | Gets the name of the material this element uses. More...
|
| virtual void | setMaterialName (const String &matName) |
| | Sets the name of the material this element will use. More...
|
| Material * | getMaterial (void) const |
| | See Renderable. More...
|
| void | getWorldTransforms (Matrix4 *xform) |
| | See Renderable. More...
|
| bool | useIdentityProjection (void) |
| | See Renderable. More...
|
| bool | useIdentityView (void) |
| | See Renderable. More...
|
| virtual void | _update (void) |
| | Internal method to update the element based on transforms applied. More...
|
| virtual void | _updateFromParent (void) |
| | Updates this elements transform based on it's parent. More...
|
| virtual void | _notifyParent (GuiContainer *parent, Overlay *overlay) |
| | Internal method for notifying the gui element of it's parent and ultimate overlay. More...
|
| virtual Real | _getDerivedLeft (void) |
| | Gets the 'left' position as derived from own left and that of parents. More...
|
| virtual Real | _getDerivedTop (void) |
| | Gets the 'top' position as derived from own left and that of parents. More...
|
| virtual void | _notifyZOrder (ushort newZOrder) |
| | Internal method to notify the element when Zorder of parent overlay has changed. More...
|
| virtual void | _updateRenderQueue (RenderQueue *queue) |
| | Internal method to put the contents onto the render queue. More...
|
| virtual const String & | getTypeName (void)=0 |
| | Gets the type name of the element. More...
|
| virtual void | setCaption (const String &text) |
| | Sets the caption on elements that support it. More...
|
| virtual const String & | getCaption (void) const |
| | Gets the caption for this element. More...
|
| virtual void | setMetricsMode (GuiMetricsMode gmm) |
| | Tells this element how to interpret the position and dimension values it is given. More...
|
| virtual GuiMetricsMode | getMetricsMode (void) |
| | Retrieves the current settings of how the element metrics are interpreted. More...
|
| virtual void | setHorizontalAlignment (GuiHorizontalAlignment gha) |
| | Sets the horizontal origin for this element. More...
|
| virtual GuiHorizontalAlignment | getHorizontalAlignment (void) |
| | Gets the horizontal alignment for this element. More...
|
| virtual void | setVerticalAlignment (GuiVerticalAlignment gva) |
| | Sets the vertical origin for this element. More...
|
| virtual GuiVerticalAlignment | getVerticalAlignment (void) |
| | Gets the vertical alignment for this element. More...
|
| virtual bool | contains (Real x, Real y) const |
| | Returns true if xy is within the constraints of the component. More...
|
| virtual GuiElement * | findElementAt (Real x, Real y) |
| | Returns true if xy is within the constraints of the component. More...
|
| virtual void | processEvent (InputEvent *e) |
| | Processes events occurring on this component. More...
|
| virtual bool | isContainer () |
| | returns false as this class is not a container type. More...
|
| virtual bool | isCloneable () |
| virtual void | setCloneable (bool c) |
| PositionTarget * | getPositionTargetParent () |
| | Returns the parent container. More...
|
| GuiContainer * | getParent () |
| | Returns the parent container. More...
|
| ushort | getZOrder () const |
| | Returns the zOrder of the element. More...
|
| Real | getSquaredViewDepth (const Camera *cam) const |
| | Overridden from Renderable. More...
|
| void | copyFromTemplate (GuiElement *templateGui) |
| ParamDictionary * | getParamDictionary (void) |
| | Retrieves the parameter dictionary for this class. More...
|
| const ParameterList & | getParameters (void) |
| | Retrieves a list of parameters valid for this object. More...
|
| virtual bool | setParameter (const String &name, const String &value) |
| | Generic parameter setting method. More...
|
| virtual String | getParameter (const String &name) |
| | Generic parameter retrieval method. More...
|
| virtual void | copyParametersTo (StringInterface *dest) |
| | Method for copying this object's parameters to another object. More...
|
| virtual void | getRenderOperation (RenderOperation &rend)=0 |
| | Gets the render operation required to send this object to the frame buffer. More...
|
| virtual unsigned short | getNumWorldTransforms (void) |
| | Returns the number of world transform matrices this renderable requires. More...
|
| virtual SceneDetailLevel | getRenderDetail () |
| | Returns the preferred rasterisation mode of this renderable. More...
|
| void | processMouseEvent (MouseEvent *e) |
| void | addMouseListener (MouseListener *l) |
| void | removeMouseListener (MouseListener *l) |
| void | processMouseMotionEvent (MouseEvent *e) |
| void | addMouseMotionListener (MouseMotionListener *l) |
| void | removeMouseMotionListener (MouseMotionListener *l) |
Protected Methods |
| virtual void | updatePositionGeometry (void)=0 |
| | Internal method which is triggered when the positions of the element get updated, meaning the element should be rebuilding it's mesh positions. More...
|
| virtual void | addBaseParameters (void) |
| | Internal method for setting up the basic parameter definitions for a subclass. More...
|
| bool | createParamDictionary (const String &className) |
| | Internal method for creating a parameter dictionary for the class, if it does not already exist. More...
|
Protected Attributes |
| String | mName |
| bool | mVisible |
| bool | mCloneable |
| Real | mLeft |
| Real | mTop |
| Real | mWidth |
| Real | mHeight |
| String | mMaterialName |
| Material * | mpMaterial |
| String | mCaption |
| GuiMetricsMode | mMetricsMode |
| GuiHorizontalAlignment | mHorzAlign |
| GuiVerticalAlignment | mVertAlign |
| short | mPixelTop |
| short | mPixelLeft |
| short | mPixelWidth |
| short | mPixelHeight |
| GuiContainer * | mParent |
| Overlay * | mOverlay |
| Real | mDerivedLeft |
| Real | mDerivedTop |
| bool | mDerivedOutOfDate |
| bool | mGeomPositionsOutOfDate |
| | Falg indicating if the vertex positons need recalculating. More...
|
| ushort | mZOrder |
| String | mParamDictName |
| | Class name for this instance to be used as a lookup (must be initialised by subclasses). More...
|
| MouseListener * | mMouseListener |
| MouseMotionListener * | mMouseMotionListener |
Static Protected Attributes |
| GuiElementCommands::CmdLeft | msLeftCmd |
| GuiElementCommands::CmdTop | msTopCmd |
| GuiElementCommands::CmdWidth | msWidthCmd |
| GuiElementCommands::CmdHeight | msHeightCmd |
| GuiElementCommands::CmdMaterial | msMaterialCmd |
| GuiElementCommands::CmdCaption | msCaptionCmd |
| GuiElementCommands::CmdMetricsMode | msMetricsModeCmd |
| GuiElementCommands::CmdHorizontalAlign | msHorizontalAlignCmd |
| GuiElementCommands::CmdVerticalAlign | msVerticalAlignCmd |
| ParamDictionaryMap | msDictionary |
| | Dictionary of parameters. More...
|