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)
void	draw (const RenderQueue &queue)
void	setArea (const Rectf &area)
const Rectf &	getArea () const
void	activate ()
void	deactivate ()
void	unprojectPoint (const GeometryBuffer &buff, const Vector2f &p_in, Vector2f &p_out) const
Public Member Functions inherited from CEGUI::EventSet
	EventSet ()
	Constructor for EventSet objects.
virtual	~EventSet (void)
	Destructor for EventSet objects.
void	addEvent (const String &name)
	Creates a new Event object with the given name and adds it to the EventSet. More...
void	addEvent (Event &event)
	Adds the given Event object to the EventSet. Ownership of the object passes to EventSet and it will be deleted when it is removed from the EventSet - whether explicitly via removeEvent or when the EventSet is destroyed. More...
void	removeEvent (const String &name)
	Removes the Event with the given name. All connections to the event are disconnected, and the underlying Event object is destroyed. More...
void	removeEvent (Event &event)
	Removes the given event from the EventSet. All connections to the event are disconnected, and the event object is destroyed. More...
void	removeAllEvents (void)
	Remove all Event objects from the EventSet. Add connections will be disconnected, and all Event objects destroyed.
bool	isEventPresent (const String &name)
	Checks to see if an Event with the given name is present in this EventSet. More...
virtual Event::Connection	subscribeEvent (const String &name, Event::Subscriber subscriber)
	Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
virtual Event::Connection	subscribeEvent (const String &name, Event::Group group, Event::Subscriber subscriber)
	Subscribes a handler to the specified group of the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
template<typename Arg1 , typename Arg2 >
Event::Connection	subscribeEvent (const String &name, Arg1 arg1, Arg2 arg2)
	Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
template<typename Arg1 , typename Arg2 >
Event::Connection	subscribeEvent (const String &name, Event::Group group, Arg1 arg1, Arg2 arg2)
	Subscribes a handler to the named Event. If the named Event is not yet present in the EventSet, it is created and added. More...
virtual Event::Connection	subscribeScriptedEvent (const String &name, const String &subscriber_name)
	Subscribes the named Event to a scripted funtion. More...
virtual Event::Connection	subscribeScriptedEvent (const String &name, Event::Group group, const String &subscriber_name)
	Subscribes the specified group of the named Event to a scripted funtion. More...
virtual void	fireEvent (const String &name, EventArgs &args, const String &eventNamespace="")
	Fires the named event passing the given EventArgs object. More...
bool	isMuted (void) const
	Return whether the EventSet is muted or not. More...
void	setMutedState (bool setting)
	Set the mute state for this EventSet. More...
Event *	getEventObject (const String &name, bool autoAdd=false)
	Return a pointer to the Event object with the given name, optionally adding such an Event object to the EventSet if it does not already exist. More...
EventIterator	getEventIterator (void) const
	Return a EventSet::EventIterator object to iterate over the events currently added to the EventSet.

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
Protected Member Functions inherited from CEGUI::EventSet
void	fireEvent_impl (const String &name, EventArgs &args)
	Implementation event firing member.
ScriptModule *	getScriptModule () const
	Helper to return the script module pointer or throw.
	EventSet (EventSet &)
EventSet &	operator= (EventSet &)

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<>
OgreRenderer &	d_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
Protected Attributes inherited from CEGUI::EventSet
EventMap	d_events
bool	d_muted
	true if events for this EventSet have been muted.

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

• true if the RenderTarget does cache rendered imagery.
• false if the RenderTarget does not cache rendered imagery.

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

target

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