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:

Ogre::Renderable List of all members.

Public Methods

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

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

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

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

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

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

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

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

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


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.


Constructor & Destructor Documentation

Ogre::BorderRenderable::BorderRenderable BorderPanelGuiElement   parent [inline]
 

Constructed with pointers to parent.


Member Function Documentation

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

Retrieves a pointer to the material this renderable object uses.

Implements Ogre::Renderable.

unsigned short Ogre::BorderRenderable::getNumWorldTransforms void    [inline, 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.

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

Returns the preferred rasterisation mode of this renderable.

Reimplemented in Ogre::SubEntity.

void Ogre::BorderRenderable::getRenderOperation RenderOperation   rend [inline, virtual]
 

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

Parameters:
rend  RenderOperation structure to update.

Implements Ogre::Renderable.

Real Ogre::BorderRenderable::getSquaredViewDepth const Camera   cam const [inline, 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.

void Ogre::BorderRenderable::getWorldTransforms Matrix4   xform [inline, 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.

bool Ogre::BorderRenderable::useIdentityProjection void    [inline, 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.

bool Ogre::BorderRenderable::useIdentityView void    [inline, 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.


Member Data Documentation

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

Copyright © 2002 by The OGRE Team