Crazy Eddie's GUI System  0.8.4
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Pages
CEGUI::OgreWindowTarget Class Reference

CEGUI::RenderTarget that targets an existing gre::RenderTarget. More...

+ Inheritance diagram for CEGUI::OgreWindowTarget:
+ Collaboration diagram for CEGUI::OgreWindowTarget:

Public Member Functions

 OgreWindowTarget (OgreRenderer &owner, Ogre::RenderSystem &rs, Ogre::RenderTarget &target)
 Constructor.
 
virtual ~OgreWindowTarget ()
 Destructor.
 
void setOgreRenderTarget (Ogre::RenderTarget &target)
 Set the Ogre::RenderTarget that the output from the OgreWindowTarget should be rendered to. More...
 
bool isImageryCache () const
 Return whether the RenderTarget is an implementation that caches actual rendered imagery. More...
 
- Public Member Functions inherited from CEGUI::OgreRenderTarget<>
 OgreRenderTarget (OgreRenderer &owner, Ogre::RenderSystem &rs)
 Constructor.
 
virtual ~OgreRenderTarget ()
 Destructor.
 
void setOgreViewportDimensions (const Rectf &area)
 Set the underlying viewport area directly - bypassing what the RenderTarget considers to be it's area - thus allowing the view port area used for rendering to be different to the area set for the target. More...
 
void draw (const GeometryBuffer &buffer)
 Draw geometry from the given GeometryBuffer onto the surface that this RenderTarget represents. More...
 
void draw (const RenderQueue &queue)
 Draw geometry from the given RenderQueue onto the surface that this RenderTarget represents. More...
 
void setArea (const Rectf &area)
 Set the area for this RenderTarget. The exact action this function will take depends upon what the concrete class is representing. For example, with a 'view port' style RenderTarget, this should set the area that the view port occupies on the display (or rendering window). More...
 
const RectfgetArea () const
 Return the area defined for this RenderTarget. More...
 
void activate ()
 Activate the render target and put it in a state ready to be drawn to. More...
 
void deactivate ()
 Deactivate the render target after having completed rendering. More...
 
void unprojectPoint (const GeometryBuffer &buff, const Vector2f &p_in, Vector2f &p_out) const
 Take point p_in unproject it and put the result in p_out. Resulting point is local to GeometryBuffer buff.
 

Protected Member Functions

void initRenderTarget (Ogre::RenderTarget &target)
 helper function to initialise the render target details
 
- Protected Member Functions inherited from CEGUI::OgreRenderTarget<>
void updateMatrix () const
 helper that initialises the cached matrix
 
void updateViewport ()
 helper that initialises the viewport
 
void updateOgreViewportDimensions (const Ogre::RenderTarget *const rt)
 helper to update the actual Ogre viewport dimensions
 

Additional Inherited Members

- Public Types inherited from CEGUI::EventSet
typedef ConstMapIterator
< EventMap > 
EventIterator
 
- Static Public Attributes inherited from CEGUI::RenderTarget
static const String EventNamespace
 Namespace for global events.
 
static const String EventAreaChanged
 
- Protected Types inherited from CEGUI::EventSet
typedef std::map< String,
Event *, StringFastLessCompare
CEGUI_MAP_ALLOC(String, Event *)> 
EventMap
 
- Protected Attributes inherited from CEGUI::OgreRenderTarget<>
OgreRendererd_owner
 OgreRenderer object that owns this RenderTarget.
 
Ogre::RenderSystem & d_renderSystem
 Ogre RendererSystem used to affect the rendering process.
 
Rectf d_area
 holds defined area for the RenderTarget
 
Ogre::RenderTarget * d_renderTarget
 Ogre render target that we are effectively wrapping.
 
Ogre::Viewport * d_viewport
 Ogre viewport used for this target.
 
Ogre::Matrix4 d_matrix
 projection / view matrix cache
 
bool d_matrixValid
 true when d_matrix is valid and up to date
 
float d_viewDistance
 tracks viewing distance (this is set up at the same time as d_matrix)
 
bool d_viewportValid
 true when d_viewport is up to date and valid.
 
Rectf d_ogreViewportDimensions
 holds set Ogre viewport dimensions
 

Detailed Description

CEGUI::RenderTarget that targets an existing gre::RenderTarget.

Member Function Documentation

bool CEGUI::OgreWindowTarget::isImageryCache ( ) const
virtual

Return whether the RenderTarget is an implementation that caches actual rendered imagery.

Typically it is expected that texture based RenderTargets would return
true in response to this call.  Other types of RenderTarget, like
view port based targets, will more likely return false.
Returns

Implements CEGUI::RenderTarget.

void CEGUI::OgreWindowTarget::setOgreRenderTarget ( Ogre::RenderTarget &  target)

Set the Ogre::RenderTarget that the output from the OgreWindowTarget should be rendered to.

Parameters
targetReference to an Ogre::RenderTarget object that will receive the rendered output.