Public Member Functions | |
ClippedContainer (const String &type, const String &name) | |
Constructor for ClippedContainer objects. | |
~ClippedContainer (void) | |
Destructor for ClippedContainer objects. | |
const Rect & | getClipArea (void) const |
Return the current clipping rectangle. | |
Window * | getClipperWindow (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. | |
Window * | d_clipperWindow |
the base window which the clipping rect is relative to. |
virtual void CEGUI::ClippedContainer::drawSelf | ( | float | z | ) | [inline, protected, virtual] |
Perform the actual rendering for this Window.
z | float value specifying the base Z co-ordinate that should be used when rendering |
Reimplemented from CEGUI::Window.
const Rect & CEGUI::ClippedContainer::getClipArea | ( | void | ) | const |
Return the current clipping rectangle.
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.
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.
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.
class_name | The class name that is to be checked. |
Reimplemented from CEGUI::Window.
References CEGUI::Window::testClassName_impl().