Crazy Eddie's GUI System  ${CEGUI_VERSION}
TextureTarget_wrapper Struct Reference
+ Inheritance diagram for TextureTarget_wrapper:
+ Collaboration diagram for TextureTarget_wrapper:

Public Member Functions

virtual void clear ()
 Clear the surface of the underlying texture.
 
virtual void declareRenderSize (::CEGUI::Sizef const &sz)
 
virtual ::CEGUI::TexturegetTexture () const
 Return a pointer to the CEGUI::Texture that the TextureTarget is using. More...
 
virtual bool isRenderingInverted () const
 Return whether rendering done on the target texture is inverted in relation to regular textures. More...
 
virtual void activate ()
 Activate the render target and put it in a state ready to be drawn to. More...
 
virtual void deactivate ()
 Deactivate the render target after having completed rendering. More...
 
virtual void draw (::CEGUI::GeometryBuffer const &buffer)
 
virtual void draw (::CEGUI::RenderQueue const &queue)
 
virtual void fireEvent (::CEGUI::String const &name,::CEGUI::EventArgs &args,::CEGUI::String const &eventNamespace="")
 
void default_fireEvent (::CEGUI::String const &name,::CEGUI::EventArgs &args,::CEGUI::String const &eventNamespace="")
 
void fireEvent_impl (::CEGUI::String const &name,::CEGUI::EventArgs &args)
 
virtual ::CEGUI::Rectf const & getArea () const
 Return the area defined for this RenderTarget. More...
 
::CEGUI::ScriptModulegetScriptModule () const
 
virtual bool isImageryCache () const
 Return whether the RenderTarget is an implementation that caches actual rendered imagery. More...
 
virtual void setArea (::CEGUI::Rectf const &area)
 
virtual ::CEGUI::RefCounted< CEGUI::BoundSlotsubscribeScriptedEvent (::CEGUI::String const &name,::CEGUI::String const &subscriber_name)
 
::CEGUI::RefCounted< CEGUI::BoundSlotdefault_subscribeScriptedEvent (::CEGUI::String const &name,::CEGUI::String const &subscriber_name)
 
virtual ::CEGUI::RefCounted< CEGUI::BoundSlotsubscribeScriptedEvent (::CEGUI::String const &name, unsigned int group,::CEGUI::String const &subscriber_name)
 
::CEGUI::RefCounted< CEGUI::BoundSlotdefault_subscribeScriptedEvent (::CEGUI::String const &name, unsigned int group,::CEGUI::String const &subscriber_name)
 
virtual void unprojectPoint (::CEGUI::GeometryBuffer const &buff,::CEGUI::Vector2f const &p_in,::CEGUI::Vector2f &p_out) const
 
- Public Member Functions inherited from CEGUI::TextureTarget
virtual void declareRenderSize (const Sizef &sz)=0
 Used to declare to the TextureTarget the largest size, in pixels, of the next set of incoming rendering operations. More...
 
virtual void declareRenderSize (const Sizef &sz)=0
 Used to declare to the TextureTarget the largest size, in pixels, of the next set of incoming rendering operations. More...
 
- Public Member Functions inherited from CEGUI::RenderTarget
virtual void draw (const GeometryBuffer &buffer)=0
 Draw geometry from the given GeometryBuffer onto the surface that this RenderTarget represents. More...
 
virtual void draw (const RenderQueue &queue)=0
 Draw geometry from the given RenderQueue onto the surface that this RenderTarget represents. More...
 
virtual void setArea (const Rectf &area)=0
 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...
 
virtual void unprojectPoint (const GeometryBuffer &buff, const Vector2f &p_in, Vector2f &p_out) const =0
 Take point p_in unproject it and put the result in p_out. Resulting point is local to GeometryBuffer buff.
 
virtual void draw (const GeometryBuffer &buffer)=0
 Draw geometry from the given GeometryBuffer onto the surface that this RenderTarget represents. More...
 
virtual void draw (const RenderQueue &queue)=0
 Draw geometry from the given RenderQueue onto the surface that this RenderTarget represents. More...
 
virtual void setArea (const Rectf &area)=0
 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...
 
virtual void unprojectPoint (const GeometryBuffer &buff, const Vector2f &p_in, Vector2f &p_out) const =0
 Take point p_in unproject it and put the result in p_out. Resulting point is local to GeometryBuffer buff.
 
- 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...
 
EventgetEventObject (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.
 
 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...
 
EventgetEventObject (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.
 

Additional Inherited Members

- Public Types inherited from CEGUI::EventSet
typedef ConstMapIterator< EventMap > EventIterator
 
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
 
typedef std::map< String, Event *, StringFastLessCompare CEGUI_MAP_ALLOC(String, Event *)> EventMap
 
- Protected Member Functions inherited from CEGUI::EventSet
void fireEvent_impl (const String &name, EventArgs &args)
 Implementation event firing member.
 
ScriptModulegetScriptModule () const
 Helper to return the script module pointer or throw.
 
 EventSet (EventSet &)
 
 EventSet (const EventSet &)
 
EventSetoperator= (EventSet &)
 
EventSetoperator= (const EventSet &)
 
void fireEvent_impl (const String &name, EventArgs &args)
 Implementation event firing member.
 
ScriptModulegetScriptModule () const
 Helper to return the script module pointer or throw.
 
 EventSet (EventSet &)
 
 EventSet (const EventSet &)
 
EventSetoperator= (EventSet &)
 
EventSetoperator= (const EventSet &)
 
- Protected Attributes inherited from CEGUI::EventSet
EventMap d_events
 
bool d_muted
 true if events for this EventSet have been muted.
 

Member Function Documentation

virtual void TextureTarget_wrapper::activate ( )
inlinevirtual

Activate the render target and put it in a state ready to be drawn to.

Note
You MUST call this before doing any rendering - if you do not call this, in the unlikely event that your application actually works, it will likely stop working in some future version.

Implements CEGUI::RenderTarget.

virtual void TextureTarget_wrapper::deactivate ( )
inlinevirtual

Deactivate the render target after having completed rendering.

Note
You MUST call this after you finish rendering to the target - if you do not call this, in the unlikely event that your application actually works, it will likely stop working in some future version.

Implements CEGUI::RenderTarget.

References CEGUI::EventSet::fireEvent(), and CEGUI::EventSet::fireEvent_impl().

virtual ::CEGUI::Rectf const& TextureTarget_wrapper::getArea ( ) const
inlinevirtual

Return the area defined for this RenderTarget.

Returns
Rect object describing the currently defined area for this RenderTarget.

Implements CEGUI::RenderTarget.

References CEGUI::EventSet::getScriptModule().

virtual ::CEGUI::Texture& TextureTarget_wrapper::getTexture ( ) const
inlinevirtual

Return a pointer to the CEGUI::Texture that the TextureTarget is using.

Returns
Texture object that the TextureTarget uses when rendering imagery.

Implements CEGUI::TextureTarget.

virtual bool TextureTarget_wrapper::isImageryCache ( ) const
inlinevirtual

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.

References CEGUI::RenderTarget::activate(), CEGUI::TextureTarget::clear(), CEGUI::RenderTarget::deactivate(), CEGUI::TextureTarget::declareRenderSize(), CEGUI::RenderTarget::draw(), CEGUI::EventSet::fireEvent(), CEGUI::RenderTarget::getArea(), CEGUI::TextureTarget::getTexture(), CEGUI::RenderTarget::isImageryCache(), CEGUI::TextureTarget::isRenderingInverted(), CEGUI::RenderTarget::setArea(), CEGUI::EventSet::subscribeScriptedEvent(), and CEGUI::RenderTarget::unprojectPoint().

virtual bool TextureTarget_wrapper::isRenderingInverted ( ) const
inlinevirtual

Return whether rendering done on the target texture is inverted in relation to regular textures.

This is intended to be used when generating geometry for rendering the TextureTarget onto another surface.

Returns
  • true if the texture content should be considered as inverted vertically in comparison with other regular textures.
  • false if the texture content has the same orientation as regular textures.
Deprecated:
This function is deprecated.

Implements CEGUI::TextureTarget.