Abstract definition of a 2D element to be displayed in an Overlay. More...
#include <OgreOverlayElement.h>
Public Member Functions | |
OverlayElement (const String &name) | |
Constructor: do not call direct, use OverlayManager::createElement. More... | |
virtual | ~OverlayElement () |
virtual void | _getClippingRegion (RealRect &clippingRegion) |
Gets the clipping region of the element. 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... | |
Real | _getHeight (void) const |
Gets the height of this element in relation to the screen (where 1.0 = screen height) 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... | |
virtual Real | _getRelativeHeight (void) |
Gets the 'height' as derived from own height and metrics mode. More... | |
virtual Real | _getRelativeWidth (void) |
Gets the 'width' as derived from own width and metrics mode. More... | |
Real | _getTop (void) const |
Gets the top of this element in relation to the screen (where 0 = far left, 1.0 = far right) More... | |
Real | _getWidth (void) const |
Gets the width of this element in relation to the screen (where 1.0 = screen width) More... | |
virtual void | _notifyParent (OverlayContainer *parent, Overlay *overlay) |
Internal method for notifying the GUI element of it's parent and ultimate overlay. More... | |
virtual void | _notifyViewport () |
Internal method to notify the element when the viewport of parent overlay has changed. More... | |
virtual void | _notifyWorldTransforms (const Matrix4 &xform) |
Internal method to notify the element when it's world transform of parent overlay has changed. More... | |
virtual ushort | _notifyZOrder (ushort newZOrder) |
Internal method to notify the element when Z-order of parent overlay has changed. More... | |
virtual void | _positionsOutOfDate (void) |
Tell the object to recalculate. More... | |
void | _setDimensions (Real width, Real height) |
Sets the width and height 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 width) More... | |
void | _setLeft (Real left) |
Sets the left of this element in relation to the screen (where 1.0 = screen width) More... | |
void | _setParent (OverlayContainer *parent) |
void | _setPosition (Real left, Real top) |
Sets the left and top of this element in relation to the screen (where 1.0 = screen width) More... | |
void | _setTop (Real top) |
Sets the top of this element in relation to the screen (where 1.0 = screen width) More... | |
void | _setWidth (Real width) |
Sets the width of this element in relation to the screen (where 1.0 = screen width) More... | |
virtual void | _update (void) |
Internal method to update the element based on transforms applied. More... | |
virtual void | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const |
Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. More... | |
virtual void | _updateFromParent (void) |
Updates this elements transform based on it's parent. More... | |
virtual void | _updateRenderQueue (RenderQueue *queue) |
Internal method to put the contents onto the render queue. More... | |
virtual OverlayElement * | clone (const String &instanceName) |
virtual bool | contains (Real x, Real y) const |
Returns true if xy is within the constraints of the component. More... | |
virtual void | copyFromTemplate (OverlayElement *templateOverlay) |
virtual void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. More... | |
virtual OverlayElement * | findElementAt (Real x, Real y) |
Returns true if xy is within the constraints of the component. More... | |
virtual const DisplayString & | getCaption (void) const |
Gets the caption for this element. More... | |
virtual bool | getCastsShadows (void) const |
Method which reports whether this renderable would normally cast a shadow. More... | |
virtual const ColourValue & | getColour (void) const |
Gets the colour for this element. More... | |
const Vector4 & | getCustomParameter (size_t index) const |
Gets the custom value associated with this Renderable at the given index. More... | |
Real | getHeight (void) const |
Gets the height of this element in relation to the screen (where 1.0 = screen height) More... | |
virtual GuiHorizontalAlignment | getHorizontalAlignment (void) const |
Gets the horizontal alignment for this element. 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... | |
const LightList & | getLights (void) const |
Gets a list of lights, ordered relative to how close they are to this renderable. More... | |
const MaterialPtr & | getMaterial (void) const |
See Renderable. More... | |
virtual const String & | getMaterialName (void) const |
Gets the name of the material this element uses. More... | |
virtual GuiMetricsMode | getMetricsMode (void) const |
Retrieves the current settings of how the element metrics are interpreted. More... | |
const String & | getName (void) const |
Gets the name of this overlay. More... | |
virtual unsigned short | getNumWorldTransforms (void) const |
Returns the number of world transform matrices this renderable requires. More... | |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. More... | |
const ParamDictionary * | getParamDictionary (void) const |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. More... | |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. More... | |
OverlayContainer * | getParent () |
Returns the parent container. More... | |
virtual bool | getPolygonModeOverrideable (void) const |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. More... | |
virtual void | getRenderOperation (RenderOperation &op)=0 |
Gets the render operation required to send this object to the frame buffer. More... | |
virtual RenderSystemData * | getRenderSystemData () const |
Gets RenderSystem private data. More... | |
const OverlayElement * | getSourceTemplate () const |
Returns the SourceTemplate for this element. More... | |
Real | getSquaredViewDepth (const Camera *cam) const |
Overridden from Renderable. More... | |
virtual Technique * | getTechnique (void) const |
Retrieves a pointer to the Material Technique this renderable object uses. 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 & | getTypeName (void) const =0 |
Gets the type name of the element. More... | |
bool | getUseIdentityProjection (void) const |
Returns whether or not to use an 'identity' projection. More... | |
bool | getUseIdentityView (void) const |
Returns whether or not to use an 'identity' view. More... | |
virtual OGRE_DEPRECATED const Any & | getUserAny (void) const |
UserObjectBindings & | getUserObjectBindings () |
Return an instance of user objects binding associated with this class. More... | |
const UserObjectBindings & | getUserObjectBindings () const |
Return an instance of user objects binding associated with this class. More... | |
virtual GuiVerticalAlignment | getVerticalAlignment (void) const |
Gets the vertical alignment for this element. More... | |
Real | getWidth (void) const |
Gets the width of this element in relation to the screen (where 1.0 = screen width) More... | |
void | getWorldTransforms (Matrix4 *xform) const |
See Renderable. More... | |
ushort | getZOrder () const |
Returns the zOrder of the element. More... | |
bool | hasCustomParameter (size_t index) const |
Checks whether a custom value is associated with this Renderable at the given index. More... | |
virtual void | hide (void) |
Hides this element if it was visible. More... | |
virtual void | initialise (void)=0 |
Initialise gui element. More... | |
virtual bool | isCloneable () const |
virtual bool | isContainer () const |
returns false as this class is not a container type More... | |
bool | isEnabled () const |
virtual bool | isKeyEnabled () const |
bool | isVisible (void) const |
Returns whether or not the element is visible. More... | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete (void *ptr, const char *, int, const char *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *ptr, const char *, int, const char *) |
void * | operator new (size_t sz, const char *file, int line, const char *func) |
operator new, with debug line info More... | |
void * | operator new (size_t sz) |
void * | operator new (size_t sz, void *ptr) |
placement operator new More... | |
void * | operator new[] (size_t sz, const char *file, int line, const char *func) |
array operator new, with debug line info More... | |
void * | operator new[] (size_t sz) |
virtual void | postRender (SceneManager *sm, RenderSystem *rsys) |
Called immediately after the Renderable has been rendered. More... | |
virtual bool | preRender (SceneManager *sm, RenderSystem *rsys) |
Called just prior to the Renderable being rendered. More... | |
void | removeCustomParameter (size_t index) |
Removes a custom value which is associated with this Renderable at the given index. More... | |
virtual void | setCaption (const DisplayString &text) |
Sets the caption on elements that support it. More... | |
virtual void | setCloneable (bool c) |
virtual void | setColour (const ColourValue &col) |
Sets the colour on elements that support it. More... | |
void | setCustomParameter (size_t index, const Vector4 &value) |
Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters. More... | |
void | setDimensions (Real width, Real height) |
Sets the dimensions of this element in relation to the screen (1.0 = screen width/height). More... | |
virtual void | setEnabled (bool b) |
void | setHeight (Real height) |
Sets the height of this element in relation to the screen (where 1.0 = screen height) More... | |
virtual void | setHorizontalAlignment (GuiHorizontalAlignment gha) |
Sets the horizontal origin for this element. 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... | |
virtual void | setMaterialName (const String &matName) |
Sets the name of the material this element will use. More... | |
virtual void | setMetricsMode (GuiMetricsMode gmm) |
Tells this element how to interpret the position and dimension values it is given. More... | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. More... | |
virtual void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. More... | |
virtual void | setPolygonModeOverrideable (bool override) |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. 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... | |
virtual void | setRenderSystemData (RenderSystemData *val) const |
Sets RenderSystem private data. More... | |
void | setTop (Real Top) |
Sets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom) More... | |
void | setUseIdentityProjection (bool useIdentityProjection) |
Sets whether or not to use an 'identity' projection. More... | |
void | setUseIdentityView (bool useIdentityView) |
Sets whether or not to use an 'identity' view. More... | |
virtual OGRE_DEPRECATED void | setUserAny (const Any &anything) |
virtual void | setVerticalAlignment (GuiVerticalAlignment gva) |
Sets the vertical origin for this element. More... | |
void | setWidth (Real width) |
Sets the width of this element in relation to the screen (where 1.0 = screen width) More... | |
virtual void | show (void) |
Shows this element if it was hidden. More... | |
void | visitRenderables (Renderable::Visitor *visitor, bool debugRenderables=false) |
Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any. More... | |
Static Public Member Functions | |
static void | cleanupDictionary () |
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g. More... | |
Protected Types | |
typedef map< size_t, Vector4 > ::type | CustomParameterMap |
Protected Member Functions | |
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... | |
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 | updateTextureGeometry (void)=0 |
Internal method which is triggered when the UVs of the element get updated, meaning the element should be rebuilding it's mesh UVs. More... | |
Abstract definition of a 2D element to be displayed in an Overlay.
Definition at line 108 of file OgreOverlayElement.h.
|
protectedinherited |
Definition at line 414 of file OgreRenderable.h.
Ogre::OverlayElement::OverlayElement | ( | const String & | name | ) |
Constructor: do not call direct, use OverlayManager::createElement.
|
virtual |
|
virtual |
Gets the clipping region of the element.
|
virtual |
Gets the 'left' position as derived from own left and that of parents.
|
virtual |
Gets the 'top' position as derived from own left and that of parents.
|
inline |
Gets the height of this element in relation to the screen (where 1.0 = screen height)
Definition at line 262 of file OgreOverlayElement.h.
|
inline |
Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)
Definition at line 256 of file OgreOverlayElement.h.
|
virtual |
Gets the 'height' as derived from own height and metrics mode.
|
virtual |
Gets the 'width' as derived from own width and metrics mode.
|
inline |
Gets the top of this element in relation to the screen (where 0 = far left, 1.0 = far right)
Definition at line 258 of file OgreOverlayElement.h.
|
inline |
Gets the width of this element in relation to the screen (where 1.0 = screen width)
Definition at line 260 of file OgreOverlayElement.h.
|
virtual |
Internal method for notifying the GUI element of it's parent and ultimate overlay.
Reimplemented in Ogre::OverlayContainer.
|
virtual |
Internal method to notify the element when the viewport of parent overlay has changed.
Reimplemented in Ogre::OverlayContainer.
|
virtual |
Internal method to notify the element when it's world transform of parent overlay has changed.
Reimplemented in Ogre::OverlayContainer.
Internal method to notify the element when Z-order of parent overlay has changed.
Reimplemented in Ogre::OverlayContainer.
|
virtual |
Tell the object to recalculate.
Reimplemented in Ogre::OverlayContainer.
Sets the width and height of this element in relation to the screen (where 1.0 = screen width)
void Ogre::OverlayElement::_setHeight | ( | Real | height | ) |
Sets the height of this element in relation to the screen (where 1.0 = screen width)
void Ogre::OverlayElement::_setLeft | ( | Real | left | ) |
Sets the left of this element in relation to the screen (where 1.0 = screen width)
|
inline |
Definition at line 460 of file OgreOverlayElement.h.
Sets the left and top of this element in relation to the screen (where 1.0 = screen width)
void Ogre::OverlayElement::_setTop | ( | Real | top | ) |
Sets the top of this element in relation to the screen (where 1.0 = screen width)
void Ogre::OverlayElement::_setWidth | ( | Real | width | ) |
Sets the width of this element in relation to the screen (where 1.0 = screen width)
|
virtual |
Internal method to update the element based on transforms applied.
Reimplemented in Ogre::BorderPanelOverlayElement, Ogre::TextAreaOverlayElement, and Ogre::OverlayContainer.
|
inlinevirtualinherited |
Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows.
constantEntry | The auto constant entry referring to the parameter being updated |
params | The parameters object which this method should call to set the updated parameters. |
Reimplemented in Ogre::SubEntity.
Definition at line 307 of file OgreRenderable.h.
References Ogre::GpuProgramParameters::_writeRawConstant(), Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::elementCount, and Ogre::GpuProgramParameters::AutoConstantEntry::physicalIndex.
|
virtual |
Updates this elements transform based on it's parent.
|
virtual |
Internal method to put the contents onto the render queue.
Reimplemented in Ogre::BorderPanelOverlayElement, Ogre::OverlayContainer, and Ogre::PanelOverlayElement.
|
protectedvirtual |
Internal method for setting up the basic parameter definitions for a subclass.
Reimplemented in Ogre::BorderPanelOverlayElement, Ogre::TextAreaOverlayElement, and Ogre::PanelOverlayElement.
|
staticinherited |
Cleans up the static 'msDictionary' required to reset Ogre, otherwise the containers are left with invalid pointers, which will lead to a crash as soon as one of the ResourceManager implementers (e.g.
MaterialManager) initializes.
|
virtual |
Reimplemented in Ogre::OverlayContainer.
Returns true if xy is within the constraints of the component.
|
virtual |
Reimplemented in Ogre::OverlayContainer.
|
inlinevirtualinherited |
Method for copying this object's parameters to another object.
dest | Pointer to object to have it's parameters set the same as this object. |
Definition at line 303 of file OgreStringInterface.h.
References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().
|
inlineprotectedinherited |
Internal method for creating a parameter dictionary for the class, if it does not already exist.
className | the name of the class using the dictionary |
Definition at line 186 of file OgreStringInterface.h.
References OGRE_LOCK_MUTEX.
|
virtual |
Returns true if xy is within the constraints of the component.
Reimplemented in Ogre::OverlayContainer.
|
virtual |
Gets the caption for this element.
|
inlinevirtualinherited |
Method which reports whether this renderable would normally cast a shadow.
Reimplemented in Ogre::TerrainQuadTreeNode::Rend, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, and Ogre::StaticGeometry::GeometryBucket.
Definition at line 224 of file OgreRenderable.h.
|
virtual |
Gets the colour for this element.
Reimplemented in Ogre::TextAreaOverlayElement.
|
inlineinherited |
Gets the custom value associated with this Renderable at the given index.
index | Index of the parameter to retrieve. |
Definition at line 268 of file OgreRenderable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
Real Ogre::OverlayElement::getHeight | ( | void | ) | const |
Gets the height of this element in relation to the screen (where 1.0 = screen height)
|
virtual |
Gets the horizontal alignment for this element.
Real Ogre::OverlayElement::getLeft | ( | void | ) | const |
Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)
|
inlinevirtual |
Gets a list of lights, ordered relative to how close they are to this renderable.
Implements Ogre::Renderable.
Definition at line 476 of file OgreOverlayElement.h.
|
virtual |
|
virtual |
Gets the name of the material this element uses.
|
virtual |
Retrieves the current settings of how the element metrics are interpreted.
const String& Ogre::OverlayElement::getName | ( | void | ) | const |
Gets the name of this overlay.
Referenced by Ogre::OverlayContainer::_removeChild().
|
inlinevirtualinherited |
Returns the number of world transform matrices this renderable requires.
Reimplemented in Ogre::BorderRenderable, Ogre::SubEntity, Ogre::InstancedGeometry::GeometryBucket, Ogre::BaseInstanceBatchVTF, Ogre::InstanceBatchHW, and Ogre::InstanceBatchShader.
Definition at line 153 of file OgreRenderable.h.
|
inlineinherited |
Retrieves the parameter dictionary for this class.
Definition at line 219 of file OgreStringInterface.h.
|
inlineinherited |
Definition at line 224 of file OgreStringInterface.h.
|
inlinevirtualinherited |
Generic parameter retrieval method.
name | The name of the parameter to get |
Definition at line 272 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().
|
inherited |
Retrieves a list of parameters valid for this object.
OverlayContainer* Ogre::OverlayElement::getParent | ( | ) |
Returns the parent container.
|
inlinevirtualinherited |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
Reimplemented in Ogre::BorderRenderable.
Definition at line 332 of file OgreRenderable.h.
|
pure virtualinherited |
Gets the render operation required to send this object to the frame buffer.
Implemented in Ogre::BillboardSet, Ogre::Frustum, Ogre::ManualObject::ManualObjectSection, Ogre::TerrainQuadTreeNode::Rend, Ogre::InstanceBatch, Ogre::BorderRenderable, Ogre::BillboardChain, Ogre::StaticGeometry::GeometryBucket, Ogre::SubEntity, Ogre::Node::DebugRenderable, Ogre::PanelOverlayElement, Ogre::SimpleRenderable, Ogre::TextAreaOverlayElement, and Ogre::ShadowRenderable.
|
inlinevirtualinherited |
Gets RenderSystem private data.
Definition at line 399 of file OgreRenderable.h.
|
inline |
Returns the SourceTemplate for this element.
Definition at line 487 of file OgreOverlayElement.h.
Overridden from Renderable.
Implements Ogre::Renderable.
Definition at line 469 of file OgreOverlayElement.h.
|
inlinevirtualinherited |
Retrieves a pointer to the Material Technique this renderable object uses.
Reimplemented in Ogre::TerrainQuadTreeNode::Rend, Ogre::InstanceBatch, Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 94 of file OgreRenderable.h.
Real Ogre::OverlayElement::getTop | ( | void | ) | const |
Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom)
|
pure virtual |
Gets the type name of the element.
All concrete subclasses must implement this.
Implemented in Ogre::PanelOverlayElement, Ogre::TextAreaOverlayElement, and Ogre::BorderPanelOverlayElement.
|
inlineinherited |
Returns whether or not to use an 'identity' projection.
Definition at line 178 of file OgreRenderable.h.
|
inlineinherited |
Returns whether or not to use an 'identity' view.
Definition at line 203 of file OgreRenderable.h.
|
inlinevirtualinherited |
Definition at line 349 of file OgreRenderable.h.
|
inlineinherited |
Return an instance of user objects binding associated with this class.
You can use it to associate one or more custom objects with this class instance.
Definition at line 355 of file OgreRenderable.h.
|
inlineinherited |
Return an instance of user objects binding associated with this class.
You can use it to associate one or more custom objects with this class instance.
Definition at line 361 of file OgreRenderable.h.
|
virtual |
Gets the vertical alignment for this element.
Real Ogre::OverlayElement::getWidth | ( | void | ) | const |
Gets the width of this element in relation to the screen (where 1.0 = screen width)
|
virtual |
See Renderable.
Implements Ogre::Renderable.
|
inline |
Returns the zOrder of the element.
Definition at line 465 of file OgreOverlayElement.h.
|
inlineinherited |
Checks whether a custom value is associated with this Renderable at the given index.
index | Index of the parameter to check for existence. |
Definition at line 259 of file OgreRenderable.h.
|
virtual |
Hides this element if it was visible.
|
pure virtual |
Initialise gui element.
Implemented in Ogre::OverlayContainer, Ogre::PanelOverlayElement, Ogre::BorderPanelOverlayElement, and Ogre::TextAreaOverlayElement.
|
inlinevirtual |
Definition at line 450 of file OgreOverlayElement.h.
|
inlinevirtual |
returns false as this class is not a container type
Reimplemented in Ogre::OverlayContainer.
Definition at line 444 of file OgreOverlayElement.h.
bool Ogre::OverlayElement::isEnabled | ( | ) | const |
|
inlinevirtual |
Definition at line 447 of file OgreOverlayElement.h.
bool Ogre::OverlayElement::isVisible | ( | void | ) | const |
Returns whether or not the element is visible.
|
inlineinherited |
Definition at line 96 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 102 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 108 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 113 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 119 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
operator new, with debug line info
Definition at line 68 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 73 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
placement operator new
Definition at line 79 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
array operator new, with debug line info
Definition at line 86 of file OgreMemoryAllocatedObject.h.
|
inlineinherited |
Definition at line 91 of file OgreMemoryAllocatedObject.h.
|
inlinevirtualinherited |
Called immediately after the Renderable has been rendered.
Definition at line 128 of file OgreRenderable.h.
|
inlinevirtualinherited |
Called just prior to the Renderable being rendered.
Reimplemented in Ogre::BillboardChain.
Definition at line 123 of file OgreRenderable.h.
|
inlineinherited |
Removes a custom value which is associated with this Renderable at the given index.
index | Index of the parameter to remove. |
Definition at line 250 of file OgreRenderable.h.
|
virtual |
Sets the caption on elements that support it.
Reimplemented in Ogre::TextAreaOverlayElement.
|
inlinevirtual |
Definition at line 453 of file OgreOverlayElement.h.
|
virtual |
Sets the colour on elements that support it.
Reimplemented in Ogre::TextAreaOverlayElement.
|
inlineinherited |
Sets a custom parameter for this Renderable, which may be used to drive calculations for this specific Renderable, like GPU program parameters.
index | The index with which to associate the value. Note that this does not have to start at 0, and can include gaps. It also has no direct correlation with a GPU program parameter index - the mapping between the two is performed by the ACT_CUSTOM entry, if that is used. |
value | The value to associate. |
Definition at line 241 of file OgreRenderable.h.
Sets the dimensions of this element in relation to the screen (1.0 = screen width/height).
|
virtual |
void Ogre::OverlayElement::setHeight | ( | Real | height | ) |
Sets the height of this element in relation to the screen (where 1.0 = screen height)
|
virtual |
Sets the horizontal origin for this element.
void Ogre::OverlayElement::setLeft | ( | Real | left | ) |
Sets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)
|
virtual |
Sets the name of the material this element will use.
Reimplemented in Ogre::PanelOverlayElement, and Ogre::TextAreaOverlayElement.
|
virtual |
Tells this element how to interpret the position and dimension values it is given.
Reimplemented in Ogre::BorderPanelOverlayElement, and Ogre::TextAreaOverlayElement.
|
virtualinherited |
Generic parameter setting method.
name | The name of the parameter to set |
value | String value. Must be in the right format for the type specified in the parameter definition. See the StringConverter class for more information. |
Referenced by Ogre::StringInterface::copyParametersTo().
|
virtualinherited |
Generic multiple parameter setting method.
paramList | Name/value pair list |
|
inlinevirtualinherited |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
override | true means that a lower camera detail will override this renderables detail level, false means it won't. |
Definition at line 324 of file OgreRenderable.h.
Sets the position of the top-left corner of the element, relative to the screen size (1.0 = screen width / height)
|
inlinevirtualinherited |
Sets RenderSystem private data.
Definition at line 407 of file OgreRenderable.h.
void Ogre::OverlayElement::setTop | ( | Real | Top | ) |
Sets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom)
|
inlineinherited |
Sets whether or not to use an 'identity' projection.
Definition at line 164 of file OgreRenderable.h.
|
inlineinherited |
Sets whether or not to use an 'identity' view.
Definition at line 189 of file OgreRenderable.h.
|
inlinevirtualinherited |
Sets any kind of user value on this object.
Definition at line 344 of file OgreRenderable.h.
|
virtual |
Sets the vertical origin for this element.
void Ogre::OverlayElement::setWidth | ( | Real | width | ) |
Sets the width of this element in relation to the screen (where 1.0 = screen width)
|
virtual |
Shows this element if it was hidden.
|
protectedpure virtual |
Internal method which is triggered when the positions of the element get updated, meaning the element should be rebuilding it's mesh positions.
Abstract since subclasses must implement this.
Implemented in Ogre::BorderPanelOverlayElement, Ogre::TextAreaOverlayElement, and Ogre::PanelOverlayElement.
|
protectedpure virtual |
Internal method which is triggered when the UVs of the element get updated, meaning the element should be rebuilding it's mesh UVs.
Abstract since subclasses must implement this.
Implemented in Ogre::BorderPanelOverlayElement, Ogre::TextAreaOverlayElement, and Ogre::PanelOverlayElement.
void Ogre::OverlayElement::visitRenderables | ( | Renderable::Visitor * | visitor, |
bool | debugRenderables = false |
||
) |
Method to allow a caller to abstractly iterate over the Renderable instances that this MovableObject will add to the render queue when asked, if any.
visitor | Pointer to a class implementing the Renderable::Visitor interface which will be called back for each Renderable which will be queued. Bear in mind that the state of the Renderable instances may not be finalised depending on when you call this. |
debugRenderables | If false, only regular renderables will be visited (those for normal display). If true, debug renderables will be included too. |
|
protected |
Definition at line 135 of file OgreOverlayElement.h.
|
protected |
Definition at line 137 of file OgreOverlayElement.h.
|
protected |
Definition at line 128 of file OgreOverlayElement.h.
|
protected |
Definition at line 136 of file OgreOverlayElement.h.
|
protectedinherited |
Definition at line 415 of file OgreRenderable.h.
|
protected |
Definition at line 157 of file OgreOverlayElement.h.
|
protected |
Definition at line 159 of file OgreOverlayElement.h.
|
protected |
Definition at line 158 of file OgreOverlayElement.h.
|
protected |
Is element enabled?
Definition at line 174 of file OgreOverlayElement.h.
|
protected |
Flag indicating if the vertex positions need recalculating.
Definition at line 162 of file OgreOverlayElement.h.
|
protected |
Flag indicating if the vertex uvs need recalculating.
Definition at line 164 of file OgreOverlayElement.h.
|
protected |
Definition at line 132 of file OgreOverlayElement.h.
|
protected |
Definition at line 140 of file OgreOverlayElement.h.
|
protected |
Is element initialised?
Definition at line 177 of file OgreOverlayElement.h.
|
protected |
Definition at line 129 of file OgreOverlayElement.h.
|
protected |
Definition at line 134 of file OgreOverlayElement.h.
|
protected |
Definition at line 133 of file OgreOverlayElement.h.
|
protected |
Definition at line 139 of file OgreOverlayElement.h.
|
protected |
Definition at line 126 of file OgreOverlayElement.h.
|
protected |
Overlay attached to.
Definition at line 154 of file OgreOverlayElement.h.
|
protected |
Parent pointer.
Definition at line 152 of file OgreOverlayElement.h.
|
protected |
Definition at line 147 of file OgreOverlayElement.h.
|
protected |
Definition at line 145 of file OgreOverlayElement.h.
|
protected |
Definition at line 148 of file OgreOverlayElement.h.
|
protected |
Definition at line 149 of file OgreOverlayElement.h.
|
protected |
Definition at line 144 of file OgreOverlayElement.h.
|
protected |
Definition at line 146 of file OgreOverlayElement.h.
|
protectedinherited |
Definition at line 416 of file OgreRenderable.h.
|
mutableprotectedinherited |
User objects binding.
Definition at line 420 of file OgreRenderable.h.
|
staticprotected |
Definition at line 119 of file OgreOverlayElement.h.
|
staticprotected |
Definition at line 117 of file OgreOverlayElement.h.
|
staticprotected |
Definition at line 121 of file OgreOverlayElement.h.
|
staticprotected |
Definition at line 114 of file OgreOverlayElement.h.
|
staticprotected |
Definition at line 118 of file OgreOverlayElement.h.
|
staticprotected |
Definition at line 120 of file OgreOverlayElement.h.
|
protected |
Used to see if this element is created from a Template.
Definition at line 180 of file OgreOverlayElement.h.
|
staticprotected |
Definition at line 115 of file OgreOverlayElement.h.
|
staticprotected |
Definition at line 122 of file OgreOverlayElement.h.
|
staticprotected |
Definition at line 123 of file OgreOverlayElement.h.
|
staticprotected |
Definition at line 116 of file OgreOverlayElement.h.
|
protected |
Definition at line 130 of file OgreOverlayElement.h.
|
protectedinherited |
Definition at line 417 of file OgreRenderable.h.
|
protectedinherited |
Definition at line 418 of file OgreRenderable.h.
|
protectedinherited |
Definition at line 419 of file OgreRenderable.h.
|
protected |
Definition at line 141 of file OgreOverlayElement.h.
|
protected |
Definition at line 127 of file OgreOverlayElement.h.
|
protected |
Definition at line 131 of file OgreOverlayElement.h.
|
protected |
World transforms.
Definition at line 171 of file OgreOverlayElement.h.
|
protected |
Zorder for when sending to render queue.
Derived from parent
Definition at line 168 of file OgreOverlayElement.h.