OGRE
2.2.4
Object-Oriented Graphics Rendering Engine
|
Abstract definition of a 2D element to be displayed in an Overlay. More...
#include <OgreOverlayElement.h>
Public Types | |
typedef map< size_t, Vector4 >::type | CustomParameterMap |
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 | _positionsOutOfDate (void) |
Tell the object to recalculate. More... | |
virtual void | _releaseManualHardwareResources () |
Notifies that hardware resources were lost. More... | |
virtual void | _restoreManualHardwareResources () |
Notifies that hardware resources should be restored. 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... | |
virtual void | _setHlmsHashes (uint32 hash, uint32 casterHash) |
Manually sets the hlms hashes. Don't call this directly. More... | |
void | _setLeft (Real left) |
Sets the left of this element in relation to the screen (where 1.0 = screen width) More... | |
virtual void | _setNullDatablock (void) |
Sets the datablock to a null pointer. 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, Camera *camera, const Camera *lodCamera) |
Internal method to put the contents onto the render queue. More... | |
void | addPoseWeight (size_t index, float w) |
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... | |
uint8 | getCurrentMaterialLod (void) const |
const Vector4 & | getCustomParameter (size_t index) const |
Gets the custom value associated with this Renderable at the given index. More... | |
const CustomParameterMap & | getCustomParameters (void) const |
HlmsDatablock * | getDatablock (void) const |
Real | getHeight (void) const |
Gets the height of this element in relation to the screen (where 1.0 = screen height) More... | |
uint32 | getHlmsCasterHash (void) const |
uint32 | getHlmsHash (void) const |
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... | |
unsigned short | getNumPoses (void) const |
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... | |
bool | getPoseHalfPrecision () const |
bool | getPoseNormals () const |
TexBufferPacked * | getPoseTexBuffer () const |
float | getPoseWeight (size_t index) const |
float * | getPoseWeights () const |
virtual void | getRenderOperation (v1::RenderOperation &op, bool casterPass)=0 |
Gets the render operation required to send this object to the frame buffer. More... | |
uint8 | getRenderQueueSubGroup (void) const |
const OverlayElement * | getSourceTemplate () const |
Returns the SourceTemplate for this element. 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 bool | getUseIdentityViewProjMatrixIsDynamic (void) const |
Returns whether the Hlms implementation should evaluate getUseIdentityProjection per object at runtime, or if it can assume the Renderable will remain with the same setting until the datablock is flushed (performance optimization) More... | |
virtual bool | getUseIdentityWorldMatrix (void) const |
Returns whether the world matrix is an identity matrix. 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... | |
const VertexArrayObjectArray & | getVaos (VertexPass vertexPass) const |
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... | |
bool | hasCustomParameter (size_t index) const |
Checks whether a custom value is associated with this Renderable at the given index. More... | |
bool | hasSkeletonAnimation (void) const |
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 | setDatablock (IdString datablockName) |
Assigns a datablock (i.e. More... | |
virtual void | setDatablock (HlmsDatablock *datablock) |
Assigns a datablock (i.e. HLMS Material) to this renderable. More... | |
void | setDatablockOrMaterialName (String materialName, String groupName) |
First tries to see if an HLMS datablock exist with the given name, if not, tries to search among low level materials. 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 | setMaterial (const MaterialPtr &material) |
Sets the given material. Overrides HLMS materials. More... | |
void | setMaterialName (const String &name, const String &groupName) |
Sets the name of the Material to be used. Prefer using HLMS setHlms. 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 | setPoseWeight (size_t index, float w) |
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 | setRenderQueueSubGroup (uint8 subGroup) |
Sets the render queue sub group. 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... | |
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... | |
Public Attributes | |
uint8 | mCustomParameter |
Only valid when using low level materials. More... | |
uint32 | mHlmsGlobalIndex |
Index in the vector holding this Rendrable reference in the HLMS datablock. More... | |
Abstract definition of a 2D element to be displayed in an Overlay.
|
inherited |
Ogre::v1::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)
|
inline |
Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)
|
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)
|
inline |
Gets the width of this element in relation to the screen (where 1.0 = screen width)
|
virtual |
Internal method for notifying the GUI element of it's parent and ultimate overlay.
Reimplemented in Ogre::v1::OverlayContainer.
|
virtual |
Internal method to notify the element when the viewport of parent overlay has changed.
Reimplemented in Ogre::v1::OverlayContainer.
|
virtual |
Tell the object to recalculate.
Reimplemented in Ogre::v1::OverlayContainer.
|
inlinevirtual |
Notifies that hardware resources were lost.
Reimplemented in Ogre::v1::PanelOverlayElement, Ogre::v1::BorderPanelOverlayElement, and Ogre::v1::TextAreaOverlayElement.
|
inlinevirtual |
Notifies that hardware resources should be restored.
Reimplemented in Ogre::v1::PanelOverlayElement, Ogre::v1::BorderPanelOverlayElement, and Ogre::v1::TextAreaOverlayElement.
Sets the width and height of this element in relation to the screen (where 1.0 = screen width)
void Ogre::v1::OverlayElement::_setHeight | ( | Real | height | ) |
Sets the height of this element in relation to the screen (where 1.0 = screen width)
Manually sets the hlms hashes. Don't call this directly.
Reimplemented in Ogre::SubItem.
void Ogre::v1::OverlayElement::_setLeft | ( | Real | left | ) |
Sets the left of this element in relation to the screen (where 1.0 = screen width)
|
virtualinherited |
Sets the datablock to a null pointer.
Use case: If you will be destroying an HlmsDatablock and all Renderables associated by it; it makes no sense to change the Renderable's datablock to a default one, only to be destroyed immediately after (you pay an unnecessary performance price).
Reimplemented in Ogre::v1::BillboardSet, and Ogre::v1::SubEntity.
|
inline |
Sets the left and top of this element in relation to the screen (where 1.0 = screen width)
void Ogre::v1::OverlayElement::_setTop | ( | Real | top | ) |
Sets the top of this element in relation to the screen (where 1.0 = screen width)
void Ogre::v1::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::v1::BorderPanelOverlayElement, Ogre::v1::TextAreaOverlayElement, and Ogre::v1::OverlayContainer.
|
virtualinherited |
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::v1::SubEntity.
|
virtual |
Updates this elements transform based on it's parent.
|
virtual |
Internal method to put the contents onto the render queue.
Reimplemented in Ogre::v1::BorderPanelOverlayElement, Ogre::v1::OverlayContainer, and Ogre::v1::PanelOverlayElement.
|
inherited |
Referenced by Ogre::SubItem::getParent().
|
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::v1::OverlayContainer.
Returns true if xy is within the constraints of the component.
|
virtual |
Reimplemented in Ogre::v1::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. |
References Ogre::StringInterface::setParameter().
|
virtual |
Returns true if xy is within the constraints of the component.
Reimplemented in Ogre::v1::OverlayContainer.
|
virtual |
Gets the caption for this element.
|
inlinevirtualinherited |
Method which reports whether this renderable would normally cast a shadow.
Reimplemented in Ogre::ManualObject::ManualObjectSection, Ogre::v1::StaticGeometry::GeometryBucket, Ogre::v1::SubEntity, Ogre::Rectangle2D, Ogre::SubItem, Ogre::WireAabb, Ogre::IfdProbeVisualizer, and Ogre::VoxelVisualizer.
|
virtual |
Gets the colour for this element.
Reimplemented in Ogre::v1::TextAreaOverlayElement.
|
inlineinherited |
References ARRAY_PACKED_REALS, and Ogre::LodStrategy::lodSet().
|
inlineinherited |
Gets the custom value associated with this Renderable at the given index.
index | Index of the parameter to retrieve. |
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
|
inlineinherited |
|
inlineinherited |
Real Ogre::v1::OverlayElement::getHeight | ( | void | ) | const |
Gets the height of this element in relation to the screen (where 1.0 = screen height)
|
inlineinherited |
|
inlineinherited |
|
virtual |
Gets the horizontal alignment for this element.
Real Ogre::v1::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.
const MaterialPtr& Ogre::v1::OverlayElement::getMaterial | ( | void | ) | const |
See Renderable.
|
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::v1::OverlayElement::getName | ( | void | ) | const |
Gets the name of this overlay.
Referenced by Ogre::v1::OverlayContainer::_removeChild().
|
inherited |
|
inlinevirtualinherited |
Returns the number of world transform matrices this renderable requires.
Reimplemented in Ogre::v1::BorderRenderable, and Ogre::v1::SubEntity.
|
inlineinherited |
Retrieves the parameter dictionary for this class.
|
inlineinherited |
|
inlinevirtualinherited |
Generic parameter retrieval method.
name | The name of the parameter to get |
References Ogre::ParamCommand::doGet().
|
inherited |
Retrieves a list of parameters valid for this object.
OverlayContainer* Ogre::v1::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::v1::BorderRenderable.
Referenced by Ogre::v1::BorderRenderable::getPolygonModeOverrideable().
|
inherited |
|
inherited |
|
inherited |
|
inherited |
Referenced by Ogre::SubItem::getParent().
|
inherited |
|
pure virtualinherited |
Gets the render operation required to send this object to the frame buffer.
Implemented in Ogre::v1::BillboardSet, Ogre::Frustum, Ogre::v1::ManualObject::ManualObjectSection, Ogre::v1::BorderRenderable, Ogre::ManualObject::ManualObjectSection, Ogre::v1::BillboardChain, Ogre::v1::StaticGeometry::GeometryBucket, Ogre::v1::SubEntity, Ogre::Rectangle2D, Ogre::v1::PanelOverlayElement, Ogre::SubItem, Ogre::v1::Rectangle2D, Ogre::v1::TextAreaOverlayElement, Ogre::v1::SimpleRenderable, Ogre::WireAabb, Ogre::IfdProbeVisualizer, and Ogre::VoxelVisualizer.
|
inlineinherited |
References Ogre::NumVertexPass.
|
inline |
Returns the SourceTemplate for this element.
Real Ogre::v1::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::v1::PanelOverlayElement, Ogre::v1::TextAreaOverlayElement, and Ogre::v1::BorderPanelOverlayElement.
|
inlineinherited |
Returns whether or not to use an 'identity' projection.
|
inlineinherited |
Returns whether or not to use an 'identity' view.
|
inlinevirtualinherited |
Returns whether the Hlms implementation should evaluate getUseIdentityProjection per object at runtime, or if it can assume the Renderable will remain with the same setting until the datablock is flushed (performance optimization)
|
inlinevirtualinherited |
Returns whether the world matrix is an identity matrix.
Reimplemented in Ogre::v1::BillboardSet.
|
inlinevirtualinherited |
Retrieves the custom user value associated with this object.
|
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.
|
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.
|
inlineinherited |
|
virtual |
Gets the vertical alignment for this element.
Real Ogre::v1::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.
Referenced by Ogre::v1::BorderRenderable::getWorldTransforms().
|
inlineinherited |
Checks whether a custom value is associated with this Renderable at the given index.
index | Index of the parameter to check for existence. |
|
inlineinherited |
|
virtual |
Hides this element if it was visible.
|
pure virtual |
Initialise gui element.
Implemented in Ogre::v1::OverlayContainer, Ogre::v1::PanelOverlayElement, Ogre::v1::BorderPanelOverlayElement, and Ogre::v1::TextAreaOverlayElement.
|
inlinevirtual |
|
inlinevirtual |
returns false as this class is not a container type
Reimplemented in Ogre::v1::OverlayContainer.
bool Ogre::v1::OverlayElement::isEnabled | ( | ) | const |
|
inlinevirtual |
bool Ogre::v1::OverlayElement::isVisible | ( | void | ) | const |
Returns whether or not the element is visible.
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
|
inlineinherited |
operator new, with debug line info
|
inlineinherited |
|
inlineinherited |
placement operator new
|
inlineinherited |
array operator new, with debug line info
|
inlineinherited |
|
inlinevirtualinherited |
Called immediately after the Renderable has been rendered.
|
inlinevirtualinherited |
Called just prior to the Renderable being rendered.
Reimplemented in Ogre::v1::BillboardChain.
|
inlineinherited |
Removes a custom value which is associated with this Renderable at the given index.
index | Index of the parameter to remove. |
|
virtual |
Sets the caption on elements that support it.
Reimplemented in Ogre::v1::TextAreaOverlayElement.
|
inlinevirtual |
|
virtual |
Sets the colour on elements that support it.
Reimplemented in Ogre::v1::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. |
|
inherited |
Assigns a datablock (i.e.
HLMS material) based on its unique name.
|
virtualinherited |
Assigns a datablock (i.e. HLMS Material) to this renderable.
Reimplemented in Ogre::v1::BillboardSet, and Ogre::v1::SubEntity.
|
inherited |
First tries to see if an HLMS datablock exist with the given name, if not, tries to search among low level materials.
Sets the dimensions of this element in relation to the screen (1.0 = screen width/height).
|
virtual |
void Ogre::v1::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::v1::OverlayElement::setLeft | ( | Real | left | ) |
Sets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right)
|
virtualinherited |
Sets the given material. Overrides HLMS materials.
Reimplemented in Ogre::v1::BillboardSet, Ogre::v1::SubEntity, and Ogre::v1::SimpleRenderable.
Sets the name of the Material to be used. Prefer using HLMS setHlms.
|
virtual |
Sets the name of the material this element will use.
Reimplemented in Ogre::v1::PanelOverlayElement, and Ogre::v1::TextAreaOverlayElement.
|
virtual |
Tells this element how to interpret the position and dimension values it is given.
Reimplemented in Ogre::v1::BorderPanelOverlayElement, and Ogre::v1::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. |
|
inherited |
Referenced by Ogre::SubItem::getParent().
Sets the position of the top-left corner of the element, relative to the screen size (1.0 = screen width / height)
|
inlineinherited |
Sets the render queue sub group.
subGroup | The sub group. This value can't exceed OGRE_MAKE_MASK( SubRqIdBits ) RenderQueue |
void Ogre::v1::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.
|
inlineinherited |
Sets whether or not to use an 'identity' view.
|
inlinevirtualinherited |
Sets any kind of user value on this object.
|
virtual |
Sets the vertical origin for this element.
void Ogre::v1::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.
|
inherited |
Only valid when using low level materials.
|
inherited |
Index in the vector holding this Rendrable reference in the HLMS datablock.
Used for O(1) removals.