GUI Control Subclasses

From HEWIKI
Jump to: navigation, search

Contents

There are certain GUI Control classes that are part of the GUIPanel list of fields, which have their own subfields. Specifically:

This page documents the fields for each of these subclasses.

xy Subclass

The xy Subclass covers x and y coordinates, for specifying things such as a size or a location. All x,y. coordinates are in pixels.

Field Datatype Default Value Description
x float 0.0 x-coordinate (width)
y float 0.0 y-coordinate (height)


uv Subclass

The uv Subclass covers the appearance of the control. It has the following subfields:

Field Subclass or Datatype Default Settings Description
color rgba (see subclass) The RGB and Alpha values of the State Presentation
position xy (see subclass) The x,y coordinates, in pixels, of the location of the Control's top left corner, in relation to the top left corner (0,0) of its parent.
size xy (see subclass) The x,y coordinates, in pixels, of the Control's lower right corner, in relation to the top left corner of the Control. So a size of (1.0,1.0) would mean a control that was exactly 1 pixel in size.
set boolean   for internal use


rgba Subclass

Field Datatype Default Value Description
r float 1.0 Red component of the RGB tint of the texture. Possible values are 0.0 - 1.0
g float 1.0 Green component of the RGB tint of the texture. Possible values are 0.0 - 1.0
b float 1.0 Blue component of the RGB tint of the texture. Possible values are 0.0 - 1.0
a float 1.0 Alpha (transparency) value of the texture. Possible values are 0.0 (transparent) - 1.0 (opaque)


windowSides Subclass

This subclass (complex field) is generally used for situations such as how a child window anchors to the parent, or how it resizes. For whichever one is TRUE, resizing the parent will also move or size the child in relation. Having just one of the top/bottom or left/right pairs set to TRUE will move the child, and having both of a pair set to TRUE will cause the child to resize.

Field Datatype Default Value Description
top boolean context-sensitive  
bottom boolean context-sensitive  
left boolean context-sensitive  
right boolean context-sensitive  


hv Subclass

Primarily used by the GUIControl tiling field. Tiling controls how the texture is drawn on the control. If tiling is turned on, then these control how the texture appears.

Field Datatype Default Value Description
horizontal boolean FALSE When set to TRUE, then the texture will be tiled horizontally, as opposed to stretched out to the length of the window.
vertical boolean FALSE When set to TRUE, then the texture will be tiled horizontally, as opposed to stretched out to the length of the window.

If both are set to TRUE, then the texture will appear in a grid pattern.


minMax Subclass

Normally used on GUINumericField and GUISlider controls. Its use is context-sensitive.

Field Datatype Default Value Description
min float 0 context-sensitive
max float 0 context-sensitive


justify Subclass

Field Datatype Default Value Description
top boolean TRUE  
bottom boolean FALSE  
left boolean TRUE  
right boolean FALSE  
vcenter boolean FALSE  
wordBreak boolean TRUE  
center boolean FALSE  
singleLine boolean FALSE  


alphaMask Subclass

Field Datatype Default Value Description
material string NULL An FQN, set to the path and name of a texture file to use as a mask
position xy 0,0 use to specify the area of the alpha mask to apply
size xy 0,0 use to specify the area of the alpha mask to apply


The alpha channel in the alphaMask is multiplied in to the rendered image, and in the portions where the alphaMask is completely transparent ( <=10% ), the control will ignore mouse events. This can be used to create controls that look and behave as if they are not rectangular.

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox