Main Page   Namespace List   Class Hierarchy   Alphabetical List   Compound List   File List   Namespace Members   Compound Members   File Members   Related Pages  

Ogre::BorderRenderable Class Reference

Class for rendering the border of a BorderPanelGuiElement. More...

#include <OgreBorderPanelGuiElement.h>

Inheritance diagram for Ogre::BorderRenderable:

Inheritance graph
[legend]
Collaboration diagram for Ogre::BorderRenderable:

Collaboration graph
[legend]
List of all members.

Public Methods

 BorderRenderable (BorderPanelGuiElement *parent)
 Constructed with pointers to parent.

MaterialgetMaterial (void) const
 Retrieves a pointer to the material this renderable object uses.

void getRenderOperation (RenderOperation &op)
 Gets the render operation required to send this object to the frame buffer.

void getWorldTransforms (Matrix4 *xform) const
 Gets the world transform matrix / matrices for this renderable object.

const QuaterniongetWorldOrientation (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 Vector3getWorldPosition (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.

unsigned short getNumWorldTransforms (void) const
 Returns the number of world transform matrices this renderable requires.

bool useIdentityProjection (void) const
 Returns whether or not to use an 'identity' projection.

bool useIdentityView (void) const
 Returns whether or not to use an 'identity' projection.

Real getSquaredViewDepth (const Camera *cam) const
 Returns the camera-relative squared depth of this renderable.

const LightListgetLights (void) const
 Gets a list of lights, ordered relative to how close they are to this renderable.

virtual TechniquegetTechnique (void) const
 Retrieves a pointer to the Material Technique this renderable object uses.

virtual SceneDetailLevel getRenderDetail () const
 Returns the preferred rasterisation mode of this renderable.

virtual bool getNormaliseNormals (void) const
 Returns whether or not this Renderable wishes the hardware to normalise normals.


Protected Attributes

BorderPanelGuiElementmParent

Detailed Description

Class for rendering the border of a BorderPanelGuiElement.

Remarks:
We need this because we have to render twice, once with the inner panel's repeating material (handled by superclass) and once for the border's separate meterial.

Definition at line 306 of file OgreBorderPanelGuiElement.h.


Constructor & Destructor Documentation

Ogre::BorderRenderable::BorderRenderable BorderPanelGuiElement   parent
 

Constructed with pointers to parent.

Definition at line 312 of file OgreBorderPanelGuiElement.h.


Member Function Documentation

const LightList& Ogre::BorderRenderable::getLights void    const [virtual]
 

Gets a list of lights, ordered relative to how close they are to this renderable.

Remarks:
Directional lights, which have no position, will always be first on this list.

Implements Ogre::Renderable.

Definition at line 322 of file OgreBorderPanelGuiElement.h.

References Ogre::LightList.

Material* Ogre::BorderRenderable::getMaterial void    const [virtual]
 

Retrieves a pointer to the material this renderable object uses.

Remarks:
Note that the Renderable also has the option to override the getTechnique method to specify a particular Technique to use instead of the best one available.

Implements Ogre::Renderable.

Definition at line 313 of file OgreBorderPanelGuiElement.h.

References Ogre::BorderPanelGuiElement::mpBorderMaterial.

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 132 of file OgreRenderable.h.

Referenced by Ogre::SceneManager::renderSingleObject().

unsigned short Ogre::BorderRenderable::getNumWorldTransforms void    const [virtual]
 

Returns the number of world transform matrices this renderable requires.

Remarks:
When a renderable uses vertex blending, it uses multiple world matrices instead of a single one. Each vertex sent to the pipeline can reference one or more matrices in this list with given weights. If a renderable does not use vertex blending this method returns 1, which is the default for simplicity.

Reimplemented from Ogre::Renderable.

Definition at line 318 of file OgreBorderPanelGuiElement.h.

virtual SceneDetailLevel Ogre::Renderable::getRenderDetail   const [virtual, inherited]
 

Returns the preferred rasterisation mode of this renderable.

Reimplemented in Ogre::SubEntity.

Definition at line 129 of file OgreRenderable.h.

References Ogre::SceneDetailLevel, and Ogre::SDL_SOLID.

Referenced by Ogre::SceneManager::renderSingleObject().

void Ogre::BorderRenderable::getRenderOperation RenderOperation   op [virtual]
 

Gets the render operation required to send this object to the frame buffer.

Implements Ogre::Renderable.

Definition at line 314 of file OgreBorderPanelGuiElement.h.

References Ogre::BorderPanelGuiElement::mRenderOp2.

Real Ogre::BorderRenderable::getSquaredViewDepth const Camera   cam const [virtual]
 

Returns the camera-relative squared depth of this renderable.

Remarks:
Used to sort transparent objects. Squared depth is used rather than actual depth to avoid having to perform a square root on the result.

Implements Ogre::Renderable.

Definition at line 321 of file OgreBorderPanelGuiElement.h.

References Ogre::GuiElement::getSquaredViewDepth(), and Ogre::Real.

virtual Technique* Ogre::Renderable::getTechnique void    const [virtual, inherited]
 

Retrieves a pointer to the Material Technique this renderable object uses.

Remarks:
This is to allow Renderables to use a chosen Technique if they wish, otherwise they will use the best Technique available for the Material they are using.

Reimplemented in Ogre::SubEntity.

Definition at line 63 of file OgreRenderable.h.

References Ogre::Material::getBestTechnique().

Referenced by Ogre::RenderPriorityGroup::addRenderable().

const Quaternion& Ogre::BorderRenderable::getWorldOrientation void    const [virtual]
 

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.

Definition at line 316 of file OgreBorderPanelGuiElement.h.

const Vector3& Ogre::BorderRenderable::getWorldPosition void    const [virtual]
 

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.

Definition at line 317 of file OgreBorderPanelGuiElement.h.

void Ogre::BorderRenderable::getWorldTransforms Matrix4   xform const [virtual]
 

Gets the world transform matrix / matrices for this renderable object.

Remarks:
If the object has any derived transforms, these are expected to be up to date as long as all the SceneNode structures have been updated before this is called.

This method will populate xform with 1 matrix if it does not use vertex blending. If it does use vertex blending it will fill the passed in pointer with an array of matrices, the length being the value returned from getNumWorldTransforms.

Implements Ogre::Renderable.

Definition at line 315 of file OgreBorderPanelGuiElement.h.

References Ogre::GuiElement::getWorldTransforms().

bool Ogre::BorderRenderable::useIdentityProjection void    const [virtual]
 

Returns whether or not to use an 'identity' projection.

Remarks:
Usually Renderable objects will use a projection matrix as determined by the active camera. However, if they want they can cancel this out and use an identity projection, which effectively projects in 2D using a {-1, 1} view space. Useful for overlay rendering. Normal renderables need not override this.

Reimplemented from Ogre::Renderable.

Definition at line 319 of file OgreBorderPanelGuiElement.h.

bool Ogre::BorderRenderable::useIdentityView void    const [virtual]
 

Returns whether or not to use an 'identity' projection.

Remarks:
Usually Renderable objects will use a view matrix as determined by the active camera. However, if they want they can cancel this out and use an identity matrix, which means all geometry is assumed to be relative to camera space already. Useful for overlay rendering. Normal renderables need not override this.

Reimplemented from Ogre::Renderable.

Definition at line 320 of file OgreBorderPanelGuiElement.h.


Member Data Documentation

BorderPanelGuiElement* Ogre::BorderRenderable::mParent [protected]
 

Definition at line 309 of file OgreBorderPanelGuiElement.h.


The documentation for this class was generated from the following file:

Copyright © 2002-2003 by The OGRE Team
Last modified Wed Jan 21 00:11:12 2004