CEGUI::ClippedContainer Class Reference

Helper container window that has configurable clipping. Used by the ItemListbox widget. More...

Inheritance diagram for CEGUI::ClippedContainer:

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

Collaboration graph
[legend]

List of all members.

Public Member Functions

 ClippedContainer (const String &type, const String &name)
 Constructor for ClippedContainer objects.
 ~ClippedContainer (void)
 Destructor for ClippedContainer objects.
const RectgetClipArea (void) const
 Return the current clipping rectangle.
WindowgetClipperWindow (void) const
 Returns the reference window used for converting the clipper rect to screen space.
void setClipArea (const Rect &r)
 Set the custom clipper area in pixels.
void setClipperWindow (Window *w)
 Set the clipper reference window.
virtual Rect getUnclippedInnerRect_impl (void) const
 Return a Rect object that describes, unclipped, the inner rectangle for this window. The inner rectangle is typically an area that excludes some frame or other rendering that should not be touched by subsequent rendering.

Static Public Attributes

static const String WidgetTypeName
 Type name for ClippedContainer.
static const String EventNamespace
 Namespace for global events.

Protected Member Functions

virtual bool testClassName_impl (const String &class_name) const
 Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.
virtual void drawSelf (float)
 Perform the actual rendering for this Window.

Protected Attributes

Rect d_clipArea
 the pixel rect to be used for clipping relative to either a window or the screen.
Windowd_clipperWindow
 the base window which the clipping rect is relative to.


Detailed Description

Helper container window that has configurable clipping. Used by the ItemListbox widget.

Member Function Documentation

virtual void CEGUI::ClippedContainer::drawSelf ( float  z  )  [inline, protected, virtual]

Perform the actual rendering for this Window.

Parameters:
z float value specifying the base Z co-ordinate that should be used when rendering
Returns:
Nothing

Reimplemented from CEGUI::Window.

const Rect & CEGUI::ClippedContainer::getClipArea ( void   )  const

Return the current clipping rectangle.

Returns:
Rect object describing the clipping area in pixel that will be applied during rendering.

References d_clipArea.

Rect CEGUI::ClippedContainer::getUnclippedInnerRect_impl ( void   )  const [virtual]

Return a Rect object that describes, unclipped, the inner rectangle for this window. The inner rectangle is typically an area that excludes some frame or other rendering that should not be touched by subsequent rendering.

Returns:
Rect object that describes, in unclipped screen pixel co-ordinates, the window object's inner rect area.

Reimplemented from CEGUI::Window.

References d_clipArea, d_clipperWindow, and CEGUI::CoordConverter::windowToScreen().

void CEGUI::ClippedContainer::setClipperWindow ( CEGUI::Window w  ) 

Set the clipper reference window.

Parameters:
w The window to be used a base for converting the custom clipper rect to screen space. NULL if the clipper rect is relative to the screen.

References d_clipperWindow, CEGUI::Window::notifyClippingChanged(), and CEGUI::Window::requestRedraw().

virtual bool CEGUI::ClippedContainer::testClassName_impl ( const String class_name  )  const [inline, protected, virtual]

Return whether this window was inherited from the given class name at some point in the inheritance hierarchy.

Parameters:
class_name The class name that is to be checked.
Returns:
true if this window was inherited from class_name. false if not.

Reimplemented from CEGUI::Window.

References CEGUI::Window::testClassName_impl().


Generated on Thu Nov 27 20:34:33 2008 for Crazy Eddies GUI System by  doxygen 1.5.7.1