Torque3D Documentation / _generateds / guiBackgroundCtrl.cpp

guiBackgroundCtrl.cpp

Engine/source/gui/controls/guiBackgroundCtrl.cpp

More...

Public Functions

ConsoleDocClass(GuiBackgroundCtrl , "@brief Renders <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> background, so you can have <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> backdrop <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> your <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">GUI.\n\n</a>" "<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Deprecated\n\n</a>" " @ingroup <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">GuiImages\n</a>" " @internal" )

Detailed Description

Public Functions

ConsoleDocClass(GuiBackgroundCtrl , "@brief Renders <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> background, so you can have <a href="/coding/file/pointer_8h/#pointer_8h_1aeeddce917cf130d62c370b8f216026dd">a</a> backdrop <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1a2732ab74fa0237854c2ba0f75f88a624">for</a> your <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">GUI.\n\n</a>" "<a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">Deprecated\n\n</a>" " @ingroup <a href="/coding/file/cmdscan_8cpp/#cmdscan_8cpp_1aeab71244afb687f16d8c4f5ee9d6ef0e">GuiImages\n</a>" " @internal" )

IMPLEMENT_CONOBJECT(GuiBackgroundCtrl )

 1
 2//-----------------------------------------------------------------------------
 3// Copyright (c) 2012 GarageGames, LLC
 4//
 5// Permission is hereby granted, free of charge, to any person obtaining a copy
 6// of this software and associated documentation files (the "Software"), to
 7// deal in the Software without restriction, including without limitation the
 8// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 9// sell copies of the Software, and to permit persons to whom the Software is
10// furnished to do so, subject to the following conditions:
11//
12// The above copyright notice and this permission notice shall be included in
13// all copies or substantial portions of the Software.
14//
15// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21// IN THE SOFTWARE.
22//-----------------------------------------------------------------------------
23
24#include "console/console.h"
25#include "gui/controls/guiBackgroundCtrl.h"
26
27IMPLEMENT_CONOBJECT(GuiBackgroundCtrl);
28
29ConsoleDocClass( GuiBackgroundCtrl,
30   "@brief Renders a background, so you can have a backdrop for your GUI.\n\n"
31
32   "Deprecated\n\n"
33
34   "@ingroup GuiImages\n"
35
36   "@internal"
37);
38
39//--------------------------------------------------------------------------
40GuiBackgroundCtrl::GuiBackgroundCtrl() : GuiControl()
41{
42   mDraw = false;
43   mIsContainer = true;
44}
45
46//--------------------------------------------------------------------------
47void GuiBackgroundCtrl::onRender(Point2I offset, const RectI &updateRect)
48{
49   if ( mDraw )
50      Parent::onRender( offset, updateRect );
51
52   renderChildControls(offset, updateRect);
53}
54
55
56