nGuiSkin Class Reference
[Graphical User Interface]
#include <nguiskin.h>
Inheritance diagram for nGuiSkin:
Detailed Description
A GUI skin object holds an user-defined table of gui resources which are used by the GUI widgets to render themselves.Each gui resource describes a rectangular texture area. That way it is possible to distribute the GUI brushes over any number of textures.
(C) 2004 RadonLabs GmbH
Definition at line 24 of file nguiskin.h.
Public Member Functions | |
| nGuiSkin () | |
| constructor | |
| virtual | ~nGuiSkin () |
| destructor | |
| void | UnloadUntouchedGuiResources () |
| unload all gui resources which have not been rendered last frame | |
| void | SetTexturePrefix (const char *prefix) |
| set texture prefix | |
| const char * | GetTexturePrefix () const |
| get texture prefix | |
| void | SetTexturePostfix (const char *postfix) |
| set texture postfix | |
| const char * | GetTexturePostfix () const |
| get texture postfix | |
| void | SetActiveWindowColor (const vector4 &c) |
| set the active window color | |
| const vector4 & | GetActiveWindowColor () const |
| get the active window color | |
| void | SetInactiveWindowColor (const vector4 &c) |
| set the inactive window color | |
| const vector4 & | GetInactiveWindowColor () const |
| get the inactive window color | |
| void | SetTextColor (const vector4 &c) |
| set the default text color | |
| const vector4 & | GetTextColor () const |
| get the default text color | |
| void | SetButtonTextColor (const vector4 &c) |
| set button text color | |
| const vector4 & | GetButtonTextColor () const |
| get button text color | |
| void | SetTitleTextColor (const vector4 &c) |
| set title text color | |
| const vector4 & | GetTitleTextColor () const |
| get title text color | |
| void | SetLabelTextColor (const vector4 &c) |
| set label text color | |
| const vector4 & | GetLabelTextColor () const |
| get label text color | |
| void | SetEntryTextColor (const vector4 &c) |
| set text entry text color | |
| const vector4 & | GetEntryTextColor () const |
| get text entry text color | |
| void | SetMenuTextColor (const vector4 &c) |
| set menu entry text color | |
| const vector4 & | GetMenuTextColor () const |
| get menu entry text color | |
| void | SetWindowBorder (const rectangle &v) |
| set window broder size | |
| const rectangle & | GetWindowBorder () const |
| get window border size | |
| void | SetWindowFont (const char *fnt) |
| set window font | |
| const char * | GetWindowFont () const |
| get window font | |
| void | SetButtonFont (const char *fnt) |
| set button font | |
| const char * | GetButtonFont () const |
| get button font | |
| void | SetLabelFont (const char *fnt) |
| set label font | |
| const char * | GetLabelFont () const |
| get label font | |
| void | BeginBrushes () |
| begin adding brushes | |
| void | AddBrush (const char *name, const char *tex, const vector2 &uvPos, const vector2 &uvSize, const vector4 &color) |
| add a skin brush | |
| void | AddDynamicBrush (const char *name, int width, int height) |
| Add dynamic brush with name `name'. | |
| void | EndBrushes () |
| end adding brushes | |
| nGuiResource * | FindBrush (const char *name) |
| lookup gui resource for a brush | |
| void | AddSoundObject (const char *name, const char *filename) |
| add a sound object | |
| nSound3 * | GetSoundObject (const char *name) |
| get sound object | |
| const char * | GetSound (const char *name) const |
| get sound filename associated with the name | |
| void | SetSoundVolume (const char *name, float volume) |
| set volume for sounds objects | |
| float | GetSoundVolume (const char *name) |
| get volume for sound object | |
Constructor & Destructor Documentation
|
|
constructor
Definition at line 15 of file nguiskin_main.cc. |
|
|
destructor
Definition at line 35 of file nguiskin_main.cc. |
Member Function Documentation
|
|
unload all gui resources which have not been rendered last frame
Definition at line 245 of file nguiskin_main.cc. |
|
|
set texture prefix
Definition at line 281 of file nguiskin.h. |
|
|
get texture prefix
Definition at line 291 of file nguiskin.h. |
|
|
set texture postfix
Definition at line 301 of file nguiskin.h. |
|
|
get texture postfix
Definition at line 311 of file nguiskin.h. |
|
|
set the active window color
Definition at line 321 of file nguiskin.h. |
|
|
get the active window color
Definition at line 331 of file nguiskin.h. |
|
|
set the inactive window color
Definition at line 341 of file nguiskin.h. |
|
|
get the inactive window color
Definition at line 351 of file nguiskin.h. |
|
|
set the default text color
Definition at line 221 of file nguiskin.h. |
|
|
get the default text color
Definition at line 231 of file nguiskin.h. |
|
|
set button text color
Definition at line 201 of file nguiskin.h. |
|
|
get button text color
Definition at line 211 of file nguiskin.h. |
|
|
set title text color
Definition at line 181 of file nguiskin.h. |
|
|
get title text color
Definition at line 191 of file nguiskin.h. |
|
|
set label text color
Definition at line 161 of file nguiskin.h. |
|
|
get label text color
Definition at line 171 of file nguiskin.h. |
|
|
set text entry text color
Definition at line 141 of file nguiskin.h. |
|
|
get text entry text color
Definition at line 151 of file nguiskin.h. |
|
|
set menu entry text color
Definition at line 241 of file nguiskin.h. |
|
|
get menu entry text color
Definition at line 251 of file nguiskin.h. |
|
|
set window broder size
Definition at line 261 of file nguiskin.h. |
|
|
get window border size
Definition at line 271 of file nguiskin.h. |
|
|
set window font
Definition at line 361 of file nguiskin.h. |
|
|
get window font
Definition at line 372 of file nguiskin.h. |
|
|
set button font
Definition at line 382 of file nguiskin.h. |
|
|
get button font
Definition at line 393 of file nguiskin.h. |
|
|
set label font
Definition at line 403 of file nguiskin.h. |
|
|
get label font
Definition at line 414 of file nguiskin.h. |
|
|
begin adding brushes Begin adding skin brushes. Definition at line 54 of file nguiskin_main.cc. |
|
||||||||||||||||||||||||
|
add a skin brush Add a new skin brush. The brush is defined by its name, the filename of a texture, and a rectangle within the texture in absolute texel coordinates. Adding 2 brushes with identical name is a fatal error.
Definition at line 82 of file nguiskin_main.cc. |
|
||||||||||||||||
|
Add dynamic brush with name `name'. Add a dynamic brush. Instead of a texture, the brush uses a render target. An outside source may render into that target (e.g. The Video Server).
Definition at line 115 of file nguiskin_main.cc. |
|
|
end adding brushes Finish adding brushes. Definition at line 64 of file nguiskin_main.cc. |
|
|
lookup gui resource for a brush Find a brush's GUI resource by its name. Returns a 0 pointer if not found. Definition at line 137 of file nguiskin_main.cc. |
|
||||||||||||
|
add a sound object Get pointer to sound object, initialize sound on demand, returns 0 if sound filename not set. Definition at line 159 of file nguiskin_main.cc. |
|
|
get sound object Get pointer to sound object, initialize sound on demand, returns 0 if sound filename not set. Definition at line 187 of file nguiskin_main.cc. |
|
|
get sound filename associated with the name Get the filename associated with that sound name Definition at line 211 of file nguiskin_main.cc. |
|
||||||||||||
|
set volume for sounds objects
Definition at line 222 of file nguiskin_main.cc. |
|
|
get volume for sound object
Definition at line 235 of file nguiskin_main.cc. |
The documentation for this class was generated from the following files:
