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

CEGUI::DirectX81Renderer Class Reference

Renderer class to interface with Microsoft DirectX 8.1. More...

#include <renderer.h>

Inheritance diagram for CEGUI::DirectX81Renderer:

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

Collaboration graph
[legend]
List of all members.

Public Types

typedef ConstBaseIterator<
EventMap
EventIterator

Public Member Functions

 DirectX81Renderer (LPDIRECT3DDEVICE8 device, uint max_quads=0)
 Constructor for Direct3D 8.1 Renderer object.
 DirectX81Renderer (LPDIRECT3DDEVICE8 device, const Size &sz)
 Constructor for Direct3D 8.1 Renderer object.
virtual ~DirectX81Renderer (void)
 Destructor for DirectX81Renderer objects.
virtual void addQuad (const Rect &dest_rect, float z, const Texture *tex, const Rect &texture_rect, const ColourRect &colours, QuadSplitMode quad_split_mode)
 Add a quad to the rendering queue. All clipping and other adjustments should have been made prior to calling this.
virtual void doRender (void)
 Perform final rendering for all quads that have been queued for rendering.
virtual void clearRenderList (void)
 Clears all queued quads from the render queue.
virtual void setQueueingEnabled (bool setting)
 Enable or disable the queueing of quads from this point on.
virtual TexturecreateTexture (void)
 Creates a 'null' Texture object.
virtual TexturecreateTexture (const String &filename, const String &resourceGroup)
 Create a Texture object using the given image file.
virtual TexturecreateTexture (float size)
 Create a Texture object with the given pixel dimensions as specified by size. NB: Textures are always square.
virtual void destroyTexture (Texture *texture)
 Destroy the given Texture object.
virtual void destroyAllTextures (void)
 Destroy all Texture objects.
LPDIRECT3DDEVICE8 getDevice (void) const
virtual bool isQueueingEnabled (void) const
 Return whether queueing is enabled.
virtual float getWidth (void) const
 Return the current width of the display in pixels.
virtual float getHeight (void) const
 Return the current height of the display in pixels.
virtual Size getSize (void) const
 Return the size of the display in pixels.
virtual Rect getRect (void) const
 Return a Rect describing the screen.
virtual uint getMaxTextureSize (void) const
 Return the maximum texture size available.
virtual uint getHorzScreenDPI (void) const
 Return the horizontal display resolution dpi.
virtual uint getVertScreenDPI (void) const
 Return the vertical display resolution dpi.
virtual void preD3DReset (void)
 Direct3D support method that must be called prior to a Reset call on the Direct3DDevice; this is required so that the GUI renderer can release any unmanaged D3D resources as needed for the device reset to succeed.
virtual void postD3DReset (void)
 Direct3D support method that must be called after a Reset call on the Direct3DDevice; this is required so that the GUI renderer can rebuild any unmanaged D3D resources after the device has been reset.
void setDisplaySize (const Size &sz)
 Set the size of the display in pixels.
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.
virtual ResourceProvidercreateResourceProvider (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 the named Event.
virtual Event::Connection subscribeEvent (const String &name, Event::Group group, Event::Subscriber subscriber)
 Subscribes the the specified group of the named Event.
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

const String EventNamespace
 Namespace for global events.
const String EventDisplaySizeChanged

Protected Types

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

Protected Attributes

ResourceProviderd_resourceProvider
 Holds the pointer to the ResourceProvider object.
EventMap d_events
bool d_muted
 true if events for this EventSet have been muted.

Detailed Description

Renderer class to interface with Microsoft DirectX 8.1.

Definition at line 64 of file renderer.h.


Member Typedef Documentation

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

Definition at line 216 of file CEGUIEventSet.h.

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

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

Definition at line 207 of file CEGUIEventSet.h.


Constructor & Destructor Documentation

CEGUI::DirectX81Renderer::DirectX81Renderer LPDIRECT3DDEVICE8  device,
uint  max_quads = 0
 

Constructor for Direct3D 8.1 Renderer object.

Parameters:
device Pointer to the IDirect3DDevice8 interface object that will be used for all rendering
max_quads Obsolete. Set to 0.

Definition at line 57 of file renderer.cpp.

References CEGUI::Size::d_height, and CEGUI::Size::d_width.

CEGUI::DirectX81Renderer::DirectX81Renderer LPDIRECT3DDEVICE8  device,
const Size sz
 

Constructor for Direct3D 8.1 Renderer object.

Parameters:
device Pointer to the IDirect3DDevice8 interface object that will be used for all rendering
sz Size object describing the initial size of the display (the dimensions should be >0)

Definition at line 82 of file renderer.cpp.

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

Destructor for DirectX81Renderer objects.

Definition at line 132 of file renderer.cpp.

References destroyAllTextures().


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 54 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::Editbox::addEditboxEvents(), CEGUI::FrameWindow::addFrameWindowEvents(), CEGUI::ListHeaderSegment::addHeaderSegmentEvents(), CEGUI::Listbox::addListboxEvents(), CEGUI::ListHeader::addListHeaderEvents(), CEGUI::MouseCursor::addMouseCursorEvents(), CEGUI::MultiColumnList::addMultiColumnListboxEvents(), CEGUI::MultiLineEditbox::addMultiLineEditboxEvents(), CEGUI::ProgressBar::addProgressBarEvents(), CEGUI::PushButton::addPushButtonEvents(), CEGUI::RadioButton::addRadioButtonEvents(), CEGUI::Scrollbar::addScrollbarEvents(), CEGUI::Slider::addSliderEvents(), CEGUI::Window::addStandardEvents(), CEGUI::TabButton::addTabButtonEvents(), CEGUI::TabControl::addTabControlEvents(), CEGUI::Thumb::addThumbEvents(), CEGUI::Renderer::Renderer(), and CEGUI::GlobalEventSet::subscribeEvent().

void CEGUI::DirectX81Renderer::addQuad const Rect dest_rect,
float  z,
const Texture tex,
const Rect texture_rect,
const ColourRect colours,
QuadSplitMode  quad_split_mode
[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

Implements CEGUI::Renderer.

Definition at line 151 of file renderer.cpp.

References CEGUI::ColourRect::d_bottom_left, CEGUI::ColourRect::d_bottom_right, CEGUI::ColourRect::d_top_left, CEGUI::ColourRect::d_top_right, CEGUI::colour::getARGB(), and CEGUI::Point.

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

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

Returns:
Nothing

Definition at line 310 of file CEGUIRenderer.h.

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

void CEGUI::DirectX81Renderer::clearRenderList void   )  [virtual]
 

Clears all queued quads from the render queue.

Returns:
Nothing

Implements CEGUI::Renderer.

Definition at line 349 of file renderer.cpp.

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

Reimplemented in CEGUI::IrrlichtRenderer.

Definition at line 76 of file CEGUIRenderer.cpp.

References CEGUI::Renderer::d_resourceProvider.

Texture * CEGUI::DirectX81Renderer::createTexture float  size  )  [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.

Implements CEGUI::Renderer.

Definition at line 381 of file renderer.cpp.

References createTexture(), CEGUI::DirectX81Texture::setD3DTextureSize(), and CEGUI::uint.

Texture * CEGUI::DirectX81Renderer::createTexture const String filename,
const String resourceGroup
[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.

Implements CEGUI::Renderer.

Definition at line 369 of file renderer.cpp.

References createTexture(), and CEGUI::DirectX81Texture::loadFromFile().

Texture * CEGUI::DirectX81Renderer::createTexture void   )  [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.

Implements CEGUI::Renderer.

Definition at line 358 of file renderer.cpp.

Referenced by createTexture().

void CEGUI::DirectX81Renderer::destroyAllTextures void   )  [virtual]
 

Destroy all Texture objects.

Returns:
Nothing

Implements CEGUI::Renderer.

Definition at line 407 of file renderer.cpp.

References destroyTexture().

Referenced by ~DirectX81Renderer().

void CEGUI::DirectX81Renderer::destroyTexture Texture texture  )  [virtual]
 

Destroy the given Texture object.

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

Implements CEGUI::Renderer.

Definition at line 392 of file renderer.cpp.

Referenced by destroyAllTextures().

void CEGUI::DirectX81Renderer::doRender void   )  [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

Implements CEGUI::Renderer.

Definition at line 186 of file renderer.cpp.

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 141 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events.

Referenced by CEGUI::Window::onActivated(), CEGUI::Window::onAlphaChanged(), CEGUI::Window::onAlwaysOnTopChanged(), 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::Window::onClippingChanged(), CEGUI::FrameWindow::onCloseClicked(), CEGUI::Window::onDeactivated(), CEGUI::Window::onDestructionStarted(), CEGUI::Window::onDisabled(), CEGUI::ListHeader::onDragMoveSettingChanged(), CEGUI::ListHeader::onDragSizeSettingChanged(), CEGUI::Combobox::onDropListDisplayed(), CEGUI::Combobox::onDroplistRemoved(), CEGUI::MultiLineEditbox::onEditboxFullEvent(), CEGUI::Editbox::onEditboxFullEvent(), CEGUI::Combobox::onEditboxFullEvent(), CEGUI::Window::onEnabled(), CEGUI::Window::onFontChanged(), CEGUI::Window::onHidden(), CEGUI::MultiLineEditbox::onHorzScrollbarModeChanged(), CEGUI::MultiColumnList::onHorzScrollbarModeChanged(), CEGUI::Listbox::onHorzScrollbarModeChanged(), CEGUI::Combobox::onHorzScrollbarModeChanged(), 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::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::Window::onMetricsChanged(), 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::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::Editbox::onTextAcceptedEvent(), CEGUI::Combobox::onTextAcceptedEvent(), CEGUI::Window::onTextChanged(), 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::Editbox::onValidationStringChanged(), CEGUI::Combobox::onValidationStringChanged(), CEGUI::Slider::onValueChanged(), CEGUI::MultiLineEditbox::onVertScrollbarModeChanged(), CEGUI::MultiColumnList::onVertScrollbarModeChanged(), CEGUI::Listbox::onVertScrollbarModeChanged(), CEGUI::Combobox::onVertScrollbarModeChanged(), CEGUI::MultiLineEditbox::onWordWrapModeChanged(), CEGUI::Window::onZChanged(), setDisplaySize(), and CEGUI::DirectX9Renderer::setDisplaySize().

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

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 320 of file CEGUIRenderer.h.

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

LPDIRECT3DDEVICE8 CEGUI::DirectX81Renderer::getDevice void   )  const [inline]
 

Definition at line 143 of file renderer.h.

virtual float CEGUI::DirectX81Renderer::getHeight void   )  const [inline, virtual]
 

Return the current height of the display in pixels.

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

Implements CEGUI::Renderer.

Definition at line 173 of file renderer.h.

References CEGUI::Texture::getHeight().

virtual uint CEGUI::DirectX81Renderer::getHorzScreenDPI void   )  const [inline, virtual]
 

Return the horizontal display resolution dpi.

Returns:
horizontal resolution of the display in dpi.

Implements CEGUI::Renderer.

Definition at line 214 of file renderer.h.

References CEGUI::uint.

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

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

Definition at line 183 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events, and CEGUI::EventSet::EventIterator.

virtual uint CEGUI::DirectX81Renderer::getMaxTextureSize void   )  const [inline, virtual]
 

Return the maximum texture size available.

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

Implements CEGUI::Renderer.

Definition at line 204 of file renderer.h.

References CEGUI::uint.

virtual Rect CEGUI::DirectX81Renderer::getRect void   )  const [inline, 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.

Implements CEGUI::Renderer.

Definition at line 194 of file renderer.h.

virtual Size CEGUI::DirectX81Renderer::getSize void   )  const [inline, virtual]
 

Return the size of the display in pixels.

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

Implements CEGUI::Renderer.

Definition at line 183 of file renderer.h.

virtual uint CEGUI::DirectX81Renderer::getVertScreenDPI void   )  const [inline, virtual]
 

Return the vertical display resolution dpi.

Returns:
vertical resolution of the display in dpi.

Implements CEGUI::Renderer.

Definition at line 224 of file renderer.h.

References CEGUI::uint.

virtual float CEGUI::DirectX81Renderer::getWidth void   )  const [inline, virtual]
 

Return the current width of the display in pixels.

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

Implements CEGUI::Renderer.

Definition at line 163 of file renderer.h.

References CEGUI::Texture::getWidth().

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

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 334 of file CEGUIRenderer.h.

Referenced by CEGUI::MultiLineEditbox::renderTextLines().

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 101 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 164 of file CEGUIEventSet.cpp.

virtual bool CEGUI::DirectX81Renderer::isQueueingEnabled void   )  const [inline, virtual]
 

Return whether queueing is enabled.

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

Implements CEGUI::Renderer.

Definition at line 153 of file renderer.h.

void CEGUI::DirectX81Renderer::postD3DReset void   )  [virtual]
 

Direct3D support method that must be called after a Reset call on the Direct3DDevice; this is required so that the GUI renderer can rebuild any unmanaged D3D resources after the device has been reset.

Definition at line 631 of file renderer.cpp.

References CEGUI::DirectX81Texture::postD3DReset(), and setDisplaySize().

void CEGUI::DirectX81Renderer::preD3DReset void   )  [virtual]
 

Direct3D support method that must be called prior to a Reset call on the Direct3DDevice; this is required so that the GUI renderer can release any unmanaged D3D resources as needed for the device reset to succeed.

Definition at line 605 of file renderer.cpp.

References CEGUI::DirectX81Texture::preD3DReset().

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

Remove all Event objects from the EventSet.

Returns:
Nothing

Definition at line 84 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 68 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_events.

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

Reset the z co-ordinate for rendering.

Returns:
Nothing

Definition at line 300 of file CEGUIRenderer.h.

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

void CEGUI::DirectX81Renderer::setDisplaySize const Size sz  ) 
 

Set the size of the display in pixels.

This method is important if your D3D 8 device is a pure device; since with a pure device the system is unable to determine the size of the view port, so you must manually tell it the size by using this method.

Note:
This method will cause the EventDisplaySizeChanged event to fire if the display size has changed.
Parameters:
sz Size object describing the size of the display.
Returns:
Nothing.

Definition at line 692 of file renderer.cpp.

References CEGUI::EventSet::fireEvent(), CEGUI::Rect::getSize(), and CEGUI::Rect::setSize().

Referenced by postD3DReset().

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 173 of file CEGUIEventSet.cpp.

References CEGUI::EventSet::d_muted.

virtual void CEGUI::DirectX81Renderer::setQueueingEnabled bool  setting  )  [inline, 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

Implements CEGUI::Renderer.

Definition at line 124 of file renderer.h.

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

Subscribes the 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 126 of file CEGUIEventSet.cpp.

References CEGUI::Event::Connection, CEGUI::EventSet::d_events, and CEGUI::Event::Subscriber.

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

Subscribes the 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 110 of file CEGUIEventSet.cpp.

References CEGUI::Event::Connection, CEGUI::EventSet::d_events, and CEGUI::Event::Subscriber.

Referenced by CEGUI::TabControl::addButtonForTabContent(), CEGUI::TabControl::addTab(), CEGUI::ListHeader::createInitialisedSegment(), CEGUI::StaticText::initialise(), CEGUI::Slider::initialise(), CEGUI::Scrollbar::initialise(), CEGUI::MultiColumnList::initialise(), CEGUI::FrameWindow::initialise(), and CEGUI::Combobox::initialise().


Member Data Documentation

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

Definition at line 208 of file CEGUIEventSet.h.

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

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

true if events for this EventSet have been muted.

Definition at line 210 of file CEGUIEventSet.h.

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

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

Holds the pointer to the ResourceProvider object.

Definition at line 362 of file CEGUIRenderer.h.

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

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

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 CEGUI::Renderer::Renderer().

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

Namespace for global events.


The documentation for this class was generated from the following files:
Generated on Wed Feb 16 12:41:22 2005 for Crazy Eddies GUI System by  doxygen 1.3.9.1