#include <OgrePanelOverlayElement.h>
Public Types | |
typedef std::map < String, OverlayElement * > | ChildMap |
typedef MapIterator < ChildMap > | ChildIterator |
typedef std::map < String, OverlayContainer * > | ChildContainerMap |
typedef MapIterator < ChildContainerMap > | ChildContainerIterator |
Public Member Functions | |
PanelOverlayElement (const String &name) | |
Constructor. | |
virtual | ~PanelOverlayElement () |
virtual void | initialise (void) |
Initialise. | |
void | setTiling (Real x, Real y, ushort layer=0) |
Sets the number of times textures should repeat. | |
Real | getTileX (ushort layer=0) const |
Real | getTileY (ushort layer=0) const |
Gets the number of times the texture should repeat vertically. | |
void | setUV (Real u1, Real v1, Real u2, Real v2) |
Sets the texture coordinates for the panel. | |
void | getUV (Real &u1, Real &v1, Real &u2, Real &v2) const |
Get the uv coordinates for the panel. | |
void | setTransparent (bool isTransparent) |
Sets whether this panel is transparent (used only as a grouping level), or if it is actually renderred. | |
bool | isTransparent (void) const |
Returns whether this panel is transparent. | |
virtual const String & | getTypeName (void) const |
See OverlayElement. | |
void | getRenderOperation (RenderOperation &op) |
See Renderable. | |
void | setMaterialName (const String &matName) |
Overridden from OverlayElement. | |
void | _updateRenderQueue (RenderQueue *queue) |
Overridden from OverlayContainer. | |
virtual void | addChild (OverlayElement *elem) |
Adds another OverlayElement to this container. | |
virtual void | addChildImpl (OverlayElement *elem) |
Adds another OverlayElement to this container. | |
virtual void | addChildImpl (OverlayContainer *cont) |
Add a nested container to this container. | |
virtual void | removeChild (const String &name) |
Removes a named element from this container. | |
virtual OverlayElement * | getChild (const String &name) |
Gets the named child of this container. | |
void | _addChild (OverlayElement *elem) |
void | _removeChild (OverlayElement *elem) |
void | _removeChild (const String &name) |
virtual ChildIterator | getChildIterator (void) |
Gets an object for iterating over all the children of this object. | |
virtual ChildContainerIterator | getChildContainerIterator (void) |
Gets an iterator for just the container children of this object. | |
virtual void | _positionsOutOfDate (void) |
Tell the object and its children to recalculate. | |
virtual void | _update (void) |
Overridden from OverlayElement. | |
virtual void | _notifyZOrder (ushort newZOrder) |
Overridden from OverlayElement. | |
virtual void | _notifyViewport () |
Overridden from OverlayElement. | |
virtual void | _notifyWorldTransforms (const Matrix4 &xform) |
Overridden from OverlayElement. | |
virtual void | _notifyParent (OverlayContainer *parent, Overlay *overlay) |
Overridden from OverlayElement. | |
bool | isContainer () const |
Overridden from OverlayElement. | |
virtual bool | isChildrenProcessEvents () const |
Should this container pass events to their children. | |
virtual void | setChildrenProcessEvents (bool val) |
Should this container pass events to their children. | |
virtual OverlayElement * | findElementAt (Real x, Real y) |
This returns a OverlayElement at position x,y. | |
void | copyFromTemplate (OverlayElement *templateOverlay) |
virtual OverlayElement * | clone (const String &instanceName) |
const String & | getName (void) const |
Gets the name of this overlay. | |
virtual void | show (void) |
Shows this element if it was hidden. | |
virtual void | hide (void) |
Hides this element if it was visible. | |
bool | isVisible (void) const |
Returns whether or not the element is visible. | |
bool | isEnabled () const |
virtual void | setEnabled (bool b) |
void | setDimensions (Real width, Real height) |
Sets the dimensions of this element in relation to the screen (1.0 = screen width/height). | |
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). | |
void | setWidth (Real width) |
Sets the width of this element in relation to the screen (where 1.0 = screen width). | |
Real | getWidth (void) const |
Gets the width of this element in relation to the screen (where 1.0 = screen width). | |
void | setHeight (Real height) |
Sets the height of this element in relation to the screen (where 1.0 = screen height). | |
Real | getHeight (void) const |
Gets the height of this element in relation to the screen (where 1.0 = screen height). | |
void | setLeft (Real left) |
Sets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right). | |
Real | getLeft (void) const |
Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right). | |
void | setTop (Real Top) |
Sets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom). | |
Real | getTop (void) const |
Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom). | |
Real | _getLeft (void) const |
Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right). | |
Real | _getTop (void) const |
Gets the top of this element in relation to the screen (where 0 = far left, 1.0 = far right). | |
Real | _getWidth (void) const |
Gets the width of this element in relation to the screen (where 1.0 = screen width). | |
Real | _getHeight (void) const |
Gets the height of this element in relation to the screen (where 1.0 = screen height). | |
void | _setLeft (Real left) |
Sets the left of this element in relation to the screen (where 1.0 = screen width). | |
void | _setTop (Real top) |
Sets the top of this element in relation to the screen (where 1.0 = screen width). | |
void | _setWidth (Real width) |
Sets the width of this element in relation to the screen (where 1.0 = screen width). | |
void | _setHeight (Real height) |
Sets the height of this element in relation to the screen (where 1.0 = screen width). | |
void | _setPosition (Real left, Real top) |
Sets the left and top of this element in relation to the screen (where 1.0 = screen width). | |
void | _setDimensions (Real width, Real height) |
Sets the width and height of this element in relation to the screen (where 1.0 = screen width). | |
virtual const String & | getMaterialName (void) const |
Gets the name of the material this element uses. | |
const MaterialPtr & | getMaterial (void) const |
See Renderable. | |
void | getWorldTransforms (Matrix4 *xform) const |
See Renderable. | |
const Quaternion & | getWorldOrientation (void) const |
Gets the worldspace orientation of this renderable; this is used in order to more efficiently update parameters to vertex & fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling. | |
const Vector3 & | getWorldPosition (void) const |
Gets the worldspace position of this renderable; this is used in order to more efficiently update parameters to vertex & fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling. | |
virtual void | _updateFromParent (void) |
Updates this elements transform based on it's parent. | |
virtual Real | _getDerivedLeft (void) |
Gets the 'left' position as derived from own left and that of parents. | |
virtual Real | _getDerivedTop (void) |
Gets the 'top' position as derived from own left and that of parents. | |
virtual Real | _getRelativeWidth (void) |
Gets the 'width' as derived from own width and metrics mode. | |
virtual Real | _getRelativeHeight (void) |
Gets the 'height' as derived from own height and metrics mode. | |
virtual void | _getClippingRegion (Rectangle &clippingRegion) |
Gets the clipping region of the element. | |
virtual void | setCaption (const DisplayString &text) |
Sets the caption on elements that support it. | |
virtual const DisplayString & | getCaption (void) const |
Gets the caption for this element. | |
virtual void | setColour (const ColourValue &col) |
Sets the colour on elements that support it. | |
virtual const ColourValue & | getColour (void) const |
Gets the colour for this element. | |
virtual void | setMetricsMode (GuiMetricsMode gmm) |
Tells this element how to interpret the position and dimension values it is given. | |
virtual GuiMetricsMode | getMetricsMode (void) const |
Retrieves the current settings of how the element metrics are interpreted. | |
virtual void | setHorizontalAlignment (GuiHorizontalAlignment gha) |
Sets the horizontal origin for this element. | |
virtual GuiHorizontalAlignment | getHorizontalAlignment (void) const |
Gets the horizontal alignment for this element. | |
virtual void | setVerticalAlignment (GuiVerticalAlignment gva) |
Sets the vertical origin for this element. | |
virtual GuiVerticalAlignment | getVerticalAlignment (void) const |
Gets the vertical alignment for this element. | |
virtual bool | contains (Real x, Real y) const |
Returns true if xy is within the constraints of the component. | |
virtual bool | isKeyEnabled () const |
virtual bool | isCloneable () const |
virtual void | setCloneable (bool c) |
OverlayContainer * | getParent () |
Returns the parent container. | |
void | _setParent (OverlayContainer *parent) |
ushort | getZOrder () const |
Returns the zOrder of the element. | |
Real | getSquaredViewDepth (const Camera *cam) const |
Overridden from Renderable. | |
const LightList & | getLights (void) const |
Gets a list of lights, ordered relative to how close they are to this renderable.
| |
const OverlayElement * | getSourceTemplate () const |
ParamDictionary * | getParamDictionary (void) |
Retrieves the parameter dictionary for this class. | |
const ParamDictionary * | getParamDictionary (void) const |
const ParameterList & | getParameters (void) const |
Retrieves a list of parameters valid for this object. | |
virtual bool | setParameter (const String &name, const String &value) |
Generic parameter setting method. | |
virtual void | setParameterList (const NameValuePairList ¶mList) |
Generic multiple parameter setting method. | |
virtual String | getParameter (const String &name) const |
Generic parameter retrieval method. | |
virtual void | copyParametersTo (StringInterface *dest) const |
Method for copying this object's parameters to another object. | |
virtual Technique * | getTechnique (void) const |
Retrieves a pointer to the Material Technique this renderable object uses. | |
virtual unsigned short | getNumWorldTransforms (void) const |
Returns the number of world transform matrices this renderable requires. | |
void | setUseIdentityProjection (bool useIdentityProjection) |
Sets whether or not to use an 'identity' projection. | |
bool | getUseIdentityProjection (void) const |
Returns whether or not to use an 'identity' projection. | |
void | setUseIdentityView (bool useIdentityView) |
Sets whether or not to use an 'identity' view. | |
bool | getUseIdentityView (void) const |
Returns whether or not to use an 'identity' view. | |
virtual bool | getNormaliseNormals (void) const |
Returns whether or not this Renderable wishes the hardware to normalise normals. | |
virtual const PlaneList & | getClipPlanes () const |
virtual bool | getCastsShadows (void) const |
Method which reports whether this renderable would normally cast a shadow. | |
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. | |
const Vector4 & | getCustomParameter (size_t index) const |
Gets the custom value associated with this Renderable at the given index. | |
virtual void | _updateCustomGpuParameter (const GpuProgramParameters::AutoConstantEntry &constantEntry, GpuProgramParameters *params) const |
Update a custom GpuProgramParameters constant which is derived from information only this Renderable knows. | |
virtual void | setPolygonModeOverrideable (bool override) |
Sets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | |
virtual bool | getPolygonModeOverrideable (void) const |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting. | |
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. | |
Protected Types | |
typedef std::map < size_t, Vector4 > | CustomParameterMap |
Protected Member Functions | |
virtual void | updatePositionGeometry (void) |
internal method for setting up geometry, called by OverlayElement::update | |
virtual void | updateTextureGeometry (void) |
Called to update the texture coords when layers change. | |
void | addBaseParameters (void) |
Method for setting up base parameters for this class. | |
bool | createParamDictionary (const String &className) |
Internal method for creating a parameter dictionary for the class, if it does not already exist. | |
Protected Attributes | |
bool | mTransparent |
Real | mTileX [OGRE_MAX_TEXTURE_LAYERS] |
Real | mTileY [OGRE_MAX_TEXTURE_LAYERS] |
size_t | mNumTexCoordsInBuffer |
Real | mU1 |
Real | mV1 |
Real | mU2 |
Real | mV2 |
RenderOperation | mRenderOp |
ChildMap | mChildren |
ChildContainerMap | mChildContainers |
bool | mChildrenProcessEvents |
String | mName |
bool | mVisible |
bool | mCloneable |
Real | mLeft |
Real | mTop |
Real | mWidth |
Real | mHeight |
String | mMaterialName |
MaterialPtr | mpMaterial |
DisplayString | mCaption |
ColourValue | mColour |
Rectangle | mClippingRegion |
GuiMetricsMode | mMetricsMode |
GuiHorizontalAlignment | mHorzAlign |
GuiVerticalAlignment | mVertAlign |
Real | mPixelTop |
Real | mPixelLeft |
Real | mPixelWidth |
Real | mPixelHeight |
Real | mPixelScaleX |
Real | mPixelScaleY |
OverlayContainer * | mParent |
Overlay * | mOverlay |
Real | mDerivedLeft |
Real | mDerivedTop |
bool | mDerivedOutOfDate |
bool | mGeomPositionsOutOfDate |
Flag indicating if the vertex positons need recalculating. | |
bool | mGeomUVsOutOfDate |
Flag indicating if the vertex uvs need recalculating. | |
ushort | mZOrder |
Matrix4 | mXForm |
bool | mEnabled |
bool | mInitialised |
OverlayElement * | mSourceTemplate |
String | mParamDictName |
Class name for this instance to be used as a lookup (must be initialised by subclasses). | |
CustomParameterMap | mCustomParameters |
bool | mPolygonModeOverrideable |
bool | mUseIdentityProjection |
bool | mUseIdentityView |
Static Protected Attributes | |
static String | msTypeName |
static CmdTiling | msCmdTiling |
static CmdTransparent | msCmdTransparent |
static CmdUVCoords | msCmdUVCoords |
static OverlayElementCommands::CmdLeft | msLeftCmd |
static OverlayElementCommands::CmdTop | msTopCmd |
static OverlayElementCommands::CmdWidth | msWidthCmd |
static OverlayElementCommands::CmdHeight | msHeightCmd |
static OverlayElementCommands::CmdMaterial | msMaterialCmd |
static OverlayElementCommands::CmdCaption | msCaptionCmd |
static OverlayElementCommands::CmdMetricsMode | msMetricsModeCmd |
static OverlayElementCommands::CmdHorizontalAlign | msHorizontalAlignCmd |
static OverlayElementCommands::CmdVerticalAlign | msVerticalAlignCmd |
static OverlayElementCommands::CmdVisible | msVisibleCmd |
static ParamDictionaryMap | msDictionary |
Dictionary of parameters. | |
static const PlaneList | msDummyPlaneList |
Classes | |
class | CmdTiling |
Command object for specifying tiling (see ParamCommand). More... | |
class | CmdTransparent |
Command object for specifying transparency (see ParamCommand). More... | |
class | CmdUVCoords |
Command object for specifying UV coordinates (see ParamCommand). More... |
Definition at line 53 of file OgrePanelOverlayElement.h.
typedef std::map<String, OverlayElement*> Ogre::OverlayContainer::ChildMap [inherited] |
Definition at line 54 of file OgreOverlayContainer.h.
typedef MapIterator<ChildMap> Ogre::OverlayContainer::ChildIterator [inherited] |
Definition at line 55 of file OgreOverlayContainer.h.
typedef std::map<String, OverlayContainer*> Ogre::OverlayContainer::ChildContainerMap [inherited] |
Definition at line 56 of file OgreOverlayContainer.h.
typedef MapIterator<ChildContainerMap> Ogre::OverlayContainer::ChildContainerIterator [inherited] |
Definition at line 57 of file OgreOverlayContainer.h.
typedef std::map<size_t, Vector4> Ogre::Renderable::CustomParameterMap [protected, inherited] |
Definition at line 285 of file OgreRenderable.h.
Ogre::PanelOverlayElement::PanelOverlayElement | ( | const String & | name | ) |
Constructor.
virtual Ogre::PanelOverlayElement::~PanelOverlayElement | ( | ) | [virtual] |
virtual void Ogre::PanelOverlayElement::initialise | ( | void | ) | [virtual] |
Initialise.
Reimplemented from Ogre::OverlayContainer.
Reimplemented in Ogre::BorderPanelOverlayElement.
Sets the number of times textures should repeat.
x | The number of times the texture should repeat horizontally | |
y | The number of times the texture should repeat vertically | |
layer | The texture layer to specify (only needs to be altered if you're using a multi-texture layer material) |
Gets the number of times the texture should repeat vertically.
layer | The texture layer to specify (only needs to be altered if you're using a multi-texture layer material) |
Sets the texture coordinates for the panel.
Get the uv coordinates for the panel.
void Ogre::PanelOverlayElement::setTransparent | ( | bool | isTransparent | ) |
Sets whether this panel is transparent (used only as a grouping level), or if it is actually renderred.
bool Ogre::PanelOverlayElement::isTransparent | ( | void | ) | const |
Returns whether this panel is transparent.
virtual const String& Ogre::PanelOverlayElement::getTypeName | ( | void | ) | const [virtual] |
See OverlayElement.
Implements Ogre::OverlayElement.
Reimplemented in Ogre::BorderPanelOverlayElement.
void Ogre::PanelOverlayElement::getRenderOperation | ( | RenderOperation & | op | ) | [virtual] |
void Ogre::PanelOverlayElement::setMaterialName | ( | const String & | matName | ) | [virtual] |
void Ogre::PanelOverlayElement::_updateRenderQueue | ( | RenderQueue * | queue | ) | [virtual] |
Overridden from OverlayContainer.
Reimplemented from Ogre::OverlayContainer.
Reimplemented in Ogre::BorderPanelOverlayElement.
virtual void Ogre::PanelOverlayElement::updatePositionGeometry | ( | void | ) | [protected, virtual] |
internal method for setting up geometry, called by OverlayElement::update
Implements Ogre::OverlayElement.
Reimplemented in Ogre::BorderPanelOverlayElement.
virtual void Ogre::PanelOverlayElement::updateTextureGeometry | ( | void | ) | [protected, virtual] |
Called to update the texture coords when layers change.
Implements Ogre::OverlayElement.
Reimplemented in Ogre::BorderPanelOverlayElement.
void Ogre::PanelOverlayElement::addBaseParameters | ( | void | ) | [protected, virtual] |
Method for setting up base parameters for this class.
Reimplemented from Ogre::OverlayElement.
Reimplemented in Ogre::BorderPanelOverlayElement.
virtual void Ogre::OverlayContainer::addChild | ( | OverlayElement * | elem | ) | [virtual, inherited] |
Adds another OverlayElement to this container.
virtual void Ogre::OverlayContainer::addChildImpl | ( | OverlayElement * | elem | ) | [virtual, inherited] |
Adds another OverlayElement to this container.
virtual void Ogre::OverlayContainer::addChildImpl | ( | OverlayContainer * | cont | ) | [virtual, inherited] |
Add a nested container to this container.
virtual void Ogre::OverlayContainer::removeChild | ( | const String & | name | ) | [virtual, inherited] |
Removes a named element from this container.
virtual OverlayElement* Ogre::OverlayContainer::getChild | ( | const String & | name | ) | [virtual, inherited] |
Gets the named child of this container.
void Ogre::OverlayContainer::_addChild | ( | OverlayElement * | elem | ) | [inherited] |
void Ogre::OverlayContainer::_removeChild | ( | OverlayElement * | elem | ) | [inherited] |
void Ogre::OverlayContainer::_removeChild | ( | const String & | name | ) | [inherited] |
virtual ChildIterator Ogre::OverlayContainer::getChildIterator | ( | void | ) | [virtual, inherited] |
Gets an object for iterating over all the children of this object.
virtual ChildContainerIterator Ogre::OverlayContainer::getChildContainerIterator | ( | void | ) | [virtual, inherited] |
Gets an iterator for just the container children of this object.
virtual void Ogre::OverlayContainer::_positionsOutOfDate | ( | void | ) | [virtual, inherited] |
virtual void Ogre::OverlayContainer::_update | ( | void | ) | [virtual, inherited] |
Overridden from OverlayElement.
Reimplemented from Ogre::OverlayElement.
Reimplemented in Ogre::BorderPanelOverlayElement.
virtual void Ogre::OverlayContainer::_notifyZOrder | ( | ushort | newZOrder | ) | [virtual, inherited] |
virtual void Ogre::OverlayContainer::_notifyViewport | ( | ) | [virtual, inherited] |
virtual void Ogre::OverlayContainer::_notifyWorldTransforms | ( | const Matrix4 & | xform | ) | [virtual, inherited] |
virtual void Ogre::OverlayContainer::_notifyParent | ( | OverlayContainer * | parent, | |
Overlay * | overlay | |||
) | [virtual, inherited] |
bool Ogre::OverlayContainer::isContainer | ( | ) | const [virtual, inherited] |
Overridden from OverlayElement.
Reimplemented from Ogre::OverlayElement.
Definition at line 120 of file OgreOverlayContainer.h.
virtual bool Ogre::OverlayContainer::isChildrenProcessEvents | ( | ) | const [virtual, inherited] |
Should this container pass events to their children.
Definition at line 124 of file OgreOverlayContainer.h.
virtual void Ogre::OverlayContainer::setChildrenProcessEvents | ( | bool | val | ) | [virtual, inherited] |
Should this container pass events to their children.
Definition at line 128 of file OgreOverlayContainer.h.
virtual OverlayElement* Ogre::OverlayContainer::findElementAt | ( | Real | x, | |
Real | y | |||
) | [virtual, inherited] |
void Ogre::OverlayContainer::copyFromTemplate | ( | OverlayElement * | templateOverlay | ) | [virtual, inherited] |
Reimplemented from Ogre::OverlayElement.
virtual OverlayElement* Ogre::OverlayContainer::clone | ( | const String & | instanceName | ) | [virtual, inherited] |
Reimplemented from Ogre::OverlayElement.
const String& Ogre::OverlayElement::getName | ( | void | ) | const [inherited] |
virtual void Ogre::OverlayElement::show | ( | void | ) | [virtual, inherited] |
Shows this element if it was hidden.
virtual void Ogre::OverlayElement::hide | ( | void | ) | [virtual, inherited] |
Hides this element if it was visible.
bool Ogre::OverlayElement::isVisible | ( | void | ) | const [inherited] |
Returns whether or not the element is visible.
bool Ogre::OverlayElement::isEnabled | ( | ) | const [inherited] |
virtual void Ogre::OverlayElement::setEnabled | ( | bool | b | ) | [virtual, inherited] |
Sets the dimensions of this element in relation to the screen (1.0 = screen width/height).
Sets the position of the top-left corner of the element, relative to the screen size (1.0 = screen width / height).
void Ogre::OverlayElement::setWidth | ( | Real | width | ) | [inherited] |
Sets the width of this element in relation to the screen (where 1.0 = screen width).
Real Ogre::OverlayElement::getWidth | ( | void | ) | const [inherited] |
Gets the width of this element in relation to the screen (where 1.0 = screen width).
void Ogre::OverlayElement::setHeight | ( | Real | height | ) | [inherited] |
Sets the height of this element in relation to the screen (where 1.0 = screen height).
Real Ogre::OverlayElement::getHeight | ( | void | ) | const [inherited] |
Gets the height of this element in relation to the screen (where 1.0 = screen height).
void Ogre::OverlayElement::setLeft | ( | Real | left | ) | [inherited] |
Sets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right).
Real Ogre::OverlayElement::getLeft | ( | void | ) | const [inherited] |
Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right).
void Ogre::OverlayElement::setTop | ( | Real | Top | ) | [inherited] |
Sets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom).
Real Ogre::OverlayElement::getTop | ( | void | ) | const [inherited] |
Gets the top of this element in relation to the screen (where 0 = top, 1.0 = bottom).
Real Ogre::OverlayElement::_getLeft | ( | void | ) | const [inherited] |
Gets the left of this element in relation to the screen (where 0 = far left, 1.0 = far right).
Definition at line 252 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::_getTop | ( | void | ) | const [inherited] |
Gets the top of this element in relation to the screen (where 0 = far left, 1.0 = far right).
Definition at line 254 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::_getWidth | ( | void | ) | const [inherited] |
Gets the width of this element in relation to the screen (where 1.0 = screen width).
Definition at line 256 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::_getHeight | ( | void | ) | const [inherited] |
Gets the height of this element in relation to the screen (where 1.0 = screen height).
Definition at line 258 of file OgreOverlayElement.h.
void Ogre::OverlayElement::_setLeft | ( | Real | left | ) | [inherited] |
Sets the left of this element in relation to the screen (where 1.0 = screen width).
void Ogre::OverlayElement::_setTop | ( | Real | top | ) | [inherited] |
Sets the top of this element in relation to the screen (where 1.0 = screen width).
void Ogre::OverlayElement::_setWidth | ( | Real | width | ) | [inherited] |
Sets the width of this element in relation to the screen (where 1.0 = screen width).
void Ogre::OverlayElement::_setHeight | ( | Real | height | ) | [inherited] |
Sets the height of this element in relation to the screen (where 1.0 = screen width).
Sets the left and top of this element in relation to the screen (where 1.0 = screen width).
Sets the width and height of this element in relation to the screen (where 1.0 = screen width).
virtual const String& Ogre::OverlayElement::getMaterialName | ( | void | ) | const [virtual, inherited] |
Gets the name of the material this element uses.
const MaterialPtr& Ogre::OverlayElement::getMaterial | ( | void | ) | const [virtual, inherited] |
void Ogre::OverlayElement::getWorldTransforms | ( | Matrix4 * | xform | ) | const [virtual, inherited] |
const Quaternion& Ogre::OverlayElement::getWorldOrientation | ( | void | ) | const [virtual, inherited] |
Gets the worldspace orientation of this renderable; this is used in order to more efficiently update parameters to vertex & fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling.
Implements Ogre::Renderable.
const Vector3& Ogre::OverlayElement::getWorldPosition | ( | void | ) | const [virtual, inherited] |
Gets the worldspace position of this renderable; this is used in order to more efficiently update parameters to vertex & fragment programs, since inverting Quaterion and Vector in order to derive object-space positions / directions for cameras and lights is much more efficient than inverting a complete 4x4 matrix, and also eliminates problems introduced by scaling.
Implements Ogre::Renderable.
virtual void Ogre::OverlayElement::_updateFromParent | ( | void | ) | [virtual, inherited] |
Updates this elements transform based on it's parent.
virtual Real Ogre::OverlayElement::_getDerivedLeft | ( | void | ) | [virtual, inherited] |
Gets the 'left' position as derived from own left and that of parents.
virtual Real Ogre::OverlayElement::_getDerivedTop | ( | void | ) | [virtual, inherited] |
Gets the 'top' position as derived from own left and that of parents.
virtual Real Ogre::OverlayElement::_getRelativeWidth | ( | void | ) | [virtual, inherited] |
Gets the 'width' as derived from own width and metrics mode.
virtual Real Ogre::OverlayElement::_getRelativeHeight | ( | void | ) | [virtual, inherited] |
Gets the 'height' as derived from own height and metrics mode.
virtual void Ogre::OverlayElement::_getClippingRegion | ( | Rectangle & | clippingRegion | ) | [virtual, inherited] |
Gets the clipping region of the element.
virtual void Ogre::OverlayElement::setCaption | ( | const DisplayString & | text | ) | [virtual, inherited] |
Sets the caption on elements that support it.
Reimplemented in Ogre::TextAreaOverlayElement.
virtual const DisplayString& Ogre::OverlayElement::getCaption | ( | void | ) | const [virtual, inherited] |
Gets the caption for this element.
virtual void Ogre::OverlayElement::setColour | ( | const ColourValue & | col | ) | [virtual, inherited] |
Sets the colour on elements that support it.
Reimplemented in Ogre::TextAreaOverlayElement.
virtual const ColourValue& Ogre::OverlayElement::getColour | ( | void | ) | const [virtual, inherited] |
virtual void Ogre::OverlayElement::setMetricsMode | ( | GuiMetricsMode | gmm | ) | [virtual, inherited] |
Tells this element how to interpret the position and dimension values it is given.
Reimplemented in Ogre::BorderPanelOverlayElement, and Ogre::TextAreaOverlayElement.
virtual GuiMetricsMode Ogre::OverlayElement::getMetricsMode | ( | void | ) | const [virtual, inherited] |
Retrieves the current settings of how the element metrics are interpreted.
virtual void Ogre::OverlayElement::setHorizontalAlignment | ( | GuiHorizontalAlignment | gha | ) | [virtual, inherited] |
Sets the horizontal origin for this element.
virtual GuiHorizontalAlignment Ogre::OverlayElement::getHorizontalAlignment | ( | void | ) | const [virtual, inherited] |
Gets the horizontal alignment for this element.
virtual void Ogre::OverlayElement::setVerticalAlignment | ( | GuiVerticalAlignment | gva | ) | [virtual, inherited] |
Sets the vertical origin for this element.
virtual GuiVerticalAlignment Ogre::OverlayElement::getVerticalAlignment | ( | void | ) | const [virtual, inherited] |
Gets the vertical alignment for this element.
Returns true if xy is within the constraints of the component.
virtual bool Ogre::OverlayElement::isKeyEnabled | ( | ) | const [virtual, inherited] |
Definition at line 440 of file OgreOverlayElement.h.
virtual bool Ogre::OverlayElement::isCloneable | ( | ) | const [virtual, inherited] |
Definition at line 443 of file OgreOverlayElement.h.
virtual void Ogre::OverlayElement::setCloneable | ( | bool | c | ) | [virtual, inherited] |
Definition at line 446 of file OgreOverlayElement.h.
OverlayContainer* Ogre::OverlayElement::getParent | ( | ) | [inherited] |
Returns the parent container.
void Ogre::OverlayElement::_setParent | ( | OverlayContainer * | parent | ) | [inherited] |
Definition at line 453 of file OgreOverlayElement.h.
ushort Ogre::OverlayElement::getZOrder | ( | ) | const [inherited] |
Overridden from Renderable.
Implements Ogre::Renderable.
Definition at line 462 of file OgreOverlayElement.h.
const LightList& Ogre::OverlayElement::getLights | ( | void | ) | const [virtual, inherited] |
Gets a list of lights, ordered relative to how close they are to this renderable.
Implements Ogre::Renderable.
Definition at line 468 of file OgreOverlayElement.h.
const OverlayElement* Ogre::OverlayElement::getSourceTemplate | ( | ) | const [inherited] |
Definition at line 479 of file OgreOverlayElement.h.
bool Ogre::StringInterface::createParamDictionary | ( | const String & | className | ) | [protected, inherited] |
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 176 of file OgreStringInterface.h.
ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | [inherited] |
Retrieves the parameter dictionary for this class.
Definition at line 200 of file OgreStringInterface.h.
const ParamDictionary* Ogre::StringInterface::getParamDictionary | ( | void | ) | const [inherited] |
Definition at line 213 of file OgreStringInterface.h.
const ParameterList& Ogre::StringInterface::getParameters | ( | void | ) | const [inherited] |
Retrieves a list of parameters valid for this object.
virtual bool Ogre::StringInterface::setParameter | ( | const String & | name, | |
const String & | value | |||
) | [virtual, inherited] |
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().
virtual void Ogre::StringInterface::setParameterList | ( | const NameValuePairList & | paramList | ) | [virtual, inherited] |
Generic multiple parameter setting method.
paramList | Name/value pair list |
virtual String Ogre::StringInterface::getParameter | ( | const String & | name | ) | const [virtual, inherited] |
Generic parameter retrieval method.
name | The name of the parameter to get |
Definition at line 269 of file OgreStringInterface.h.
References Ogre::ParamCommand::doGet(), and Ogre::ParamDictionary::getParamCommand().
virtual void Ogre::StringInterface::copyParametersTo | ( | StringInterface * | dest | ) | const [virtual, inherited] |
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 300 of file OgreStringInterface.h.
References Ogre::ParamDictionary::mParamDefs, and Ogre::StringInterface::setParameter().
static void Ogre::StringInterface::cleanupDictionary | ( | ) | [static, inherited] |
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 Technique* Ogre::Renderable::getTechnique | ( | void | ) | const [virtual, inherited] |
Retrieves a pointer to the Material Technique this renderable object uses.
Reimplemented in Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 73 of file OgreRenderable.h.
virtual unsigned short Ogre::Renderable::getNumWorldTransforms | ( | void | ) | const [virtual, inherited] |
Returns the number of world transform matrices this renderable requires.
Reimplemented in Ogre::BorderRenderable, Ogre::InstancedGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 111 of file OgreRenderable.h.
void Ogre::Renderable::setUseIdentityProjection | ( | bool | useIdentityProjection | ) | [inherited] |
Sets whether or not to use an 'identity' projection.
Definition at line 122 of file OgreRenderable.h.
bool Ogre::Renderable::getUseIdentityProjection | ( | void | ) | const [inherited] |
Returns whether or not to use an 'identity' projection.
Definition at line 136 of file OgreRenderable.h.
void Ogre::Renderable::setUseIdentityView | ( | bool | useIdentityView | ) | [inherited] |
Sets whether or not to use an 'identity' view.
Definition at line 147 of file OgreRenderable.h.
bool Ogre::Renderable::getUseIdentityView | ( | void | ) | const [inherited] |
Returns whether or not to use an 'identity' view.
Definition at line 161 of file OgreRenderable.h.
virtual bool Ogre::Renderable::getNormaliseNormals | ( | void | ) | const [virtual, inherited] |
Returns whether or not this Renderable wishes the hardware to normalise normals.
Reimplemented in Ogre::SubEntity.
Definition at line 171 of file OgreRenderable.h.
virtual const PlaneList& Ogre::Renderable::getClipPlanes | ( | ) | const [virtual, inherited] |
Definition at line 179 of file OgreRenderable.h.
virtual bool Ogre::Renderable::getCastsShadows | ( | void | ) | const [virtual, inherited] |
Method which reports whether this renderable would normally cast a shadow.
Reimplemented in Ogre::InstancedGeometry::GeometryBucket, Ogre::StaticGeometry::GeometryBucket, and Ogre::SubEntity.
Definition at line 187 of file OgreRenderable.h.
void Ogre::Renderable::setCustomParameter | ( | size_t | index, | |
const Vector4 & | value | |||
) | [inherited] |
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 204 of file OgreRenderable.h.
const Vector4& Ogre::Renderable::getCustomParameter | ( | size_t | index | ) | const [inherited] |
Gets the custom value associated with this Renderable at the given index.
@see | setCustomParaemter for full details. |
Definition at line 213 of file OgreRenderable.h.
References Ogre::Exception::ERR_ITEM_NOT_FOUND, and OGRE_EXCEPT.
virtual void Ogre::Renderable::_updateCustomGpuParameter | ( | const GpuProgramParameters::AutoConstantEntry & | constantEntry, | |
GpuProgramParameters * | params | |||
) | const [virtual, inherited] |
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 252 of file OgreRenderable.h.
References Ogre::GpuProgramParameters::_writeRawConstant(), Ogre::GpuProgramParameters::AutoConstantEntry::data, Ogre::GpuProgramParameters::AutoConstantEntry::elementCount, and Ogre::GpuProgramParameters::AutoConstantEntry::physicalIndex.
virtual void Ogre::Renderable::setPolygonModeOverrideable | ( | bool | override | ) | [virtual, inherited] |
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 269 of file OgreRenderable.h.
virtual bool Ogre::Renderable::getPolygonModeOverrideable | ( | void | ) | const [virtual, inherited] |
Gets whether this renderable's chosen detail level can be overridden (downgraded) by the camera setting.
Reimplemented in Ogre::BorderRenderable.
Definition at line 277 of file OgreRenderable.h.
bool Ogre::PanelOverlayElement::mTransparent [protected] |
Definition at line 125 of file OgrePanelOverlayElement.h.
Real Ogre::PanelOverlayElement::mTileX[OGRE_MAX_TEXTURE_LAYERS] [protected] |
Definition at line 127 of file OgrePanelOverlayElement.h.
Real Ogre::PanelOverlayElement::mTileY[OGRE_MAX_TEXTURE_LAYERS] [protected] |
Definition at line 128 of file OgrePanelOverlayElement.h.
size_t Ogre::PanelOverlayElement::mNumTexCoordsInBuffer [protected] |
Definition at line 129 of file OgrePanelOverlayElement.h.
Real Ogre::PanelOverlayElement::mU1 [protected] |
Definition at line 130 of file OgrePanelOverlayElement.h.
Real Ogre::PanelOverlayElement::mV1 [protected] |
Definition at line 130 of file OgrePanelOverlayElement.h.
Real Ogre::PanelOverlayElement::mU2 [protected] |
Definition at line 130 of file OgrePanelOverlayElement.h.
Real Ogre::PanelOverlayElement::mV2 [protected] |
Definition at line 130 of file OgrePanelOverlayElement.h.
RenderOperation Ogre::PanelOverlayElement::mRenderOp [protected] |
Definition at line 132 of file OgrePanelOverlayElement.h.
String Ogre::PanelOverlayElement::msTypeName [static, protected] |
Reimplemented in Ogre::BorderPanelOverlayElement.
Definition at line 143 of file OgrePanelOverlayElement.h.
CmdTiling Ogre::PanelOverlayElement::msCmdTiling [static, protected] |
Definition at line 146 of file OgrePanelOverlayElement.h.
CmdTransparent Ogre::PanelOverlayElement::msCmdTransparent [static, protected] |
Definition at line 147 of file OgrePanelOverlayElement.h.
CmdUVCoords Ogre::PanelOverlayElement::msCmdUVCoords [static, protected] |
Definition at line 148 of file OgrePanelOverlayElement.h.
ChildMap Ogre::OverlayContainer::mChildren [protected, inherited] |
Definition at line 60 of file OgreOverlayContainer.h.
ChildContainerMap Ogre::OverlayContainer::mChildContainers [protected, inherited] |
Definition at line 62 of file OgreOverlayContainer.h.
bool Ogre::OverlayContainer::mChildrenProcessEvents [protected, inherited] |
Definition at line 64 of file OgreOverlayContainer.h.
OverlayElementCommands::CmdLeft Ogre::OverlayElement::msLeftCmd [static, protected, inherited] |
Definition at line 110 of file OgreOverlayElement.h.
OverlayElementCommands::CmdTop Ogre::OverlayElement::msTopCmd [static, protected, inherited] |
Definition at line 111 of file OgreOverlayElement.h.
OverlayElementCommands::CmdWidth Ogre::OverlayElement::msWidthCmd [static, protected, inherited] |
Definition at line 112 of file OgreOverlayElement.h.
OverlayElementCommands::CmdHeight Ogre::OverlayElement::msHeightCmd [static, protected, inherited] |
Definition at line 113 of file OgreOverlayElement.h.
OverlayElementCommands::CmdMaterial Ogre::OverlayElement::msMaterialCmd [static, protected, inherited] |
Definition at line 114 of file OgreOverlayElement.h.
OverlayElementCommands::CmdCaption Ogre::OverlayElement::msCaptionCmd [static, protected, inherited] |
Definition at line 115 of file OgreOverlayElement.h.
OverlayElementCommands::CmdMetricsMode Ogre::OverlayElement::msMetricsModeCmd [static, protected, inherited] |
Definition at line 116 of file OgreOverlayElement.h.
OverlayElementCommands::CmdHorizontalAlign Ogre::OverlayElement::msHorizontalAlignCmd [static, protected, inherited] |
Definition at line 117 of file OgreOverlayElement.h.
OverlayElementCommands::CmdVerticalAlign Ogre::OverlayElement::msVerticalAlignCmd [static, protected, inherited] |
Definition at line 118 of file OgreOverlayElement.h.
OverlayElementCommands::CmdVisible Ogre::OverlayElement::msVisibleCmd [static, protected, inherited] |
Definition at line 119 of file OgreOverlayElement.h.
String Ogre::OverlayElement::mName [protected, inherited] |
Definition at line 122 of file OgreOverlayElement.h.
bool Ogre::OverlayElement::mVisible [protected, inherited] |
Definition at line 123 of file OgreOverlayElement.h.
bool Ogre::OverlayElement::mCloneable [protected, inherited] |
Definition at line 124 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mLeft [protected, inherited] |
Definition at line 125 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mTop [protected, inherited] |
Definition at line 126 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mWidth [protected, inherited] |
Definition at line 127 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mHeight [protected, inherited] |
Definition at line 128 of file OgreOverlayElement.h.
String Ogre::OverlayElement::mMaterialName [protected, inherited] |
Definition at line 129 of file OgreOverlayElement.h.
MaterialPtr Ogre::OverlayElement::mpMaterial [protected, inherited] |
Definition at line 130 of file OgreOverlayElement.h.
DisplayString Ogre::OverlayElement::mCaption [protected, inherited] |
Definition at line 131 of file OgreOverlayElement.h.
ColourValue Ogre::OverlayElement::mColour [protected, inherited] |
Definition at line 132 of file OgreOverlayElement.h.
Rectangle Ogre::OverlayElement::mClippingRegion [protected, inherited] |
Definition at line 133 of file OgreOverlayElement.h.
GuiMetricsMode Ogre::OverlayElement::mMetricsMode [protected, inherited] |
Definition at line 135 of file OgreOverlayElement.h.
GuiHorizontalAlignment Ogre::OverlayElement::mHorzAlign [protected, inherited] |
Definition at line 136 of file OgreOverlayElement.h.
GuiVerticalAlignment Ogre::OverlayElement::mVertAlign [protected, inherited] |
Definition at line 137 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mPixelTop [protected, inherited] |
Definition at line 140 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mPixelLeft [protected, inherited] |
Definition at line 141 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mPixelWidth [protected, inherited] |
Definition at line 142 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mPixelHeight [protected, inherited] |
Definition at line 143 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mPixelScaleX [protected, inherited] |
Definition at line 144 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mPixelScaleY [protected, inherited] |
Definition at line 145 of file OgreOverlayElement.h.
OverlayContainer* Ogre::OverlayElement::mParent [protected, inherited] |
Definition at line 148 of file OgreOverlayElement.h.
Overlay* Ogre::OverlayElement::mOverlay [protected, inherited] |
Definition at line 150 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mDerivedLeft [protected, inherited] |
Definition at line 153 of file OgreOverlayElement.h.
Real Ogre::OverlayElement::mDerivedTop [protected, inherited] |
Definition at line 154 of file OgreOverlayElement.h.
bool Ogre::OverlayElement::mDerivedOutOfDate [protected, inherited] |
Definition at line 155 of file OgreOverlayElement.h.
bool Ogre::OverlayElement::mGeomPositionsOutOfDate [protected, inherited] |
Flag indicating if the vertex positons need recalculating.
Definition at line 158 of file OgreOverlayElement.h.
bool Ogre::OverlayElement::mGeomUVsOutOfDate [protected, inherited] |
Flag indicating if the vertex uvs need recalculating.
Definition at line 160 of file OgreOverlayElement.h.
ushort Ogre::OverlayElement::mZOrder [protected, inherited] |
Definition at line 164 of file OgreOverlayElement.h.
Matrix4 Ogre::OverlayElement::mXForm [protected, inherited] |
Definition at line 167 of file OgreOverlayElement.h.
bool Ogre::OverlayElement::mEnabled [protected, inherited] |
Definition at line 170 of file OgreOverlayElement.h.
bool Ogre::OverlayElement::mInitialised [protected, inherited] |
Definition at line 173 of file OgreOverlayElement.h.
OverlayElement* Ogre::OverlayElement::mSourceTemplate [protected, inherited] |
Definition at line 176 of file OgreOverlayElement.h.
ParamDictionaryMap Ogre::StringInterface::msDictionary [static, protected, inherited] |
String Ogre::StringInterface::mParamDictName [protected, inherited] |
Class name for this instance to be used as a lookup (must be initialised by subclasses).
Definition at line 164 of file OgreStringInterface.h.
const PlaneList Ogre::Renderable::msDummyPlaneList [static, protected, inherited] |
Definition at line 284 of file OgreRenderable.h.
CustomParameterMap Ogre::Renderable::mCustomParameters [protected, inherited] |
Definition at line 286 of file OgreRenderable.h.
bool Ogre::Renderable::mPolygonModeOverrideable [protected, inherited] |
Definition at line 287 of file OgreRenderable.h.
bool Ogre::Renderable::mUseIdentityProjection [protected, inherited] |
Definition at line 288 of file OgreRenderable.h.
bool Ogre::Renderable::mUseIdentityView [protected, inherited] |
Definition at line 289 of file OgreRenderable.h.
Copyright © 2000-2005 by The OGRE Team
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sat May 10 16:27:24 2008