Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CEGUI::Renderer Class Reference

Abstract class defining the interface for Renderer objects. More...

#include <CEGUIRenderer.h>

Inheritance diagram for CEGUI::Renderer:

Inheritance graph
[legend]
Collaboration diagram for CEGUI::Renderer:

Collaboration graph
[legend]
List of all members.

Public Types

typedef ConstBaseIterator<
EventMap
EventIterator

Public Member Functions

virtual void addQuad (const Rect &dest_rect, float z, const Texture *tex, const Rect &texture_rect, const ColourRect &colours, QuadSplitMode quad_split_mode)=0
 Add a quad to the rendering queue. All clipping and other adjustments should have been made prior to calling this.
virtual void doRender (void)=0
 Perform final rendering for all quads that have been queued for rendering.
virtual void clearRenderList (void)=0
 Clears all queued quads from the render queue.
virtual void setQueueingEnabled (bool setting)=0
 Enable or disable the queueing of quads from this point on.
virtual TexturecreateTexture (void)=0
 Creates a 'null' Texture object.
virtual TexturecreateTexture (const String &filename, const String &resourceGroup)=0
 Create a Texture object using the given image file.
virtual TexturecreateTexture (float size)=0
 Create a Texture object with the given pixel dimensions as specified by size. NB: Textures are always square.
virtual void destroyTexture (Texture *texture)=0
 Destroy the given Texture object.
virtual void destroyAllTextures (void)=0
 Destroy all Texture objects.
virtual bool isQueueingEnabled (void) const =0
 Return whether queueing is enabled.
virtual float getWidth (void) const =0
 Return the current width of the display in pixels.
virtual float getHeight (void) const =0
 Return the current height of the display in pixels.
virtual Size getSize (void) const =0
 Return the size of the display in pixels.
virtual Rect getRect (void) const =0
 Return a Rect describing the screen.
virtual uint getMaxTextureSize (void) const =0
 Return the maximum texture size available.
virtual uint getHorzScreenDPI (void) const =0
 Return the horizontal display resolution dpi.
virtual uint getVertScreenDPI (void) const =0
 Return the vertical display resolution dpi.
void resetZValue (void)
 Reset the z co-ordinate for rendering.
void advanceZValue (void)
 Update the z co-ordinate for the next major UI element (window).
float getCurrentZ (void) const
 return the current Z value to use (equates to layer 0 for this UI element).
float getZLayer (uint layer) const
 return the z co-ordinate to use for the requested layer on the current GUI element.
const StringgetIdentifierString () const
 Return identification string for the renderer module. If the internal id string has not been set by the Renderer module creator, a generic string of "Unknown renderer" will be returned.
virtual ResourceProvidercreateResourceProvider (void)
virtual ~Renderer (void)
void addEvent (const String &name)
 Add a new Event to the EventSet with the given name.
void removeEvent (const String &name)
 Removes the Event with the given name. All connections to the event are disconnected.
void removeAllEvents (void)
 Remove all Event objects from the EventSet.
bool isEventPresent (const String &name)
 Checks to see if an Event with the given name is present in the EventSet.
virtual Event::Connection subscribeEvent (const String &name, Event::Subscriber subscriber)
 Subscribes the named Event.
virtual Event::Connection subscribeEvent (const String &name, Event::Group group, Event::Subscriber subscriber)
 Subscribes the specified group of the named Event.
virtual Event::Connection subscribeScriptedEvent (const String &name, const String &subscriber_name)
 Subscribes the named Event to a scripted funtion.
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.
virtual void fireEvent (const String &name, EventArgs &args, const String &eventNamespace="")
 Fires the named event passing the given EventArgs object.
bool isMuted (void) const
 Return whether the EventSet is muted or not.
void setMutedState (bool setting)
 Set the mute state for this EventSet.
EventIterator getIterator (void) const
 Return a EventSet::EventIterator object to iterate over the available events.

Static Public Attributes

static const String EventNamespace
 Namespace for global events.
static const String EventDisplaySizeChanged

Protected Types

typedef std::map< String,
Event * > 
EventMap

Protected Member Functions

 Renderer (void)

Protected Attributes

ResourceProviderd_resourceProvider
 Holds the pointer to the ResourceProvider object.
String d_identifierString
 String that holds some id information about the renderer.
EventMap d_events
bool d_muted
 true if events for this EventSet have been muted.

Detailed Description

Abstract class defining the interface for Renderer objects.

Objects derived from Renderer are the means by which the GUI system interfaces with specific rendering technologies. To use a rendering system or API to draw CEGUI imagery requires that an appropriate Renderer object be available.

Definition at line 68 of file CEGUIRenderer.h.


Member Typedef Documentation

typedef ConstBaseIterator<EventMap> CEGUI::EventSet::EventIterator [inherited]
 

Definition at line 255 of file CEGUIEventSet.h.

typedef std::map<String, Event*> CEGUI::EventSet::EventMap [protected, inherited]
 

Definition at line 246 of file CEGUIEventSet.h.


Constructor & Destructor Documentation

CEGUI::Renderer::Renderer void   )  [protected]
 

Definition at line 54 of file CEGUIRenderer.cpp.

References CEGUI::EventSet::addEvent(), EventDisplaySizeChanged, and resetZValue().

CEGUI::Renderer::~Renderer void   )  [virtual]
 

Definition at line 68 of file CEGUIRenderer.cpp.

References d_resourceProvider.


Member Function Documentation

void CEGUI::EventSet::addEvent const String name  )  [inherited]
 

Add a new Event to the EventSet with the given name.

Parameters:
name String object containing the name to give the new Event. The name must be unique for the EventSet.
Returns:
Nothing
Exceptions:
AlreadyExistsException Thrown if an Event already exists named name.

Definition at line 55 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events, and CEGUI::EventSet::isEventPresent().

Referenced by CEGUI::Checkbox::addCheckboxEvents(), CEGUI::Combobox::addComboboxEvents(), CEGUI::ComboDropList::addComboDropListEvents(), CEGUI::DragContainer::addDragContainerEvents(), CEGUI::Editbox::addEditboxEvents(), CEGUI::FrameWindow::addFrameWindowEvents(), CEGUI::ListHeaderSegment::addHeaderSegmentEvents(), CEGUI::ItemListBase::addItemListBaseEvents(), CEGUI::Listbox::addListboxEvents(), CEGUI::ListHeader::addListHeaderEvents(), CEGUI::MenuBase::addMenuBaseEvents(), CEGUI::MenuItem::addMenuItemEvents(), CEGUI::MouseCursor::addMouseCursorEvents(), CEGUI::MultiColumnList::addMultiColumnListboxEvents(), CEGUI::MultiLineEditbox::addMultiLineEditboxEvents(), CEGUI::ProgressBar::addProgressBarEvents(), CEGUI::PushButton::addPushButtonEvents(), CEGUI::RadioButton::addRadioButtonEvents(), CEGUI::ScrollablePane::addScrollablePaneEvents(), CEGUI::Scrollbar::addScrollbarEvents(), CEGUI::ScrolledContainer::addScrolledContainerEvents(), CEGUI::Slider::addSliderEvents(), CEGUI::Spinner::addSpinnerEvents(), CEGUI::Window::addStandardEvents(), CEGUI::TabButton::addTabButtonEvents(), CEGUI::TabControl::addTabControlEvents(), CEGUI::Thumb::addThumbEvents(), CEGUI::Tooltip::addTooltipEvents(), Renderer(), and CEGUI::GlobalEventSet::subscribeEvent().

virtual void CEGUI::Renderer::addQuad const Rect dest_rect,
float  z,
const Texture tex,
const Rect texture_rect,
const ColourRect colours,
QuadSplitMode  quad_split_mode
[pure virtual]
 

Add a quad to the rendering queue. All clipping and other adjustments should have been made prior to calling this.

Parameters:
dest_rect Rect object describing the destination area (values are in pixels)
z float value specifying the z co-ordinate / z order of the quad
tex pointer to the Texture object that holds the imagery to be rendered
texture_rect Rect object holding the area of tex that is to be rendered (values are in texture co-ordinates).
colours ColourRect object describing the colour values that are to be applied when rendering.
quad_split_mode One of the QuadSplitMode values specifying the way quads are split into triangles
Returns:
Nothing

Implemented in CEGUI::DirectX81Renderer, CEGUI::DirectX9Renderer, CEGUI::IrrlichtRenderer, and CEGUI::OpenGLRenderer.

Referenced by CEGUI::Imageset::draw().

void CEGUI::Renderer::advanceZValue void   )  [inline]
 

Update the z co-ordinate for the next major UI element (window).

Returns:
Nothing

Definition at line 331 of file CEGUIRenderer.h.

Referenced by CEGUI::Window::render().

virtual void CEGUI::Renderer::clearRenderList void   )  [pure virtual]
 

Clears all queued quads from the render queue.

Returns:
Nothing

Implemented in CEGUI::DirectX81Renderer, CEGUI::DirectX9Renderer, CEGUI::IrrlichtRenderer, and CEGUI::OpenGLRenderer.

Referenced by CEGUI::System::renderGUI().

ResourceProvider * CEGUI::Renderer::createResourceProvider void   )  [virtual]
 

Reimplemented in CEGUI::IrrlichtRenderer.

Definition at line 77 of file CEGUIRenderer.cpp.

References d_resourceProvider.

virtual Texture* CEGUI::Renderer::createTexture float  size  )  [pure virtual]
 

Create a Texture object with the given pixel dimensions as specified by size. NB: Textures are always square.

Parameters:
size float value that specifies the size to use for the width and height when creating the new texture.
Returns:
a newly created Texture object. The initial contents of the texture memory is undefined / random.
Note:
Textures are always created with a size that is a power of 2. If you specify a size that is not a power of two, the final size will be rounded up. So if you specify a size of 1024, the texture will be (1024 x 1024), however, if you specify a size of 1025, the texture will be (2048 x 2048). You can check the ultimate size by querying the texture after creation.

Implemented in CEGUI::DirectX81Renderer, CEGUI::DirectX9Renderer, CEGUI::IrrlichtRenderer, and CEGUI::OpenGLRenderer.

virtual Texture* CEGUI::Renderer::createTexture const String filename,
const String resourceGroup
[pure virtual]
 

Create a Texture object using the given image file.

Parameters:
filename String object that specifies the path and filename of the image file to use when creating the texture.
resourceGroup Resource group identifier to be passed to the resource provider when loading the texture file.
Returns:
a newly created Texture object. The initial contents of the texture memory is the requested image file.
Note:
Textures are always created with a size that is a power of 2. If the file you specify is of a size that is not a power of two, the final size will be rounded up. Additionally, textures are always square, so the ultimate size is governed by the larger of the width and height of the specified file. You can check the ultimate sizes by querying the texture after creation.

Implemented in CEGUI::DirectX81Renderer, CEGUI::DirectX9Renderer, CEGUI::IrrlichtRenderer, and CEGUI::OpenGLRenderer.

virtual Texture* CEGUI::Renderer::createTexture void   )  [pure virtual]
 

Creates a 'null' Texture object.

Returns:
a newly created Texture object. The returned Texture object has no size or imagery associated with it, and is generally of little or no use.

Implemented in CEGUI::DirectX81Renderer, CEGUI::DirectX9Renderer, CEGUI::IrrlichtRenderer, and CEGUI::OpenGLRenderer.

Referenced by CEGUI::Imageset_xmlHandler::elementStart().

virtual void CEGUI::Renderer::destroyAllTextures void   )  [pure virtual]
 

Destroy all Texture objects.

Returns:
Nothing

Implemented in CEGUI::DirectX81Renderer, CEGUI::DirectX9Renderer, CEGUI::IrrlichtRenderer, and CEGUI::OpenGLRenderer.

virtual void CEGUI::Renderer::destroyTexture Texture texture  )  [pure virtual]
 

Destroy the given Texture object.

Parameters:
texture pointer to the Texture object to be destroyed
Returns:
Nothing

Implemented in CEGUI::DirectX81Renderer, CEGUI::DirectX9Renderer, CEGUI::IrrlichtRenderer, and CEGUI::OpenGLRenderer.

Referenced by CEGUI::Imageset::unload().

virtual void CEGUI::Renderer::doRender void   )  [pure virtual]
 

Perform final rendering for all quads that have been queued for rendering.

The contents of the rendering queue is retained and can be rendered again as required. If the contents is not required call clearRenderList().

Returns:
Nothing

Implemented in CEGUI::DirectX81Renderer, CEGUI::DirectX9Renderer, CEGUI::IrrlichtRenderer, and CEGUI::OpenGLRenderer.

Referenced by CEGUI::System::renderGUI().

void CEGUI::EventSet::fireEvent const String name,
EventArgs args,
const String eventNamespace = ""
[virtual, inherited]
 

Fires the named event passing the given EventArgs object.

Parameters:
name String object holding the name of the Event that is to be fired (triggered)
args The EventArgs (or derived) object that is to be bassed to each subscriber of the Event. Once all subscribers have been called the 'handled' field of the event is updated appropriately.
eventNamespace String object describing the global event namespace prefix for this event.
Returns:
Nothing.
Exceptions:
UnknownObjectException Thrown if no Event named name was found in the EventSet.

Reimplemented in CEGUI::GlobalEventSet.

Definition at line 160 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events, CEGUI::EventSet::d_muted, CEGUI::GlobalEventSet::fireEvent(), and CEGUI::GlobalEventSet::getSingleton().

Referenced by CEGUI::ScrollablePane::handleAutoSizePaneChanged(), CEGUI::Window::onActivated(), CEGUI::Window::onAlphaChanged(), CEGUI::Window::onAlwaysOnTopChanged(), CEGUI::ScrolledContainer::onAutoSizeSettingChanged(), CEGUI::ScrollablePane::onAutoSizeSettingChanged(), CEGUI::Window::onCaptureGained(), CEGUI::Window::onCaptureLost(), CEGUI::MultiLineEditbox::onCaratMoved(), CEGUI::Editbox::onCaratMoved(), CEGUI::Combobox::onCaratMoved(), CEGUI::Window::onCharacter(), CEGUI::Window::onChildAdded(), CEGUI::Window::onChildRemoved(), CEGUI::ListHeaderSegment::onClickableSettingChanged(), CEGUI::TabButton::onClicked(), CEGUI::PushButton::onClicked(), CEGUI::MenuItem::onClicked(), CEGUI::Window::onClippingChanged(), CEGUI::FrameWindow::onCloseClicked(), CEGUI::ScrolledContainer::onContentChanged(), CEGUI::ScrollablePane::onContentPaneChanged(), CEGUI::ScrollablePane::onContentPaneScrolled(), CEGUI::Window::onDeactivated(), CEGUI::Window::onDestructionStarted(), CEGUI::Window::onDisabled(), CEGUI::Tooltip::onDisplayTimeChanged(), CEGUI::DragContainer::onDragAlphaChanged(), CEGUI::Window::onDragDropItemDropped(), CEGUI::Window::onDragDropItemEnters(), CEGUI::Window::onDragDropItemLeaves(), CEGUI::DragContainer::onDragDropTargetChanged(), CEGUI::DragContainer::onDragEnabledChanged(), CEGUI::DragContainer::onDragEnded(), CEGUI::DragContainer::onDragMouseCursorChanged(), CEGUI::ListHeader::onDragMoveSettingChanged(), CEGUI::DragContainer::onDragPositionChanged(), CEGUI::ListHeader::onDragSizeSettingChanged(), CEGUI::DragContainer::onDragStarted(), CEGUI::DragContainer::onDragThresholdChanged(), CEGUI::Combobox::onDropListDisplayed(), CEGUI::Combobox::onDroplistRemoved(), CEGUI::MultiLineEditbox::onEditboxFullEvent(), CEGUI::Editbox::onEditboxFullEvent(), CEGUI::Combobox::onEditboxFullEvent(), CEGUI::Window::onEnabled(), CEGUI::Tooltip::onFadeTimeChanged(), CEGUI::Window::onFontChanged(), CEGUI::Window::onHidden(), CEGUI::Window::onHorizontalAlignmentChanged(), CEGUI::ScrollablePane::onHorzScrollbarModeChanged(), CEGUI::MultiLineEditbox::onHorzScrollbarModeChanged(), CEGUI::MultiColumnList::onHorzScrollbarModeChanged(), CEGUI::Listbox::onHorzScrollbarModeChanged(), CEGUI::Combobox::onHorzScrollbarModeChanged(), CEGUI::Tooltip::onHoverTimeChanged(), CEGUI::Window::onIDChanged(), CEGUI::MouseCursor::onImageChanged(), CEGUI::Window::onInheritsAlphaChanged(), CEGUI::Editbox::onInvalidEntryAttempted(), CEGUI::Combobox::onInvalidEntryAttempted(), CEGUI::Window::onKeyDown(), CEGUI::Window::onKeyUp(), CEGUI::MultiColumnList::onListColumnMoved(), CEGUI::MultiColumnList::onListColumnSized(), CEGUI::MultiColumnList::onListContentsChanged(), CEGUI::Listbox::onListContentsChanged(), CEGUI::ItemListBase::onListContentsChanged(), CEGUI::Combobox::onListContentsChanged(), CEGUI::ComboDropList::onListSelectionAccepted(), CEGUI::Combobox::onListSelectionAccepted(), CEGUI::Combobox::onListSelectionChanged(), CEGUI::Editbox::onMaskCodePointChanged(), CEGUI::Editbox::onMaskedRenderingModeChanged(), CEGUI::MultiLineEditbox::onMaximumTextLengthChanged(), CEGUI::Editbox::onMaximumTextLengthChanged(), CEGUI::Combobox::onMaximumTextLengthChanged(), CEGUI::Spinner::onMaximumValueChanged(), CEGUI::Window::onMetricsChanged(), CEGUI::Spinner::onMinimumValueChanged(), CEGUI::Window::onMouseButtonDown(), CEGUI::Window::onMouseButtonUp(), CEGUI::Window::onMouseClicked(), CEGUI::Window::onMouseDoubleClicked(), CEGUI::Window::onMouseEnters(), CEGUI::Window::onMouseLeaves(), CEGUI::Window::onMouseMove(), CEGUI::Window::onMouseTripleClicked(), CEGUI::Window::onMouseWheel(), CEGUI::ListHeaderSegment::onMovableSettingChanged(), CEGUI::Window::onMoved(), CEGUI::Listbox::onMultiselectModeChanged(), CEGUI::MultiColumnList::onNominatedSelectColumnChanged(), CEGUI::MultiColumnList::onNominatedSelectRowChanged(), CEGUI::Window::onParentDestroyChanged(), CEGUI::Window::onParentSized(), CEGUI::MenuBase::onPopupClosed(), CEGUI::MenuBase::onPopupOpened(), CEGUI::ProgressBar::onProgressChanged(), CEGUI::ProgressBar::onProgressDone(), CEGUI::MultiLineEditbox::onReadOnlyChanged(), CEGUI::Editbox::onReadOnlyChanged(), CEGUI::Combobox::onReadOnlyChanged(), CEGUI::Window::onRenderingEnded(), CEGUI::Window::onRenderingStarted(), CEGUI::FrameWindow::onRollupToggled(), CEGUI::Scrollbar::onScrollConfigChanged(), CEGUI::Scrollbar::onScrollPositionChanged(), CEGUI::ListHeader::onSegmentAdded(), CEGUI::ListHeaderSegment::onSegmentClicked(), CEGUI::ListHeader::onSegmentClicked(), CEGUI::ListHeaderSegment::onSegmentDragPositionChanged(), CEGUI::ListHeaderSegment::onSegmentDragStart(), CEGUI::ListHeaderSegment::onSegmentDragStop(), CEGUI::ListHeader::onSegmentOffsetChanged(), CEGUI::ListHeader::onSegmentRemoved(), CEGUI::ListHeader::onSegmentSequenceChanged(), CEGUI::ListHeaderSegment::onSegmentSized(), CEGUI::ListHeader::onSegmentSized(), CEGUI::TabControl::onSelectionChanged(), CEGUI::MultiColumnList::onSelectionChanged(), CEGUI::Listbox::onSelectionChanged(), CEGUI::MultiColumnList::onSelectionModeChanged(), CEGUI::Checkbox::onSelectStateChange(), CEGUI::RadioButton::onSelectStateChanged(), CEGUI::Window::onShown(), CEGUI::Window::onSized(), CEGUI::ListHeaderSegment::onSizingSettingChanged(), CEGUI::MultiColumnList::onSortColumnChanged(), CEGUI::ListHeader::onSortColumnChanged(), CEGUI::MultiColumnList::onSortDirectionChanged(), CEGUI::ListHeaderSegment::onSortDirectionChanged(), CEGUI::ListHeader::onSortDirectionChanged(), CEGUI::Listbox::onSortModeChanged(), CEGUI::Combobox::onSortModeChanged(), CEGUI::ListHeader::onSortSettingChanged(), CEGUI::ListHeaderSegment::onSplitterDoubleClicked(), CEGUI::ListHeader::onSplitterDoubleClicked(), CEGUI::Spinner::onStepChanged(), CEGUI::Editbox::onTextAcceptedEvent(), CEGUI::Combobox::onTextAcceptedEvent(), CEGUI::Window::onTextChanged(), CEGUI::Spinner::onTextInputModeChanged(), CEGUI::Editbox::onTextInvalidatedEvent(), CEGUI::Combobox::onTextInvalidatedEvent(), CEGUI::MultiLineEditbox::onTextSelectionChanged(), CEGUI::Editbox::onTextSelectionChanged(), CEGUI::Combobox::onTextSelectionChanged(), CEGUI::Thumb::onThumbPositionChanged(), CEGUI::Thumb::onThumbTrackEnded(), CEGUI::Slider::onThumbTrackEnded(), CEGUI::Scrollbar::onThumbTrackEnded(), CEGUI::Thumb::onThumbTrackStarted(), CEGUI::Slider::onThumbTrackStarted(), CEGUI::Scrollbar::onThumbTrackStarted(), CEGUI::Tooltip::onTooltipActive(), CEGUI::Tooltip::onTooltipInactive(), CEGUI::Editbox::onValidationStringChanged(), CEGUI::Combobox::onValidationStringChanged(), CEGUI::Spinner::onValueChanged(), CEGUI::Slider::onValueChanged(), CEGUI::Window::onVerticalAlignmentChanged(), CEGUI::ScrollablePane::onVertScrollbarModeChanged(), CEGUI::MultiLineEditbox::onVertScrollbarModeChanged(), CEGUI::MultiColumnList::onVertScrollbarModeChanged(), CEGUI::Listbox::onVertScrollbarModeChanged(), CEGUI::Combobox::onVertScrollbarModeChanged(), CEGUI::MultiLineEditbox::onWordWrapModeChanged(), CEGUI::Window::onZChanged(), CEGUI::DirectX81Renderer::setDisplaySize(), CEGUI::OpenGLRenderer::setDisplaySize(), and CEGUI::DirectX9Renderer::setDisplaySize().

float CEGUI::Renderer::getCurrentZ void   )  const [inline]
 

return the current Z value to use (equates to layer 0 for this UI element).

Returns:
float value that specifies the z co-ordinate to be used for layer 0 on the current GUI element.

Definition at line 341 of file CEGUIRenderer.h.

Referenced by CEGUI::MultiLineEditbox::cacheTextLines(), CEGUI::TextItem::populateRenderCache(), CEGUI::MultiColumnList::populateRenderCache(), CEGUI::Listbox::populateRenderCache(), and CEGUI::Window::render().

virtual float CEGUI::Renderer::getHeight void   )  const [pure virtual]
 

Return the current height of the display in pixels.

Returns:
float value equal to the current height of the display in pixels.

Implemented in CEGUI::DirectX81Renderer, CEGUI::DirectX9Renderer, CEGUI::IrrlichtRenderer, and CEGUI::OpenGLRenderer.

Referenced by CEGUI::Window::getParentHeight(), CEGUI::FrameWindow::moveBottomEdge(), CEGUI::FrameWindow::moveTopEdge(), and CEGUI::Window::screenToWindowY().

virtual uint CEGUI::Renderer::getHorzScreenDPI void   )  const [pure virtual]
 

Return the horizontal display resolution dpi.

Returns:
horizontal resolution of the display in dpi.

Implemented in CEGUI::DirectX81Renderer, CEGUI::DirectX9Renderer, CEGUI::IrrlichtRenderer, and CEGUI::OpenGLRenderer.

const String & CEGUI::Renderer::getIdentifierString  )  const
 

Return identification string for the renderer module. If the internal id string has not been set by the Renderer module creator, a generic string of "Unknown renderer" will be returned.

Returns:
String object holding a string that identifies the Renderer in use.

Definition at line 83 of file CEGUIRenderer.cpp.

References d_identifierString.

EventSet::EventIterator CEGUI::EventSet::getIterator void   )  const [inherited]
 

Return a EventSet::EventIterator object to iterate over the available events.

Definition at line 203 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events.

virtual uint CEGUI::Renderer::getMaxTextureSize void   )  const [pure virtual]
 

Return the maximum texture size available.

Returns:
Size of the maximum supported texture in pixels (textures are always assumed to be square)

Implemented in CEGUI::DirectX81Renderer, CEGUI::DirectX9Renderer, CEGUI::IrrlichtRenderer, and CEGUI::OpenGLRenderer.

virtual Rect CEGUI::Renderer::getRect void   )  const [pure virtual]
 

Return a Rect describing the screen.

Returns:
A Rect object that describes the screen area. Typically, the top-left values are always 0, and the size of the area described is equal to the screen resolution.

Implemented in CEGUI::DirectX81Renderer, CEGUI::DirectX9Renderer, CEGUI::IrrlichtRenderer, and CEGUI::OpenGLRenderer.

Referenced by CEGUI::ScrolledContainer::getUnclippedInnerRect(), CEGUI::Titlebar::onMouseButtonDown(), CEGUI::MouseCursor::setConstraintArea(), and CEGUI::MouseCursor::setUnifiedConstraintArea().

virtual Size CEGUI::Renderer::getSize void   )  const [pure virtual]
 

Return the size of the display in pixels.

Returns:
Size object describing the dimensions of the current display.

Implemented in CEGUI::DirectX81Renderer, CEGUI::DirectX9Renderer, CEGUI::IrrlichtRenderer, and CEGUI::OpenGLRenderer.

Referenced by CEGUI::MouseCursor::getConstraintArea(), CEGUI::Window::getWindowSize_impl(), CEGUI::Window::screenToWindow(), and CEGUI::Window::setWindowArea_impl().

virtual uint CEGUI::Renderer::getVertScreenDPI void   )  const [pure virtual]
 

Return the vertical display resolution dpi.

Returns:
vertical resolution of the display in dpi.

Implemented in CEGUI::DirectX81Renderer, CEGUI::DirectX9Renderer, CEGUI::IrrlichtRenderer, and CEGUI::OpenGLRenderer.

virtual float CEGUI::Renderer::getWidth void   )  const [pure virtual]
 

Return the current width of the display in pixels.

Returns:
float value equal to the current width of the display in pixels.

Implemented in CEGUI::DirectX81Renderer, CEGUI::DirectX9Renderer, CEGUI::IrrlichtRenderer, and CEGUI::OpenGLRenderer.

Referenced by CEGUI::ListHeaderSegment::doDragSizing(), CEGUI::Window::getParentWidth(), CEGUI::FrameWindow::moveLeftEdge(), CEGUI::FrameWindow::moveRightEdge(), and CEGUI::Window::screenToWindowX().

float CEGUI::Renderer::getZLayer uint  layer  )  const [inline]
 

return the z co-ordinate to use for the requested layer on the current GUI element.

Parameters:
layer Specifies the layer to return the Z co-ordinate for. Each GUI element can use up to 10 layers, so valid inputs are 0 to 9 inclusive. If you specify an invalid value for layer, results are undefined.
Returns:
float value that specifies the Z co-ordinate for layer layer on the current GUI element.

Definition at line 355 of file CEGUIRenderer.h.

Referenced by CEGUI::MultiLineEditbox::cacheTextLines(), CEGUI::TextItem::populateRenderCache(), CEGUI::MultiColumnList::populateRenderCache(), and CEGUI::Listbox::populateRenderCache().

bool CEGUI::EventSet::isEventPresent const String name  )  [inherited]
 

Checks to see if an Event with the given name is present in the EventSet.

Returns:
true if an Event named name was found, or false if the Event was not found

Definition at line 102 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events.

Referenced by CEGUI::EventSet::addEvent().

bool CEGUI::EventSet::isMuted void   )  const [inherited]
 

Return whether the EventSet is muted or not.

Returns:
  • true if the EventSet is muted. All requests to fire events will be ignored.
  • false if the EventSet is not muted. All requests to fire events are processed as normal.

Definition at line 184 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_muted.

Referenced by CEGUI::Spinner::onTextInputModeChanged(), and CEGUI::Spinner::onValueChanged().

virtual bool CEGUI::Renderer::isQueueingEnabled void   )  const [pure virtual]
 

Return whether queueing is enabled.

Returns:
true if queueing is enabled, false if queueing is disabled.

Implemented in CEGUI::DirectX81Renderer, CEGUI::DirectX9Renderer, CEGUI::IrrlichtRenderer, and CEGUI::OpenGLRenderer.

void CEGUI::EventSet::removeAllEvents void   )  [inherited]
 

Remove all Event objects from the EventSet.

Returns:
Nothing

Definition at line 85 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events.

Referenced by CEGUI::EventSet::~EventSet().

void CEGUI::EventSet::removeEvent const String name  )  [inherited]
 

Removes the Event with the given name. All connections to the event are disconnected.

Parameters:
name String object containing the name of the Event to remove. If no such Event exists, nothing happens.
Returns:
Nothing.

Definition at line 69 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events.

void CEGUI::Renderer::resetZValue void   )  [inline]
 

Reset the z co-ordinate for rendering.

Returns:
Nothing

Definition at line 321 of file CEGUIRenderer.h.

Referenced by Renderer(), and CEGUI::System::renderGUI().

void CEGUI::EventSet::setMutedState bool  setting  )  [inherited]
 

Set the mute state for this EventSet.

Parameters:
setting 
  • true if the EventSet is to be muted (no further event firing requests will be honoured until EventSet is unmuted).
  • false if the EventSet is not to be muted and all events should fired as requested.
Returns:
Nothing.

Definition at line 193 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_muted.

Referenced by CEGUI::Spinner::onTextInputModeChanged(), and CEGUI::Spinner::onValueChanged().

virtual void CEGUI::Renderer::setQueueingEnabled bool  setting  )  [pure virtual]
 

Enable or disable the queueing of quads from this point on.

This only affects queueing. If queueing is turned off, any calls to addQuad will cause the quad to be rendered directly. Note that disabling queueing will not cause currently queued quads to be rendered, nor is the queue cleared - at any time the queue can still be drawn by calling doRender, and the list can be cleared by calling clearRenderList. Re-enabling the queue causes subsequent quads to be added as if queueing had never been disabled.

Parameters:
setting true to enable queueing, or false to disable queueing (see notes above).
Returns:
Nothing

Implemented in CEGUI::DirectX81Renderer, CEGUI::DirectX9Renderer, CEGUI::IrrlichtRenderer, and CEGUI::OpenGLRenderer.

Referenced by CEGUI::System::renderGUI().

Event::Connection CEGUI::EventSet::subscribeEvent const String name,
Event::Group  group,
Event::Subscriber  subscriber
[virtual, inherited]
 

Subscribes the specified group of the named Event.

Parameters:
name String object containing the name of the Event to subscribe to.
group Group which is to be subscribed to. Subscription groups are called in ascending order.
subscriber Function or object that is to be subscribed to the Event.
Returns:
Connection object that can be used to check the status of the Event connection and to disconnect (unsubscribe) from the Event.
Exceptions:
UnknownObjectException Thrown if an Event named name is not in the EventSet

Reimplemented in CEGUI::GlobalEventSet.

Definition at line 145 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events.

Event::Connection CEGUI::EventSet::subscribeEvent const String name,
Event::Subscriber  subscriber
[virtual, inherited]
 

Subscribes the named Event.

Parameters:
name String object containing the name of the Event to subscribe to.
subscriber Function or object that is to be subscribed to the Event.
Returns:
Connection object that can be used to check the status of the Event connection and to disconnect (unsubscribe) from the Event.
Exceptions:
UnknownObjectException Thrown if an Event named name is not in the EventSet

Reimplemented in CEGUI::GlobalEventSet.

Definition at line 129 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events.

Referenced by CEGUI::TabControl::addButtonForTabContent(), CEGUI::TabControl::addTab(), CEGUI::ListHeader::createInitialisedSegment(), CEGUI::StaticText::initialise(), CEGUI::Spinner::initialise(), CEGUI::Slider::initialise(), CEGUI::Scrollbar::initialise(), CEGUI::ScrollablePane::initialise(), CEGUI::MultiLineEditbox::initialise(), CEGUI::MultiColumnList::initialise(), CEGUI::Listbox::initialise(), CEGUI::Combobox::initialise(), CEGUI::ScrolledContainer::onChildAdded(), and CEGUI::EventSet::subscribeScriptedEvent().

Event::Connection CEGUI::EventSet::subscribeScriptedEvent const String name,
Event::Group  group,
const String subscriber_name
[virtual, inherited]
 

Subscribes the specified group of the named Event to a scripted funtion.

Parameters:
name String object containing the name of the Event to subscribe to.
group Group which is to be subscribed to. Subscription groups are called in ascending order.
subscriber_name String object containing the name of the script funtion that is to be subscribed to the Event.
Returns:
Connection object that can be used to check the status of the Event connection and to disconnect (unsubscribe) from the Event.
Exceptions:
UnknownObjectException Thrown if an Event named name is not in the EventSet

Definition at line 120 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::subscribeEvent().

Event::Connection CEGUI::EventSet::subscribeScriptedEvent const String name,
const String subscriber_name
[virtual, inherited]
 

Subscribes the named Event to a scripted funtion.

Parameters:
name String object containing the name of the Event to subscribe to.
subscriber_name String object containing the name of the script funtion that is to be subscribed to the Event.
Returns:
Connection object that can be used to check the status of the Event connection and to disconnect (unsubscribe) from the Event.
Exceptions:
UnknownObjectException Thrown if an Event named name is not in the EventSet

Definition at line 111 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::subscribeEvent().


Member Data Documentation

EventMap CEGUI::EventSet::d_events [protected, inherited]
 

Definition at line 247 of file CEGUIEventSet.h.

Referenced by CEGUI::EventSet::addEvent(), CEGUI::GlobalEventSet::fireEvent(), CEGUI::EventSet::fireEvent(), CEGUI::EventSet::getIterator(), CEGUI::EventSet::isEventPresent(), CEGUI::EventSet::removeAllEvents(), CEGUI::EventSet::removeEvent(), CEGUI::GlobalEventSet::subscribeEvent(), and CEGUI::EventSet::subscribeEvent().

String CEGUI::Renderer::d_identifierString [protected]
 

String that holds some id information about the renderer.

Definition at line 395 of file CEGUIRenderer.h.

Referenced by getIdentifierString(), and CEGUI::IrrlichtRenderer::IrrlichtRenderer().

bool CEGUI::EventSet::d_muted [protected, inherited]
 

true if events for this EventSet have been muted.

Definition at line 249 of file CEGUIEventSet.h.

Referenced by CEGUI::GlobalEventSet::fireEvent(), CEGUI::EventSet::fireEvent(), CEGUI::EventSet::isMuted(), and CEGUI::EventSet::setMutedState().

ResourceProvider* CEGUI::Renderer::d_resourceProvider [protected]
 

Holds the pointer to the ResourceProvider object.

Definition at line 394 of file CEGUIRenderer.h.

Referenced by CEGUI::IrrlichtRenderer::createResourceProvider(), createResourceProvider(), CEGUI::IrrlichtRenderer::IrrlichtRenderer(), and ~Renderer().

const String CEGUI::Renderer::EventDisplaySizeChanged [static]
 

event that fires when the underlying display size had changed.

It is important that all Renderer implementers fire this properly as the system itself subscribes to this event.

Referenced by Renderer(), CEGUI::DirectX81Renderer::setDisplaySize(), CEGUI::OpenGLRenderer::setDisplaySize(), and CEGUI::DirectX9Renderer::setDisplaySize().

const String CEGUI::Renderer::EventNamespace [static]
 

Namespace for global events.

Referenced by CEGUI::DirectX81Renderer::setDisplaySize(), CEGUI::OpenGLRenderer::setDisplaySize(), and CEGUI::DirectX9Renderer::setDisplaySize().


The documentation for this class was generated from the following files:
Generated on Wed Sep 7 10:07:00 2005 for Crazy Eddies GUI System by  doxygen 1.4.3